v1

latestOpenAPI 3.1.0Proprietary2026-07-24462215.9 KB

Simulation

Simulate Order Status Update

Simulates a status transition for an existing order in the sandbox environment. The status update is processed asynchronously and triggers the corresponding webhooks for the target status.

post/v3/simulation/order

Headers

MIDstring required

Merchant or sub-merchant MID

Request body

orderIdstring required

The order ID to update. Must start with "OR-" or "PF-".

statusstring required

Target status to simulate for the order (e.g. fund_settled, fund_deposited, fund_failed). Allowed statuses

errorCodestring

Optional error code to attach when simulating a failed status.. Allowed codes

Example request

{
  "orderId": "OR-2603130504320558904",
  "status": "fund_settled",
  "errorCode": "PAYMENT_NOT_COMPLETED"
}

Response

Order status update accepted for processing

statusstring