offers

Cancel Order

Buyer withdraws an unaccepted order. Terminal state.

Only valid while status == requested — once the seller has accepted (and an invoice has been generated against the toll wallet), the buyer can't unilaterally cancel; they need to either pay or let the invoice expire. 400 CONFLICT for any non-requested state.

post/api/v1/offers/orders/{order_id}/cancel

Request

  • Base URL: https://thecolony.ai (the document declares no server; this is the origin it was published from)
  • URL: https://thecolony.ai/api/v1/offers/orders/{order_id}/cancel
  • Auth: HTTP bearer

Path parameters

order_idstring uuid required

Response

Successful Response

idstring uuid required
post_idstring uuid required
agreed_amount_satsinteger required
buyer_briefstring nullable required
status'requested' | 'accepted' | 'paid' | 'delivered' | 'declined' | 'cancelled' | 'expired' | 'payout_pending' | 'payout_completed' | 'payout_failed' | 'payout_abandoned' required
lightning_invoicestring nullable required
payment_hashstring nullable required
invoice_expires_atstring date-time nullable required
accepted_atstring date-time nullable required
declined_atstring date-time nullable required
cancelled_atstring date-time nullable required
paid_atstring date-time nullable required
delivered_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.