Disable FX payouts
Disable the FX setting when your payout configuration should not permit foreign-exchange behavior. This operation changes the setting returned by the Payouts API; it does not modify financial accounts or destination mappings.
Prerequisites
- An authenticated Commerce application
- Access to the application's payout settings
Disable the setting
Call Disable FX payouts. The endpoint accepts an empty JSON body and returns the updated payout settings with fx_enabled: false.
This operation supports idempotency. A successful response can be replayed with the same idempotency key and request body for 24 hours.
Confirm the result
Use Retrieve payout settings and check fx_enabled. The current financial-account and destination contracts accept ghs; disabling FX preserves that currency-matched configuration.
Disabling the setting does not cancel an existing payout. Use Cancel a payout separately when a scheduled payout remains eligible for cancellation.
Related resources
- Disable FX payouts - Complete endpoint contract
- Retrieve payout settings - Read the current setting
- Enable FX payouts - Turn the setting on
- Manage payout destinations - Configure destinations