The POLi nudge ensures that the merchant receives a real-time notification that a transaction has reached a terminal (final) state.
If a customer closes their web browser before returning to the merchant's website but after completing the payment, the Nudge is how their transaction gets credited and is how the merchant's system is updated.
Initiate Transaction API Call
Your customer completes the payment and is redirected back
Nudge sent to Notification URL
POLi POSTS a Nudge to your Notification URL unpon transaction reaching a final state
GET Transaction API Call
You call the GET Transaction and direct the customer to the appropriate page
Merchants can specify that the POLi nudge be sent to them by specifying a NotificationURL
in their InitiateTransaction
request.
POLi will send a HTTP POST to the merchant’s specified NotificationURL
upon the transaction reaching a terminal (final) state. The data contains the token which is URL-encoded and is posted inside the Request.Form
collection in a field marked as Token
. The Notification URL must be publicly accessible.
The merchant can then call the GETTransaction API
with the Token
to check the status of the transaction, and update the transaction to credited.
{info} Note:
The nudge is only a notification that a transaction has reached a terminal (final) state. This is not a notification indicating that funds will be received. The information you receive in yourGETTransaction
call should update your system in the correct way. Daily reconciliation should then be performed to ensure funds are received before issuing the good/service purchased.
The transaction process ends with one of the following terminal statuses:
Status | Description |
---|---|
Completed | A successful payment, indicating funds are to be credited to the merchant |
TimedOut | The customer did not complete the payment in the allotted time |
Failed | The customer was unable to complete the transaction |
ReceiptUnverified | POLi is unable to determine if the transaction was successful (rare) |
Cancelled | The transaction was cancelled by the user |
Visit POLi Transaction Status to learn more about the statuses of a POLi transactions.
{danger} Important:
For security reasons, the POLi Nudge contains no detailed information about the transaction and alone cannot be used as confirmation that a payment was successful; it only indicates that the transaction process has now ended.
In order to maintain secure communications, Merchants must configure their Nudge endpoint to comply with industry standards on encryption for web servers using TLS.
Webservers must be configured to use a minimum of TLS version 1.2. POLi currently requires TLS 1.2 communication to be enabled for Nudge functionality to operate correctly. TLS versions 1.1, 1.0 and SSL versions 2 and 3 are considered unsafe and/or vulnerable.
The following recommended cipher suites are supported by the POLi Nudge service:
More information and additional detail on a secure TLS configuration can be found at the following publications:
{warning} Caution:
The POLi Nudge can only be sent to port 80 or 443.
#### << Headers >> ####
Connection: Keep-Alive
Expect: 100-continue
Host: your.url.com
Content-Length: 40
Content-Type: application/x-www-form-urlencoded
#### << Content >> ####
Token=EIgVQw2%2bvHofiynsAW41X5r4AhqbfpL2
As the POLi Nudge ensures that the merchant receives a real-time notification that a transaction has reached a terminal state. Successful delivery of the Nudge is mandatory for all POLi transactions and is a requirement in order to complete the QA test and be set live.
You can check for the Nudge delivery status by running a transaction report and drilling down into the transaction by clicking the POLi ID, then clicking the logs tab.
Nudge has been delivered to the merchant 2023-09-30 09:20:30.461
Unable to deliver nudge to the merchant 2023-09-30 09:20:30.461
NotificationURL
is not being publicly accessible125.239.19.83
52.64.125.233
and 54.153.153.81