Skip to content

Webhooks

For each transaction made by the user, SIBS Gateway sends a notification to the merchant by e-mail or via an endpoint configuration. This notification (Webhook) will inform the Merchant of the details and status of a transaction.

The type of webhook sent by the SIBS Gateway must be configured on the SIBS Gateway Backoffice platform. If the merchant chooses the Webhook URL type, the merchant must enter the URL where they wish to receive the webhook. If the Merchant chooses the Webhook E-mail type, the Merchant must enter the default e-mail address that will receive the notifications sent by SIBS Gateway. The webhook can be configured per payment method and per merchant, store or terminal.

To configure the Webhook URL type, the merchant needs to make the following technical settings:

  • The webhook endpoint must be available in TLS 1.2 and on ports 80 or 443;
  • The merchant must store and enter an encryption key on the SIBS Gateway V2 Backoffice platform or use the key suggested by the platform in order to decrypt the webhook received;
  • The webhook is encrypted with AES-256;
  • The Merchant must enter a specific e-mail address where they will receive notifications regarding problems with the webhook.

For the e-mail type Webhook, only one notification will be sent per transaction. If the Merchant chooses the Webhook URL type and does not acknowledge the reception of the notification, SIBS Gateway will trigger the Webhook Retry System.

In the webhook structure, the “notificationID” field plays a crucial part in the webhook sending process. This field identifies the webhook that was sent by SIBS Gateway and will be used by the Merchant to send the acknowledge of the reception of the webhook to SIBS Gateway, in addition to the “statusCode” field with value “200” and the “statusMsg” field with value “Success”. This will prevent the Webhook Retry System from triggering and, in case of URL type webhook, from sending an e-mail with the failed notifications.

In case there’s communication or system issues, the Webhook Retry System cannot guarantee the message sequence, especially if the time difference between the notifications is smaller than the time it takes to process them. Once the issues are resolved, new notifications will arrive in real-time and old notifications will be resent. If for some reason the webhooks are not retried or the Merchant is not able to open the webhook, SIBS Gateway provides the “Checkout Status” service where the Merchant can access information about the status of a transaction.