Accept quote

POST 
/v1/quotes/:batch_id/quote/:quote_id/accept

Accept an individual rate quote, within a batch. All other rate quotes will automatically be rejected.

Request

Path Parameters

batch_id stringrequired
quote_id stringrequired

application/json

Body

client_order_id string

The client's unique identifier for the order.

order_notes string
Order notes.
Possible values: <= 256 characters
Example: My order notes

Responses

200

Quote successfully accepted.

application/json

Schema

Schema

quote

object

A Quote may result from a successful quotes request.

id stringrequired

The unique identifier for the quote.

source_id stringrequired

The source's unique identifier for the quote.

client_id stringrequired

The unique identifier fo the client.

rate doublerequired

The rate for the quote.

source stringrequired

The source of the quote.

expires int64required

The quote expiry in milliseconds.

quote_date date-time

Quote date.

status stringrequired

Rejection status.

Possible values: [pending, accepted, rejected]

Default value: pending

trade

object

A Trade may result from a successfully executed order or quote.

id stringrequired

Id for the trade.

source_order_id string

Source order id for the trade.

source_execution_id stringrequired

Source execution id for the trade.

source stringrequired

Source for the exected trade.

buy_currency stringrequired

The currency that you bought.

sell_currency stringrequired

The currency that you sold.

buy_amount doublerequired

The amount that you bought.

sell_amount doublerequired

The anount that you sold.

price doublerequired

The rate for the trade.

trade_date date-timerequired

Trade date.

Example (from schema)

{
  "quote": {
    "id": "string",
    "source_id": "string",
    "client_id": "string",
    "rate": 0,
    "source": "string",
    "expires": 0,
    "quote_date": "2024-07-29T15:51:28.071Z",
    "status": "pending"
  },
  "trade": {
    "id": "string",
    "source_order_id": "string",
    "source_execution_id": "string",
    "source": "string",
    "buy_currency": "string",
    "sell_currency": "string",
    "buy_amount": 0,
    "sell_amount": 0,
    "price": 0,
    "trade_date": "2024-07-29T15:51:28.071Z"
  }
}

401

Authentication token is required for this action that was not provided, expired or invalid.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

403

Not authorized for the requested action.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

404

The requested endpoint or entity does not exist.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

409

Action could not be completed because of conflict.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

500

Internal server error.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

Loading...