Transfer credits between main and sub accounts.

Transfer credits between accounts.

From Main account to Sub account.

From Sub account to Main account.

From Sub account to another Sub account.

Your WinSMS account number and sub account number/s can be obtained by logging in to the WinSMS Client Zone (www.winsms.co.za/cz) with the main account's credentials.

The main account number is on the home tab and the sub account numbers are under the sub accounts tab.

Account numbers should be submitted as integers. Do not add the 'W' prefix.

curl --location --request POST 'https://www.winsms.co.za/api/rest/v1/credits/transfer' \ --header 'Content-Type: application/json' \ --data-raw '{ "receivingAccountNumber": 10345, "sendingAccountNumber": 7564, "transferQuantity": 100 }'

Request

Body Params application/json

receivingAccountNumber

integer

required

The WinSMS account number of the account to which credits will be added.

Example:

10345

sendingAccountNumber

integer

required

The WinSMS account number of the account from which credits will be deducted.

Example:

7564

transferQuantity

integer

required

The number of credits to transfer from the sending account to the receiving account.

Example:

100

Examples

Responses

🟢200OK

application/json

Body

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

transferSuccessful

boolean

optional

A boolean value indictating whether the credits were successfully transfered from the sending account into the receiving account.

version

string

optional

The current version of the API of the endpoint that was called

🟠400Bad Request

🟠401Unauthorized

🟠404Not found

🟠405Method Not Allowed

🟠413Payload Too Large

🟠415Unsupported Media Type

🟠422Unprocessable Entity

🔴500Internal Server Error