Events
Webhook event types and their payloads
Order Events
Order webhooks notify you when an order's delivery status changes.
order.delivered
Triggered when all vouchers in an order have been successfully fulfilled.
{
"id": "evt_abc123",
"type": "order.delivered",
"created_at": "2025-01-15T14:30:00Z",
"data": {
"id": 12345,
"reference_code": "MY_ORDER_001",
"status": "DELIVERED",
"product_name": "Steam Wallet Card",
"denomination": 50.00,
"quantity": 5,
"amount": 250.00,
"delivered_quantity": 5,
"delivered_on": "2025-01-15T14:30:00Z",
"created_at": "2025-01-15T14:00:00Z"
}
}order.partially_delivered
Triggered when some vouchers in an order have been fulfilled but others are still pending or failed.
{
"id": "evt_def456",
"type": "order.partially_delivered",
"created_at": "2025-01-15T14:35:00Z",
"data": {
"id": 12346,
"reference_code": "BULK_ORDER_001",
"status": "PARTIALLY_DELIVERED",
"product_name": "Google Play Gift Card",
"denomination": 25.00,
"quantity": 100,
"amount": 2500.00,
"delivered_quantity": 87,
"delivered_on": "2025-01-15T14:35:00Z",
"created_at": "2025-01-15T13:00:00Z"
}
}Order Event Data Fields
| Key | Type | Description |
|---|---|---|
id | integer | Order ID |
reference_code | string | Your reference code for the order |
status | string | DELIVERED or PARTIALLY_DELIVERED |
product_name | string | Name of the product ordered |
denomination | number | Face value per voucher |
quantity | integer | Total vouchers ordered |
amount | number | Total face value of the order |
delivered_quantity | integer | Number of vouchers successfully delivered |
delivered_on | string | Timestamp of delivery (RFC 3339) |
created_at | string | When the order was placed (RFC 3339) |
After receiving an order.delivered or order.partially_delivered webhook, call GET /api/v1/orders/:id to retrieve the full order with voucher codes and PINs. The webhook payload confirms delivery but does not include the voucher codes themselves.
Supported Events Summary
| Event | Trigger |
|---|---|
order.delivered | All vouchers in the order fulfilled |
order.partially_delivered | Some vouchers fulfilled, others pending or failed |
There are currently no webhook events for order.failed, order.cancelled, or wallet top-ups. For these, poll the Orders API or Transactions API respectively.