Check SMS balance

POST

/sms/balance

Returns the live QuickSend balance for manual integrations or the APIX wallet balance for managed integrations.

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

API Key

Add parameter in header

X-API-SECRET

Example:

X-API-SECRET: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Balance returned successfully.

Body

🟠401

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/sms/balance' \
--header 'X-ENV;' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-SECRET: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Response Example

200 - Manual integration balance

{
    "success": true,
    "request_id": "req_123456789",
    "data": {
        "source": "quicksend_direct",
        "balance_formatted": "1500",
        "provider_response": {
            "status": "success",
            "balance": 1500
        }
    }
}

Modified at 2026-03-31 22:25:00

Send SMS

Generate QR code