Transaction Notification Service

~ also referred to as the Payment Advice Webhook ~

Merchants have the option to be enabled for the Transaction Notification Service, which provides notifications of the outcome of transactions that have been sent to the Payment Gateway.

Transaction Notifications use a webhook which is event driven. This differs from an API interface which is request driven and uses polling.

Transaction types Supported

Transaction notifications can be sent for the following transaction types:

• Authorize
• Capture
• Payment
• Refund
• Void

Merchant Requirements

Transaction notifications are sent via a webhook from Ecentric’s Payment Gateway using an HTTP POST with a JSON data payload to a merchant notification URL when the gateway completes transactions.

Setting up an API endpoint to receive notifications:

1. Set up an API endpoint using HTTPS/TLS1.2 (minimum)
2. Send Ecentric this Notification URL where notifications will be sent
3. Configure the endpoint to use either Basic or OAuth2.0 authentication to ensure that the notifications are sent from Ecentric as specified in the section that follows.

Authentication

There are 2 options for authentication using the webhook:

1. Basic authentication - which requires a username and password

OR

2. OAuth2.0 authentication – which offers greater security (requires some technical expertise to set up). The following fields are required:
   • Grant_type = client_credentials
   • Scope
   • Client_ID
   • Client_secret
   • TokenURL
     (More information here: https://oauth.net/2/)
     
     

Consuming the webhook

Once the endpoint has been set up, the webhook will need to be consumed by responding with an HTTP 200 response to let the gateway know that it was received.

Retry policy

If the gateway does not receive a 200 response, it will attempt to resend the webhook 3 times.

Payload format

Notifications are sent using HTTPS POST with a JSON payload with the fields specified in the API reference.