Reseller (1.0.0)

Learn how to manage your clients and reseller accounts via API.

Note:

Unfortunately, our reseller dashboard, white-label and reseller API are only available to customers who were approved as resellers before 1st Jan, 2024. If you were not approved as a reseller before 1st Jan, 2024, you may still earn profits by adding a mark-up on your client rates when reselling ClickSend through our standard messaging endpoints.

View Client Accounts

Get list of reseller accounts

Parameters

Parameter In Type Required Description
page query integer(int32) false Page number
limit query integer(int32) false Number of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...
Request
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/reseller/accounts
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/reseller/accounts'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Here are you data.",
  • "data": {
    }
}

Create Reseller Account

Create reseller account

Properties

Name Type Required Restrictions Description
username string true none Account username
password string true none Account password (unhashed)
user_email string true none Account email
user_phone string true none Account phone number
user_first_name string true none Account owner first name
user_last_name string true none Account owner last name
account_name string true none Account name (usually company name)
country string true none Country of account holder

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...
Request
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object
Responses
200

Successful response

post/v3/reseller/accounts
Request samples
application/json
{
  • "country": "country",
  • "password": "password",
  • "user_email": "user_email",
  • "user_first_name": "user_first_name",
  • "user_last_name": "user_last_name",
  • "account_name": "account_name",
  • "user_phone": "user_phone",
  • "username": "username"
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "New reseller has been added.",
  • "data": {
    }
}

View Specific Client Account

Get Reseller clients Account

Parameters

Parameter In Type Required Description
client_user_id path integer(int32) true User ID of client

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...
Request
path Parameters
client_user_id
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/reseller/accounts/{client_user_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/reseller/accounts/{client_user_id}'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Here are your data.",
  • "data": {
    }
}

Update Client Account

Update Reseller clients Account

Parameters

Parameter In Type Required Description
client_user_id path integer(int32) true User ID of client

Properties

Name Type Required Restrictions Description
username string true none Account username
password string true none Account password (unhashed)
user_email string true none Account email
user_phone string true none Account phone number
user_first_name string true none Account owner first name
user_last_name string true none Account owner last name
account_name string true none Account name (usually company name)
country string true none Country of account holder

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...
Request
path Parameters
client_user_id
required
string
header Parameters
Content-Type
string
Example: application/x-www-form-urlencoded
Request Body schema: application/json
object
Responses
200

Successful response

put/v3/reseller/accounts/{client_user_id}
Request samples
application/json
{
  • "number": "number",
  • "expiry_month": 0,
  • "cvc": 1,
  • "name": "name",
  • "bank_name": "bank_name",
  • "expiry_year": 6
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Reseller account has been updated.",
  • "data": {
    }
}

Reseller Transfer Credit

Transfer Credit

Properties

Name Type Required Restrictions Description
client_user_id integer(int32) true none User ID of client
balance integer(int32) true none Balance to transfer
currency string true none Currency of balance to transfer

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...
Request
header Parameters
Content-Type
string
Example: application/x-www-form-urlencoded
Request Body schema: application/json
object
Responses
200

Successful response

put/v3/reseller/transfer-credit
Request samples
application/json
{
  • "number": "number",
  • "expiry_month": 0,
  • "cvc": 1,
  • "name": "name",
  • "bank_name": "bank_name",
  • "expiry_year": 6
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Your balance has been successfully transferred.",
  • "data": {
    }
}
Copyright © ClickSend 2024. All right reserved.