List FX trades

post

https://api-exchange-now-beta.vertofx.com/fx/list

List FX trades for your company with pagination and optional filters for trade state, date range, source and target type, and payment IDs.

📘
NOTE:
Always confirm your Base URL: If you are testing in the sandbox environment, ensure your base URL is set to the sandbox base url: https://api-company-sandbox.vertofx.com, and if in production, use the production base URL: https://api-company-beta.vertofx.com. Using them interchangably will result in 403 errors.

Query Params

limit

int32

required

max records to return

skip

int32

required

number of items to skip

Body Params

createdStartDate

date-time

start date for filtering the list.

createdEndDate

date-time

end date for filtering the list.

scheduledStartDate

date-time

scheduled start date for filtering the list.

scheduledEndDate

date-time

scheduled end date for filtering the list.

fromCurrencies

array of objects

specify the source currency list for fx orders.

fromCurrencies

toCurrencies

array of objects

specify the target currency list for fx orders.

toCurrencies

sources

array of objects

specify the sources for filtering the list.

sources

Allowed:

targets

array of objects

specify the targets for filtering the list.

targets

Allowed:

sourceTargetPairs

array of objects

sourceTargetPairs

minimumAmount

number

specify the minimum amount from for filtering the list.

maximumAmount

number

specify the maximum amount from for filtering the list.

string

length between 1 and 50

search the records.

state

object

paymentIds

array of strings

paymentIds

companyIds

string of strings

userId

string | null

filter orders by specific user record ID (admin only).

Responses

200success

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error