Order and User status simulation

The TransFi Sandbox includes a set of Simulation APIs that let you drive your integration end-to-end without waiting for real-world events. Instead of waiting for a user to complete a bank transfer or a KYC provider to return a decision, you can call a simulation endpoint to instantly move an order or a user to any target status — and have the corresponding webhook fired automatically.

Note: All simulation endpoints are strictly for the Sandbox environment and require a valid MID header in every request.

Simulate Order Status Update

Use this endpoint to move an existing order (or prefund) to a target status. The update is accepted asynchronously — your request returns immediately with a 202 Accepted, and the status transitions (including any intermediate states) are applied in the background with webhooks fired at each step.

Request

curl --location 'https://sandbox-api.transfi.com/v3/simulation/order' \
--header 'MID: YOUR_MID' \
--header 'Content-Type: application/json' \
--header 'Authorization: ******' \
--data '{
    "orderId": "OR-2603130504320558904",
    "status": "fund_settled"
}'

Request Parameters

Allowed Statuses by Order Type

The statuses you can simulate depend on the order's type and fund flow. The simulation engine automatically fires all intermediate status events to reach the target state.

Gaming order types are not supported for simulation.

Allowed Error Codes

Error codes are only valid for certain failure and review statuses. Passing errorCode for any other status will return a 400 error. If you omit errorCode for a status that supports one, the default code listed below is used.

Response

{
  "status": "success",
  "data": {
    "message": "Order status update accepted for processing",
    "code": "ORDER_STATUS_UPDATE_ACCEPTED"
  }
}

For the full API specification, see Simulate Order Status Update.

Simulate User Status Update

Use this endpoint to move an existing user to a target KYC or KYB status. This immediately updates the user's record and fires the corresponding webhook — useful for testing downstream flows that depend on a specific verification outcome.

Request

curl --location 'https://sandbox-api.transfi.com/v3/simulation/user' \
--header 'MID: YOUR_MID' \
--header 'Content-Type: application/json' \
--header 'Authorization: ******' \
--data '{
    "userId": "UX-260108160852530",
    "status": "kyc_success"
}'

Request Parameters

Allowed Statuses — Individual Users

Allowed Statuses — Business / Organization Users

Response

{
  "status": "success",
  "message": "User status updated successfully"
}

For the full API specification, see Simulate User Status Update.