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

Attribute	Type	Description	Required

| 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 - Pix payment created

{
   "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 - Pix payment paid

{
   "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"
   }
}