Subscriptions and Settlement Webhooks

By using the ‘WebhookUrl’ field or the subscriptions, you can specify a callback URL to get an update when the order is updated status. If the ‘WebhookUrl’ is set when creating an order or if a subscription exists, the API will send an HTTP POST request to that URL with a JSON payload containing the OrderId when the order status is changed. The kind of event that was triggered will be passed in a header called "Event-Type" where possible events are

• settlement_completed

• settlement_cancelled

• settlement_status_updated

[SettlementCompleted]
Header: Event-Type: "settlement_completed"
Body:

{
  "EventType": "settlement_completed",
  "Timestamp": "2026-09-16T14:35:02.118+00:00",
  "SettlementId": "e7f4a1c2-9b3d-4e56-8f7a-1c2d3e4f5a6b",
  "DriverId": "9c3e7a21-5b44-4e10-8f2a-6d1c4e9b0a77",
  "WasUpdated": false,
  "TotalAmount": 342.75
}

[SettlementCancelled]
Header: Event-Type: "settlement_cancelled"
Body:

{
  "EventType": "settlement_cancelled",
  "Timestamp": "2026-09-16T14:35:02.118+00:00",
  "SettlementId": "e7f4a1c2-9b3d-4e56-8f7a-1c2d3e4f5a6b",
  "DriverId": "9c3e7a21-5b44-4e10-8f2a-6d1c4e9b0a77"
}

[SettlementStatusUpdated]
Header: Event-Type: "settlement_status_updated"
Body:

{
  "EventType": "settlement_status_updated",
  "Timestamp": "2026-09-16T14:35:02.118+00:00",
  "SettlementId": "e7f4a1c2-9b3d-4e56-8f7a-1c2d3e4f5a6b",
  "DriverId": "9c3e7a21-5b44-4e10-8f2a-6d1c4e9b0a77",
  "Status": 1,
  "TotalAmount": 342.75
}