getExchangeRate

Returns an exchange rate between two currencies.

Request
Security:
query Parameters
fromCurrency
required
string

The currency which amounts are converted from. One unit of this currency multiplied by the rate returned by this operation is equal to one unit of the toCurrency. This currency is expressed as a three digit number as specified in ISO 4217, e.g. South African Rand is encoded as 710.

toCurrency
required
string

The currency which amounts are converted to. One unit of this currency multiplied by the rate returned by this operation is equal to one unit of the fromCurrency. This currency is expressed as a three digit number as specified in ISO 4217, e.g. South African Rand is encoded as 710.

receiverId
string

The ID of the receiver who would process such a currency exchange. If this is supplied then a specific institution's exchange rate may be returned. If this parameter is not supplied then the exchange rate may simply be the market exchange rate.

settlementEntity
string

The ID of the settlement entity who would process such a currency exchange. If this is supplied then a specific settlement entity's exchange rate may be returned for a specific receiver.

Responses
200

OK

400

Bad request

500

Internal Server Error

501

Not implemented

503

Service Unavailable

504

Gateway Timeout

get/admin/exchangerate
Request samples
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.electrum.io/moneytransfer/v2/admin/exchangerate?fromCurrency=string&toCurrency=string&receiverId=string&settlementEntity=string'
Response samples
application/json
{
  • "rate": 0,
  • "fromCurrency": "string",
  • "toCurrency": "string"
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2022. All right reserved.