Notificação Webhook
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.
Descrição dos atributos
| Atributo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
platform_name | string | Nome da plataforma que está gerando o pagamento | Não |
billing_url | string | URL para redirecionar o usuário para a página customizada de cobrança | Não |
return_url | string | URL do webhook onde as notificações serão enviadas | Não |
Exemplos
Webhook - Pagamento pix criado
{
"notification_type":"pix_qrcode",
"message":{
"value_cents":10001,
"reference_code":"string",
"external_reference":null,
"content":"string",
"status":"string",
"generator_name":null,
"generator_document":null,
"payer_name":null,
"payer_document":null,
"registration_date":"string",
"payment_date":null,
"end_to_end":null,
"billing_url":"string",
"platform_name":"string",
"return_url":"string"
}
}
Webhook - Pagamento pix pago
{
"notification_type":"pix_qrcode",
"message":{
"value_cents":10001,
"reference_code":"string",
"external_reference":null,
"content":"string",
"status":"string",
"generator_name":null,
"generator_document":null,
"payer_name":"string",
"payer_document":"string",
"registration_date":"string",
"payment_date":"string",
"end_to_end":"string",
"billing_url":"string",
"platform_name":"string",
"return_url":"string"
}
}