WebHooks

WebHooks are an asynchronous notification mechanism. They are triggered by operations invoked using the Browser integration method. They notify merchant systems that a successful operation has taken place and provides the detailed result.

WebHooks are triggered only if the merchant has provided a WebHook URL in the request to obtain an AuthKey. The {{platform.NAMESPACE}} system will attempt the WebHook notification upon transaction completion, retrying at 1 hour intervals until successfully acknowledged by the merchant or the retry period has expired. The retry period is 24 hours.

Note: There is a possibility that multiple WebHook calls for the same action may be seen by the Merchant's server. For this reason, it is important that WebHook request contents are checked for uniqueness prior to updating data.

Note: China UnionPay transactions will always have a response code of "P". You will need to poll {{platform.NAMESPACE}} using the 2 Party Search Transaction method to obtain the result. China UnionPay only returns a response for approved transactions. If the transaction is not completed and approved within 2 hours then a response code of "x" - "description" will be returned.

All WebHook calls are HTTP POST methods containing a JSON payload. The contents of the payload depend on the action that caused the WebHook call to be made.

Originating IP addresses

WebHook calls originate from specified IP addresses. Please refer to the Firewall Configuration section under References