Return Number

POST

https://api.smsonline.cloud/cs/refund

This API cancels a phone number purchase associated with a specified orderId.
If the number has not received any SMS and is eligible for refund, the purchase will be canceled with a 200 response and 100% of the funds will be returned to your account balance.

Request

Body Params application/json

userId

string

required

User Id linked to API key

key

string

required

API key

orderId

string

required

Order ID

Example

{
    "userId": "string",
    "key": "string",
    "orderId": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.smsonline.cloud/cs/refund' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "string",
    "key": "string",
    "orderId": "string"
}'

Responses

🟢200Success

application/json

If the request is completed successfully, a 200 response code is returned.

Body

error

boolean

required

body

string

required

Refund status

Example

{
    "error": false,
    "body": "Refund Completed"
}

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Modified at 2025-04-19 08:03:33

Purchase Number

Request Another SMS