terminalOrder.status.changed | Payroc

Event type: terminalOrder.status.changed
Version: 1.0.0
Resource: Boarding

We trigger this event when we change the status of a terminal order, for example, when we ship the items in the terminal order.

If we ship items to the merchant as part of the terminal order, the final status is dispatched. We don’t trigger a status of fulfilled.

Notification payload

Attribute	Description
terminalOrderId	Unique identifier that we assigned to the terminal order.
processingAccountId	Unique identifier that we assigned to the processing account.
status	Status of the terminal order. The status is one of the following values: • open – We are currently working on the terminal order. • dispatched – We have shipped the items in the terminal order. • fulfilled – We have completed the terminal order. • cancelled – We have cancelled the terminal order. For more information about why we have cancelled the order, see the reason parameter. • held – We have placed the terminal order is on hold. For more information about why we have held the order, see the reason parameter.
reason	If the status of the terminal order is `cancelled` or `held`, we provide a reason to explain why we have cancelled or held the terminal order.

Example

1 {
2   "specversion": "1.0",
3   "type": "terminalOrder.status.changed",
4   "version": "1.0.0"
5   "source": "payroc",
6   "id": "c24a7423-9bed-403d-93eb-004dfadcc19b",
7   "time": "2024-11-01T16:00:00.000Z",
8   "datacontenttype": "application/json",
9   "data": {
10     "terminalOrderId": "1436",
11     "processingAccountId": "12345678",
12     "status": "held",
13     "reason": "Pending MID Approval",
14   }
15 }