WHAT ARE WEBHOOKS?
Webhooks allow APEXX to push transaction updates to the merchant application as they become available. In the normal course of events, the merchant application sends out API requests to which APEXX responds in turn. If the merchant requires a notification for an event such as a settlement or chargeback, the communication will need to be initiated by APEXX instead.
HOW ARE WEBHOOKS IMPLEMENTED?
The merchant application will need to provide a URL that the webhook can deliver the data to and which is accessible to APEXX servers.
The full URL for the webhook endpoint can either be configured against a specific account by your APEXX Implementation Consultant, or sent dynamically in the webhook_transaction_update field of the transaction request. To ensure that webhook notifications are only received by authorised domains, the top level domain received in the must match the top level domain configured on the APEXX account used for the transaction. If a full webhook transaction update URL are supplied in both the account configuration in APEXX and in the API request, then the URL provided in the request will override that in the account configuration, as long as the top level domains
The merchant application will need to processes the incoming webhook events and return a response message to APEXX. If APEXX does not receive a message indicating that the event update was successfully received, it will attempt to resend the update at a later point in time. After 10 failed delivery attempts, APEXX will send a delivery failure notification to the merchant.
HOW ARE WEBHOOKS TRIGGERED?
A typical use case for webhooks are transaction updates originating from reconciliation files:
- APEXX imports reconciliation data provided by the acquiring bank in a data file
- Captured transactions are updated to Settled, triggering a webhook
- Chargeback notifications are created, triggering a webhook
WHAT DATA IS SENT IN A WEBHOOK?
Please refer to the transaction webhooks section in the APEXX API specification for details.