Rate

The Rate object represents an exchange rate between two currencies.

This object contains the following attributes:

Field Name	Data Type	Description
id	string	The primary identifier for the rate. Example: FXR-1234-4678-0000-0001
pair	object	A reference to the currency pair this rate applies to. Example: { "id": "FXP-1234-4678" }
externalId	string	The ID of the external system from where the rate is fetched. Example: EXCHR-23456
recordDate	datetime	The date and time when this rate was fetched. Example: 2024-05-09T14:40:28.958Z
rate	number	The exchange rate from currency A to B. Example: 1.3267
status	string	Indicates whether the item is active or deleted. Example: Active
audit	object	A reference to the audit object. Example: { "created": { "at": "2024-04-08T06:30:05.807Z", "by": { "id": "USR-2172-2499", "revision": 1, "name": "John User" } }, "updated": { "at": "2024-05-16T09:17:36.406Z", "by": { "id": "TKN-3836-7769", "revision": 1, "name": "My token" }, "deleted": { "at": "2024-05-17T09:17:36.406Z", "by": { "id": "TKN-3836-7769", "revision": 1, "name": "My token" } } }
revision	integer	The entity revision number. Example: 3

Example response

{
  "id": "FXR-1671-0642-0000",
  "pair": {
    "id": "FXP-1671-0642",
    "name": "EUR: GBP",
    "latestRate": {
      "rate": 0.88
    },
    "revision": 1
  },
  "externalId": "RATE-1234",
  "recordDate": "2024-05-09T14:40:28.958Z",
  "value": 1.1456,
  "status": "Active",
  "audit":{
    "created": {
      "at": "2024-04-08T06:30:05.807Z",
      "by": {
        "id": "USR-2172-2499",
        "revision": 1,
        "name": "John User"
      }
    },
    "updated": {
      "at": "2024-05-16T09:17:36.406Z",
      "by": {
        "id": "TKN-3836-7769",
        "revision": 1,
        "name": "My token"
      }
    },
    "deleted": {
      "at": "2024-05-17T09:17:36.406Z",
      "by": {
        "id": "TKN-3836-7769",
        "revision": 1,
        "name": "My token"
      }
    }
  },
  "revision": 1
}