Orders

Cancel an order and refund it

Refunds the full price to your balance. Only valid while the order is still cancellable — an order that already received a code is not.

Also served as POST /api/v1/order/{id}/cancel.

post/api/v1/orders/{id}/cancel

Request

  • Base URL: https://virtualsms.io
  • URL: https://virtualsms.io/api/v1/orders/{id}/cancel
  • Auth: one of:
    • API key in header X-API-Key
    • API key in query parameter api_key

Path parameters

idstring uuid required

Response

Cancelled and refunded

successboolean
order_idstring uuid
statusstring
refundednumber float

Example response

{
  "status": "cancelled"
}

Changes

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