PUT api/v1/orders/cancel

Cancel an order.

Request Information

URI Parameters

None.

Body Parameters

cancel_order
NameDescriptionTypeAdditional information
account_number

Account number.

 string

Required

Max length: 10
order_number

Order number.

 string

Required

Max length: 25

Request Formats

application/json, text/json

Sample: 
{
  "account_number": "10501",
  "order_number": "TEST12726"
}

Response Information

Resource Description

response_put_orders
NameDescriptionTypeAdditional information
error_code

Zero if no errors. When different from zero, the operation is rejected. See 'error_message' for a detailed description of the error.

 integer

None.
error_message

Returns a detailed description of the error.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "error_code": 0,
  "error_message": ""
}