Retrieve a collection of FX transactions
This API endpoint allows you to retrieve a collection of FX transactions, providing you with a list of recent FX transactions. You can use various query parameters to customize your request and filter the results according to your specific needs.
Query Parameters
- page integer
Default value:
1
The collection page number
- itemsPerPage integer
Possible values:
<= 50
Default value:
30
The number of items per page
- pagination boolean
Enable or disable pagination
- currencyFrom string
- currencyTo string
- amountFrom[lt] string
- amountFrom[lte] string
- amountFrom[gt] string
- amountFrom[gte] string
- amountTo[lt] string
- amountTo[lte] string
- amountTo[gt] string
- amountTo[gte] string
- dealDate[lte] string
The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"
- dealDate[lt] string
The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"
- dealDate[gte] string
The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"
- dealDate[gt] string
The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"
- valueDate[lte] string
The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"
- valueDate[lt] string
The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"
- valueDate[gte] string
The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"
- valueDate[gt] string
The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"
- 200
- 401
- 403
OK - The request was processed successfully.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- id integer
- currencyFrom string
- currencyTo string
- amountFrom string
- amountTo string
- direction string
Possible values: [
sell
,buy
] - dealDate string
- valueDate string
- type string
Possible values: [
spot
,forward
] - spotRate string
- forwardPoints stringnull
- platformRate string
- status string
Possible values: [
not hedged
,hedged
,error
,to-hedge
,hedging
] - fromAutomation boolean
- ]
[
{
"id": 1,
"currencyFrom": "CHF",
"currencyTo": "EUR",
"amountFrom": "100.00",
"amountTo": "105.53",
"direction": "sell",
"dealDate": "2023-01-01T00:00:00+00:00",
"valueDate": "2023-01-01T00:00:00+00:00",
"type": "forward",
"spotRate": "1.0553",
"forwardPoints": "1.0553",
"platformRate": "1.0553",
"status": "hedged",
"fromAutomation": true
}
]
Unauthorised -- Your access token is wrong.
- application/json
- Schema
- Example (from schema)
Schema
- type string
- title string
- detail string
{
"type": "string",
"title": "string",
"detail": "string"
}
Forbidden -- Access to the requested resource or action is forbidden.
- application/json
- Schema
- Example (from schema)
Schema
- type string
- title string
- detail string
{
"type": "string",
"title": "string",
"detail": "string"
}