For the complete documentation index, see llms.txt. This page is also available as Markdown.

Cancel an Order

Cancel an eligible bearer-token order and safely release its held payment.

POST /v2/receive-sms/orders/{orderId}/cancel

POST /v2/rent-numbers/orders/{orderId}/cancel

Authorization: Bearer <accessToken>

The response is the latest full order snapshot.

Receive-SMS eligibility

  • An unpaid order may be cancelled immediately.

  • A paid order becomes eligible three minutes after payment only after it reaches waiting_for_sms.

  • Cancellation is rejected during allocation or after any SMS data has been received.

  • Use cancellation.eligible and cancellation.availableAt from the order response.

For a paid order, sms4sats claims the cancellation state, verifies there is still no SMS, cancels the provider activation, and only then releases the Lightning hold. Interrupted cleanup remains in a transitional state and is retried safely.

Rental eligibility

  • An unpaid rental may be cancelled.

  • Any paid rental is not manually cancellable, including while allocation is still in progress.

Example

curl -sS -X POST \
  https://api.sms4sats.com/v2/receive-sms/orders/ORDER_ID/cancel \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Last updated