Modify an Order

The method PATCH v4/orders/ enables you to provide a set of new properties to an existing order, such as changing the price or amount. Hence, you no longer need to cancel and place a new order when you want to change any of its modifiable properties.

To use this endpoint effectively, be cautious with the following constraints:

• Order's direction and type are unchangeable: You cannot modify an order's direction or type.
• Not all orders are modifiable: Market, completed, or cancelled orders are unavailable for modifications.
• Configure a valid update: Several property combinations cannot be modified. For example, you can update the stop parameter only on un-triggered Stop Orders.
• Account must have an available balance: Your account must maintain sufficient available balance to cover the difference in value or amount when modifying an order. For a more detailed understanding of balances, refer to the section, Get Account Balance.
  
  New major or minor value calculations may be triggered based on the order direction (buy or sell) and the request payload. If you only modify the price, then no additional balance is required.
  
  The amount, expressed in the major currency, is computed using the formula: amount = value / price ,
  while the value, expressed in minor, is calculated using the equation: value = amount × price .
  
  The following examples showcase calculations in the BTC/USD order book:

HTTP Request

You have two ways to specify the identifier of the order to update:

• A path parameter: Use the Bitso-supplied ID.
• A query parameter: Use either the Bitso-supplied or user-supplied ID.

Request

• PATCH https://api-stage.bitso.com/api/v4/orders/{oid}
• PATCH https://api-stage.bitso.com/api/v4/orders?oid={oid}
• PATCH https://api-stage.bitso.com/api/v4/orders?origin_id={origin_id}

Path Parameters

Use the following path parameter to specify the order:

Query Parameters

However, if you prefer to use a query parameter, use either of the following ones to identify the order:

Body Parameters

Body parameters must be JSON encoded and precisely the same as the JSON payload used to construct the signature:

🚧

The request body must not be empty.

Your request must include at least one of the following body parameters:

• major
• minor
• price
• stop

The cancel parameter cannot be sent alone.

JSON Response Payload

The endpoint returns a JSON object representing the order. This object includes the following field:

The following response object exemplifies the JSON object returned:

{
    "success": true,
    "payload": {
        "oid": "qlbga6b600n3xta7"
    }
}