![]() |
reseller
is added when reseller has a customer specific business
Getting Transaction Details of a Sub-Reseller
Description
Gets a Sub-Reseller's Transactions along with their details.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| transaction-ids | Array of Integer | Required | Transaction Ids of the Transactions whose details are to be fetched |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/billing/reseller-transactions.json?auth-userid=0&api-key=key&transaction-ids=0&transaction-ids=1
Response
Returns a hash map of Sub-Reseller's Transactions containing the below details:
-
Transaction Id (transid)
-
Order Id (orderid)
-
Transaction Key (transactionkey)
-
Transaction Date (transactiondate)
-
Transaction Type (type)
-
Transaction Description (description)
-
Product Key (key)
-
Transaction Settlement Date (timestamp)
-
Whether Total Receipts is updated due to the Transaction (totalreceiptupdated)
-
Last Payment Reminder Sent Date (lastreminder)
-
Whether Transaction is Greedy (greedy)
-
Whether the Transaction Description can be modified (isDescriptionModifiable)
-
Reseller Id Associated with the Transaction (resellerid)
-
Reseller Chain by RID (parentkey)
-
Sub-Reseller Details (reseller_name, reseller_company, reseller_address1, reseller_city, reseller_state, reseller_country, reseller_zip, reseller_telnocc, reseller_telno)
-
Reseller Id of the Sub-Reseller's Parent Reseller (parentid)
-
Parent Reseller Details (parent_name,parent_company, brandname, parent_address1, parent_city, parent_state, parent_country, parent_zip, parent_telnocc, parent_telno)
-
Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)
-
Transaction Amount in the Selling Currency (sellingamount)
-
Applicable Tax Amount in the Selling Currency (sellingtaxamount)
-
Transaction Amount without Tax in the Selling Currency (sellingamountwithouttax)
-
Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)
-
Accounting Currency Symbol of the Parent Reseller (accountingcurrencysymbol)
-
Transaction Amount in the Accounting Currency (accountingamount)
-
Applicable Tax Amount in the Accounting Currency (accountingtaxamount)
-
Transaction Amount without Tax in the Accounting Currency (accountingamountwithouttax)
-
Unutilised Transaction Amount in the Accounting Currency (unutilisedaccountingamount)
-
Applicable Tax Rule Id (taxruleid)
-
Foreign Exchange Difference (forexdiff)
-
Whether Transaction Notification is to be sent to the Sub-Reseller (sendresellernotification)
-
Whether Transaction Notification is to be sent to the Parent Reseller (sendparentnotification)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Getting Greedy Transactions of a Sub-Reseller
Description
Gets the specified Sub-Reseller's Greedy Transactions along with their details.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| reseller-id | Integer | Required | Reseller Id of the Sub-Reseller whose Greedy Transactions are to be fetched |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/billing/reseller-greedy-transactions.xml?auth-userid=0&api-key-key&reseller-id=0
Response
Returns a hash map of Sub-Reseller's Transactions containing the below details:
-
Transaction Id (reseller_transaction.transid)
-
Transaction Date (reseller_transaction.transactiondate)
-
Transaction Type (reseller_transaction.type)
-
Transaction Description (reseller_transaction.description)
-
Whether Transaction is Greedy (greedy)
-
Sub-Reseller Id Associated with the Transaction (reseller_transaction.resellerid)
-
Selling Currency Symbol of the Parent Reseller (reseller_transaction.sellingcurrencysymbol)
-
Transaction Amount in the Selling Currency (reseller_transaction.sellingamount)
-
Unutilised Transaction Amount in the Selling Currency (reseller_transaction.unutilisedsellingamount)
-
Accounting Currency Symbol of the Parent Reseller (reseller_transaction.accountingcurrencysymbol)
-
Transaction Amount in the Accounting Currency (reseller_transaction.accountingamount)
-
Unutilised Transaction Amount in the Accounting Currency (reseller_transaction.unutilisedaccountingamount)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Search Transactions of a Sub-Reseller
Description
Gets a detailed list of Sub-Reseller's Transactions, matching the search criteria.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| no-of-records | Integer | Required | Number of Transactions to be fetched |
| page-no | Integer | Required | Page number for which details are to be fetched |
| reseller-id | Array of Integers | Optional | Reseller Id of the Sub-Reseller(s) whose Transactions are to be fetched |
| username | Array of Strings | Optional | Username of the Sub-Reseller(s) whose Transactions are to be fetched |
| transaction-type | Array of Strings | Optional | Type of the Transactions. Possible values can be credit, debit, invoice, receipt. |
| transaction-key | String | Optional | Transaction key. Possible value can be manually or systemgenerated. |
| transaction-id | Array of Integers | Optional | Transaction Ids |
| transaction-description | String | Optional | Transaction description |
| balance-type | String | Optional |
Payment status for the Transaction. Possible values can be:
If this parameter is not included in the API call, all Transactions (balanced as well as unbalanced) will be fetched. |
| amt-range-start | Integer | Optional | Lowest amount in the range of Transactions you intend to list |
| amt-range-end | Integer | Optional | Highest amount in the range of Transactions you intend to list |
| transaction-date-start | String | Optional | UNIX TimeStamp for listing of Transactions whose Creation Date is greater than transaction-date-start |
| transaction-date-end | String | Optional | UNIX TimeStamp for listing of Transactions whose Creation Date is less than transaction-date-end |
| order-by | Array of Strings | Optional | One or more parameters by which you want to sort the Transactions.
Example: If page-no is 1, no-of-records is 30 and order-by is reseller-id; it will fetch the first 30 Transactions which match the search criteria sorted by reseller-id. If page-no is 2, no-of-records is 30 and order-by is reseller-id; it will fetch the second batch of 30 Transactions sorted by reseller-id. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/billing/reseller-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1
Response
Returns a hash map of the Sub-Reseller's Transactions containing the below details:
-
Transaction Id (reseller_transaction.transid)
-
Transaction Date (reseller_transaction.transactiondate)
-
Order Id associated with the Transaction (reseller_transaction.orderid)
-
Product Key (reseller_transaction.key)
-
Transaction Type (reseller_transaction.type)
-
Transaction Description (reseller_transaction.description)
-
Whether Transaction is Greedy (greedy)
-
Reseller Id Associated with the Transaction (reseller_transaction.resellerid)
-
Selling Currency Symbol of the Parent Reseller (reseller_transaction.sellingcurrencysymbol)
-
Transaction Amount in the Selling Currency (reseller_transaction.sellingamount)
-
Unutilised Transaction Amount in the Selling Currency (reseller_transaction.unutilisedsellingamount)
-
Accounting Currency Symbol of the Parent Reseller (reseller_transaction.accountingcurrencysymbol)
-
Transaction Amount in the Accounting Currency (reseller_transaction.accountingamount)
-
Unutilised Transaction Amount in the Accounting Currency (reseller_transaction.unutilisedaccountingamount)
-
Foreign Exchange Difference (forexdiff)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Adding Funds in a Customer Account
Description
Adds funds in a Customer's Account.
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 in whose Debit Account these funds are to be added |
| amount | Float | Required | Amount to be added |
| description | String | Required | Description for the Transaction |
| transaction-type | Array of Strings | Required | Type of the Transaction. Possible values can be credit or receipt. |
| transaction-key | String | Required | A unique Transaction key |
| update-total-receipt | Boolean | Required | Possible values are true or false. Pass true if the amount needs to be added to the Total Receipts figure of the Customer. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/billing/add-customer-fund.json?auth-userid=0&api-key=key&customer-id=0&amount=0&description=description-text&transaction-type=credit&transaction-key=transaction-key-text&update-total-receipt=true
Response
Returns a Transaction Id (Integer) if funds are added successfully in the specified Customer's Account.
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Adding Funds in a Sub-Reseller Account
Description
Adds funds in a Sub-Reseller's account.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| reseller-id | Integer | Required | Reseller Id of the Sub-Reseller in whose Debit Account these funds are to be added |
| amount | Float | Required | Amount to be added |
| description | String | Required | Description for the Transaction |
| transaction-type | Array of Strings | Required | Type of Transactions. Possible values can be credit or receipt. |
| transaction-key | String | Required | A unique Transaction key |
| update-total-receipt | Boolean | Required | Possible values are true or false. Pass true if this amount needs to be added to the Total Receipts figure of the Sub-Reseller. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/billing/add-reseller-fund.json?auth-userid=0&api-key=key&reseller-id=0&amount=0&description=description-text&transaction-type=credit&transaction-key=transaction-key-text&update-total-receipt=true
Response
Returns a Transaction Id (Integer) if funds are added successfully in the specified Sub-Reseller's Account.
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Validating a Transfer Request
Description
Checks if a transfer request is valid for the specified domain name.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| domain-name | String | Required | Domain name for which you want to check if the transfer request is valid. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/domains/validate-transfer.json?auth-userid=0&api-key=key&domain-name=domain.com
Response
Returns true (String) if the transfer request is valid. Returns false otherwise.
Rechecking NS with .DE Registry
Description
Recheck zone configuration with .DE Registry of the expired .DE Domain Registration order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order Id of the .DE Domain Registration Order whose zone configuration needs to be rechecked. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/domains/de/recheck-ns.json?auth-userid=0&api-key=key&order-id=0
Response
Returns a hash map containing the below details:
-
Zone successfully updated at the Registry: A status key with value as success
-
Zone not updated at the Registry: A status key with value as failed and a description key with value as Invalid Name Servers or Zone records. Please re-check your settings
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Modify Details
Description
Modifies the Account details of the specified Sub-Reseller.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| reseller-id | Integer | Required | Reseller Id of the Sub-Reseller for whom the details need to be modified |
| username | String | Required | Username of the Sub-Reseller. Username should be an email address. |
| lang-pref | String | Required | Language Code as per ISO |
| address-line-1 | String | Required | Address line 1 of the Sub-Reseller's address |
| city | String | Required | City |
| state | String | Required | State |
| zipcode | String | Required | ZIP code |
| phone-cc | String | Required | Phone number Country Code |
| phone | String | Required | Phone number |
| 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 |
| brand-name | String | Optional | Brand name used for branding |
| website-url | String | Optional | Branded website URL |
| vat-id | String | Optional | VAT ID for EU VAT |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/resellers/modify-details.json?auth-userid=0&api-key=key&[email protected]&lang-pref=en&address-line-1=address-line-1&city=city&state=state&zipcode=0000&phone-cc=0&phone=000000
Response
Returns a status key with value as Success if the Sub-Reseller'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.
Search
Description
Gets details of the Sub-Resellers that match the Search criteria.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| no-of-records | Integer | Required | Number of records to be fetched. This should be a value between 10 to 500. |
| page-no | Integer | Required | Page number for which details are to be fetched |
| reseller-id | Array of Integers | Optional | Reseller Id of Sub-Reseller(s) |
| username | String | Optional | Username of Sub-Reseller. Username should be an email address. |
| name | String | Optional | Name of Sub-Reseller |
| company | String | Optional | Company Name of Sub-Reseller |
| city | String | Optional | City |
| state | String | Optional | State |
| status | String | Optional | Status of Sub-Reseller. Values can be Active, Suspended and Deleted. |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of Sub-Resellers whose Creation Date is greater than creation-date-start |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of Sub-Resellers whose Creation Date is less than creation-date-end |
| total-receipt-start | Float | Optional | Total receipts of Sub-Resellers which is greater than total-receipt-start |
| total-receipt-end | Float | Optional | Total receipts of Sub-Resellers which is less than total-receipt-end |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/resellers/search.json?auth-userid=0&api-key=key&no-of-records=10&page-no=1
Response
Returns a hash map containing the below details of the Sub-Resellers that match the search criteria:
-
Number of Sub-Resellers requested matching the search criteria (recsonpage)
Following details of each Sub-Resellers
-
Reseller Id (reseller.resellerid)
-
Username (reseller.username)
-
Name (reseller.name)
-
Company (reseller.company)
-
City (reseller.city)
-
State (reseller.state)
-
Country Code (reseller.country)
-
Current Status (reseller.resellerstatus)
-
Total Receipts (reseller.totalreceipts)
-
-
Number of Sub-Resellers in the System matching the search criteria (recsindb)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
