right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (505 APIs)

API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Create Fx

Create or Update Fx for the Bank.

Example:

“from_currency_code”:“EUR”,
“to_currency_code”:“USD”,
“conversion_value”: 1.136305,
“inverse_conversion_value”: 1 / 1.136305 = 0.8800454103431737,

Thus 1 Euro = 1.136305 US Dollar
and
1 US Dollar = 0.8800 Euro

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

conversion_value: 100

effective_date: 2020-01-27

from_currency_code:

inverse_conversion_value: 50

to_currency_code: EUR

Typical Successful Response: 

								
									
{
  "bank_id":"gh.29.uk",
  "from_currency_code":"EUR",
  "to_currency_code":"USD",
  "conversion_value":1.136305,
  "inverse_conversion_value":0.8800454103431737,
  "effective_date":"1100-01-01T00:00:00Z"
}
Required Roles:
  • CanCreateFxRate - Please login to request this Role
  • CanCreateFxRateAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by createFx, operation_id: OBPv2.2.0-createFx Tags: FX,

Get Currencies at a Bank

Get Currencies specified by BANK_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alphanumeric_code: alphanumeric_code

currencies: currencies

Typical Successful Response: 

								
									
{
  "currencies":[{
    "alphanumeric_code":"EUR"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by getCurrenciesAtBank, operation_id: OBPv5.1.0-getCurrenciesAtBank Tags: FX,

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:

BANK_ID: gh.29.uk

FROM_CURRENCY_CODE:

TO_CURRENCY_CODE: EUR

JSON response body fields:

bank_id: gh.29.uk

conversion_value: 100

effective_date: 2020-01-27

from_currency_code:

inverse_conversion_value: 50

to_currency_code: EUR

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":"1100-01-01T00:00:00Z"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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.
Connector Methods:
Version: OBPv2.2.0, function_name: by getCurrentFxRate, operation_id: OBPv2.2.0-getCurrentFxRate Tags: FX,