List FX Trades (Atlas)

Overview

The POST /banking/ibans/v2/fx/list endpoint enables searching, filtering, and paginating through historical FX trades executed by your company.

Filter parameters support narrowing results by date ranges, source/target currencies, execution states, specific payment UUIDs, and minimum/maximum amounts.

Resource Access

• HTTP Method: POST
• Endpoint: /banking/ibans/v2/fx/list
• Authentication: Bearer token required

Request Headers

Header	Value	Required	Description
Authorization	Bearer {access_token}	Yes	JWT Bearer access token
Content-Type	application/json	Yes	Request payload format
Accept	application/json	Yes	Response payload format

Query Parameters

Parameter	Type	Required	Description
limit	integer	Yes	Maximum number of records to return per page.
skip	integer	Yes	Number of records to skip for pagination.

Request Body

Filter Parameters

Field	Type	Description
fromCurrencies	array of strings	Filter by source currencies (e.g. ["USD", "EUR"]).
toCurrencies	array of strings	Filter by target currencies (e.g. ["GBP", "CAD"]).
createdStartDate	string (ISO date)	Filter trades created after this timestamp.
createdEndDate	string (ISO date)	Filter trades created before this timestamp.
minimumAmount	number	Filter trades with source amount greater than or equal to this value.
maximumAmount	number	Filter trades with source amount less than or equal to this value.
search	string	Free-text search matching order reference.
state.include	array of strings	Include only trades matching these states (confirmed, inwardSettlementDone, etc.).
paymentIds	array of strings	Filter by client idempotency payment UUIDs.

Request Example

{
  "fromCurrencies": ["USD"],
  "toCurrencies": ["GBP", "EUR"],
  "createdStartDate": "2026-09-01T00:00:00.000Z",
  "createdEndDate": "2026-09-16T23:59:59.000Z",
  "state": {
    "include": ["confirmed", "outwardSettlementDone"]
  }
}

Response

Success Response (200 OK)

{
  "totalCount": 18,
  "currentPage": 1,
  "pageSize": 10,
  "items": [
    {
      "id": "10492",
      "reference": "EN-01011900-001",
      "currencyFrom": "USD",
      "amountFrom": 5000.00,
      "currencyTo": "GBP",
      "amountTo": 3927.00,
      "rate": 0.7854,
      "state": "outwardSettlementDone",
      "createdAt": "2026-09-16T02:00:00.000Z"
    }
  ]
}

Response Fields

Field	Type	Description
totalCount	number	Total number of trades matching the filters.
currentPage	number	Current pagination page index.
pageSize	number	Number of items returned in the batch.
items	array	Array of ClientOrderResponse objects.

Code Examples

cURL

curl -X POST "https://gateway.ahrvo.network/banking/ibans/v2/fx/list?limit=10&skip=0" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "fromCurrencies": ["USD"],
    "toCurrencies": ["GBP"]
  }'

Python

import requests

url = "https://gateway.ahrvo.network/banking/ibans/v2/fx/list?limit=10&skip=0"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json"
}

payload = {
    "fromCurrencies": ["USD"],
    "toCurrencies": ["GBP"]
}

response = requests.post(url, json=payload, headers=headers)
print("Orders found:", response.json().get("totalCount"))

JavaScript (Node.js)

const axios = require('axios');

const url = 'https://gateway.ahrvo.network/banking/ibans/v2/fx/list';
const headers = {
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
  'Content-Type': 'application/json'
};

const payload = {
  fromCurrencies: ['USD'],
  toCurrencies: ['GBP']
};

axios.post(url, payload, { headers, params: { limit: 10, skip: 0 } })
  .then(res => console.log('Total Trades:', res.data.totalCount))
  .catch(err => console.error(err.response ? err.response.data : err.message));

Interactive API Explorer