Através desse endpoint é possível criar um QR Code para pagamento do tipo Estático.
Descrição
O QR Code de cobrança estática contém informações fixas, como o valor a ser pago e os dados do recebedor. QR Codes estáticos são QRCodes que não expiram, podem ser pagos várias vezes.
Durante a requisição, é possível informar o identificador da chave ou o valor da chave para o qual o QR Code deve ser gerado, porém se ambas as informações não forem passadas, o sistema irá pegar a qualquer chave ativa disponível para a conta. É obrigatório o uso do accountIdentifier no header para identificar a conta emissora.
Também é possível informar a url para notificação de pagamento através do campo urlNotification.
Corpo da Requisição
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
keyIdentifier | String | Não | Identificador da chave PIX |
keyValue | String | Não | Valor da chave para a criação do QrCode |
description | String | Não | Descrição do QR Code |
value | Double | Sim | Valor do QR Code |
urlNotification | String | Não | Url para envio de webhook em caso de pagamento |
{
"keyIdentifier": "05d93d08-20d4-4303-b466-616886f8f470",
"keyValue":"05d93d08-20d4-4303-b466-616886f8f470",
"description": "Uma descrição",
"value": 125.00,
"urlNotification":"www.webhook.com"
}
Resposta de Sucesso
Campo | Tipo | Descrição |
---|---|---|
copyAndPaste | String | Copia e cola do QR Code gerado |
identifier | String | Identificador do QR Code |
key | String | Valor da chave utilizada para emissão do QR Code |
type | Double | Tipo da chave utilizada |
{
"copyAndPaste": "00020101021126670014br.gov.bcb.pix0136756a966c-48cc-4901-948f-e2bde0b48acc0205Teste520400005303986540512.335802BR5921Mateus de Morais Lima6011Joao Pessoa61085807641062240520220320241428184569296304060C",
"identifier": "03da45ac-86f7-4fc3-a813-84c0a0cbe447",
"key": "756a966c-48cc-4901-948f-e2bde0b48acc",
"type": "RANDOM"
}
Response em Caso de Erro
Em caso de erro durante o processamento da requisição, o endpoint retorna uma resposta com status HTTP 500 (Internal Server Error) e o seguinte corpo:
Campo | Tipo | Descrição |
---|---|---|
path | String | Caminho do erro |
error | String | Tipo de erro |
message | String | Mensagem de erro |
errors | Array | Lista de erros adicionais |
timestamp | String | Carimbo de data/hora do erro |
status | Number | Código de status HTTP do erro |