v1

latestOpenAPI 3.0.0Proprietary2026-07-2642128296.2 KB
Payout orders Cancel

Cancel a payout order if is possible

Can be used to cancel a payout order if it is still waiting to be processed

patch/payout_orders/{payout_order_id}/state

Response

Returns when was possible to cancel the payout order identified by the given id.

shinkansen_payout_order_statestring

The state of the payout order. This will have the value "cancelled" as other values return error.

Example response

{
  "shinkansen_payout_order_state": "cancelled"
}