Gerar QRCode de Cobrança
A API de recebimentos Pix foi implementada para que o parceiro pudesse fazer uma gestão de cobranças pela ferramenta Pix, gerando QrCodes e consultando-os posteriormente para visualizar os detalhes do pagamento. Uma vez que uma cobrança é sinalizada como paga, a API envia uma mensagem para notificar o parceiro através de um Webhook previamente cadastrado. Mais detalhes poderão ser encontrados na seção Webhooks deste documento.
Gerar QRCode de Cobrança
Este endpoint realiza a geração de um QRCode de pagamento Pix. Para fazê-lo deve ser efetuada a chamada para a API, como especificado abaixo:
Fazendo Requisição
A chamada deverá ser feita utilizando o método POST.
POST/v1/pix/qrcodes{
"value_cents": 10001 ,
"generator_name": "string" ,
"generator_document": "string",
"expiration_time": "string",
"external_reference": "string" ,
"platform_name": "string",
"billing_url": "string",
"return_url": "string",
}
Descrição dos atributos
| ATRIBUTOS | DESCRIÇÃO | TIPO |
|---|---|---|
| value_cents (Obrigatório) | Valor, em centavos, da cobrança | INTEGER maior que 0 |
| generator_name (Opcional) | Nome do usuário gerador do qrcode. Será utilizado para cadastrar a cobrança. | STRING limite de 100 caracteres |
| generator_document (Opcional) | Documento (CPF/CNPJ) do usuário gerador do qrcode. Será utilizado para cadastrar a cobrança. Obrigatório caso seja informado o atributo generator_name. | STRING limite de 14 caracteres Apenas números |
| expiration_time (Opcional) | Tempo de expiração do QRCode gerado para cobrança, em segundos. | INTEGER maior que 0 |
| external_reference (Opcional) | Valor informado pelo parceiro como identificação do qrcode gerado. | STRING limite de 255 caracteres |
| platform_name (Opcional) | Nome da plataforma que está gerando o pagamento | STRING limite de 100 caracteres |
| billing_url (Opcional) | URL para redirecionar o usuário para a página customizada de cobrança | STRING limite de 255 caracteres |
| return_url (Opcional) | URL do webhook onde as notificações serão enviadas | STRING limite de 255 caracteres |
Sucesso
Após a chamada, é retornado um JSON com o status 201 - Created caso o procedimento tenha ocorrido com sucesso.
cont ssas = Zendry
{
"qrcode": {
"reference_code": "ZENDRYTESTPIXQRCODE6" {{ssas}},
"external_reference": "Teste2",
"content": "00000000000000000000br.gov.bcb.pix012345678900-1234-1234-1234-12345678901234567890123456789000.012345BR5925Zendry Solucoes em Paga6009SAO PAULO62230519ZENDRYPIXQRCODETESTE00000",
"image_base64": null
}
}
Descrição dos Atributos
| PARÂMETRO | DESCRIÇÃO | TIPO |
|---|---|---|
| qrcode (Obrigatório) | Objeto de dados do qrcode cadastrado. | OBJECT |
| qrcode.external_reference (Opcional) | Valor informado pelo parceiro como identificação do qrcode gerado. | STRING limite de 255 caracteres |
| qrcode.reference_code (Obrigatório) | Identificador único do QRCode. | STRING limite de 100 caracteres |
| qrcode.content (Obrigatório) | Conteúdo do QRCode. (Código copia e cola Pix) | STRING limite de 255 caracteres padrão: 30 |
Eventos Notificados
- O sistema irá enviar notificações para todos os status disponíveis da transação.
- Isso vale para Checkout, PixQrCode e Cartão
- Qualquer mudança de status (Criação, confirmação, cancelamento, etc.) resultará em uma chamada ao webhook configurado na criação da transação.
- As notificações seguirão exatamente o mesmo padrão de dados já utilizados pelo webhook existente, garantindo compatibilidade e consistência na integração.
Entre nesta página para mais detalhes sobre Webhook - Notificação do qrcode
Erros
Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido invalidada.
{
"error": "generator_name blank | generator_document invalid | generator_document not_a_number"
}
{
"error": "Generator not allowed"
}
{
"error": "Operation failed! Please try again or contact our support team"
}