Webhooks

If webHookUrl is passed when creating an access token we'll make a POST to that url when the transaction is complete. We do not pass the status in this call due to security concerns. The outcome of the transaction must be confirmed via our REST API.

Exponential Backoff

If the POST to the webHookUrl fails or doesn't return either an HTTP 200 or 201 we will retry with an exponential backoff starting with a 10 second delay up to a maximum delay of 600 seconds. This means that this url could be posted to more than once so should be idempotent.

Payload

Parameter Description
id
required
Id returned when creating the access token associated with this transaction.
orderId
required
OrderId passed when creating the access token associated with this transaction.
merchantTransactionId MerchantTransactionId passed when creating the access token associated with this transaction.

Example Payload

{
    "id": "odie4VCNTGoJkGaaOC28kb0uls1XoCbK7MenU5ARxHTG3l6QzvPYQdUd3Bg-no8yVRc6DKl03O1W9iSC7wnAm_KVpwNdZy-ZtjO3AjWCzxWD1nreXxVh",
    "orderId": "123456",
    "merchantTransactionId": "123456123456"
}