Get FX Markup Configuration (New)

Overview

Retrieve active foreign exchange markup rules configured for your company or downstream sub-accounts.

Resource Access

• HTTP Method: GET
• Endpoint: /banking/ibans/v2/fx/markup/config
• Authentication: Bearer token required (Authorization: Bearer {access_token})

Query Parameters

Parameter	Type	Required	Description
currencyFrom	string	No	Filter by source currency code (e.g. USD).
currencyTo	string	No	Filter by target currency code (e.g. EUR).
markupType	string	No	Filter by rule type: currency_pair or universal.

Response

Success Response (200 OK)

{
  "success": true,
  "statusCode": 200,
  "configs": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "companyId": "3046",
      "markupType": "currency_pair",
      "markupPerc": 1.5,
      "currencyFrom": "USD",
      "currencyTo": "EUR",
      "subAccountId": null,
      "isActive": true,
      "createdAt": "2024-08-04T10:30:00Z",
      "updatedAt": "2024-08-04T10:30:00Z"
    }
  ]
}

Response Fields

Field	Type	Description
success	boolean	Indicates whether the configuration retrieval succeeded.
statusCode	number	HTTP status code (e.g. 200).
configs	array	Array of active markup configuration objects.
configs[]._id	string	Unique configuration identifier.
configs[].markupType	string	currency_pair or universal.
configs[].markupPerc	number	Markup margin applied.
configs[].currencyFrom	string	Source currency.
configs[].currencyTo	string	Target currency.
configs[].isActive	boolean	Whether the rule is currently active.

Error Responses

• 401 Unauthorized: Missing or expired access token.
• 500 Internal Server Error: Internal platform error.

Code Examples

cURL

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

Python

import requests

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

response = requests.get(url, headers=headers, params=params)
data = response.json()
for config in data.get("configs", []):
    print(f"Markup for {config.get('currencyFrom')}/{config.get('currencyTo')}: {config.get('markupPerc')}%")

JavaScript / Node.js

const response = await fetch("https://api.ahrvo.network/banking/ibans/v2/fx/markup/config?currencyFrom=USD&currencyTo=EUR", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
  }
});

const result = await response.json();
console.log("Configured markups:", result.configs);

Interactive API Explorer