Create FX Trade (New)

This API can be used to create an FX trade between all the currency pairs we support. You can convert it into another wallet or send the converted funds to a beneficiary.

Body Params

An object containing all necessary details to initiate a payment as part of the foreign exchange transaction.

string
enum
required

The type of payment you intend to make which is based on where you are sending the funds.

Allowed:
number
required

The wallet you intend to deduct the fund for the exchange.

float
required

The amount you intend to deduct the fund from the provided wallet for the exchange.

number

Use purposeId to state the purpose of the transfer of funds. Use the Get Purpose Codes API to get the purpose codes.

Required for convertWalletPayout request.

string
required

The representation of the rate. This token is generated using the Get FX Rate API. The validity for which is 30 seconds.

string | null

You can use this to pass a reference that you'd like Verto to store.

float

The amount you intend to receive from the exchange

number

The id of beneficiary you intend to send the converted funds.

Required for convertWalletPayout request.

number

The id of wallet you intend to send the converted funds.

Required for convertWithinWallets request.

string
required

This helps us identify a unique payment request. If the same value is sent in a duplicate payment request, it will be rejected.

string

key obtained in generate an upload link in case client wants to attach supporting document.

sender
object

Business or Individual initiating the transaction

fxMarkup
object

Use this field to specify the FX markup configuration for a transaction. This field is only available for Atlas for Platform use cases (subaccounts with type PARTNER_REFERRED).

Responses

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