Notificação QrCodes
Quando um QrCode for pago, o sistema enviará uma notificação para o endereço fornecido pelo cliente, informando atualização de status do mesmo.
A URL que receberá as notificações deverá ser informada através do endpoint Cadastrar/Alterar Webhook
A notificação será enviada utilizando o método POST, e espera uma resposta do tipo HTTP 200.
Segue estrutura do JSON enviado como request body:
Request Body
{
"notification_type": "PIX:QRCODE",
"message": {
"reference_code": "PAY2MPIXQRCODE2",
"external_reference": "INVOICE01",
"value": 2,
"content": "00020101021126580014br.gov.bcb.pix0136d5091c68-5056-481b-88ad-95eb340a1a2152040000530398654040025802BR5925Pay2m SolutionsPAULO62220518PAY2MPIXQRCODE263044FC9",
"status": "paid",
"generator_name": "John Doe",
"generator_document": "67178678097",
"payer_name": "John Doe",
"payer_document": "67178678097",
"payment_date": "2021-11-10T14:52:10.000-03:00",
"end_to_end": "E18236120202206142202a1022c1tg10"
},
}
Caso seja obtido um resultado diferente de 200, o sistema tentará enviar pelos próximos 10 minutos, a cada minuto ou enquanto não for obtido um resultado de sucesso. O erro persistindo nas 10 tentativas, a notificação será marcada como cancelada no sistema e nossa equipe entrará em contato para averiguar quaisquer problemas de integração.
Descrição dos Atributos
| ATRIBUTO | DESCRIÇÃO | TIPO |
|---|---|---|
| notification_type (Obrigatório) | Indica o tipo de mensagem transmitida | STRINGE limite de 25 caracteres |
| message (Obrigatório) | Objeto qrcode atualizado, conforme apresentado pelo endpoint Listar Qrcodes | OBJECT |
| message.reference_code (Obrigatório) | Identificador único do QrCode. | STRING limite de 100 caracteres |
| message.external_reference (Opcional) | Identificador fornecido pelo parceiro | STRING limite de 100 caracteres |
| message.value (Obrigatório) | Valor da cobrança, em reais | DECIMAL Maior que zero |
| message.content (Obrigatório) | Conteúdo do QrCode. (Código copia e cola PIX) | STRING limite de 255 caracteres |
| message.status (Obrigatório) | Status da cobrança | ENUM expired (Cobrança expirada) awaiting_payment (Aguardando pagamento) paid (Pago) canceled(Cancelado) |
| message.generator_name (Opcional) | Nome do gerador | STRING limite de 100 caracteres |
| message.generator_document (Opcional) | Documento do gerador | STRING limite de 14 caracteres |
| message.payer_name (Opcional) | Nome do pagador | STRING limite de 100 caracteres |
| message.payer_document (Opcional) | Documento do pagador | STRING limite de 100 caracteres |
| message.payment_date (Opcional) | Data de pagamento da cobrança | STRING formato datetime YYYY-mm-ddTHH:MM:ss. z |
| message.end_to_end (Opcional) | Identificador único do pagamento PIX. | STRING limite de 32 caracteres |