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:
Header | Type | Description |
---|---|---|
Content-Type | string | The media type of the resource: application/json |
Company-Id | string | The Company ID associated with the payment. |
Mid | string | The Mid ID associated with the payment. |
Webhook-Version | string | The version of the webhook body schema. |
Hash | string | The calculated hash value. |
The webhook body will contain the following parameters:
Field | Type | Description |
---|---|---|
webhook_type | string | Describes the type of event: status_update |
webhook_id | string | UUID assigned by Acquired.com for the notification. |
webhook_body | JSON object | NA |
transaction_id | string | UUID 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. |
status | string | The final status for the payment. (To view a list of all statuses, click here.) |
timestamp | integer | Exact date of when the webhook was delivered in UNIX timestamp format. |
order_id | string | The 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.
Updated 20 days ago