Skip to main content
POST
/
trade
/
orders
/
cancel-by-external-id
Orders - Cancel Order By External Id
curl --request POST \
  --url https://api.ripio.com/trade/orders/cancel-by-external-id \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --header 'signature: <signature>' \
  --header 'timestamp: <timestamp>' \
  --data '
{
  "external_id": "0F4A8504-21FB-4BE6-9771-25DCF5F68F87"
}
'
{
  "data": {
    "create_date": "2017-12-08T23:42:54.960Z",
    "executed_amount": 0.02347418,
    "external_id": "B4A9F7F4-9C79-4921-9330-224C17260BDF",
    "id": "7155ED34-9EC4-4733-8B32-1E4319CB662F",
    "pair": "BTC_BRL",
    "price": 42600,
    "remaining_amount": 0.1,
    "remaining_value": 0.6,
    "requested_amount": 0.02347418,
    "requested_value": 1000,
    "side": "buy",
    "status": "canceled",
    "total_value": 1000,
    "type": "limit",
    "update_date": "2017-12-13T21:48:48.817Z"
  },
  "error_code": null,
  "message": null
}

Headers

​
authorization
string
required

The API key as a string.

​
signature
string
required

See the Generating Signature section for more details.

​
timestamp
number
required

A timestamp in milliseconds. See the Timestamp Security section for more details.

​
timstamp-tolerance
number

An additional, non-required parameter, that you can send to specify the number of milliseconds after the timestamp for the request to be valid. See the Timestamp Security section for more details.

Body

application/json
​
external_id
string
required

Order external_id

Example:

"0F4A8504-21FB-4BE6-9771-25DCF5F68F87"

Response

200 - application/json

Ok

​
data
object
required
Example:
{
  "create_date": "2017-12-08T23:42:54.960Z",
  "executed_amount": 0.02347418,
  "external_id": "B4A9F7F4-9C79-4921-9330-224C17260BDF",
  "id": "7155ED34-9EC4-4733-8B32-1E4319CB662F",
  "pair": "BTC_BRL",
  "price": 42600,
  "remaining_amount": 0.1,
  "remaining_value": 0.6,
  "requested_amount": 0.02347418,
  "requested_value": 1000,
  "side": "buy",
  "status": "canceled",
  "total_value": 1000,
  "type": "limit",
  "update_date": "2017-12-13T21:48:48.817Z"
}
​
error_code
number
required
Example:

null

​
message
string
required
Example:

null