Skip to navigation
API Referencesms-number

Refund Sms Number

View as Markdown

Refund a rented number to the reseller wallet. Only possible before refundable_until and before any SMS has arrived.

Authentication

x-api-keystring

API key generated from the dashboard (Settings → API Keys). Each key is limited to 8 requests per 1-second window.

Path parameters

idstringRequired>=1 character
SimJuno SMS number rental ID

Response

Successful response
idstring>=1 character
SimJuno SMS number rental ID
transaction_idstring or null

Reseller-assigned transaction ID; null for numbers rented on simjuno.com

namestring
phone_numberstring

Rented number in international format, without the +

daysdouble
statusenum
Allowed values:
amountdouble

Amount charged, in units of 1/10,000 USD (30000 = $3.00)

expires_atstring
esim_idstring or null

eSIM that received SMS are forwarded to; null keeps them in the inbox only

message_countdouble
refundable_untilstring or null

Refundable until then if no SMS has arrived; null when it can’t be refunded

created_atstring

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error