Skip to main content

Webhook Notification

Notified Events

  • The system will send notifications for all available transaction statuses.
  • This applies to Checkout, PixQrCode, and Card transactions.
  • Any status change (Creation, confirmation, cancellation, etc.) will result in a call to the webhook configured during the transaction's creation.
  • The notifications will follow the exact same data pattern already used by the existing webhook, ensuring compatibility and consistency in the integration.

Attribute Description

AttributeTypeDescriptionRequired

| platform_name | string | Platform name generating the checkout | No | | billing_url | string | URL to redirect the user to the customized billing page | No | | return_url | string | Webhook URL where notifications will be sent | No |

Examples

Webhook - Generated Checkout
{
{
"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 - Paid Checkout
{
{
"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"
}
}
}