Create an FX Trade

post

https://api-v3-sandbox.vertofx.com/orders/v2.1/fx

This service is used to convert money between different currencies within wallets.

You will need to include vfx_token value in your request which is returned in the response of Get FXRate call and valid for 30 seconds only.

You also need to specify the side as either Sell or Buy as well as the amount subject to trade. clientReference field is available for any internal use to identify the transaction.

Body Params

vfx_token

string

required

This token is generated in the response body [response.body.vfx_token] of the Get an FX Rate API. The validity for which is 30 seconds.

side

string

enum

required

Indicates the direction of the foreign exchange transaction. This field specifies whether the transaction is a BUY or SELL order.

Let's assume transaction involves 100 USD to 160000 NGN transfer.

If you set the side as BUY, the transaction involves buying the fixed 160000 NGN with the source currency.

Conversely, if you set the side as SELL, transaction involves selling the fixed 100 USD to obtain the target currency.

Allowed:

amount

number

required

Amount you want to BUY or SELL.

clientReference

string

length ≤ 35

Use this client reference to pass your customer name or any reference you'd like for us to carry through. maximum length (35 chars, without special characters)

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error