API Explorer

v2.2.0 (143 APIs)


Get Current FxRate

Get the latest FX rate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE

OBP may try different sources of FX rate information depending on the Connector in operation.

For example we want to convert EUR => USD:

OBP will:
1st try - Connector (database, core banking system or external FX service)
2nd try part 1 - fallbackexchangerates/eur.json
2nd try part 2 - fallbackexchangerates/usd.json (the inverse rate is used)
3rd try - Hardcoded map of FX rates.

FX Flow

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

{ "bank_id":"gh.29.uk", "from_currency_code":"EUR", "to_currency_code":"GBP", "conversion_value":1.001, "inverse_conversion_value":0.998, "effective_date":"2017-09-19T00:00:00Z" }
Possible Errors:
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10004: ISO Currency code combination not supported for FX. Please modify the FROM_CURRENCY_CODE or TO_CURRENCY_CODE.
  • OBP-50000: Unknown Error.
Implemented in OBPv2.2.0 by getCurrentFxRate, operation_id: OBPv2.2.0-getCurrentFxRate