Knowledge Base

Create a Sub-Reseller Account Using the API

When you want to create a sub-reseller account using the API. This article explains required account details, activation options, supported parameters, consent requirements, and response details for reseller account creation.

Signing Up

Description

Creates a Sub-Reseller Account using the details provided.

Parameters

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
username	String	Required	Username for the Sub-Reseller account. Username should be an email address.
passwd	String	Required	Password for the Sub-Reseller account.
name	String	Required	Name of the Sub-Reseller
company	String	Required	Company Name of the Sub-Reseller
address-line-1	String	Required	Address line 1 of the Sub-Reseller's address
city	String	Required	City
state	String	Required	State
country	String	Required	Country Code as per ISO 3166-1 alpha-2
zipcode	String	Required	ZIP code
phone-cc	String	Required	Phone number Country Code
phone	String	Required	Phone number
lang-pref	String	Required	Language Code as per ISO
accounting-currency-symbol	String	Required	Accounting Currency Symbol of Sub-Reseller
selling-currency-symbol	String	Required	Selling Currency Symbol of Sub-Reseller
sales-contact-id	Integer	Optional	Sales User Id of Parent Sub-Reseller
address-line-2	String	Optional	Address line 2 of the Sub-Reseller's address
address-line-3	String	Optional	Address line 3 of the Sub-Reseller's address
alt-phone-cc	String	Optional	Alternate phone country code
alt-phone	String	Optional	Alternate phone number
fax-cc	String	Optional	Fax number country code
fax	String	Optional	Fax number
mobile-cc	String	Optional	Mobile number Country Code
mobile	String	Optional	Mobile number
sms-consent	Boolean	Optional	Incase of a US based sub-reseller, consent is required to receive SMSes for low fund or loss alerts
vat-id	String	Optional	VAT ID for EU VAT
auto-activate	Boolean	Optional	Pass true if the reseller account should be activated immediately
accept-policy	Boolean	Optional	Accept Terms and Conditions and Privacy Policy to create an account
marketing-email-consent	Boolean	Optional	In case of EEA (European Economic Area) countries capture consent to receive marketing emails

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/resellers/v2/signup.xml?auth-userid=0&api-key=key&username=email@email.com&passwd=password9&name=name &company=company&address-line-1=address-line-1&city=city&state=state&country=US&zipcode=0000&phone-cc=0&phone=000000&sales-contact-id=0&accounting-currency-symbol=USD&selling-currency-symbol=USD&lang-pref=en

Response

Creates a Sub-Reseller Account and returns below details of the newly added Sub-Reseller. The response data varies based on the Sub-Reseller Signup option set by you within your Reseller Account:

Sub-Reseller Signup Option	Response Data
Manual Activation	Sub-Reseller Signup Option (activationstatus) Sub-Reseller Account Creation Action Id (eaqid) Sub-Reseller Account Creation Action Status (status) Reseller ID (resellerid) Minimum Total Receipts required for Activation (minreceiptrequired)
Activation on Total Receipts	Sub-Reseller Signup Option (activationstatus) Sub-Reseller Account Creation Action Id (eaqid) Sub-Reseller Account Creation Action Status (status) Reseller ID (resellerid) Minimum Total Receipts required for Activation (minreceiptrequired)
Direct Activation	Sub-Reseller Account Creation Action Status (status) Reseller ID (resellerid)

Note

If auto-activate is passed as true, the reseller account will be activated immediately.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.