{
"id": "O-01H5WQGHKCBB85MQFM68S9KJ5Q",
"status": "PROCESSING",
"created_at": "2023-11-07T05:31:56Z",
"payment_method": {
"type": "ACCOUNT_BALANCE",
"currency": "USD"
},
"currency": "USD",
"total_price": "10.00",
"total_discount": "1.00",
"completed_at": "2023-11-07T05:31:56Z",
"description": "Your own reference text"
}Order completion
Order completion events are triggered when an order has completed processing.
WEBHOOK
order.completion
{
"id": "O-01H5WQGHKCBB85MQFM68S9KJ5Q",
"status": "PROCESSING",
"created_at": "2023-11-07T05:31:56Z",
"payment_method": {
"type": "ACCOUNT_BALANCE",
"currency": "USD"
},
"currency": "USD",
"total_price": "10.00",
"total_discount": "1.00",
"completed_at": "2023-11-07T05:31:56Z",
"description": "Your own reference text"
}Webhook overview
Webhooks work differently to the API endpoints. Take a read of our guide to
understand how they work.
status field to determine the type of payload you have received.
- Successfully completed orders will have a
statusofCOMPLETED - Failed orders will have a
statusofFAILED
New integrations should use
order.completed and
order.failed instead.
order.failed also tells you why the order 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.
- Completed order webhook
- Failed order
Webhook message sent when an order has completed processing.
Free format text reference for the order. The order description will not be visible to the end user. You will see this description in the Runa web portal.
This field is optional and can be omitted if not needed.
If not provided, the field will be set to null in the response.
Maximum string length:
128Example:
"Your own reference text"
Response
200
Return a 200 status to indicate that the data was received successfully
Was this page helpful?