Simulate the payout for an FX trade (sandbox only)

Sandbox only — always returns 403 in production. Simulates the payout completing for a trade in PROCESSING (deposit already settled), driving it to COMPLETED through its normal lifecycle asynchronously: poll GET /v1/fx/trades/{tradeId} or subscribe to FX trade webhooks to observe the transition.

post/v1/fx/trades/{tradeId}/simulate-payout

Path parameters

tradeIdstring required

Trade ID (tfr_…)

Headers

X-API-Keystring

API key

Response

Simulation accepted. The trade completes asynchronously as the simulated payout settles.

simulatedboolean required

Always true — the simulation request was accepted.

notestring required

Human-readable note about what happens next. The trade advances asynchronously; poll GET /v1/fx/trades/{tradeId} or subscribe to FX trade webhooks to observe the transition.

Example response

{
  "simulated": true,
  "note": "Deposit simulation accepted. The trade will advance automatically as the simulated funds settle."
}

Changes

No recorded changes to this endpoint across all 6 revisions of this API.