Get FX Markup Configuration (Atlas)

Overview

The GET /banking/ibans/v2/fx/markup/config endpoint retrieves active and historical FX markup configurations set for your company.

Optional query parameters allow filtering by specific source/target currency corridors or markup type.

Resource Access

• HTTP Method: GET
• Endpoint: /banking/ibans/v2/fx/markup/config
• Authentication: Bearer token required

Request Headers

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

Query Parameters

Parameter	Type	Required	Description
markupType	string	No	Filter by configuration type: universal, currency_pair, sub_client, partner_refereel.
currencyFrom	string	No	Source currency code filter (e.g. USD).
currencyTo	string	No	Destination currency code filter (e.g. EUR).
limit	integer	No	Maximum number of configurations to return.
skip	integer	No	Number of records to skip for pagination.

Response

Success Response (200 OK)

{
  "totalCount": 2,
  "statusCode": 200,
  "items": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "companyId": "3046",
      "markupType": "currency_pair",
      "markupPerc": 1.25,
      "currencyFrom": "USD",
      "currencyTo": "EUR",
      "isActive": true,
      "createdAt": "2026-08-04T10:30:00Z"
    },
    {
      "_id": "507f1f77bcf86cd799439012",
      "companyId": "3046",
      "markupType": "universal",
      "markupPerc": 0.75,
      "isActive": true,
      "createdAt": "2026-08-04T11:00:00Z"
    }
  ]
}

Response Fields

Field	Type	Description
totalCount	number	Total number of matching markup configurations.
items	array	Array of FxMarkupConfig objects.
items[]._id	string	Unique configuration identifier.
items[].markupType	string	Configuration scope.
items[].markupPerc	number	Applied markup percentage spread.
items[].isActive	boolean	Indicates whether the configuration is actively applied.

Code Examples

cURL

curl -X GET "https://gateway.ahrvo.network/banking/ibans/v2/fx/markup/config?markupType=currency_pair&currencyFrom=USD" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

Python

import requests

url = "https://gateway.ahrvo.network/banking/ibans/v2/fx/markup/config"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}
params = {
    "markupType": "currency_pair",
    "currencyFrom": "USD"
}

response = requests.get(url, params=params, headers=headers)
print("Configurations:", response.json().get("items"))

JavaScript (Node.js)

const axios = require('axios');

const url = 'https://gateway.ahrvo.network/banking/ibans/v2/fx/markup/config';
const headers = {
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
  'Accept': 'application/json'
};

axios.get(url, { headers, params: { markupType: 'currency_pair' } })
  .then(res => console.log('Markup Items:', res.data.items))
  .catch(err => console.error(err.response ? err.response.data : err.message));

Interactive API Explorer