Payout FX settings
Payout settings include an fx_enabled flag that you can enable or disable. The flag is observable configuration, but it does not by itself guarantee that a foreign-currency account, destination, or currency pair is accepted.
Prerequisites
- Understand payout settings
- Connect a currently supported financial account
- Configure a payout destination
What the setting controls
Use Enable FX payouts and Disable FX payouts to change fx_enabled. Both operations return the updated payout settings.
The current connection and destination contracts accept ghs. Do not infer support for USD, EUR, GBP, cross-currency routing, a particular exchange rate, or conversion pricing from fx_enabled: true. Those capabilities are available only when the relevant endpoint contracts explicitly accept them.
Design your integration conservatively
Keep financial-account currency and payout-destination currency aligned. Before adding a conversion flow, verify all three parts of the public contract:
- The destination account currency is accepted by the Financial Accounts API.
- The destination mapping is accepted by the Payouts API.
- The required currency pair, rate, fees, and resulting payout fields are documented.
Until all three are present, treat the FX setting as stored configuration rather than an executable cross-currency payout guarantee.
Related resources
- Retrieve payout settings - Read
fx_enabled - Enable FX payouts - Enable the setting
- Disable FX payouts - Disable the setting
- Set payout destinations - Configure current destination mappings