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 - Checkout gerado
{
{
"notification_type": "checkout",
"message": {
"description": "string",
"link": "string",
"expiration_date": "string",
"reference_code": "string",
"callback_url": "string",
"generator_name": "string",
"generator_document": "string",
"value_cents": 100,
"status": "string",
"registration_date": "string",
"payment_date": "string",
"platform_name": "string",
"billing_url": "string",
"return_url": "string"
}
}
}
Webhook - Checkout pago
{
{
"notification_type": "checkout",
"message": {
"description": "string",
"link": "string",
"expiration_date": "string",
"reference_code": "string",
"callback_url": "string",
"generator_name": "string",
"generator_document": "string",
"value_cents": 100,
"status": "string",
"registration_date": "string",
"payment_date": "string",
"platform_name": "string",
"billing_url": "string",
"return_url": "string"
}
}
}