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 - Card payment created
{
"notification_type":"card_payment",
"message":{
"muid":"string",
"rrn":"string",
"amount":100,
"currency":"string",
"status":"string",
"last_digits":"string",
"installments":1,
"tracking_number":"string",
"card_holder_name":"string",
"card_holder_email":null,
"card_holder_document":"string",
"brand":null,
"request_token":"string",
"payment_type":"string",
"authorization_code":"string",
"first_digits":null,
"active":true,
"slug_authorizer":null,
"slug_customer":null,
"slug_terminal":null,
"slug_merchant":null,
"sales_channel":null,
"authorizer_merchant_id":null,
"authorizer_terminal_id":null,
"transaction_status":"string",
"product_or_issuer":null,
"settlement_management_type":null,
"transaction_method":null,
"cancelling":false,
"billing_url":"string",
"return_url":"string",
"platform_name":"string",
"created_at":"string",
"updated_at":"string"
}
}
Webhook - Card payment paid
{
"notification_type":"card_payment",
"message":{
"muid":"string",
"rrn":"string",
"amount":100,
"currency":"string",
"status":"string",
"last_digits":"string",
"installments":1,
"tracking_number":"string",
"card_holder_name":"string",
"card_holder_email":null,
"card_holder_document":"string",
"brand":null,
"request_token":"string",
"payment_type":"string",
"authorization_code":"string",
"first_digits":"string",
"active":true,
"slug_authorizer":"string",
"slug_customer":"string",
"slug_terminal":"string",
"slug_merchant":"string",
"sales_channel":null,
"authorizer_merchant_id":"string",
"authorizer_terminal_id":"string",
"transaction_status":"string",
"product_or_issuer":"string",
"settlement_management_type":null,
"transaction_method":"string",
"cancelling":false,
"billing_url":"string",
"return_url":"string",
"platform_name":"string",
"created_at":"string",
"updated_at":"string"
}
}