Skip to main content
GET
/
pix
/
qrcode
/
dynamic
/
:transactionIdentifier
curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/dynamic/{{transactionIdentifier}}' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}'
{
    "transactionId": "vchargec9bdeb422c204c79b72b5de6e",
    "correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
    "type": "DYNAMIC_IMMEDIATE_PAYMENT",
    "amount": 99.90,
    "status": "CONCLUDED",
    "allowChangeAmount": false,
    "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",
    "createdAt": "2024-12-11T14:05:20.310Z",
    "expiresAt": "2024-12-11T14:35:20.310Z",
    "payments": [
        {
            "idempotencyKey": "c9d990bd-2752-42a3-912e-a10bc06eee68",
            "transactionId": "vchargec9bdeb422c204c79b72b5de6e",
            "correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
            "endToEndId": "E382248572024121114111XCLOQ653D5",
            "key": "+5511999975734",
            "status": "PIX_EFFECTIVE",
            "amount": 99.90,
            "initiationType": "QR_CODE_DYNAMIC",
            "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"
        }
    ]
}
Para o passo a passo completo de uso, veja o guia Cobrança Imediata (QR Code Dinâmico).

Headers

x-delbank-api-key
string
required
Sua API key.
x-delfinance-account-id
string
required
Número da conta Delfinance.

Path Parameters

transactionIdentifier
string
required
Identificador do QR Code: pode ser o correlationId ou o transactionId.

Response

transactionId
string
Identificador único do QR Code.
correlationId
string
Identificador de correlação definido na criação.
type
string
Tipo da cobrança. Valor: DYNAMIC_IMMEDIATE_PAYMENT.
amount
number
Valor da cobrança.
status
string
Status atual do QR Code. Valores possíveis: ACTIVE, CONCLUDED, CANCELLED.
allowChangeAmount
boolean
Indica se o pagador pode alterar o valor ao pagar.
payer
object
Dados do pagador informados na criação, quando presentes.
address
object
Endereço da transação (cityName, zipCode, state, street).
payloadPix
string
Payload Pix (BR Code) em texto — o “copia e cola”.
createdAt
string
Data e hora de criação, em formato ISO 8601.
expiresAt
string
Data e hora de expiração, em formato ISO 8601.
additionalInfos
array
Informações adicionais definidas na criação.
payments
array
Lista de pagamentos realizados sobre este QR Code. Para um QR Code Dinâmico, conterá no máximo um item. O array estará vazio enquanto o pagamento não tiver ocorrido.
curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/dynamic/{{transactionIdentifier}}' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}'
{
    "transactionId": "vchargec9bdeb422c204c79b72b5de6e",
    "correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
    "type": "DYNAMIC_IMMEDIATE_PAYMENT",
    "amount": 99.90,
    "status": "CONCLUDED",
    "allowChangeAmount": false,
    "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",
    "createdAt": "2024-12-11T14:05:20.310Z",
    "expiresAt": "2024-12-11T14:35:20.310Z",
    "payments": [
        {
            "idempotencyKey": "c9d990bd-2752-42a3-912e-a10bc06eee68",
            "transactionId": "vchargec9bdeb422c204c79b72b5de6e",
            "correlationId": "0123e8d1-e193-4335-9ca6-8ad99b6822a1",
            "endToEndId": "E382248572024121114111XCLOQ653D5",
            "key": "+5511999975734",
            "status": "PIX_EFFECTIVE",
            "amount": 99.90,
            "initiationType": "QR_CODE_DYNAMIC",
            "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"
        }
    ]
}