Customer API

Cancel an order

Cancel a pending order and receive a full refund.

2-minute hold: Orders cannot be cancelled within the first 2 minutes of purchase. This is to prevent abuse. If you try to cancel too early, you'll get a 425 response telling you how many seconds to wait.

Cancellation is only possible while the order is in waiting status (no SMS received).

post/api/v1/customer/cancel/{orderId}

Request

  • Base URL: https://virtualsms.io
  • URL: https://virtualsms.io/api/v1/customer/cancel/{orderId}
  • Auth: API key in header X-API-Key

Path parameters

orderIdstring uuid required

Order ID to cancel

Response

Order cancelled and refunded

successboolean
order_idstring uuid
statusstring
refund_amountnumber float

Example response

{
  "success": true,
  "status": "cancelled",
  "refund_amount": 0.4
}

Changes

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