You are viewing a non-production environment — the API surface may differ from production.
Developers
Ordering APIEvents

Order requires payment

Fired when an order needs payment (e.g. INSTANT flow, or tab settlement).

Request Body

application/json

Payload delivered to your subscribed webhook URL for the order.payment_required event.

TypeScript Definitions

Use the request body type in TypeScript.

Envelope POSTed to subscribed webhook URLs. Signed with HMAC-SHA256 in the X-Webhook-Signature header.

id*string

Unique id of this delivery attempt group.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
event*"order.payment_required"

Value in

  • "order.payment_required"
resource*"order"

Value in

  • "order"
resourceId*string
timestamp*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
apiVersion*string
data*

Response Body

Example Requests

Envelope POSTed to subscribed webhook URLs. Signed with HMAC-SHA256 in the X-Webhook-Signature header.

POST/order.payment_required

Items added to an existing order Webhook

Fired when items are added to a kitchen dispatch that already exists.

Order reversed (void) Webhook

Fired when a kitchen dispatch is reversed — e.g. void requested or booking unseated. Carries full item snapshots so subscribers (printer-service) can produce KORRBONG void tickets.