APappdirect
CurrencyExchangeRate

Deactivate a Currency Exchange Rate

Changed on

Deactivate a Currency Exchange Rate. To stop supporting currency exchange on your marketplace, deactivate a rate. This will prevent the exchange rate from being used to convert usage.

patch/channel/v1/exchangeRates/{currencyExchangeRateUuid}

Request

Path parameters

currencyExchangeRateUuidstring required

The unique identifier of the currency exchange rate.

Request body

activeboolean

Currency Exchange Rates can be only deactivated. Allowed value: false.

Example request

{
  "active": true
}

Response

OK

baseCurrency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

Supported currencies for the system

counterCurrency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

Supported currencies for the system

ratenumber

A currency pair is the quotation and pricing structure of the currencies traded in a forex market. A Currency Pair is represented as XXX/YYY where XXX is the Base currency and YYY is the Counter currency.

In AppDirect the Base currency is an external currency and the Counter currency is a supported currency in your marketplace.

When an exchange rate is provided with a Currency Pair, it represents how much of the Counter currency is required to purchase 1 unit of the Base currency. EUR/USD=1.18; EUR is the Base currency and USD is the counter currency. 1 EUR is equal to 1.18 USD. In order to buy 1 EUR, the buyer must pay 1.18 USD.

validFromnumber

Date from which the rate is valid

activeboolean

Whether or not the exchange rate is active and can be used in a conversion event

authenticationTypestring

The type of authentication used to create or change an exchange rate instance

oauthKeystring

The oauth key used to create or change an exchange rate instance

userIdnumber

The user id of the user who created or changed an exchange rate instance

currencyExchangeRateUuidstring

Unique identifier for the object

Example response

{
  "baseCurrency": {
    "href": "...",
    "id": "..."
  },
  "counterCurrency": {
    "href": "...",
    "id": "..."
  },
  "rate": 0.5,
  "validFrom": 1507077229000,
  "active": true,
  "authenticationType": "USER_LOGIN",
  "oauthKey": "...",
  "userId": 12345,
  "currencyExchangeRateUuid": "..."
}

Changes