Skip to main content

Order Delivery Webhook

POST 
/Order/callback

Reference contract for the delivery callback that the platform sends to your notification endpoint whenever the state of an order line changes. The URL configured in your API settings receives an HTTP POST with the payload shown below; this endpoint in the documentation only exists so you can see the exact request shape.

Authentication​

Every callback is sent with an Apikey HTTP header. The value is the API key that belongs to your account. Always validate it on your side before processing the body.

Status values​

StatusMeaning
0Order was cancelled
1Order was delivered
2Order is being processed
3Order was removed from processing

Delivery payload​

  • For digital products such as E-PIN (delivered by email or SMS), the delivered codes are sent inside the DeliveryData array, for example: ["test-code-1", "test-code-2"].
  • For products such as Goldbar or top-up items that are delivered manually (no digital code), human-readable delivery information is sent inside DeliveryNote, for example: ["Goldbar delivered to character Xagok."].

The DeliverID and OrderDetailID fields in the payload match the values you sent (or received back) when the order was created, so you can reconcile the callback with the order on your side.

Sample request​

POST /your-notify-url HTTP/1.1
Host: your-domain.com
Apikey: {ApiKey}
Content-Type: application/json
{
  "DeliverID": "your_deliver_id",
  "OrderDetailID": 55501,
  "Status": 1,
  "DeliveryData": ["test-code-1", "test-code-2"],
  "DeliveryNote": null
}

Expected response​

Return HTTP 200 OK with a simple JSON envelope so the platform can mark the callback as acknowledged. Any non-2xx response causes the callback to be retried.

{ "success": true, "message": "OK" }

Request​

Responses​

Callback processed successfully.