Webhooks

Webhook Events

Webhook allows your system to receive real-time event notifications. To create a Webhook, go to your Portal. From the Main Menu, navigate to Operations > Webhook and click on Add Webhook. Here is a list of webhook event types along with their event ID and information:

Event TypeEvent IDDescription

CREATE ACCOUNT

1

A notification to alert you when a customer account (Savings or Current) is created.

UPDATE ACCOUNT

2

A notification to alert you when a customer account (Savings or Current) is updated.

CREATE CUSTOMER

3

A notification to alert you when a customer (Individual, Group or Organisation) is created.

UPDATE CUSTOMER

4

A notification to alert you when a customer (Individual, Group or Organisation) is updated.

TRANSACTION SUCCESSFUL

5

A notification to alert you when a transaction is successful.

TRANSACTION REVERSED

6

A notification to alert you when a transaction is reversed.

Webhook Fault Tolerance

When sending a POST request to your webhook URL, we will make five retry attempts if we do not receive a 2XX response code. The retry time will follow an exponential back-off pattern, starting with 2 seconds and doubling after each attempt (2² times). If the maximum number of attempts is reached and the request fails, it will be logged and can be retried manually on the portal.

We advise using the entity's ID to check for duplicates in your system to ensure proper event handling. For secure communication, using HTTPS for all interactions is highly recommended.

Authenticated calls are supported. We accept a Basic Authentication Type in which you supply a Username and Password for Authorisation.

Last updated