Retrieve quotes batch

GET 
/v1/quotes/:batch_id

Retrieve a quotes batch with specified id.

Request

Path Parameters

batch_id stringrequired

Responses

200

Quotes batch

application/json

Schema

Schema

batch_id string

The batch id for the rate quotes.

buy_currency string

The currency code that you want to buy.

Possible values: >= 3 characters and <= 3 characters

sell_currency string

The currency code that you want to sell.

Possible values: >= 3 characters and <= 3 characters

buy_amount double

The amount you want to buy.

sell_amount double

The amountyou want to sell.

tenor TenorREST (string)
The tenor value for the quote e.g. SPOT, CASH (T+0), NEXT DAY (T+1)
Possible values: [SPOT, TOD, TOM]
Default value: SPOT
Example: SPOT
type string
Quotes returned in the response.
Possible values: [all, best]
Default value: all
sources string[]

Restrict quotes to specified sources.

quotes

object[]

Array [

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

]

error

object

An error may be received in response to a failed request.

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)

{
  "batch_id": "string",
  "buy_currency": "string",
  "sell_currency": "string",
  "buy_amount": 0,
  "sell_amount": 0,
  "tenor": "SPOT",
  "type": "all",
  "sources": [
    "string"
  ],
  "quotes": [
    {
      "id": "string",
      "source_id": "string",
      "client_id": "string",
      "rate": 0,
      "source": "string",
      "expires": 0,
      "quote_date": "2024-07-29T15:51:28.071Z",
      "status": "pending"
    }
  ],
  "error": {
    "errorId": "string",
    "code": "string",
    "text": "string",
    "parameter_name": "string",
    "parameter_value": {}
  }
}

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

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...