Async Notifications
Welcome to the Till Payments Host Async Notifications guide.
Async notifications occur to notify you of a change in status of a payment. That change in status may happen for various reasons, often depending on the brand. For example, an offline invoice payment has been fulfilled or a risk transaction has moved from REVIEW status to ACCEPT. Async notifications can occur while using any of the following integration methods:
- Till.js
- Server-to-Server
This tutorial explains how the Till Payments Host provides notifications and what you must do to support them. There are three steps:
How it works
Request
Sending the request parameters server-to-server and receive the redirect
information back.
Step 1 - Request
Notifications are sent to the notificationUrl
that was sent in original request, therefore, to support async notifications requests should include the notificationUrl
.
![](/sites/default/files/ajax-loader.gif)
Step 2 - Notification
We send a HTTP GET request to the notificationUrl
with the following information:
GET {notificationUrl}?id={id}&resourcePath={resourcePath}
In order to receive this message, you should expose an endpoint that is accessible over the internet (we recommend over https) and use this endpoint as your notificationUrl
.
The resourcePath
is a path (starting with /
) relative to the server URL which you must call in order to obtain the intend information for the notification.
Example of a resourcePath
:
/v1/payments/01234567890123456789012345678901
Step 3 - Get Status
https://test.tillpayments.io{resourcePath}?entityId={entityId}