Jump to

• Request
• Response

Get Currency Exchange Rates

get

/services/private/CurrencyRates/currencyRates

This service is used to retrieve all currencies and currency conversion rates. The conversion rate is the value used to convert to the primary currency.

Request

Header Parameters

• Accept-Language:
  Accept-Language header

  Example:

  en-US

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

Default Response

default response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object CurrencyRates

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CurrencyRates"
    }
}

Nested Schema : CurrencyRates

Type: object

Show Source

• currencyCode: string
• effectiveDate: string (date-time)
• exchangeRate: number
• exchangeType: string
• hyperMediaContent: object hyperMediaContent
• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "exchangeRate":{
            "type":"number"
        },
        "exchangeType":{
            "type":"string"
        },
        "currencyCode":{
            "type":"string"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Back to Top