This endpoint queries the information about this qr code and the payments related to it.
Request
GET 'https://apisandbox.delbank.com.br/baas/api/v1/pix/qrcode/dynamic/:correlationId'
Headers
| Name | Description |
|---|---|
| x-delbank-api-key | Required. API key |
Path Parameters
| Name | Type | Description |
|---|---|---|
| correlactionId | string | Required. Identification of the QR code passed at the time of the request |
Response
The status code 200 indicates success in the transaction.
Being succeeded, the return will have the following fields in Json format:
{
"correlationId": "87506682-571d-47a9-a588-9f5202349327",
"amount": 299.10,
"status": "PAID",
"expiresIn": 86400,
"createdAt": "2024-02-08T13:45:21.891Z",
"updatedAt": "2024-02-08T13:47:24.300Z",
"expiresAt": "2024-02-09T13:45:21.891Z",
"qrCodePayload": "00020101021226850014br.gov.bcb.pix2563pix-h.delbank.com.br/v1/qrcode/vcharge0135efc5abdd4ae2830245c7a5204000053039865802BR5907DELBANK6004NAME62070503***63049B34",
"payer": {
"name": "BRUNO DA SILVA",
"document": "***308565**"
},
"city": {
"name": "Name",
"zipCode": "95095100"
},
"payments": [
{
"idempotencyKey": "52f885b7-46fc-4e50-a6f2-edb53cece4ce",
"transactionId": "vcharge0135efc5abdd4ae2830245c7a",
"endToEndId": "E9999900320240208134724YPdmp6gJV",
"status": "PIX_EFFECTIVE",
"initiationType": "QR_CODE_DYNAMIC",
"operationType": "RECEIPT",
"amount": 299.10,
"createdAt": "2024-02-08T13:47:24.630Z",
"finishedAt": "2024-02-08T13:47:24.630Z",
"payer": {
"number": "826953",
"branch": "9162",
"type": "CURRENT",
"participant": {
"name": "BCO DO BRASIL S.A.",
"ispb": "00000000"
},
"holder": {
"name": "CENTRO DE SAUDE CREDILUZ LTDA",
"document": "12345678901234",
"type": "LEGAL"
}
},
"beneficiary": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "DELCRED SCD S.A.",
"ispb": "38224857"
},
"holder": {
"name": "BXXDBDE",
"document": "32752023000149",
"type": "LEGAL"
}
}
}
]
}
It is possible to consult only payments without qr code information.
Request
GET 'https://apisandbox.delbank.com.br/baas/api/v1/pix/qrcode/dynamic/:correlationId/payments'
Response
The status code 200 indicates success in the transaction.
Being succeeded, the return will have the following fields in Json format:
[
{
"idempotencyKey": "52f885b7-46fc-4e50-a6f2-edb53cece4ce",
"transactionId": "vcharge0135efc5abdd4ae2830245c7a",
"endToEndId": "E9999900320240208134724YPdmp6gJV",
"status": "PIX_EFFECTIVE",
"initiationType": "QR_CODE_DYNAMIC",
"operationType": "RECEIPT",
"amount": 299.10,
"createdAt": "2024-02-08T13:47:24.630Z",
"finishedAt": "2024-02-08T13:47:24.630Z",
"payer": {
"number": "826953",
"branch": "9162",
"type": "CURRENT",
"participant": {
"name": "BCO DO BRASIL S.A.",
"ispb": "00000000"
},
"holder": {
"name": "CENTRO DE SAUDE CREDILUZ LTDA",
"document": "12345678901234",
"type": "LEGAL"
}
},
"beneficiary": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"participant": {
"name": "DELCRED SCD S.A.",
"ispb": "38224857"
},
"holder": {
"name": "BXXDBDE",
"document": "32752023000149",
"type": "LEGAL"
}
}
}
]