You may receive webhooks when certain order statuses are reached. This is an optional configuration that can reduce the number of API requests you need to send to Banxa.

Using Webhooks

We can configure webhooks to a URL that you provide. Once configured, webhooks will be sent to this URL when an order has transitioned to a particular status. A webhook notification will be sent in the below format and will only include the Order ID.

{'order_id':'ABCD1234'}

When you receive a webhook, you can then call the Get Order endpoint to retrieve detailed order information. This ensures that you do not receive calls from bad actors with incorrect information.

Securing Webhooks

If required, webhooks can be sent with HMAC authentication using the same key and secret provided during onboarding.

Webhook Events

As webhook will be triggered and sent to your URL when the order has transitioned to the below statuses.

Order Status Transition

IN-PROGRESS

COMPLETED

EXPIRED

PENDING