Create FX trade

Create an FX trade to convert wallet funds and either pay out to a beneficiary or move funds into another wallet.

Sender information

The sender object is required when using convertWalletPayout as the paymentType and you are a fintech or financial institution making a payout on behalf of an underlying customer from your master wallet. It is not required for convertWithinWallets transfers.

Not required if you are:

  • An Atlas for Platform client — sender identity is established through the sub-account's KYB data
  • A corporate sending on your own principal basis (e.g. supplier payments, payroll, merchant settlements)
  • Initiating a payout from a sub-account — sender information is inherited from the sub-account directly
📘

If you are unsure whether your use case requires a sender object, contact [email protected] before going live. See the Sender object guide for full field requirements.

Body Params
enum
required
Allowed:
number
sources
array of objects
sources
number
number
number
required
string | null
number | null

Mandatory for APIKey login, if they are adding supportingDocS3Key.

string | null
string
required
string | null

Mandatory for APIKey login, helps identify a unique payment request. If the same value is sent in a duplicate payment request, it will be rejected.

fxMarkup
object
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json