Webhook Notifications

Set up webhooks to get updates on payments.

When the final status of the payment is known, Acquired.com will deliver a webhook notification to the URI endpoint configured in the Hub.

Webhook structure

Each webhook will contain the following headers:

Content-TypestringThe media type of the resource: application/json
Company-IdstringThe Company ID associated with the payment.
MidstringThe Mid ID associated with the payment.
Webhook-VersionstringThe version of the webhook body schema.
HashstringThe calculated hash value.

The webhook body will contain the following parameters:

webhook_typestringDescribes the type of event: status_update
webhook_idstringUUID assigned by Acquired.com for the notification.
webhook_bodyJSON objectNA
transaction_idstringUUID assigned by Acquired.com for the payment. Implementations should be able to handle blank transaction ID values, since payments can be "cancelled" by users before this value is generated.
statusstringThe final status for the payment. (To view a list of all statuses, click here.)
timestampintegerExact date of when the webhook was delivered in UNIX timestamp format.
order_idstringThe order ID value that was passed by you in the payment request.
    "webhook_type": "status_update",
    "webhook_id": "298467ac-1f5e-4fad-bc5d-5874bd841df3",
    "webhook_body": {
        "transaction_id": "1d0483a7-6f84-4784-9fba-3c7553847be0",
        "status": "cancelled",
        "timestamp": 32908394083,
        "order_id": "x"

Webhook retry policy

We consider a webhook as having been successfully delivered when we receive a HTTP status code 200 from your webhook URI.

If we do not receive a 200 success status response code then we will start retrying. Our retry logic will resend the notification every 5 minutes until a 200 status code is returned. If we do not receive a 200 status code after 25 minutes, we will discard the webhook.