Subscribe exchange events
POST/api/v1/orders/exchange/subscribe
Subscribe to updates across all exchanges
Request
- application/json
Body
required
Responses
- 201
- 400
- 401
- 403
- 404
- 405
- 415
- 429
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
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": {}
}
Unsupported Media Type
- 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": {}
}
Callbacks
- POST Exchange webhook
POST$request.body.callbackUrl
- application/json
Body
required
Request body to be implemented
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
Callbacks Responses
- 200
None 200 will be retried with exponential backoff upto 7 days