This endpoint queries the information about this qr code and the payments related to it.

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/dynamic/:correlationId'

Headers

Name	Description
x-delbank-api-key	Required. API key

Path Parameters

Name	Type	Description
correlationId	`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:

{
    "transactionId": "vchargec9bdeb422c204c79b72b5de6e",
    "correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
    "type": "DYNAMIC_IMMEDIATE_PAYMENT",
    "amount": 0.10,
    "status": "CONCLUDED",
    "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",
    "expiresAt": "2024-12-11T14:35:20.31Z",
    "createdAt": "2024-12-11T14:05:20.31Z",
    "payments": [
        {
            "idempotencyKey": "c9d990bd-2752-42a3-912e-a10bc06eee68",
            "transactionId": "vchargec9bdeb422c204c79b72b5de6e",
            "correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
            "endToEndId": "E382248572024121114111XCLOQ653D5",
            "key": "+5511999975734",
            "status": "PIX_EFFECTIVE",
            "amount": 0.10,
            "initiationType": "QR_CODE_DYNAMIC",
            "description": "description",
            "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"
        }
    ],
    "additionalInfo": [
        {
            "name": "INFO 01",
            "value": "INFO VALUE 01"
        }
    ],
    "allowChangeAmount": true
}

Request for dynamic due-date

GET 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/due-date/:correlationId'

Headers

Name	Description
x-delbank-api-key	Required. API key

Path Parameters

Name	Type	Description
correlationId	`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:

{
    "transactionId": "wcharge8f497a9b863846cdaa8251249",
    "correlationId": "9b722646-187e-4d62-91e2-56eae6a54d56",
    "type": "DYNAMIC_DUE_DATE",
    "amount": 59.00,
    "originalAmount": 80,
    "status": "ACTIVE",
    "payer": {
        "name": "JOAO ALVES",
        "document": "12345678912",
        "validate": false
    },
    "address": {
        "cityName": "ARACAJU",
        "zipCode": "49000000",
        "uf": "SE",
        "state": "SE",
        "street": "LOGRADOURO"
    },
    "payloadPix": "26810014br.gov.bcb.pix2559pix.delbank.com.br/v2/cobv/wcharge8f497a9b863846cdaa82512495204000053039865802BR5907DELBANK6007ARACAJU62070503***6304A957",
    "createdAt": "2025-01-13T20:24:56.875Z",
    "dueDate": "2025-12-30",
    "maxDaysOverdue": 60,
    "rebate": {
        "amount": 1.00,
        "chargeType": "FIXED_AMOUNT"
    },
    "discount": {
        "chargeType": "FIXED_AMOUNT",
        "discountsDueDate": [
            {
                "dueDate": "2025-05-16",
                "amount": 20.00
            },
            {
                "dueDate": "2025-06-16",
                "amount": 10.00
            }
        ]
    },
    "interest": {
        "amount": 1.00,
        "chargeType": "PERCENTAGE_PER_DAY_CALENDAR_DAY"
    },
    "fine": {
        "amount": 10.00,
        "chargeType": "PERCENTAGE"
    },
    "payments": [],
    "additionalInfo": [
        {
            "name": "INFO 01",
            "value": "INFO VALUE 01"
        }
    ]
}

The QR Code can have the following status types

Status	Description
ACTIVE	Indicates de QR Code is active and can be paid
CONCLUDED	The QR Code has been paid
EXPIRED	The QR Code has expired
REMOVED_BY_PAYEE	The QR Code has been removed by it's creator
REMOVED_BY_PSP	The QR Code has been removed by us Delbank