# OpenFX

> OpenFX API documentation for v1, v2, and v3. Real-time cross-border FX and stablecoin payment infrastructure.

## Docs

- [Introduction](https://api-docs-v3.openfx.dev/v3/introduction.md): OpenFX v3 gives financial institutions programmatic access to FX and stablecoin liquidity, with bare-resource responses, stable error codes, and cursor pagination behind one /v3/fx/ surface.
- [Quickstart](https://api-docs-v3.openfx.dev/v3/quickstart.md): Get from zero to your first executed trade in under 5 minutes.
- [Environments](https://api-docs-v3.openfx.dev/v3/environments.md): Sandbox and Live share api.openfx.com; Sandbox API keys carry a sandbox_ prefix.
- [Authentication](https://api-docs-v3.openfx.dev/v3/authentication.md): Mint ES256-signed JWT bearer tokens and ES256 request signatures to access the OpenFX API.
- [Cheat sheet](https://api-docs-v3.openfx.dev/v3/cheat-sheet.md): Every v3 endpoint at a glance. Method, path, auth, idempotency, pagination, response shape.
- [Migration from v2](https://api-docs-v3.openfx.dev/v3/migration-from-v2.md): Endpoint-by-endpoint mapping from v2 to v3, every field rename, and the breaking changes ranked by impact.
- [Currencies](https://api-docs-v3.openfx.dev/v3/references/currencies.md): Currencies supported by v3 — fiat ISO codes, stablecoin tickers, precision, and the use case each serves on the OpenFX platform.
- [Supported currencies](https://api-docs-v3.openfx.dev/v3/references/supported-currencies.md): Every fiat and stablecoin currency on v3, in one table, with its release state.
- [Supported Networks](https://api-docs-v3.openfx.dev/v3/supported-networks.md): Stablecoin networks supported for deposits and withdrawals. USDC and USDT each settle on 10 chains; EURC settles on 4.
- [Resource IDs](https://api-docs-v3.openfx.dev/v3/resource-ids.md): Every v3 resource has a readable, typed ID — a resource-type prefix plus a Base58 encoding of the underlying UUID. Foreign-key fields like withdrawalAccountId and quoteId reference these IDs across resources.
- [Amounts](https://api-docs-v3.openfx.dev/v3/amounts.md): Format rules, prefix vocabulary, parsing examples, and per-currency precision limits for monetary values in v3.
- [Metadata & tracing](https://api-docs-v3.openfx.dev/v3/metadata-and-tracing.md): Every response carries an X-Trace-Id and an X-Request-Timestamp. Log the trace ID for correlation, retries, and support triage.
- [Trade](https://api-docs-v3.openfx.dev/v3/trading.md): Atomic FX trades: discover supported pairs, quote a rate, execute the trade against the quote.
- [Trade models](https://api-docs-v3.openfx.dev/v3/trade-models.md): Reference for v3 trade-related resource shapes.
- [Trade Settlement](https://api-docs-v3.openfx.dev/v3/trade-settlement.md): Account-side flows in the Trade product: deposits land funds in your balances; withdrawals send them out to verified withdrawal accounts. One endpoint covers fiat and stablecoin.
- [Deposit lifecycle](https://api-docs-v3.openfx.dev/v3/deposit-lifecycle.md): State machine, detection mechanics per rail, and the reconciliation pattern for incoming funds.
- [Withdrawal lifecycle](https://api-docs-v3.openfx.dev/v3/withdrawal-lifecycle.md): Settlement windows per rail, and an adaptive polling pattern for the time between submission and settlement.
- [Verified accounts](https://api-docs-v3.openfx.dev/v3/setup/verified-accounts.md): Pre-configure your bank accounts and stablecoin wallets so withdrawals only need an `withdrawalAccountId` and a `withdrawalAmount`.
- [Settlement Times](https://api-docs-v3.openfx.dev/v3/settlement-times.md): Submission cut-offs per fiat rail. Withdrawals submitted after the cut-off are processed the next banking day.
- [Exposure](https://api-docs-v3.openfx.dev/v3/exposure.md): The organization's credit-line usage: how much is committed to unsettled trades, and the breakdown by currency and settlement stage.
- [Idempotency](https://api-docs-v3.openfx.dev/v3/idempotency.md): Idempotency-Key headers make retries safe: required on every v3 write, TTLs from 30 minutes to 7 days, explicit responses for in-flight/mismatch, and the crash-recovery pattern to keep it safe across restarts.
- [Errors](https://api-docs-v3.openfx.dev/v3/errors.md): v3 returns errors in a stable, machine-readable envelope with a code, type, human message, retry strategy, and per-code details.
- [Rate limiting](https://api-docs-v3.openfx.dev/v3/rate-limiting.md): OpenFX exposes IETF-standard RateLimit-* headers on every response. LIVE: 300 requests / 10s. SANDBOX: 600 requests / 10s. On a 429 or 409 IDEMPOTENCY_IN_FLIGHT, wait Retry-After seconds.
- [Pagination](https://api-docs-v3.openfx.dev/v3/pagination.md): List endpoints use cursor pagination with a Stripe-style startingAfter / endingBefore pattern. No page numbers, no deep-pagination cliff.
- [Live checklist](https://api-docs-v3.openfx.dev/v3/live-checklist.md): Pre-launch checklist, key rotation, IP allowlisting, monitoring, and ongoing operations guidance.
- [Glossary](https://api-docs-v3.openfx.dev/v3/references/glossary.md): Definitions for the v3 vocabulary — resources, headers, status enums, and concepts used across the spec.
- [Webhooks setup](https://api-docs-v3.openfx.dev/v3/webhooks/setup.md): Register an HTTPS endpoint, store the signing secret, verify every event, and stop polling.
- [Webhook authentication](https://api-docs-v3.openfx.dev/v3/webhooks/authentication.md): HMAC-SHA256 signatures in `X-OpenFX-Signature`. Verify every event server-side with a timestamp check and constant-time comparison.
- [Deposit webhooks](https://api-docs-v3.openfx.dev/v3/webhooks/deposits.md): Receive a signed event when a fiat or stablecoin deposit completes or fails. Event envelope and Deposit resource shape.
- [Withdrawal webhooks](https://api-docs-v3.openfx.dev/v3/webhooks/withdrawals.md): Receive a signed event when a fiat or stablecoin withdrawal is processing, completes, or fails. Event envelope and Withdrawal resource shape.
- [List currency pairs](https://api-docs-v3.openfx.dev/v3/api-reference/trade/list-currency-pairs.md): Returns every currency pair tradable on your account, with per-pair limits and supported directions.
- [Create a quote](https://api-docs-v3.openfx.dev/v3/api-reference/trade/create-quote.md): Locks a rate for a currency pair and amount, returning a quote id valid until expiresAt.
- [Retrieve a quote](https://api-docs-v3.openfx.dev/v3/api-reference/trade/get-quote-by-id.md): Returns a single quote by ID. Useful for audit, reconciliation, and verifying a quote has not been consumed.
- [Execute a trade](https://api-docs-v3.openfx.dev/v3/api-reference/trade/execute-trade.md): Executes a trade against a quote. Call this before the quotes expiresAt.
- [List trades](https://api-docs-v3.openfx.dev/v3/api-reference/trade/list-trades.md): Returns trades on your account, newest first.
- [Retrieve a trade](https://api-docs-v3.openfx.dev/v3/api-reference/trade/get-trade.md): Returns a single trade by ID.
- [Generate a reverse quote](https://api-docs-v3.openfx.dev/v3/api-reference/trade/generate-reverse-quote.md): Creates a time-limited quote previewing the amounts and differential for reversing a trade.
- [Reverse a trade](https://api-docs-v3.openfx.dev/v3/api-reference/trade/reverse-trade.md): Executes a reversal of a previously executed trade against an approved reverse quote.
- [Settle a trade](https://api-docs-v3.openfx.dev/v3/api-reference/trade/settle-trade.md): Settles a trade whose settlement is finalized out of band.
- [List balances](https://api-docs-v3.openfx.dev/v3/api-reference/trade-settlement/list-balances.md): Returns one entry per currency held, with available and total balances.
- [List deposits](https://api-docs-v3.openfx.dev/v3/api-reference/trade-settlement/list-deposits.md): Returns deposits to your account, newest first.
- [Retrieve a deposit](https://api-docs-v3.openfx.dev/v3/api-reference/trade-settlement/get-deposit.md): Returns a single deposit by ID.
- [Create a withdrawal](https://api-docs-v3.openfx.dev/v3/api-reference/trade-settlement/create-withdrawal.md): Initiates a withdrawal to a verified withdrawal account. Pass a withdrawalAccountId from List withdrawal accounts.
- [List withdrawals](https://api-docs-v3.openfx.dev/v3/api-reference/trade-settlement/list-withdrawals.md): Returns withdrawals on your account, newest first. Fiat and stablecoin withdrawals appear in the same list.
- [Retrieve a withdrawal](https://api-docs-v3.openfx.dev/v3/api-reference/trade-settlement/get-withdrawal.md): Returns a single withdrawal by ID.
- [List withdrawal accounts](https://api-docs-v3.openfx.dev/v3/api-reference/trade-settlement/list-withdrawal-accounts.md): Returns the verified withdrawal accounts on your account — fiat bank accounts and stablecoin wallets.
- [Get exposure summary](https://api-docs-v3.openfx.dev/v3/api-reference/exposure/get-exposure-summary.md): Returns the organization's credit-line usage, aggregated and broken down by currency.

## OpenAPI Specs

- [openapi-v3](https://api-docs-v3.openfx.dev/api-reference/openapi-v3.json)
- [openapi-v2](https://api-docs-v3.openfx.dev/api-reference/openapi-v2.json)
- [openapi-v1](https://api-docs-v3.openfx.dev/api-reference/openapi-v1.json)