curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/dynamic/{{transactionIdentifier}}' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}'
{
"transactionId": "vchargec9bdeb422c204c79b72b5de6e",
"correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
"type": "DYNAMIC_IMMEDIATE_PAYMENT",
"amount": 99.90,
"status": "CONCLUDED",
"allowChangeAmount": false,
"payer": {
"name": "PAYER NAME",
"document": "47779921018",
"validate": true
},
"address": {
"cityName": "SAO PAULO",
"zipCode": "49000000",
"state": "SP",
"street": "LOGRADOURO"
},
"payloadPix": "00020101021226820014br.gov.bcb.pix2560pix-h.delbank.com.br/v2/cob/vchargec9bdeb422c204c79b72b5de6e5204000053039865802BR5907DELBANK6009SAO PAULO62070503***6304DCAD",
"createdAt": "2024-12-11T14:05:20.310Z",
"expiresAt": "2024-12-11T14:35:20.310Z",
"payments": [
{
"idempotencyKey": "c9d990bd-2752-42a3-912e-a10bc06eee68",
"transactionId": "vchargec9bdeb422c204c79b72b5de6e",
"correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
"endToEndId": "E382248572024121114111XCLOQ653D5",
"key": "+5511999975734",
"status": "PIX_EFFECTIVE",
"amount": 99.90,
"initiationType": "QR_CODE_DYNAMIC",
"payer": {
"number": "29823",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "DELBANK",
"ispb": "38224857"
},
"holder": {
"name": "HOMOLOGACAO INTEGRACAO API",
"document": "30287697789",
"type": "NATURAL"
}
},
"beneficiary": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "DELBANK",
"ispb": "38224857"
},
"holder": {
"name": "BXXDBDE",
"document": "32752023000149",
"type": "LEGAL"
}
},
"createdAt": "2024-12-11T14:12:14.442Z",
"finishedAt": "2024-12-11T14:12:14.442Z"
}
]
}
Pix
Consultar QR Code Dinâmico
Consulta os dados de um QR Code Dinâmico e o pagamento associado a ele, quando realizado.
GET
/
pix
/
qrcode
/
dynamic
/
:transactionIdentifier
curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/dynamic/{{transactionIdentifier}}' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}'
{
"transactionId": "vchargec9bdeb422c204c79b72b5de6e",
"correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
"type": "DYNAMIC_IMMEDIATE_PAYMENT",
"amount": 99.90,
"status": "CONCLUDED",
"allowChangeAmount": false,
"payer": {
"name": "PAYER NAME",
"document": "47779921018",
"validate": true
},
"address": {
"cityName": "SAO PAULO",
"zipCode": "49000000",
"state": "SP",
"street": "LOGRADOURO"
},
"payloadPix": "00020101021226820014br.gov.bcb.pix2560pix-h.delbank.com.br/v2/cob/vchargec9bdeb422c204c79b72b5de6e5204000053039865802BR5907DELBANK6009SAO PAULO62070503***6304DCAD",
"createdAt": "2024-12-11T14:05:20.310Z",
"expiresAt": "2024-12-11T14:35:20.310Z",
"payments": [
{
"idempotencyKey": "c9d990bd-2752-42a3-912e-a10bc06eee68",
"transactionId": "vchargec9bdeb422c204c79b72b5de6e",
"correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
"endToEndId": "E382248572024121114111XCLOQ653D5",
"key": "+5511999975734",
"status": "PIX_EFFECTIVE",
"amount": 99.90,
"initiationType": "QR_CODE_DYNAMIC",
"payer": {
"number": "29823",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "DELBANK",
"ispb": "38224857"
},
"holder": {
"name": "HOMOLOGACAO INTEGRACAO API",
"document": "30287697789",
"type": "NATURAL"
}
},
"beneficiary": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "DELBANK",
"ispb": "38224857"
},
"holder": {
"name": "BXXDBDE",
"document": "32752023000149",
"type": "LEGAL"
}
},
"createdAt": "2024-12-11T14:12:14.442Z",
"finishedAt": "2024-12-11T14:12:14.442Z"
}
]
}
Para o passo a passo completo de uso, veja o guia Cobrança Imediata (QR Code Dinâmico).
Headers
string
required
Sua API key.
string
required
Número da conta Delfinance.
Path Parameters
string
required
Identificador do QR Code: pode ser o
correlationId ou o transactionId.Response
string
Identificador único do QR Code.
string
Identificador de correlação definido na criação.
string
Tipo da cobrança. Valor:
DYNAMIC_IMMEDIATE_PAYMENT.number
Valor da cobrança.
string
Status atual do QR Code. Valores possíveis:
ACTIVE, CONCLUDED, CANCELLED.boolean
Indica se o pagador pode alterar o valor ao pagar.
object
Dados do pagador informados na criação, quando presentes.
object
Endereço da transação (
cityName, zipCode, state, street).string
Payload Pix (BR Code) em texto — o “copia e cola”.
string
Data e hora de criação, em formato ISO 8601.
string
Data e hora de expiração, em formato ISO 8601.
array
Informações adicionais definidas na criação.
array
Lista de pagamentos realizados sobre este QR Code. Para um QR Code Dinâmico, conterá no máximo um item. O array estará vazio enquanto o pagamento não tiver ocorrido.
Show payments[]
Show payments[]
string
Chave de idempotência do pagamento.
string
Identificador do QR Code associado ao pagamento.
string
Identificador de correlação do QR Code.
string
Identificador único do pagamento no Banco Central (E2E ID).
string
Chave Pix do recebedor utilizada na transação.
string
Status do pagamento. Valor esperado após liquidação:
PIX_EFFECTIVE.number
Valor efetivamente pago.
string
Tipo de iniciação do pagamento. Valor:
QR_CODE_DYNAMIC.object
Dados reais da conta que realizou o pagamento (banco, agência, titular).
object
Dados da conta recebedora.
string
Data e hora em que o pagamento foi processado.
string
Data e hora em que o pagamento foi liquidado.
curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/dynamic/{{transactionIdentifier}}' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}'
{
"transactionId": "vchargec9bdeb422c204c79b72b5de6e",
"correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
"type": "DYNAMIC_IMMEDIATE_PAYMENT",
"amount": 99.90,
"status": "CONCLUDED",
"allowChangeAmount": false,
"payer": {
"name": "PAYER NAME",
"document": "47779921018",
"validate": true
},
"address": {
"cityName": "SAO PAULO",
"zipCode": "49000000",
"state": "SP",
"street": "LOGRADOURO"
},
"payloadPix": "00020101021226820014br.gov.bcb.pix2560pix-h.delbank.com.br/v2/cob/vchargec9bdeb422c204c79b72b5de6e5204000053039865802BR5907DELBANK6009SAO PAULO62070503***6304DCAD",
"createdAt": "2024-12-11T14:05:20.310Z",
"expiresAt": "2024-12-11T14:35:20.310Z",
"payments": [
{
"idempotencyKey": "c9d990bd-2752-42a3-912e-a10bc06eee68",
"transactionId": "vchargec9bdeb422c204c79b72b5de6e",
"correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
"endToEndId": "E382248572024121114111XCLOQ653D5",
"key": "+5511999975734",
"status": "PIX_EFFECTIVE",
"amount": 99.90,
"initiationType": "QR_CODE_DYNAMIC",
"payer": {
"number": "29823",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "DELBANK",
"ispb": "38224857"
},
"holder": {
"name": "HOMOLOGACAO INTEGRACAO API",
"document": "30287697789",
"type": "NATURAL"
}
},
"beneficiary": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "DELBANK",
"ispb": "38224857"
},
"holder": {
"name": "BXXDBDE",
"document": "32752023000149",
"type": "LEGAL"
}
},
"createdAt": "2024-12-11T14:12:14.442Z",
"finishedAt": "2024-12-11T14:12:14.442Z"
}
]
}
⌘I