Webhooks

Webhooks are a way to receive real-time notifications of events on Interswitch.
This allows you to automate tasks and workflows based on these events, such as updating your inventory, tracking transactions, sending customer notifications, or triggering fraud detection.

To set up webhooks:

1. Go to your Quickteller Business dashboard and click Developer Tools.
2. Select the event types you want notified about( Invoices, Payout, Transactions, Payment links, Subscriptions, and Enable all notifications).
3. Under Webhooks, click Save changes.
4. Click Create.

Webhook Events

We currently support the following Event types:

• TRANSACTION: Transaction state changes when the customer is paying
• SUBSCRIPTION: Subscription payments
• PAYMENT LINKS: Payments on a payment link
• INVOICES: Invoice Payments

Each Event has a set of actions that explain what type of event has just happened.
e.g. TRANSACTION.COMPLETED means that a transaction has just been completed; it has either been successfully paid for or failed and cannot be retried.

1. TRANSACTION Event Types

2. SUBSCRIPTION Event Types

3. PAYMENT LINK Event Types

4. INVOICE Event Types

Sample Message
All webhook messages you receive from us will follow this general format.

{
 "event": "TRANSACTION.COMPLETED",
 "uuid": "2Xdf35faAyX2Sk5Dalu405rUD",
 "timestamp": 1594646111460,
 "data": {
 "remittanceAmount": 0,
 "bankCode": "011",
 "amount": 12000,
 "paymentReference": "FBN|WEB|MX6072|13-07-2020|3481032|762672",
 "channel": "WEB",
 "splitAccounts": [],
 "retrievalReferenceNumber": "000106923853",
 "transactionDate": 1594646111460,
 "accountNumber": null,
 "responseCode": "00",
 "token": null,
 "responseDescription": "Approved by Financial Institution",
 "paymentId": 3481032,
 "merchantCustomerId": "[email protected]",
 "escrow": false,
 "merchantReference": "2Xdf35faAyX2Sk5Dalu405rUD",
 "currencyCode": "566",
 "merchantCustomerName": "yee tod",
 "cardNumber": "561233*********0865"
 }
}

Field Descriptions

Sending Back Response

You are expected to return a 200 HTTP response to every message received. This is to confirm that you received the message. If you return any HTTP response code other than 200, Interswitch will retry up to 5 times.

🚧

Do not send any response body with the response code. Any response body you send with the HTTP 200 will be discarded.

Also, respond with a 200 immediately before starting any other long process. If your application takes too long to respond, Interswitch will retry, which can lead to duplicate data.

Message Security

All webhook messages sent are hashed with the HmacSHA512 algorithm. The hash is generated using the entire object received in the current notification.

The secret key used to hash the message is the unique one generated for you in the configuration.

The generated hash is Hex encoded and then passed in the header with the parameter field. X-Interswitch-Signature.

This enables you to verify that any message you receive on your configured URL is from Interswitch.
To verify every message, you will need to do the following.

1. Generate another hash using the same algorithm (HMAC-SHA512), your secret key, and the raw JSON object received as a string.
2. Compare the hash generated to the one passed in the X-Interswitch-Signature header.

Example:

If the request body we send to you is

{"event": "TRANSACTION.UPDATED", "uuid": "2Xdf35faAyX2Sk5Dalu405rUD", "timestamp":1594646111460,"data":{ "bankCode":"011"}}

The hash is going to be hex-encoded with your secret key

**HmacSHA512** ( {"event": "TRANSACTION.UPDATED", "uuid": "2Xdf35faAyX2Sk5Dalu405rUD", "timestamp":1594646111460,"data":{ "bankCode":"011"}} )

If the hash you generate does not match the hash you receive in the X-Interswitch-Signature header, the request was not from us.

Any request you receive without the X-Interswitch-Signature is also not from Interswitch.