Cobrança com QR Code dinâmico (pagamento imediato)

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v1/charges'

curl --location 'https://apisandbox.delbank.com.br/baas/api/v1/charges' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: ${apiKey}' \
--data '{
		"correlationId": "8a1ce36a-886c-431a-9f83-38e7d7a3f012",
    "type": "PIX_DYNAMIC",
    "expiresIn": 3600,
    "amount": 9.00,
    "city": {
        "zipCode": "49000000",
        "name": "ARACAJU"
    },    
    "payer": {
        "document": "86173851547",
        "name": "payer name"
    }
}'

Cabeçalhos (Headers)

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

Corpo da requisição (Body)

Nome	Tipo	Descrição
type	`enum`	Obrigatório. `PIX_DYNAMIC`
correlationId	`string`	Obrigatório. Id de correlação para conciliação com o `sistema cliente` Este valor será retornado nas integração via webhook e pode ser utilizado para consultar a cobrança e pagamentos
description	`string`	Descrição interna da cobrança
amount	`number`	Valor da cobrança
expiresIn	`number`	Limite para expiração do QRCode, com granularidade de segundos, para que o pagamento da cobrança possa ser realizado, a partir da data-hora de criação ou do vencimento, se existir. Se não for informado, assume-se o valor default 86400
payer	`object`	Informações do `cliente pagador`
payer.name	`string`	Nome do `cliente pagador`
payer.document	`string`	Documento (CPF/CNPJ) do `cliente pagador`
city	`object`	Informações da cidade onde é efetuada a transação
city.name	`string`	Nome da Cidade onde é efetuada transação
city.zipCode	`string`	CEP da localidade onde é efetuada transação

Exemplo básico

A forma mais simples de gerar um QR Code Dinâmico é da seguinte forma:

{
    "type": "PIX_DYNAMIC",
    "correlationId": "{{$guid}}",
    "amount": 12.12,
    "payer": {
        "name": "FULANO CICLANO",
        "document": "16166823533"
    },
    "city": {
        "name": "ARACAJU",
        "zipCode": "49000000"
    }
}

Além das informações acima, é possível enviar um tempo de expiração (caso não informado, será considerado o valor default de 86400.

{
    "type": "PIX_DYNAMIC",
    "correlationId": "{{$guid}}",
    "amount": 12.12,
    "expiresIn": 60,
    "payer": {
        "name": "FULANO CICLANO",
        "document": "16166823533"
    },
    "city": {
        "name": "ARACAJU",
        "zipCode": "49000000"
    },
    "additionalInformation": [
        {
            "key": "Campo 1",
            "value": "Informação Adicional1 do PSP-Recebedor"
        },
        {
            "key": "Campo 2",
            "value": "Informação Adicional2 do PSP-Recebedor"
        }
    ]
}

Resposta (Response)

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

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

Nome	Tipo	Descrição
type	`enum`	`PIX_DYNAMIC`
correlationId	`string`	Id de correlação para conciliação com o `sistema cliente`
description	`string`	Descrição interna da cobrança
amount	`number`	Valor da cobrança
expiresIn	`number`	Limite para expiração do QRCode, com granularidade de segundos, para que o pagamento da cobrança possa ser realizado, a partir da data-hora de criação ou do vencimento, se existir. Se não for informado, assume-se o valor default 86400
payer	`object`	Informações do `cliente pagador`
payer.name	`string`	Nome do `cliente pagador`
payer.document	`string`	Documento (CPF/CNPJ) do `cliente pagador`
city	`object`	Informações da cidade onde é efetuada a transação
city.name	`string`	Nome da Cidade onde é efetuada transação
city.zipCode	`string`	CEP da localidade onde é efetuada transação
qrCodePayload	`string`	Pix copia e cola
qrCodeImageBase64	`string`	Imagem `base64` do qrcode

{
    "type": "PIX_DYNAMIC",
    "correlationId": "3053b28f-e2ab-4b64-9a4d-49b456b262ba",
    "amount": 10,
    "status": "Pending",
    "expiresIn": 60,
    "dueDate": "2023-08-22T02:04:11.2338376Z",
    "updatedAt": "2023-08-22T02:03:11.2338376Z",
    "createdAt": "2023-08-22T02:03:11.2338376Z",
    "qrCodePayload": "00020101021226850014br.gov.bcb.pix2563pix-h.delbank.com.br/v1/qrcode/charge8CESaDodPjxydyhVSDHRMsry3S5204000053039865802BR5907BXXDBDE6007ARACAJU62070503***6304BE37",
    "qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAmIAAAJiAQAAAABMLZNLAAAFqUlEQVR4nO2ZQbLjMAhEqfIBfKRc3UfyAVLFTKAbcP6sZsev1sKxJfSUTRc0MsM4PH7c78NzXKc7Fs/35xGz7wyJT3v9/bTXbT+GaKItpL0i6MOI7a8M/bvp+jA+qzHnl8XDLOISCRrOF0205bTbaiZkg0+AMhDKGlKaj1DlIZpov4t2WSnLjklrFUFjZIgm2m+jtWxQdsVcl1Of3IJE9AkJtZmxABNNtP20kE7OsJyqTTiB+SZTTTNePDWGaKLtpmEwXfzPw34M0UTbR/MeaEN17WXMQQ7jMbJMBtOsAyCaaJtpV6sio2A8YgzZBDJsyXDsbUtiVTTRdtOOqqSOEhBVlNqhI2mDkm/pSHh0Kks00dbSzrqMi+lKK3kC+7IjB11kZIK5+CfMRBNtM+07t9zdkJpC4ycrLi8F5j85RRNtOS2i4DRCJyeMB7lccMor35zcTDUOimii7aYxo5SroFi8L+js4UjgyWPiZjdKNNHW0zLBfLWcMhRR5UieuSUG3bmZaKItpiGeTiOrK+PDRwfqbmVRd1+fl2iibaZBT+05oJe5kLKhGXmeYN2zMtFE20yLUHRekTjaif+w6CHDbkOxRuOCaKItpl3c3qG9vZuzXn3ZTERfrSm4FNFEW05jQ2rmGyQO3lGgOVsJxqo/laCME020vTT6hmduqTwCY05HEsh0KbHXZsUVc6KJtpbW8a/KGe7+9CF0H8a3FBWUNRQlmmiLaQ6dsGqyQRuGO5V1M98MbsWZaKItprnTUo/QMuZdj30dA1CMKsAu0UTbTCvXzYcZLi8MapvIs4y5kTGsimiiLaZ1gJXhxueX3TjbiTMOyjq8TxBNtLW03G42opBgeILjQoNV2PVoSM3WrWii7aa9jdphfyrfhv9uEHw6cotXHPKSaKLtpcFSF7cKsGukH6sQZ7FlaOdy6RBNtOW0zB5MIfTk8TarsFl23cdMRLWXOUs00VbS3NmBCn2gJdvlVAkoRcVs1JmHe9PXiybaWto03PzMEwJ+mZX4mHRKgY9Vd/p60URbSeudvX0I6FWreYPBrhQl1zsP0UTbThsN1sNtGHNyWXERnmklUw3UVncfoom2l9Y1Faqmh2zGdtZUaE21BUnvTmGKJtpSGgx3+e8snc5+0IfkKLOe7qNk6CzZRBNtL82QajCdYqFFz7MMq3mWex3DVPMYoom2kjZMxsvRiO1yahRWqR2WWEOBcb5nH0s00fbSujlrVhZkVldktEtp8eHBewsTTbTFtCGMTzmVAgrZeGqnnQZXrf5EPhgrmmjLadmDPbyTSSPTayN07vS64aNzOUQT7RfQOoBeO77bWjAR4QRu++HYRRNtMe2i154tJ7OhMRpuymu+Vc+K/V7RRNtKSxBcxUwTNOZvtm5vBGNH/ZOXe3sZ0URbS0M3loUVe7XvOia7TTPBNKiUxTs80UTbTMvpIFX79QYo/AUbUkg/fcNHM8KSTTTRNtNiwFdXfyr05J1WeOC4o8iHldCsh2ii7aShs8S1alIxwcBadCJCB6rhPPADEE20vbQBustaVOaZ5VR0aJ8Z5SyrcqNxJZpoW2kspx7KijU4DdJQWCH9AHnCzRMgmmiraZajJZJvMZ5OA3N9IN+q3yuaaGtpZswe8TamsyX76DvNnW1BTvgV0UTbTmt5oeJiN5afCU+X8v6HkcfRnBNNtJU0rwFuDnalkEzYlZqOHXG9Kppoq2kclWrovx29WmoMdtzg2IORj1DgyDKiibaT9gqFMD7TRXht3NzVJmftNbY9lCWaaMtp38mkAmK0/roDZXVv4Vx93eNXNNG204ae6tKO2sFdRiYd40V3qQ1WRTTRfgUtZJOKYXU1kkn59OxF+Y3bvL7tFk205bQhG7acIjTLLquFM8GlrHlMLogm2moaBm12yYZSsrLjhvSTZ7HY4qmPIZpo62h/ACAg39V9smWKAAAAAElFTkSuQmCC",
    "payer": {
        "name": "Bruno da Silva",
        "document": "85088102020"
    }
}