reseller

is added when reseller has a customer specific business

Authenticate Token

Description

Authenticates token generated by the Generate Token method & returns the Sub-Reseller 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/resellers/authenticate-token.json?auth-userid=0&api-key=key&token=generatedtoken

Response

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

    • Company (company)

    • Name (name)

    • Brand Name (brandname)

    • Reseller Id (resellerid)

    • Parent Id (parentid)

    • Sub-Reseller Status (resellerstatus)

    • Creation Date (creationdt)

    • Total Receipts (totalreceipts)

    • Address (address1)

    • City (city)

    • State (state)

    • Other State (other_state)

    • ZIP (zip)

    • Country (country)

    • Telephone Number Country Code (telnocc)

    • Telephone Number (telno)

    • Username (username)

    • Password (password)

    • Personal Identification Number (pin)

    • Language Preference (langpref)

    • Selling Currency Symbol (sellingcurrencysymbol)

    • Accounting Currency Symbol (accountingcurrencysymbol)

    • Sales Contact Id (salescontactid)

    • Billing Contact From Name (billingfromname)

    • Billing Contact Telephone Number Country Code (billingtelnocc)

    • Billing Contact Telephone Number (billingtelno)

    • Billing Contact Email Address (billingemailaddr)

    • Sales Contact From Name (salesfromname)

    • Sales Contact Telephone Number Country Code (salestelnocc)

    • Sales Contact Telephone Number (salestelno)

    • Sales Contact Email Address (salesemailaddr)

    • Sales Contact Signature (salessignature)

    • Technical Support Contact Telephone Number Country Code (technicalsupporttelnocc)

    • Technical Support Contact Telephone Number (technicalsupporttelno)

    • Technical Support Contact Email Address (technicalsupportmailaddr)

    • Abuse Desk Contact From Name (abusefromname)

    • Abuse Desk Contact Email Address (abuseemailaddr)

    • Abuse Desk Contact Signature (abusesignature)

    • Selling Currency Symbol of the Parent Reseller (parentsellingcurrencysymbol)

    • Funds Threshold Level (fundthreshold)

    • Minimum Total Receipts Required for Sub-Reseller Activation (minreceiptrequire)

    • Minimum Transaction Amount for making Payments Online (minimumbillingamount)

    • Minimum Transaction Amount for Adding Funds Online (minimumaddfundamount)

    • Offline Payment Details for Customers (directpaymentdetails_customer)

    • Offline Payment Details for Resellers (directpaymentdetails_reseller)

    • Whether Offline Payment Details Displayed to Customers (showdirectPayment_customer)

    • Whether Offline Payment Details Displayed to Resellers (showdirectpayment_reseller)

    • Conversion Rate (conversionrate)

    • Whether using System Conversion Rate (usesystemconversionrate)

    • Whether Generation of Risk Assessment Reports Enabled (sendriskreportmail)

    • Whether Sub-Reseller Signup is Restricted (isresellerrestricted)

    • Whether Automatic Signup for New Products Enabled (futureProductSignup)

    • Branding URL of the Parent Reseller (parentbrandingurl)

    • Partially Branded SuperSite 2 URL (partialsupersite2url)

    • Partially Branded PartnerSite URL (partialpartnersiteurl)

    • Partially Branded Control Panel URL (brandingurl)

    • Fully Branded SuperSite 2 URL (supersite2url)

    • Fully Branded SuperSite URL (supersiteurl)

    • Fully Branded PartnerSite URL (partnersiteurl)

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

Generate Token

Description

Authenticates Sub-Reseller and returns authentication token, if the Sub-Reseller is authenticated successfully.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
ip String Required IP Address of the Sub-Reseller

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/resellers/generate-token.json?auth-userid=0&api-key=key&ip=1.1.1.1

Response

Returns the below details if the Sub-Reseller is authenticated successfully:

  • Company (company)

  • Name (name)

  • Sub-Reseller Brand Name (brandname)

  • Reseller Id (userid)

  • Username (username)

  • Parent Id (parentid)

  • Sub-Reseller Account Status (resellerstatus)

  • Token (userLoginId)

  • Technical Support Contact Email Address (technicalsupportmailaddr)

  • Technical Support URL (technicalsupporturl)

  • Accounting Currency Symbol (accountingcurrencysymbol)

  • Selling Currency Symbol (sellingcurrencysymbol)

  • Whether Password has Expired (ispasswdexpired)

  • Signout URL (logoutURL)

  • Language Preference for Contro Panel and Emails (langpref)

  • Country (country)

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.

Getting the List For a Reseller

Description

Gets the allowed list of Payment Gateways for Sub-Resellers.

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/pg/list-for-reseller.json?auth-userid=0&api-key=key

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 for Customers (customeraccesslevel)

  • Allowed Transaction Type for Customers (customerallowedpaymenttype)

  • Payment Gateway Access Level for Sub-Resellers (reselleraccesslevel)

  • Allowed Transaction Type for Sub-Resellers (resellerallowedpaymenttype)

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&username=username@customer.com&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.

Get Reseller Details

Description

Returns Reseller-specific details such as Branding, Personal Details, etc..

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
reseller-id Integer Optional Reseller Id of the Sub-Reseller whose details need to be fetched. In case the Reseller Id is not provided, details of the Reseller making the API call will be returned.

HTTP Method

GET

Example Test URL Request


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

Response

Returns a hash map containing the below details:

  • Company (company)

  • Name (name)

  • Brand Name (brandname)

  • Reseller Id (resellerid)

  • Parent Id (parentid)

  • Reseller Status (resellerstatus)

  • Creation Date (creationdt)

  • Total Receipts (totalreceipts)

  • Address (address1)

  • City (city)

  • State (state)

  • Other State (other_state)

  • ZIP (zip)

  • Country (country)

  • Telephone Number Country Code (telnocc)

  • Telephone Number (telno)

  • Username (username)

  • Password (password)

  • Personal Identification Number (pin)

  • Language Preference (langpref)

  • Selling Currency Symbol (sellingcurrencysymbol)

  • Accounting Currency Symbol (accountingcurrencysymbol)

  • Sales Contact Id (salescontactid)

  • Billing Contact From Name (billingfromname)

  • Billing Contact Telephone Number Country Code (billingtelnocc)

  • Billing Contact Telephone Number (billingtelno)

  • Billing Contact Email Address (billingemailaddr)

  • Sales Contact From Name (salesfromname)

  • Sales Contact Telephone Number Country Code (salestelnocc)

  • Sales Contact Telephone Number (salestelno)

  • Sales Contact Email Address (salesemailaddr)

  • Sales Contact Signature (salessignature)

  • Technical Support Contact Telephone Number Country Code (technicalsupporttelnocc)

  • Technical Support Contact Telephone Number (technicalsupporttelno)

  • Technical Support Contact Email Address (technicalsupportmailaddr)

  • Abuse Desk Contact From Name (abusefromname)

  • Abuse Desk Contact Email Address (abuseemailaddr)

  • Abuse Desk Contact Signature (abusesignature)

  • Selling Currency Symbol of the Parent Reseller (parentsellingcurrencysymbol)

  • Funds Threshold Level (fundthreshold)

  • Minimum Total Receipts Required for Sub-Reseller Activation (minreceiptrequire)

  • Minimum Transaction Amount for making Payments Online (minimumbillingamount)

  • Minimum Transaction Amount for Adding Funds Online (minimumaddfundamount)

  • Offline Payment Details for Customers (directpaymentdetails_customer)

  • Offline Payment Details for Resellers (directpaymentdetails_reseller)

  • Whether Offline Payment Details Displayed to Customers (showdirectPayment_customer)

  • Whether Offline Payment Details Displayed to Resellers (showdirectpayment_reseller)

  • Conversion Rate (conversionrate)

  • Whether using System Conversion Rate (usesystemconversionrate)

  • Whether Generation of Risk Assessment Reports Enabled (sendriskreportmail)

  • Whether Sub-Reseller Signup is Restricted (isresellerrestricted)

  • Whether Automatic Signup for New Products Enabled (futureProductSignup)

  • Branding URL of the Parent Reseller (parentbrandingurl)

  • Partially Branded SuperSite 2 URL (partialsupersite2url)

  • Partially Branded PartnerSite URL (partialpartnersiteurl)

  • Primary Branded Control Panel URL (brandingurl)

  • Fully Branded SuperSite 2 URL (supersite2url)

  • Fully Branded SuperSite URL (supersiteurl)

  • Fully Branded PartnerSite URL (partnersiteurl)

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

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.