Webhooks APIs

Version

Current Specification Version: V9.1.4

View Change History

General

General Information

Overview

The purpose of this document is to provide documentation for 3rd parties to integrate with the Webhooks API

Connectivity information

Webhook API is a mechanism designed to deliver notifications about various events initiated by a bank, processor, or the system itself by sending requests to a preconfigured URL address (webhook).

To set up notification delivery, you need to follow several steps:

Prepare the notification URL address

You must create a web page or specify an existing URL address that will be used to deliver notifications. This page should be externally accessible so that the gateway could send requests to it.

After preparing the notification URL address, you need to register it in the system for a specific portfolio or reseller.
If you have access to the configuration interface, you can specify the notification URL address, select the types of events for which you want to send notifications, and configure other parameters if necessary. If you don't have access to the configuration interface, you should ask for assistance from the support service.

Event subscription mechanism

Your system can receive notifications about important events that are not directly related to API calls. For example, when a subscription status gets changed through the user interface (UI), this event can be delivered through a webhook notification. Or when a bank initiates the chargeback or return process, you can be automatically notified of this event. This enables you to promptly get notified of such events and act as necessary. You can view a list of all supported events below.

Authentication mechanism

The system provides a flexible mechanism for working with regular URLs, both with and without authentication.
The system allows you to work with URLs that do not require authentication. In this case, only the address of the URL will be necessary to set up.
You can also use URLs that do require authentication. In the case you will need to supply username and password in addition to the URL address.

Re-delivery mechanism

The re-delivery mechanism in Gateway ensures reliable notification delivery by resending them in case of non-delivery. If the page receiving the notification does not confirm its successful processing, the mechanism continues to resend the notification according to a defined schedule. For more information see Integration Notes.

Events

The notification mechanism supports different events. For more information see Integration Notes.

Supported Operations

General

Billing Callback

Receive real-time billing notifications to streamline subscription and payment process automation in your SaaS platform.\n\r\n> **Note:** Billing callbacks deliver structured data on subscriptions, payment options, allocations, and payment events through webhooks, enabling automated workflows and system integrations.\n\r\n> **Warning:** Reach out to support if you require assistance with setting up webhooks. Your endpoint must respond with notification ID confirmation to prevent automatic redelivery of notifications.\n\r\n> **Tip:** Use these webhooks to synchronize customer data, trigger subscription fulfillment or account provisioning workflows, and maintain accurate subscription status in your application. See Webhooks Integration Guide for implementation details.

Processing Callback

Receive real-time payment event notifications to automate workflows in response to critical payment events.\n\r\n> **Note:** Callbacks deliver structured notifications for chargebacks, returns, reversals, and Notice of Change (NOC) events through your configured webhook endpoint.\n\r\n> **Warning:** Your webhook endpoint must acknowledge notifications by returning the notification ID to prevent automatic redelivery attempts. Failed deliveries will be retried up to 5 times using an incremental retry schedule (5 minutes, 15 minutes, 60 minutes, and 24 hours).\n\r\n> **Tip:** Use the `dataType` field to identify the JSON schema of the `data` payload for easier parsing. See the Webhooks Management guide for implementation details.

Management Callback

The structure of callback that is used for events in the Management module.

Message Formats

Usage:

R	-	required in request/always present in response for direct debit transactions and credit card transactions of all levels (I, II, III).
O	-	optional in request/not always present in response.
C	-	conditional; conditions of the usage are defined below the corresponding section.
E	-	echo back from request; if present in request, it is present in response, if it is not present in request, it is not present in response.
SR	-	required in request/always present in response for split transactions only.
I	-	for internal use only.
N	-	not used.
*	-	required fields in these specific sections are only required if this specific feature is used.