Simulate the deposit for an FX trade (sandbox only)

Sandbox only — always returns 403 in production. Simulates the deposit arriving for a trade in AWAITING_DEPOSIT, standing in for the on-chain transfer (crypto-source) or the bank wire (fiat-source, which cannot be sent in sandbox). The trade then advances 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-deposit

Path parameters

tradeIdstring required

Trade ID (tfr_…)

Headers

X-API-Keystring

API key

Response

Simulation accepted. The trade advances asynchronously as the simulated funds settle.

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 19 revisions of this API.