Skip to main content

Exchange

Exchange record

iduuidrequired

Unique ID of the exchange

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
shortIdstringrequired

Short ID of the exchange

Possible values: non-empty

Example: TR123
externalIdstringrequired

External ID of the exchange

Possible values: non-empty

Example: EX123
rate objectrequired

Rate of the exchange

pricenumberrequired
currencyPairstringrequired

Possible values: non-empty

typestringrequired

Possible values: [BID, OFFER]

from objectrequired

Money from the exchange

amountnumberrequired

The specific monetary value that is being converted from in the currency exchange

Example: 100
currencystringrequired

The type of currency that the money is being exchanged from

Possible values: non-empty, Value must match regular expression [A-Z]{3}

Example: USD
to objectrequired

Money to the exchange

amountnumberrequired

The specific monetary value that is being converted from in the currency exchange

Example: 100
currencystringrequired

The type of currency that the money is being exchanged from

Possible values: non-empty, Value must match regular expression [A-Z]{3}

Example: USD
settlementDatedaterequired

Settlement date of the exchange

Example: 2023-12-31
exchangeStatus objectrequired

Status of the exchange

statestringrequired

State of the exchange

Possible values: [DRAFT, SUBMITTING, UNKNOWN, SUBMITTED, ORDERED, ORDER_SETTLED, SUCCESS, REJECTED, FAILED, CANCELLED]

Example: SUBMITTED
reasonstring

Reason for the exchange state

Possible values: [DRAFT, SUBMITTING, UNKNOWN, SUBMITTED, ORDERED, ORDER_SETTLED, SUCCESS, REJECTED, FAILED, FAILED_BREACHES_LIMIT, CANCELLED]

Example: REJECTED_BREACHES_LIMIT
completeboolean

Completion status of the exchange

Example: false
createdAtdate-timerequired

Creation time of the exchange

Example: 2023-01-01T00:00:00Z
completedAtdate-time

Completion time of the exchange

Example: 2023-01-02T00:00:00Z
Exchange
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "shortId": "TR123",
  "externalId": "EX123",
  "rate": {
    "price": 0,
    "currencyPair": "string",
    "type": "BID"
  },
  "from": {
    "amount": 100,
    "currency": "USD"
  },
  "to": {
    "amount": 100,
    "currency": "USD"
  },
  "settlementDate": "2023-12-31",
  "exchangeStatus": {
    "state": "SUBMITTED",
    "reason": "REJECTED_BREACHES_LIMIT",
    "complete": false
  },
  "createdAt": "2023-01-01T00:00:00Z",
  "completedAt": "2023-01-02T00:00:00Z"
}