Skip to main content
POST
Cancel an order

Authorizations

X-API-Key
string
header
required

API key from virtualsms.io dashboard (Settings -> API tab). Prefix: vsms_

Path Parameters

orderId
string<uuid>
required

Order ID to cancel

Response

Order cancelled and refunded

success
boolean
Example:

true

order_id
string<uuid>
status
string
Example:

"cancelled"

refund_amount
number<float>
Example:

0.4