POST api/BackOffice/ExchangeRates

Receive request to get exchange rates

Request Information

URI Parameters

None.

Body Parameters

Exchange rates request object

ExchangeRatesRequest
NameDescriptionTypeAdditional information
OriginCurrencyCode

The ISO 4217 origin currency code (USD/EUR/ILS/...)

 string

Required

Max length: 3
UserName

The provided user name.

 string

Required
Salt

A random number(at least 9 digits)

 integer

Required
Digest

A digest of the user credentials and the request

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "OriginCurrencyCode": "ILS",
  "UserName": "AmsalemWebIL",
  "Salt": 403614193,
  "Digest": "O/Y04XZ4o2sh5yN+QV4HNHbzX3E/YiN/3ioq25qDDipfv5ExR1btb1kDkXmVM3f2NXi/PR0dV40eA00qlthKag=="
}

application/xml, text/xml

Sample: 
<ExchangeRatesRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="AmsalemWebIL" Salt="403614193" Digest="O/Y04XZ4o2sh5yN+QV4HNHbzX3E/YiN/3ioq25qDDipfv5ExR1btb1kDkXmVM3f2NXi/PR0dV40eA00qlthKag==">
  <OriginCurrencyCode>ILS</OriginCurrencyCode>
</ExchangeRatesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Exchange rates response object

ExchangeRatesResponse
NameDescriptionTypeAdditional information
ExchangeRates

A list of the rates

 Collection of CurrencyRate

None.
FromCache

if the rates taken from cache

 boolean

None.
RefreshTimeUTC

last read from DB or API

 date

None.
Success

Indicate if the operation was success

 boolean

None.
Message

Return of errors or indicated return message/data

 string

None.
Extra1

Additional info 1 to return

 string

None.
Extra2

Additional info 2 to return

 string

None.
Extra3

Additional info 3 to return

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ExchangeRates": [
    {
      "CurrencyCode": "USD",
      "ExchangeRate": 3.7182
    },
    {
      "CurrencyCode": "EUR",
      "ExchangeRate": 3.9649
    }
  ],
  "FromCache": false,
  "RefreshTimeUTC": "2025-11-08T15:59:13.378786Z",
  "Success": false,
  "Message": null,
  "Extra1": null,
  "Extra2": null,
  "Extra3": null
}

application/xml, text/xml

Sample: 
<ExchangeRatesResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>false</Success>
  <FromCache>false</FromCache>
  <RefreshTimeUTC>2025-11-08T15:59:13.378786Z</RefreshTimeUTC>
  <ExchangeRates>
    <CurrencyRate>
      <CurrencyCode>USD</CurrencyCode>
      <ExchangeRate>3.7182</ExchangeRate>
    </CurrencyRate>
    <CurrencyRate>
      <CurrencyCode>EUR</CurrencyCode>
      <ExchangeRate>3.9649</ExchangeRate>
    </CurrencyRate>
  </ExchangeRates>
</ExchangeRatesResponse>