Skip to main content

PATCH /split/orders/:orderId/cancel

Cancel an unpaid order. Refused once SOL sits on the deposit address, because a cancelled order is never looked at again and that SOL would be stranded.

Use case​

Abandon an EXTERNAL order you will not pay.

Path params​

ParamRequiredDescription
orderIdyesSplit order id.

Response 200​

The cancelled order object (same shape as get order), with eStatus: "CANCELLED".

Errors​

StatusMeaning
400orderId malformed.
404Order not found or not yours.
409Order is not PENDING_DEPOSIT; or the deposit address already holds SOL (body adds nReceivedSOL — pay and call check-payment, or contact support); or the order changed state meanwhile.

Example​

curl -X PATCH "$BASE_URL/split/orders/<orderId>/cancel" \
-H "Authorization: Bearer $ACCESS" -H "x-user-id: $USER_ID"