Cobrança com QR Code Estático

O QR Code estático é um tipo de código QR que contém informações fixas e não muda ao longo do tempo. Diferentemente do QR Code dinâmico, que permite a atualização das informações contidas nele, o QR Code estático mantém os mesmos dados desde o momento de sua criação.

Alguns casos de uso

Pagamentos em estabelecimentos físicos: Empresas podem gerar QR Codes estáticos do Pix e exibi-los em seus estabelecimentos, permitindo que os clientes façam pagamentos escaneando o código diretamente de seus aplicativos de bancos ou carteiras digitais. Isso agiliza o processo de pagamento e elimina a necessidade de usar maquininhas de cartão.
Doações: Instituições de caridade e organizações sem fins lucrativos podem utilizar QR Codes estáticos do Pix para receber doações de forma rápida e prática. As pessoas interessadas em contribuir podem escanear o código e realizar o pagamento diretamente de seus dispositivos móveis.

Requisição

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

curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/static' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: ${apiKey}' \
--data '{
    "type": "PIX_STATIC",
    "correlationId": "2f908499-685c-4e36-af04-30567dc08dc5",
    "description": "pix estático com valor",
    "amount": 9.99,
    "additionalInformation": "Testando qrcode"
}'

Cabeçalhos (Headers)

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

Corpo da requisição (Body)

Nome	Tipo	Descrição
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. Caso não informado, será considerado que o `cliente pagador`poderá informar qual valor deseja pagar
pixKey	`string`	Caso deseje usar uma chave específica
additionalInformation	`string`	Informações que serão mostradas ao `cliente pagador` Tamanho máximo: 64 caracteres
formatResponse	`enum`	Informe `PAYLOAD_AND_QRCODE`, se quiser o payload e a imagem do QR code, se não for passado irá gerar somente com payload

Exemplo básico

A forma mais simples de gerar um QR Code Estático é da seguinte forma:

// example request I
{
  "correlationId": "{{$guid}}"
}

Além das informações acima, é possível enviar um TEXTO que será apresentado ao cliente pagador. Outra informação importante que é factível informar, é o valor, e caso este não seja informado, indica que o cliente pagadorpoderá informar o valor que deseja pagar (utilizado bastante em cenários de doação).

// example request II
{
    "correlationId": "{{$guid}}",
    "description": "pix estático sem valor",
    "amount": 9.99,
    "additionalInfo": "Testando qrcode"
}

É possível gerar o QR code com imagem e/ou informar uma chave Pix específica:

// example request III
{
    "pixKey": "5b0ac9a4-fad6-43f9-be70-6d7c9a2fad26",
    "correlationId": "{{$guid}}",
    "description": "pix estático sem valor",
    "amount": 9.99,
    "additionalInfo": "Testando qrcode",
    "formatResponse": "PAYLOAD_AND_QRCODE"
}

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
transactionId	`string`	Id do QR code
correlationId	`string`	Id de correlação
amount	`number`	Valor da cobrança (se houver)
pixKey	`string`	A chave Pix usada
beneficiaryName	`string`	Nome do recebedor
address	`object`	Objeto contendo a informação de endereço
additionalInfo	`string`	Informações que serão mostradas ao `cliente pagador`
createdAt	`DATETIME`	Data e hora que o QR code foi criado
payloadPix	`string`	O payload usado para pagar o QR code (Pix copia e cola)
base64Image	`string`	Imagem `base64` do qrcode

{
    "transactionId": "vchargeffeeed94cdbc41",
    "correlationId": "6f388279-0658-4bfa-80e5-e5c405cdb318",
    "amount": 9.99,
    "pixKey": "+5511999975734",
    "beneficiaryName": "DELBANK",
    "address": {
        "cityName": "ARACAJU",
        "zipCode": "49000000",
        "uf": "SE",
        "state": "SE",
        "street": "LOGRADOURO"
    },
    "additionalInfo": "testing qrcode",
    "createdAt": "2024-12-10T11:51:55.306Z",
    "payloadPix": "00020126540014br.gov.bcb.pix0114+55119999757340214testing qrcode52040000530398654049.995802BR5907DELBANK6007ARACAJU62250521vchargeffeeed94cdbc41630494CD",
  	"base64Image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAA=="
}