TRtransfi
Simulation

Simulate Order Status Update

Changed on

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

Request

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

mockRefundboolean

Optional. Applies to offramp orders only. When true and status is fund_failed, the order is failed with INVALID_ACCOUNT_DETAILS (the payout failure that triggers a refund on live orders) and a refund of the crypto the user sent is created once the order reaches fund_failed, so you can test the refund flow and its webhooks. errorCode is ignored when the refund is mocked. Ignored for any other order type or status.

Example request

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

Response

Order status update accepted for processing

statusstring

Changes