otp/docs

Balance

Return the current wallet balance for the authenticated account, as a USD decimal string.

GET/v1/balance

Return the current wallet balance for the authenticated account, as a USD decimal string. Buying a number charges this balance; refunds credit it back.

curl
curl https://api.otp.black/v1/balance \
  -H "Authorization: Bearer $API_KEY"
200 OK
{ "balance": "12.34" }

Fields

  • balance — available wallet balance, USD decimal string.

If a POST /v1/activations would exceed your balance it returns 402 and nothing is charged. Top up from your dashboard.

Prices

The current price and available stock for a service in a country, as USD decimal strings.

Activations

An activation is one purchased number waiting for one code. Create it, poll it, and read the code when it lands.

On this page

Fields