Esse endpoint consulta as informações desse qr code e os pagamento relacionados a ele.

Requisição

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

Cabeçalhos (headers)

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave de API

Parâmetros da rota (Path)

Nome	Tipo	Descrição
correlationId	`string`	Obrigatório. Identificação do QR code passado no momento da requisição

Resposta (Response)

O status code 200 indicará sucesso na transação.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
    "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
}

Requisição para dynamic due-date

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

Cabeçalhos (headers)

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave de API

Parâmetros da rota (Path)

Name	Type	Description
correlationId	`string`	Obrigatório. Identificação do QR code passado no momento da requisição

Resposta (Response)

O status code 200 indicará sucesso na transação.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
    "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"
        }
    ]
}

O QR Code pode ter os seguintes tipos de status

Status	Description
ACTIVE	Indica que o QR Code está ativo e pode ser pago
CONCLUDED	O QR Code foi pago
EXPIRED	O QR Code expirou
REMOVED_BY_PAYEE	O QR Code foi removido por quem criou
REMOVED_BY_PSP	O QR Code foi removido por nós, Delbank