reseller

is added when reseller has a customer specific business

Getting Customer Transactions

Description

Gets the list of Customers' Payment Gateway Transactions, matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
payment-type-id Integer Required Payment Type Id
transaction-ids Array of Integer Optional Transaction Ids
customer-ids Array of Integer Optional Customer Id of the Customer(s) for whom the details are to be fetched
transaction-type String Required Transaction type. Values can be addfund or payment.
start-date String Optional Start date of the duration for which Transactions are to be fetched
end-date String Optional End date of the duration for which Transactions are to be fetched
status Array of Strings Optional Status of the Transaction. Values can be AuthCancelled, AuthFailed, AuthPending, AuthStarted, FailedByCron, Refunded or Settled.
no-of-records Integer Required Number of records to be returned
page-no Integer Required Page number for which records are required

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/pg/customer-transactions.xml?auth-userid=0&api-key=key&payment-type-id=1&transaction-type=addfund&no-of-records=10&page-no=1

Response

Returns a hash map of Customers' Payment Gateway Transactions containing the below details:

  • Transaction Id (transid)

  • Transaction Creation Date (creationdt)

  • Entity initiating the Transaction (role)

  • Customer Id (userid)

  • Transaction Status (status)

  • Transaction Amount in the Selling Currency of the Parent Reseller (sellingamount)

  • Amount Charged in the Selling Currency of the Parent Reseller (chargedamount)

  • Transaction Amount in the Accounting Currency of the Parent Reseller (accountingamount)

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

Move

Description

Moves all products from one customer to other customer.

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 that needs to be moved
existing-customer-id Integer Required Existing Customer ID from which the products are to be transferred
new-customer-id Integer Required New Customer ID to which the products are to be transferred
default-contact String Required
Attention

This API Parameter will be deprecated from 1st December 2016 due to IRTP changes in the system. This parameter will not be required post 1st December 2016 as by default only the old contact can be used.

Value to indicate whether the old Contact has to be retained or to use the Default Contact of the new Customer. Valid entries are oldcontact or default.

Note

In case of a .CN domain name, the Default Contact of the new Customer cannot be associated with the domain name and the old Contact has to be retained. Hence, oldcontact
will be the only valid value.

Note

In case of a .ES domain name, the Default Contact of the new Customer cannot be associated with the domain name and the old Contact has to be retained. Hence, oldcontact
will be the only valid value.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/products/move.json?auth-userid=0&api-key=key&domain-name=domain.com&existing-customer-id=0&new-customer-id=0&default-contact=oldcontact

Response

Returns a hash map containing a status key with value as Success, if the move request is accepted by the system for processing.

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

Disabling the Theft Protection Lock

Description

Disables the Theft Protection Lock on the specified 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 Domain Registration Order on which the Theft Protection Lock is to be removed.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/disable-theft-protection.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Disable Theft Protection Action (actiontypedesc)

  • Action ID of the Disable Theft Protection Action (eaqid)

  • Disable Theft Protection Action Status (actionstatus)

  • Description of the Disable Theft Protection Action Status (actionstatusdesc)

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

Enabling the Theft Protection Lock

Description

Applies the Theft Protection Lock on the specified 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 Domain Registration Order on which the Theft Protection Lock to be applied.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/enable-theft-protection.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Enable Theft Protection Action (actiontypedesc)

  • Action ID of the Enable Theft Protection Action (eaqid)

  • Enable Theft Protection Action Status (actionstatus)

  • Description of the Enable Theft Protection Action Status (actionstatusdesc)

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

Get the List of Locks Applied on a Domain Name

Description

Gets the list of the Locks applied on the specified 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 Domain Registration Order whose list of the locks need to be fetched.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/locks.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the list of Locks applied on the Domain Registration Order as below:

  • Reseller Lock (resellerlock) with details as -

    • Reseller ID of the Reseller who placed the Reseller Lock (lockerid)

    • Company Name of the Reseller who placed the Reseller Lock (addedby)

    • Reason for placing the Reseller Lock (reason)

    • Timestamp when the Reseller Lock was placed (creationdt)

  • Transfer Lock (transferlock) with value as true, if set

  • Customer Lock (customerlock) with value as true, if Transfer Lock set.

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

Get OrderID (Deprecated)

Note

These methods have been deprecated. You can use these methods instead.

Description

Returns the SiteBuilder OrderId associated with the domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-password String Required Authentication Parameter
domain-name String Required The domain name for which the details are required.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitebuilder/order-id.xml?auth-userid=1&auth-password=password&domain-name=xyz

Response

Returns the OrderId associated with the given domain name.

Modify FTP Details (Deprecated)

Note

These methods have been deprecated. You can use these methods instead.

Description

Modifies FTP details.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-password String Required Authentication Parameter
order-id Integer Required The orderid for which you want to enroll for a certificate.
ftphost String Required FTP Host Value.
ftpport String Required FTP Port Value
ftpusername String Required FTP Username
ftppassword String Required FTP Password
ftppath String Required FTP Path

HTTP Method

POST

Example Test URL


https://test.httpapi.com/api/sitebuilder/modify-ftp-details.xml?auth-userid=1&auth-password=password&order-id=12&ftphost=host&ftpport=80&ftpusername=test&ftppassword=password&ftppath=test

Response

Returns a map of the result.

Delete (Deprecated)

Note

These methods have been deprecated. You can use these methods instead.

Description

Deletes the specified Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-password String Required Authentication Parameter
order-id Integer Required OrderId for the order which has to be deleted.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/sitebuilder/delete.xml?auth-userid=1&auth-password=password&order-id=12

Response

Returns a map with the status of action.

Get Order Details (Deprecated)

Note

These methods have been deprecated. You can use these methods instead.

Description

Gets details for a particular SiteBuilder Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-password String Required Authentication Parameter
order-id Integer Required OrderId for which details are required.
option Array of Strings Required Vector of different option for details listing. Allowed Option values are:
  • All

  • ConflictDetails

  • PricingDetails

  • OrderDetails

  • StatusDetails

  • ExecutionInfoParams

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitebuilder/details.xml?auth-userid=1&auth-password=password&order-id=1233&option=All

Response

Returns a map containing all the details depending upon the options specified.