For the complete documentation index, see llms.txt. This page is also available as Markdown.

FX APIs

FX APIs provide a complete workflow for performing currency-conversion trades within a merchant's Global Collections account — from viewing indicative market rates and locking a guaranteed price, through executing the trade and confirming settlement delivery.

By integrating with these APIs, organizations can:

  • Monitor reference exchange rates: Retrieve live indicative bid and offer rates for available currency pairs via the Get FX Rates API, enabling treasury teams to make informed decisions about when and how to convert balances.

  • Lock a guaranteed FX rate: Use the FX Inquiry API to obtain a firm, time-limited quote token for a specific currency pair and amount, protecting against market movements between the decision to convert and the actual trade execution.

  • Execute currency-conversion trades: Submit the locked token to the Create FX Order API to immediately execute the conversion trade at the agreed rate, without renegotiation or slippage.

  • Track trade and settlement status: Poll the Get Detail FX Order API to monitor the trade lifecycle from PROCESSING through DELIVERING to SUCCESS, and use the Get FX Delivery Status API to confirm that converted funds have been credited to the account.

In essence, FX APIs empower you to manage currency conversion end-to-end — from rate discovery and commitment, through trade execution, to settlement confirmation — with full visibility at every step.

Endpoints

Last updated

Was this helpful?