Currency

Currency Endpoints

This section will display all available endpoints to get currency data.

Subsections of Currency

Currency by IP

This method returns a currency by player’s IP address, generally used before Registration to determine which currency to display to player upon registration.

Request (GET)

/gateway/currencies/{version}/currencyByIP/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.

Response

Status 200

{
  "status": "success",
  "data": {
    "isoCountryCode": "IL",
    "isoCurrencyCode": "USD",
    "symbol": "$"
  }
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 400

{
  "status": "failed",
  "data": "currency not found, reason: reason"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
status indication if request was successful or not.
data.isoCountryCode ISO2 country code, will be fetch from X-Forwarded-For header.
data.isoCurrencyCode ISO3 currency code for this country.
data.symbol currency symbol.

Supported Currencies

This method returns a currency of the brand and all supported currencies.

Request (GET)

/gateway/cashier/supported/currencies/{brand_id}

Parameters:

Name In Type Required Description
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.

Response

Status 200

{
  "base_currency": "EUR",
  "supported_currencies": [
    {
      "iso_code": "USD",
      "symbol": "$",
      "unicode": "$",
      "position": "before"
    },
    {
      "iso_code": "EUR",
      "symbol": "€",
      "unicode": "€",
      "position": "before"
    }
  ]
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
base_currency Brand base currency.
supported_currencies.iso_code ISO2 code of currency.
supported_currencies.symbol symbol of currency.
supported_currencies.unicode unicode of currency.
supported_currencies.position where does the symbol of currency should be displayed, before/after the amount.