Currex

Gotranverse Currency Exchange Service provides a way to store and manage multiple collections of exchange rates for the enabled currencies.

For more information, please search through the Gotransverse online documentation:

Terms of Service: Public use
Request Content-Types: application/json
Response Content-Types: application/json
Version: 2.3.0.3

Authentication

api_key_header

An authorization key that is assigned to perform an action in the system. Passed in the form of a X-Api-Key header that is attached to the call. e.g 325509ed604449279d4587c5e35e3235

type
apiKey
name
X-Api-Key
in
header

Testing

GET /test-connection

Tests that a connection can be made.

200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (200 OK)
{
  "level": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

Rate Set Provider Management

GET /rate-sets/providers/{provider_type}/properties

Retrieves the list of templte properties for a given provider type.

provider_type: string OANDA, CUSTOM, FILE
in path

The provider type to lookup

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (200 OK)
[
  {
    "label": "string",
    "data-type": "string",
    "format": "string",
    "key": "string",
    "value": "string"
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

POST /rate-sets/providers/{provider_type}/properties

Creates the list of template properties for a given provider type.

The properties as JSON

ConfigurationProperty
provider_type: string OANDA, CUSTOM, FILE
in path

The provider type to lookup

Request Example
[
  {
    "label": "string",
    "data-type": "string",
    "format": "string",
    "key": "string",
    "value": "string"
  }
]
201 Created

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

409 Conflict

Entity already exists

422 Unprocessable Entity

Validation failure

Response Example (201 Created)
{
  "level": "string",
  "message": "string"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

PUT /rate-sets/providers/{provider_type}/properties

Updates the list of template properties for a given provider type.

The properties as JSON

ConfigurationProperty
provider_type: string OANDA, CUSTOM, FILE
in path

The provider type to lookup

Request Example
[
  {
    "label": "string",
    "data-type": "string",
    "format": "string",
    "key": "string",
    "value": "string"
  }
]
200 OK

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Example (200 OK)
{
  "level": "string",
  "message": "string"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

Rate Set Management

GET /rate-sets

Retrieves a list of rate sets.

page_number: integer
in query

The page number of results desired

page_size: integer
in query

The number of results per page to return (max 500)

200 OK

Success

type
400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (200 OK)
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "interval_type": "string",
    "provider_type": "string",
    "provider_name": "string",
    "provider_properties": [
      {
        "label": "string",
        "data-type": "string",
        "format": "string",
        "key": "string",
        "value": "string"
      }
    ]
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

POST /rate-sets

Inserts a rate set

The rate_set as JSON

Request Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "interval_type": "string",
  "provider_type": "string",
  "provider_name": "string",
  "provider_properties": [
    {
      "label": "string",
      "data-type": "string",
      "format": "string",
      "key": "string",
      "value": "string"
    }
  ]
}
201 Created

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

409 Conflict

Entity already exists

422 Unprocessable Entity

Validation failure

Response Example (201 Created)
{
  "id": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "interval_type": "string",
  "provider_type": "string",
  "provider_name": "string",
  "provider_properties": [
    {
      "label": "string",
      "data-type": "string",
      "format": "string",
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

DELETE /rate-sets/{rate_set_id}

Deletes a rate set for a given tenant.

rate_set_id: string
in path

The id for the rate set.

204 No Content

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /rate-sets/{rate_set_id}

Retrieves a rate set.

rate_set_id: string
in path

The id for the rate set.

200 OK

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (200 OK)
{
  "id": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "interval_type": "string",
  "provider_type": "string",
  "provider_name": "string",
  "provider_properties": [
    {
      "label": "string",
      "data-type": "string",
      "format": "string",
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

PUT /rate-sets/{rate_set_id}

Updates a rate set

The rate_set as JSON

rate_set_id: string
in path

The id for the rate set.

Request Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "interval_type": "string",
  "provider_type": "string",
  "provider_name": "string",
  "provider_properties": [
    {
      "label": "string",
      "data-type": "string",
      "format": "string",
      "key": "string",
      "value": "string"
    }
  ]
}
200 OK

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

409 Conflict

Entity already exists

422 Unprocessable Entity

Validation failure

Response Example (200 OK)
{
  "id": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "interval_type": "string",
  "provider_type": "string",
  "provider_name": "string",
  "provider_properties": [
    {
      "label": "string",
      "data-type": "string",
      "format": "string",
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

Currency Rate Management

DELETE /rate-sets/{rate_set_id}/intervals/{id}

Deletes a conversion interval by id for a given tenant.

rate_set_id: string
in path

The id for the rate set the interval belongs to.

id: string
in path

The id for the desired currency interval to delete

204 No Content

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

GET /rate-sets/{rate_set_id}/intervals/{id}

Retrieves a conversion interval and all the conversion rates for that interval.

rate_set_id: string
in path

The id for the rate set the interval belongs to.

id: string
in path

The id of the currency conversion interval to retrieve

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (200 OK)
{
  "rates": [
    {
      "id": "string",
      "source_currency": "string",
      "to_currency": "string",
      "rate": "number",
      "override_rate": "number"
    }
  ],
  "id": "string",
  "rate_set_id": "string",
  "from_date": "string (date-time)",
  "to_date": "string (date-time)"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

POST /rate-sets/{rate_set_id}/intervals/{id}/rates

Creates a new conversion rate for a given conversion interval

The conversion rate as JSON

CurrexRate
rate_set_id: string
in path

The id for the rate set the interval belongs to.

id: string
in path

The id of the conversion interval to add the conversion rate to

mode: string OVERWRITE_ON_EXISTING, KEEP_ON_EXISTING, FAIL_BATCH_ON_EXISTING FAIL_BATCH_ON_EXISTING
in query

A field that indicates how to update existing rates in storage if same ones were posted.

Request Example
[
  {
    "id": "string",
    "source_currency": "string",
    "to_currency": "string",
    "rate": "number",
    "override_rate": "number"
  }
]
201 Created

Success

type
400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

409 Conflict

Entity already exists

422 Unprocessable Entity

Validation failure

Response Example (201 Created)
[
  {
    "id": "string",
    "source_currency": "string",
    "to_currency": "string",
    "rate": "number",
    "override_rate": "number"
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /rate-sets/{rate_set_id}/intervals/{id}/rates/{rate_id}/override

Creates an override for a currency rate

The override rate as JSON

rate_set_id: string
in path

The id for the rate set the interval belongs to.

id: string
in path

The id of the conversion interval the rate belongs to

rate_id: string (int64)
in path

The id of the conversion rate to create the override for

Request Example
{
  "override_rate": "number"
}
201 Created

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Example (201 Created)
{
  "id": "string",
  "source_currency": "string",
  "to_currency": "string",
  "rate": "number",
  "override_rate": "number"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

PUT /rate-sets/{rate_set_id}/intervals/{id}/rates/{rate_id}/override

Updates an override for a currency rate

The override rate as JSON

rate_set_id: string
in path

The id for the rate set the interval belongs to.

id: string
in path

The id of the conversion interval the rate belongs to

rate_id: string
in path

The id of the conversion rate to update the override for

Request Example
{
  "override_rate": "number"
}
200 OK

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Example (200 OK)
{
  "id": "string",
  "source_currency": "string",
  "to_currency": "string",
  "rate": "number",
  "override_rate": "number"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

DELETE /rate-sets/{rate_set_id}/intervals/{id}/rates/{rate_id}/override

Removes an override for a currency rate

rate_set_id: string
in path

The id for the rate set the interval belongs to.

id: string
in path

The id of the conversion interval the rate belongs to

rate_id: string
in path

The id of the conversion rate to remove the override for

200 OK

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

DELETE /rate-sets/{rate_set_id}/intervals

Deletes a list of conversion intervals for a given tenant. If no from or to dates are provided, then all intervals are deleted. All underlying rates are deleted as well.

rate_set_id: string
in path

The id for the rate set the interval belongs to.

from_date: string (date-time)
in query

The interval starting date to look for

to_date: string (date-time)
in query

The interval ending date to look for

204 No Content

Success

403 Forbidden

Forbidden - Authentication failed

404 Not Found

Entity not found

Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

GET /rate-sets/{rate_set_id}/intervals

Gets a list of conversion intervals for a given tenant. Underlying rates are not returned by default unless include=RATES is set.

rate_set_id: string
in path

The id for the rate set the interval belongs to.

from_date: string (date-time)
in query

The interval starting date to look for

to_date: string (date-time)
in query

The interval ending date to look for

include: string NOTHING, RATES RATES
in query

A field indicating to return sub-items as part of this search. Note that the service will not return these sub-items if more than 100 intervals are being returned.

min_max_only: boolean false
in query

A flag indicating whether or not to just return the minimum and maximum intervals. If set, this overrides the to_date and from_date settings.

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (200 OK)
[
  {
    "rates": [
      {
        "id": "string",
        "source_currency": "string",
        "to_currency": "string",
        "rate": "number",
        "override_rate": "number"
      }
    ],
    "id": "string",
    "rate_set_id": "string",
    "from_date": "string (date-time)",
    "to_date": "string (date-time)"
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

POST /rate-sets/{rate_set_id}/intervals

Inserts a conversion interval with assocated conversion rates

The conversion_interval as JSON

rate_set_id: string
in path

The id for the rate set the interval belongs to.

Request Example
{
  "rates": [
    {
      "id": "string",
      "source_currency": "string",
      "to_currency": "string",
      "rate": "number",
      "override_rate": "number"
    }
  ],
  "id": "string",
  "rate_set_id": "string",
  "from_date": "string (date-time)",
  "to_date": "string (date-time)"
}
201 Created

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

409 Conflict

Entity already exists

422 Unprocessable Entity

Validation failure

Response Example (201 Created)
{
  "rates": [
    {
      "id": "string",
      "source_currency": "string",
      "to_currency": "string",
      "rate": "number",
      "override_rate": "number"
    }
  ],
  "id": "string",
  "rate_set_id": "string",
  "from_date": "string (date-time)",
  "to_date": "string (date-time)"
}
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (409 Conflict)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

History

GET /rate-sets/{rate_set_id}/history

Retrieves history information for changes to currex rates.

rate_set_id: string
in path

The id for the rate set the interval belongs to.

from_date: string (date-time)
in query

The history starting date to look for

to_date: string (date-time)
in query

The history ending date to look for

Success

400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (200 OK)
[
  {
    "entity_type": "string",
    "entity_sub_type": "string",
    "created_on": "string (date-time)",
    "created_by": "string",
    "id": "integer (int64)",
    "entity_id": "integer (int64)",
    "root_entity_id": "integer (int64)",
    "start_date": "string (date-time)",
    "end_date": "string (date-time)",
    "change_type": "string",
    "description": "string",
    "grouping_key": "string",
    "user_id": "integer (int64)"
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

Currency Rate Retrieval

GET /conversion-rates

Retrieves conversion rate for a given date, source and target currencies

rate_set_id: string
in query

The id for the rate set

from_date: string (date-time)
in query

The start date range for the conversion rate

to_date: string (date-time)
in query

The end date range for the conversion rate

source_currency: string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, BRL, PLN, CNY, ILS, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN
in query

The source currency for the exchange rate.

target_currency: string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, BRL, PLN, CNY, ILS, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN
in query

The target currency for the exchange rate. If empty, then all targets are returned.

page_number: integer 1
in query

The page number of results desired

page_size: integer 500
in query

The number of results per page to return (max 500)

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (200 OK)
[
  {
    "id": "string",
    "source_currency": "string",
    "to_currency": "string",
    "rate": "number",
    "override_rate": "number",
    "rate_set_id": "string",
    "from_date": "string (date-time)",
    "to_date": "string (date-time)",
    "name": "string",
    "description": "string",
    "status": "string",
    "interval_type": "string",
    "provider_type": "string",
    "provider_name": "string",
    "provider_properties": [
      {
        "label": "string",
        "data-type": "string",
        "format": "string",
        "key": "string",
        "value": "string"
      }
    ]
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

GET /conversion-rates/{rate-set-id}

Retrieves conversion rate for a given date, source and target currencies

rate-set-id: string
in path

The id for the rate set

date: string (date-time)
in query

The desired date for the conversion rate

source_currency: string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, BRL, PLN, CNY, ILS, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN
in query

The source currency for the exchange rate.

target_currency: string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, BRL, PLN, CNY, ILS, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN
in query

The target currency for the exchange rate. If empty, then all targets are returned.

200 OK

Success

type
400 Bad Request

Bad request

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Example (200 OK)
[
  {
    "id": "string",
    "source_currency": "string",
    "to_currency": "string",
    "rate": "number",
    "override_rate": "number"
  }
]
Response Example (400 Bad Request)
{
  "code": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

Schema Definitions

Message: object

level: string INFO, WARN, DEBUG

A level for the specific message.

message: string

A message providing additional detail for message.

Example
{
  "level": "string",
  "message": "string"
}

Error: object

code: string

A code for the specific error. Used to help in determining possible root causes of an error.

message: string

A message providing additional detail for an error.

Example
{
  "code": "string",
  "message": "string"
}

ConfigurationProperty:

label: string

The friendly label for the property.

data-type: string STRING, NUMBER
format: string DATE_TIME, DATE, INT32, INT64
Example
{
  "label": "string",
  "data-type": "string",
  "format": "string",
  "key": "string",
  "value": "string"
}

RateSet: object

id: string

The internal id for this rate set.

name: string

The friendly name for this rate set.

description: string

A description for this rate set.

status: string DRAFT, ACTIVE, INACTIVE
interval_type: string DAILY, WEEKLY, MONTHLY, YEARLY

The available interval ranges for currency rates.

  • DAILY - rates are typically an average rate for a given day.
  • WEEKLY - rates are an average of rates over a given week.
  • MONTHLY - rates are an average over a given month.
  • YEARLY - rates are an average over a given year
provider_type: string OANDA, CUSTOM, FILE

The fx provider_type for this rate set.

provider_name: string

Friendly name of the FX provider

provider_properties: ConfigurationProperty
ConfigurationProperty
Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "interval_type": "string",
  "provider_type": "string",
  "provider_name": "string",
  "provider_properties": [
    {
      "label": "string",
      "data-type": "string",
      "format": "string",
      "key": "string",
      "value": "string"
    }
  ]
}

CurrexIntervalRates: object

rates: CurrexRate

The available rates for this conversion interval.

CurrexRate
Example
{
  "rates": [
    {
      "id": "string",
      "source_currency": "string",
      "to_currency": "string",
      "rate": "number",
      "override_rate": "number"
    }
  ],
  "id": "string",
  "rate_set_id": "string",
  "from_date": "string (date-time)",
  "to_date": "string (date-time)"
}

CurrexRate: object

The conversion rate for a given source currency to target currency for a given parent interval.

id: string

The internal id for this rate.

source_currency: CurrencyEnum
to_currency: CurrencyEnum
rate: number

The rate to multiply the source currrency by to get the target currency.

override_rate: number

The overridden value for this rate if it differs from the original rate.

Example
{
  "id": "string",
  "source_currency": "string",
  "to_currency": "string",
  "rate": "number",
  "override_rate": "number"
}

CurrexOverride: object

An override rate for a given currex rate.

override_rate: number

The value to override the standard rate with.

Example
{
  "override_rate": "number"
}

CurrencyAuditEvent:

entity_type: string CONFIGURED_CURRENCY, CONVERSION_RATE

An indicator of the entity type that was affected by the event.

  • ConfiguredCurrency - A currency was either enabled or disabled within the system
  • ConversionRate - A conversion rate was either overridden or an override was removed.
entity_sub_type: string CURRENCY, CONVERSION

An indicator of what type of entity group was affected by the event.

  • CURRENCY - An entity within the Currency management function was affected
  • CONVERSION - An entity within the Converstion Rate Management function was affected
created_on: string (date-time)

The event date.

created_by: string

Event creator.

Example
{
  "entity_type": "string",
  "entity_sub_type": "string",
  "created_on": "string (date-time)",
  "created_by": "string",
  "id": "integer (int64)",
  "entity_id": "integer (int64)",
  "root_entity_id": "integer (int64)",
  "start_date": "string (date-time)",
  "end_date": "string (date-time)",
  "change_type": "string",
  "description": "string",
  "grouping_key": "string",
  "user_id": "integer (int64)"
}

CurrexSetIntervalRate: object

Example
{
  "id": "string",
  "source_currency": "string",
  "to_currency": "string",
  "rate": "number",
  "override_rate": "number",
  "rate_set_id": "string",
  "from_date": "string (date-time)",
  "to_date": "string (date-time)",
  "name": "string",
  "description": "string",
  "status": "string",
  "interval_type": "string",
  "provider_type": "string",
  "provider_name": "string",
  "provider_properties": [
    {
      "label": "string",
      "data-type": "string",
      "format": "string",
      "key": "string",
      "value": "string"
    }
  ]
}

KeyValue: object

A simple key-value pair.

key: string

A unique key for this pair.

value: string

A value for this pair.

Example
{
  "key": "string",
  "value": "string"
}

CurrexInterval: object

id: string

The id for the desired interval

rate_set_id: string

The rate set this interval belongs to.

from_date: string (date-time)

The starting date of the interval

to_date: string (date-time)

The ending date of the interval

Example
{
  "id": "string",
  "rate_set_id": "string",
  "from_date": "string (date-time)",
  "to_date": "string (date-time)"
}

CurrencyEnum: string

The currency code based upon ISO 4217

string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, BRL, PLN, CNY, ILS, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN USD

AuditEvent: object

An audit record of an event within the system indicating that something has happened to an underlying entity.

id: integer (int64)

The id of the audit event. Auto-generated by system on creation of event.

entity_id: integer (int64)

The id of the entity being changed.

root_entity_id: integer (int64)

Typically the same as the entity_id. If a parent entity is owning this change, then the parent's entity id. Same value as entity_id if not provided.

start_date: string (date-time)

The time the event started

end_date: string (date-time)

The time the event started. Same value as start_date if not provided.

change_type: string INSERT, UPDATE, DELETE

The type of change performed on the entity.

description: string

A description of what is getting changed.

grouping_key: string

A hash value for a group of events that occured together as part of a transaction. An internally generated UUID value if not provided.

user_id: integer (int64)

The id of the user making the change.

Example
{
  "id": "integer (int64)",
  "entity_id": "integer (int64)",
  "root_entity_id": "integer (int64)",
  "start_date": "string (date-time)",
  "end_date": "string (date-time)",
  "change_type": "string",
  "description": "string",
  "grouping_key": "string",
  "user_id": "integer (int64)"
}