Esse endpoint busca as informações contida no QR code

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/static/:transactionIdentifier'

Headers

Name	Description
x-delbank-api-key	Obrigatório. chave de API

Path Parameters

Name	Type	Description
transactionIdentifier	`string`	Obrigatório. Identificação do código QR, pode ser correlationId ou transactionId

Response

O código de status 200 indica sucesso na transação. Note que esta requisição só encontrará um QR code se ele foi criado com a mesma chave de API

Sendo bem-sucedido, o retorno terá os seguintes campos no formato Json:

{
    "transactionId": "vchargef80c2fdcef614a",
    "correlationId": "45db17ca-601c-486c-bb7b-4e8cfdd845f2",
    "type": "QR_CODE_STATIC",
    "amount": 9.99,
    "status": "ACTIVE",
    "address": {
        "cityName": "ARACAJU",
        "zipCode": "49000000",
        "state": "SE",
        "street": "LOGRADOURO"
    },
    "payloadPix": "00020126540014br.gov.bcb.pix0114+55119999757340214testing qrcode52040000530398654049.995802BR5907DELBANK6007ARACAJU62250521vchargef80c2fdcef614a63047878",
    "createdAt": "2024-12-10T19:49:59.753Z"
}

Consultar pagamentos por QR code

Como pode haver vários pagamentos para um QR code estático, temos um ponto final específico para obter os pagamentos feitos

GET 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/static/:identifier/payments'

Response

Em caso de sucesso, esta é a resposta:

[
    {
        "endToEndId": "E3822485720241210195543SXPF4UBZ9",
        "correlationId": "45db17ca-601c-486c-bb7b-4e8cfdd845f2",
        "amount": 0.10,
        "createdAt": "2024-12-10T19:55:44.341Z",
        "proof": {
            "endToEndId": "E3822485720241210195543SXPF4UBZ9",
            "transactionId": "vchargef80c2fdcef614a",
            "correlationId": "45db17ca-601c-486c-bb7b-4e8cfdd845f2",
            "amount": 0.10,
            "description": "description",
            "payer": {
                "number": "29823",
                "branch": "0001",
                "type": 0,
                "participant": {
                    "name": "DELBANK",
                    "ispb": "38224857"
                },
                "holder": {
                    "name": "HOMOLOGACAO INTEGRACAO API",
                    "document": "30287697789",
                    "type": "NATURAL"
                }
            },
            "beneficiary": {
                "number": "31712",
                "branch": "0001",
                "type": 0,
                "participant": {
                    "name": "DELBANK",
                    "ispb": "38224857"
                },
                "holder": {
                    "name": "BXXDBDE",
                    "document": "32752023000149",
                    "type": "LEGAL"
                }
            }
        }
    }
]