WEBHOOK
order.completion
{
  "id": "O-01H5WQGHKCBB85MQFM68S9KJ5Q",
  "status": "PROCESSING",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "description": "Your own reference text",
  "payment_method": {
    "type": "ACCOUNT_BALANCE",
    "currency": "USD"
  },
  "currency": "USD",
  "total_price": "10",
  "total_discount": "1"
}

Webhook overview

Webhooks work differently to the API endpoints. Take a read of our guide to understand how they work.
 This event is essential when using the async ordering mode if you need to take action when an order has completed processing. It’s also useful if you want to feed ordering data into your system. The webhook payload depends on whether the order was processed successfully or not. You should use the status field to determine the type of payload you have received.
  • Successfully completed orders will have a status of COMPLETED
  • Failed orders will have a status of FAILED

Body

application/json

Sent when an order finishes processing, the body object will be one of the following schemas depending on the order status.

Webhook message sent when an order has completed processing. Used for orders that have completed. This class is typically used when returning a list of orders to the client.

Response

200

Return a 200 status to indicate that the data was received successfully