/
v3.0.11Get access

getCurrencyConfig

The API is used to fetch configuration details and exchange rates for various currencies.

Request parameters:

NameDescriptionTypeValuesDefault
supportedCurrencies
An array of ISO currency codes to filter the results. If the parameter is not passed in the request, the API defaults to returning all available currencies in the system.array--

Call example:

getCurrencyConfig({
  supportedCurrencies: ['RON']
})

Response examples:

{
  currency: {
    '946': {
      id: 946,
      name: 'RON',
      rounding: 2,
      iso_long: 'RON',
      rate: 0.19097465
    }
  }
}

Response parameters:

NameDescriptionTypeValues
currency
Object where each key is the internal Currency ID (e.g., "946"), mapping to an object with currency info data.object
└─
The internal Currency ID.object
└─ id
The unique database/internal identifier for the currency.number-
└─ name
The standard display name or short code.string-
└─ rounding
The number of decimal places to round financial transactions for this currency (typically 2 for most fiat currencies).number-
└─ iso_long
The standard 3-letter ISO 4217 currency code.string-
└─ rate
The current exchange rate conversion factor relative to the system's base currency.number-