Lookup an exchange by ID
GET/api/v1/orders/exchange/:id
Lookup an exchange by ID
Request
Path Parameters
Unique identifier of the exchange
Header Parameters
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 429
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Unique ID of the exchange
Short ID of the exchange
External ID of the exchange
rate objectrequired
Rate of the exchange
Possible values: [BID
, OFFER
]
from objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
to objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
Settlement date of the exchange
exchangeStatus objectrequired
Status of the exchange
Possible values: [DRAFT
, SUBMITTING
, UNKNOWN
, SUBMITTED
, ORDERED
, ORDER_SETTLED
, SUCCESS
, REJECTED
, FAILED
, CANCELLED
]
The current state of the exchange process
Possible values: [DRAFT
, SUBMITTING
, UNKNOWN
, SUBMITTED
, ORDERED
, ORDER_SETTLED
, SUCCESS
, REJECTED
, FAILED
, FAILED_BREACHES_LIMIT
, CANCELLED
]
Reason for the exchange state
Completion status of the exchange
Creation time of the exchange
Completion time of the 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"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}