API Reference
Log In
API Reference

Query Static QR Code

This endpoint queries the information about this qr code.

Request

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

Headers

NameDescription
x-delbank-api-keyRequired. API key

Path Parameters

NameTypeDescription
transactionIdentifierstringRequired. Identification of the QR code, can be the correlationId or transactionId

Response

The status code 200 indicates success in the transaction. Note that this request will only find a QR code if it was created with the same API Key

Being succeeded, the return will have the following fields in Json format:

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

Query QR code payments

Since there can be multiple payments to a static QR code, we have a specific endpoint to get the payments made

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

Response

On success, this is the response:

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