Enable FX payouts
The FX setting records whether your payout configuration permits foreign-exchange behavior. Enabling it does not expand the currencies currently accepted when connecting financial accounts or configuring payout destinations.
Prerequisites
- An authenticated Commerce application
- Payout settings configured for your application
- A supported financial account and payout destination
Enable the setting
Call Enable FX payouts. The endpoint accepts an empty JSON body and returns the updated payout settings with fx_enabled: true.
This operation supports idempotency. A successful response can be replayed with the same idempotency key and request body for 24 hours.
Current configuration limits
Financial-account connection and payout-destination configuration currently accept ghs. Enabling fx_enabled does not make foreign-currency accounts or cross-currency destination mappings valid. Do not build a cross-currency payout flow until those contracts explicitly list the currency pair and destination combination you need.
Use Retrieve payout settings to confirm the stored value. Treat fx_enabled as a setting, not proof that a particular conversion route is available.
Related resources
- Enable FX payouts - Complete endpoint contract
- Retrieve payout settings - Read the current setting
- Disable FX payouts - Turn the setting off
- Set up financial accounts - Configure currently accepted accounts