Channel Manager - Notifications
Notifications enable your platform to find out about events as they happen, these will be supplied in the form of webhooks.
These will be for customers that are shared between the Modulr platform and the Channel Manager platform.
You will need to build a listener to look out for webhooks
Notification Type | Description | Subscription Level |
|---|---|---|
Card Authorisation - CARDAUTH | A notification to alert you that there has been a new or updated card authorisation | Channel Manager |
Offline Card Authorisation – CARDAUTHOFFLINE | A notification to alert that the card has been used for an authorisation offline, this means that there will be no other corresponding authorisation but just a settlement. This is advice only and does not instruct any money movements | Channel Manager |
Card Refund – PAYIN | When there's a new refund in a card that's associated with one of your accounts | Channel Manager |
Card Settlement - PAYOUT | When there's a new settlement in a card that's associated with one of your accounts | Channel Manager |
Webhooks - An Introduction
A Webhook, in simple terms, is a user-defined HTTP callback. It is a mechanism for the system to notify you about an event. How does it notify you? By doing an HTTP POST to the Webhook (i.e. the Web URL that you define). In terms of implementation, you can write an API endpoint that is capable of receiving an HTTP POST in an application stack of your choice.
Remember in live this must be reliable and resilient if you are to depend on it for information.
The advantage of a Webhook is that there is no persistent open connection to the system where you keep filtering for events that you are interested in. It is an asynchronous mechanism where you will wait for the system to notify you. The HTTP POST payload will contain the details of the event.
Webhook security
We sign the POST request with an HMAC digest, using a secret that you provide. This can be set when registering the endpoint for the webhook type of notification. It is required that you validate this signature, particularly if you are acting upon these events to authorise actions in your system. The method of calculation of the hmac signature is the same as in HMAC Signatures / Authorisation header calculation
For webhook requests that are sent from us to you, we use the webhook id as the key and the secret you have provided when creating the webhook to sign the webhook.
Updated about 3 hours ago