Get Balance

GET

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

Request

Query Params

userId

string

required

User Id linked to API key

Example:

key

string

required

API key

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

error

boolean

required

body

object

required

userId

string

required

The userId associated with the record

balance

integer

required

Account balance associated with userId

totalCharges

string

required

The total top-up amount associated with the userId

currentDiscountRate

string

required

Current discount percentage

discountRates

array [array]

required

Current discount conditions

Example

{
  "error": false,
  "body": {
    "userId": "123123abc",
    "balance": 500,
    "totalCharges": "1500",
    "currentDiscountRate": "0%",
    "discountRates": [
      [
        8000,
        0.8,
        "-20%"
      ],
      [
        6000,
        0.85,
        "-15%"
      ],
      [
        4000,
        0.9,
        "-10%"
      ],
      [
        2000,
        0.95,
        "-5%"
      ],
      [
        0,
        1,
        "0%"
      ]
    ]
  }
}

🟠401Unauthorized

Modified at 2025-02-15 15:35:47

Make a top-up with crypto