Subscribe exchange events

POST 
/api/v1/orders/exchange/subscribe

Subscribe to updates across all exchanges

Request

application/json

Body

required

callbackUrl stringrequired
sharedKey stringrequired
headerKey string
headerValue string

Responses

201

Created

application/json

Schema

Schema

id uuid

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

400

Bad Request

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

401

Unauthorized

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

403

Forbidden

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

404

Not Found

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

405

Method Not Allowed

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

415

Unsupported Media Type

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

429

Too Many Requests

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

500

Internal Server Error

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "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

id uuidrequired

Unique ID of the exchange

shortId stringrequired

Short ID of the exchange

externalId stringrequired

External ID of the exchange

rate objectrequired

Rate of the exchange

price numberrequired

currencyPair stringrequired

type stringrequired

Possible values: [BID, OFFER]

from objectrequired

amount numberrequired

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

currency stringrequired

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

The type of currency that the money is being exchanged from

to objectrequired

amount numberrequired

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

currency stringrequired

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

The type of currency that the money is being exchanged from

settlementDate daterequired

Settlement date of the exchange

exchangeStatus objectrequired

Status of the exchange

state stringrequired

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

The current state of the exchange process

reason string

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

Reason for the exchange state

complete boolean

Completion status of the exchange

createdAt date-timerequired

Creation time of the exchange

completedAt date-time

Completion time of the exchange

Callbacks Responses

200

None 200 will be retried with exponential backoff upto 7 days

Loading...