Criar QR Code Dinâmico

curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/dynamic' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "correlationId": "{{$guid}}",
    "amount": 99.90,
    "expiresIn": 1800,
    "formatResponse": "PAYLOAD_AND_QRCODE"
}'

{
    "correlationId": "40ede975-031d-4517-bdd4-31472d3f00a4",
    "transactionId": "vchargeffab8b4c963344c283e491f5e",
    "amount": 99.90,
    "allowChangeAmount": false,
    "expiresIn": 1800,
    "status": "ACTIVE",
    "address": {
        "cityName": "ARACAJU",
        "zipCode": "49000000",
        "uf": "SE",
        "state": "SE",
        "street": "LOGRADOURO"
    },
    "createdAt": "2024-12-10T13:19:26.501Z",
    "updatedAt": "2024-12-10T13:19:26.501Z",
    "expiresAt": "2024-12-10T13:49:26.501Z",
    "payloadPix": "00020101021226820014br.gov.bcb.pix2560pix-h.delbank.com.br/v2/cob/vchargeffab8b4c963344c283e491f5e5204000053039865802BR5907DELBANK6007ARACAJU62070503***6304CB42",
    "qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoA..."
}

POST

pix

qrcode

dynamic

curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/dynamic' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "correlationId": "{{$guid}}",
    "amount": 99.90,
    "expiresIn": 1800,
    "formatResponse": "PAYLOAD_AND_QRCODE"
}'

{
    "correlationId": "40ede975-031d-4517-bdd4-31472d3f00a4",
    "transactionId": "vchargeffab8b4c963344c283e491f5e",
    "amount": 99.90,
    "allowChangeAmount": false,
    "expiresIn": 1800,
    "status": "ACTIVE",
    "address": {
        "cityName": "ARACAJU",
        "zipCode": "49000000",
        "uf": "SE",
        "state": "SE",
        "street": "LOGRADOURO"
    },
    "createdAt": "2024-12-10T13:19:26.501Z",
    "updatedAt": "2024-12-10T13:19:26.501Z",
    "expiresAt": "2024-12-10T13:49:26.501Z",
    "payloadPix": "00020101021226820014br.gov.bcb.pix2560pix-h.delbank.com.br/v2/cob/vchargeffab8b4c963344c283e491f5e5204000053039865802BR5907DELBANK6007ARACAJU62070503***6304CB42",
    "qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoA..."
}

Para entender quando usar este endpoint e ver o passo a passo completo, veja o guia Cobrança Imediata (QR Code Dinâmico).

Headers

string

required

Sua API key.

string

required

Número da conta Delfinance.

Body

string

required

Identificador usado para conciliação com o seu sistema. Retornado no webhook de confirmação de pagamento. Deve ser um GUID.

number

required

Valor da cobrança em reais.

string

Descrição interna da cobrança.

number

Prazo de expiração do QR Code em segundos, contados a partir da criação. O padrão é 86400 (24 horas).

string

Controla se a imagem do QR Code é retornada na resposta. Valores aceitos:

ONLY_PAYLOAD (padrão) — retorna apenas o payloadPix.
PAYLOAD_AND_QRCODE — retorna também qrCodeImageBase64 com a imagem pronta (250×250 px).

object

Dados do pagador esperado.

Show payer

string

Nome do pagador.

string

CPF ou CNPJ do pagador.

boolean

Quando true, o QR Code só pode ser pago pelo documento informado. Qualquer outra pessoa que tentar pagar será bloqueada.

object

Endereço da transação. Se omitido, o padrão é Aracaju/SE.

Show address

string

Nome da cidade.

string

CEP.

string

UF do estado (ex: SP).

string

Nome do logradouro.

array

Lista de informações adicionais exibidas ao pagador no app do banco.

Show additionalInfos[]

string

Rótulo da informação.

string

Valor da informação.

array

Instruções de split: distribuição automática de parte do valor para outra conta no momento do recebimento. O amount total das divisões não pode ultrapassar 50% do valor da cobrança, e o valor da cobrança deve ser maior que R$ 1,00.

Show splitInstructions[]

string

required

Número da conta que receberá a parcela.

string

required

Tipo do split: FIXED (valor fixo em reais) ou PERCENTAGE (porcentagem do total).

number

required

Valor ou percentual a ser transferido, conforme o type.

object

Dados do beneficiário final da transação. Usado por gateways e subadquirentes para identificar o recebedor real — essa informação é exibida ao pagador no app do banco.

Show finalBeneficiary

string

required

Nome do beneficiário final.

string

required

CPF ou CNPJ do beneficiário final.

string

required

Cidade do beneficiário final.

Response

string

Identificador de correlação enviado na criação.

string

Identificador único do QR Code gerado.

number

Valor da cobrança.

boolean

Indica se o pagador pode alterar o valor ao pagar.

number

Prazo de expiração em segundos.

string

Status do QR Code. Valor inicial: ACTIVE.

object

Dados do pagador, quando informados na criação.

object

Endereço da transação (cityName, zipCode, uf, state, street).

string

Data e hora de criação, em formato ISO 8601.

string

Data e hora da última atualização.

string

Data e hora exata de expiração, em formato ISO 8601.

string

Payload Pix (BR Code) em texto — o “copia e cola”.

string

Imagem do QR Code pronta para exibição, em base64 (250×250 px). Presente apenas quando formatResponse é PAYLOAD_AND_QRCODE.

array

Informações adicionais enviadas na criação.

array

Instruções de split enviadas na criação.

object

Dados do beneficiário final, quando informado na criação.

curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/dynamic' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "correlationId": "{{$guid}}",
    "amount": 99.90,
    "expiresIn": 1800,
    "formatResponse": "PAYLOAD_AND_QRCODE"
}'

{
    "correlationId": "40ede975-031d-4517-bdd4-31472d3f00a4",
    "transactionId": "vchargeffab8b4c963344c283e491f5e",
    "amount": 99.90,
    "allowChangeAmount": false,
    "expiresIn": 1800,
    "status": "ACTIVE",
    "address": {
        "cityName": "ARACAJU",
        "zipCode": "49000000",
        "uf": "SE",
        "state": "SE",
        "street": "LOGRADOURO"
    },
    "createdAt": "2024-12-10T13:19:26.501Z",
    "updatedAt": "2024-12-10T13:19:26.501Z",
    "expiresAt": "2024-12-10T13:49:26.501Z",
    "payloadPix": "00020101021226820014br.gov.bcb.pix2560pix-h.delbank.com.br/v2/cob/vchargeffab8b4c963344c283e491f5e5204000053039865802BR5907DELBANK6007ARACAJU62070503***6304CB42",
    "qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoA..."
}

Introdução

Pix

Boleto

Split de Pagamentos

Webhooks

Criar QR Code Dinâmico

Headers

Body

Response

​Headers

​Body

​Response

Headers

Body

Response