reseller

is added when reseller has a customer specific business

Activate

Description

Activates the Free Email service.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id for which Free Email service needs to be activated

HTTP Method

POST

Example Test URL

https://test.httpapi.com/api/mail/activate.xml?auth-userid=0&api-key=key&order-id=0

Response

Returns a map containing status information.

Getting Promo Prices

Description

Gets the Reseller's Promo prices.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/resellers/promo-details.json?auth-userid=0&api-key=key

Response

Returns a hash map containing the below details:

    • Reseller Id (resellerid)

    • Product Key (productkey)

    • Promo Start Time (starttime)

    • Promo End Time (endtime)

    • Promo Period (period)

    • Discounted Price (resellerpriceone)

    • Standard Price (resellerpricetwo)

    • Customer Price (customerprice)

    • Barrrier Price (barrierprice)

    • Price Applicable to the Sub-Reseller (resellerprice)

    • Currency Symbol of the Price Applicable to the Sub-Reseller (resellerpricecurrencysymbol)

    • Type of Action the Promo is Applicable for (actiontype)

    • Selling Currency of the Registration Service Provider (serviceprovidersellingcurrency)

    • Promo Status (isactive)

    • Whether the Promo can be trickled down the Sub-Reseller chain (istrickleallow)

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

Authenticating a Token

Description

Authenticates the token generated by the Generate Token method and returns the Customer details, if authenticated.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
token String Required Authentication Token

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/customers/authenticate-token.json?auth-userid=0&api-key=key&token=authenticationtoken

Response

Returns a hash map containing the below details, if the token is authenticated:

  • Customer Id (customerid)

  • Customer Username (username)

  • Your Reseller Id (resellerid)

  • Reseller Id of your Parent Reseller (parentid)

  • Name (name)

  • Company (company)

  • Email Address (useremail)

  • Telephone Number Country Code (telnocc)

  • Telephone Number (telno)

  • First line of address of the Customer (address1)

  • Second line of address of the Customer (address2)

  • Third line of address of the Customer (address3)

  • City (city)

  • State (state)

  • Country Code (country)

  • ZIP Code (zip)

  • Personal Identification Number (pin)

  • Creation Date (creationdt)

  • Current Status (customerstatus)

  • Sales Contact Name and Email Id (salesrepresentative)

  • Language Preference for the Control Panel and Emails (langpref)

  • Total Receipts (totalreceipts)

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

Generating a Token

Description

Authenticates a Customer by returning an authentication token on successful authentication.

Note

The token will be valid for a duration of only 120 seconds.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
username String Required Username of the Customer
passwd String Required Password of the Customer
ip String Required IP address of the Customer

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/customers/generate-token.json?auth-userid=0&api-key=key&[email protected]&passwd=customerpassword&ip=1.1.1.1

Response

Returns a token (String) if the Customer is authenticated successfully.

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

Getting the Allowed List For a Customer

Description

Gets the allowed list of Payment Gateways for the specified Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required The Customer for whom the allowed Payment Gateway list is to be retrieved.
payment-type String Optional Type of Transaction. Values can be AddFund or Payment. If type is not provided, by default, it will return the Gateway(s) that support both AddFund and Payment.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/pg/allowedlist-for-customer.json?auth-userid=0&api-key=key&payment-type=type&customer-id=0

Response

Returns a hash map of allowed Payment Gateways containing the below details:

  • Payment Gateway Type (gatewaytype)

  • Payment Gateway Name (gatewayname)

  • Payment Type Id (paymenttypeid)

  • Payment Gateway URL (posturl)

  • Payment Gateway Display Position (displayposition)

  • Payment Gateway Access Level (customeraccesslevel)

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

Changing a Customer's Password

Description

Changes the password for the specified Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer Id of the Customer whose password needs to be changed
new-passwd String Required New password

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/customers/change-password.json?auth-userid=0&api-key=key&customer-id=0&new-passwd=password1

Response

Returns true (Boolean) if the Customer's password is changed successfully.

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

Modifying Customer Details

Description

Modifies the Account details of the specified Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer Id of the Customer whose details need to be modified
username String Required Username for the Customer account. Username should be an email address.
name String Required Name of the Customer
company String Required Company name of the Customer
address-line-1 String Required Address line 1 of the Customer's address
city String Required City
state String Required State. In case the State information is not available, you need to pass the value for this parameter as Not Applicable.
other-state String Optional

This parameter needs to be included if the State information is not available.

Mention an appropriate value for this parameter.
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
address-line-2 String Optional Address line 2 of the customer's address
address-line-3 String Optional Address line 3 of the Customer'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 country code
mobile String Optional Mobile number
vat-id String Optional VAT ID for EU VAT

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/customers/modify.json?auth-userid=0&api-key=key&customer-id=0&[email protected]&name=name&company=company&lang-pref=en&address-line-1=address-line-1&city=city&state=state&country=US&zipcode=0000&phone-cc=0&phone=000000

Response

Returns true (Boolean) if the Customer's Account details are modified successfully.

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

Subscribe to reseller