for developers and administrators
User Interface Reference
Resources (Directory Structure)
Zip and Country Codes
Supported Providers (Banks & Networks)
UniPay Codes & Code Mappings
Integrated 3rd Party Libraries
Diagrams and Documents
This section only
Current Specification Version: V9.1.4
View Change History
The purpose of this document is to provide documentation for 3rd parties to integrate with the Webhooks API
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.
Register the URL address in the system
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.
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.
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
The notification mechanism supports different events. For more information see
The structure of callback that is used for events in the Billing module.
The structure of callback that is used for events in the Processing module.
The structure of callback that is used for events in the Management module.
required in request/always present in response for direct debit transactions and credit card transactions of all levels (I, II, III).
optional in request/not always present in response.
conditional; conditions of the usage are defined below the corresponding section.
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.
required in request/always present in response for split transactions only.
for internal use only.
required fields in these specific sections are only required if this specific feature is used.
UniPay - Payment Gateway Software
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.