Skip to main content
Version: 1.0.8

Notifications API

The Notifications API allows to subscribe to an asynchronous server to server Webhook call to your server whenever the payment status is updated during the payment processing lifecycle. This API is one of the central components used for defining the so called Blueprint like PSP, Marketplace, Wallet, etc..

It is intended to be used for the following use-cases.

Use-Cases​

Asynchronous Payment Processing​

In order to perform an action on your server based on asynchronous updates during the payment processing and clearing flow. Most commonly you will be updating the order status and flow accordingly.

Asynchronous Payment Settlement & Reconciliation (Post-processing)​

In order to perform an action on your server based on asynchronous updates after the entire payment processing flow. Most commonly you will be updating the order settlement and reconciliation data on your server based on asynchronous updates on receiving a new settlement report.

Asynchronous Payment Data Collecting (Reporting)​

In order to collect payment processing data for reporting purposes, you can subscribe to domain events of interest and feed data to your system asynchronously.

How it works​

  1. Integrator creates a Notification subscribing to one or more event pre-defined in the current UNAK payment flow.
  2. UNAK fires a Notification on the configured event(s) to the Integrator's system
  3. Integrator handles the Notification on their server accordingly updating the order information and consumer, etc.

API Guide​

The Notifications API offers APIs for subscribing for a particular event, as well as for managing the notification's delivery and data.

The API is separated into the following endpoints:

  • Subscriptions - for managing subscriptions based on events
  • Notifications - for querying status and data of a notification and retry
  • Deliveries - for querying status and data of a notification delivery

You can find a complete reference of the currently supported domain events within UNAK in the Notification Events section.

Once you have subscribed to a notification based on an event, you can continue with notification message handling in your backend in the Handle Notification section below.