WINSMS
  1. credits
WINSMS
  • credits
    • Get your current WinSMS credit balance
      GET
    • Transfer credits between main and sub accounts.
      POST
  • shortcode
    • Get a list of incoming short/long code messages
      GET
  • sms
    • Get a list of incoming SMS messages
      GET
    • Get a list of incoming opt-out SMS messages
      GET
    • Send SMS messages
      POST
    • Send multiple different SMS messages
      POST
    • Get SMS delivery statuses
      POST
    • Get a list of scheduled SMS messages
      GET
    • Delete scheduled SMS messages and refund credits
      POST
  • subaccounts
    • Get a list of all Sub Accounts.
      GET
  1. credits

Get your current WinSMS credit balance

GET
/credits/balance
credits
Get the current remaining credit balance for the account.
Note - The credit balance is expressed as a value with a single decimal place.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://www.winsms.co.za/api/rest/v1/credits/balance'
Response Response Example
200 - response
{
  "creditBalance": 3645,
  "statusCode": 200,
  "timeStamp": "20170120152253514",
  "version": "1.0"
}

Request

None

Responses

🟢200OK
application/json
Body
creditBalance
number <double>
optional
The current remaining credit balance for the account. Contains a single decimal place
statusCode
integer 
optional
The http status code returned - reflected in the body for convenience
timeStamp
string 
optional
The date/time the request was processed, in the format YYYYMMDDhhmmssSSS
version
string 
optional
The current version of the API of the endpoint that was called
🟠401Unauthorized
🟠404Not found
🟠405Method Not Allowed
🔴500Internal Server Error
Modified at 2023-08-15 09:05:19
Next
Transfer credits between main and sub accounts.
Built with