Orders

Events

Action Event name
Completing order creation after a referenced payment (PATCH /orders) orders.modified
Overwriting/updating payments of an order (POST /orders/:orderId/payments) payments.updated

Payload for orders.modified

Emitted when an order is completed after a referenced payment with waitForPaymentCompletion is completed (PATCH /orders with operation to complete the referenced payment).

{
  "attemptId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created": 1754320000,
  "data": {},
  "event": "orders.modified",
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "livemode": false
}

The data field contains the order with updated payments (structure matches the order/transaction format returned by the API).

Field Type Description
attemptId string Attempt identifier (UUID).
created number Unix timestamp when the event was created.
data object Order with updated payments (formatted order/transaction).
event string Event name: orders.modified.
id string Event identifier (UUID).
livemode boolean Whether the event is from a live or test environment.

Payload for payments.updated

Emitted when order payments are overwritten via POST /orders/:orderId/payments (e.g. after confirming a referenced or manual payment).

{
  "attemptId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "created": 1754320100,
  "data": [],
  "event": "payments.updated",
  "id": "d4e5f6a7-b8c9-0123-def0-234567890123",
  "livemode": false
}

The data field is the array of updated payment objects for the transaction.

Field Type Description
attemptId string Attempt identifier (UUID).
created number Unix timestamp when the event was created.
data array Updated payment objects for the order's transaction.
event string Event name: payments.updated.
id string Event identifier (UUID).
livemode boolean Whether the event is from a live or test environment.