reseller

is added when reseller has a customer specific business

Get Details

Description

Gets the details of an existing CodeGuard Order.

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 of the Order for which the details are to be fetched

HTTP Method

GET

Example Test URL Request


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

Response

Returns a hash map containing the below details:

  • Order ID (entityid)

  • Order Description (description)

  • Domain Name (domainname)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended or Deleted

  • Product key (productkey)

  • Product Category (productcategory)

  • Plan ID of the CodeGuard Plan (planid)

  • Status of the CodeGuard Plan (paused)

  • Order Creation Date (creationtime)

  • Expiry Date (endtime)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Reseller Chain by RID (parentkey)

  • Customer ID Associated with the Order (customerid)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Order Deletion is Allowed (allowdeletion)

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

Delete

Description

Deletes an existing CodeGuard Order.

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 of the Order which is to be deleted

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/codeguard/delete.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 CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Delete Action (actiontypedesc)

  • Action ID of the CodeGuard Order Delete Action (eaqid)

  • CodeGuard Order Delete Action Status (actionstatus)

  • Description of the CodeGuard Order Delete Action Status (actionstatusdesc)

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

Upgrade/Downgrade

Description

Upgrades/Downgrades an existing CodeGuard order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order ID of the Order which is to be upgraded/downgraded
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details i.e. plan-id etc, use this method.
months Integer Required The number of months in the new plan for which the Order is to be upgraded/downgraded
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/codeguard/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Upgrade/Downgrade Action (actiontypedesc)

  • Action ID of the CodeGuard Order Upgrade/Downgrade Action (eaqid)

  • CodeGuard Order Upgrade/Downgrade Action Status (actionstatus)

  • Description of the CodeGuard Order Upgrade/Downgrade Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Upgrade/Downgrade Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the CodeGuard Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Renew

Description

Renews an existing CodeGuard Order.

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 of the Order which is to be renewed
months Integer Required The number of months for which the Order is to be renewed
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/codeguard/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Renew Action (actiontypedesc)

  • Action ID of the CodeGuard Order Renew Action (eaqid)

  • CodeGuard Order Renew Action Status (actionstatus)

  • Description of the CodeGuard Order Renew Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Renew Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the CodeGuard Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Add

Description

Places a CodeGuard Order 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 The domain name for which the Order is to be placed
customer-id Integer Required The Customer under whom the Order should be added
months Integer Required The number of months for which the Order is to be placed
plan-id Integer Required The plan under which the Order should be added. To fetch the plan details i.e. plan-id etc., use this method.
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/codeguard/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Add Action (actiontypedesc)

  • Action ID of the CodeGuard Order Add Action (eaqid)

  • CodeGuard Order Add Action Status (actionstatus)

  • Description of the CodeGuard Order Add Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the CodeGuard Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Adding / Modifying a PayU Gateway

Integrating a PayU Gateway with our system simply requires filling in a form specifying your preferences and account details.

Before you Start

You will need to know your PayU Merchant ID and Secret Key / Salt, to add this payment gateway in your Reseller Account. The Merchant ID and Secret Key / Salt will be generated for your PayU Merchant Account once the account sign-up process is complete.

Adding a PayU Gateway in your Reseller Account

  1. Login to your Reseller Control Panel. See details

  2. In the Menu, point to Settings -> Finance & Billing -> Payment Gateway and click List / Add.

  3. Click the Add a Gateway link.

  4. Click the Add a PayU Gateway link.

  5. Enter the following details and save your changes by clicking the Submit button:

    • Gateway Name: This Gateway Name would be shown to your Customers / Sub-Resellers, when they are about to make a transaction. You may mention the Gateway Name as PayU.

    • Enter Your MerchantID: This is the Merchant ID associated with your PayU Account.

    • SALT: This is the Secret Key / Salt associated with your PayU Account.

    • Currency: Select the Currency in which you want to charge your Customers / Sub-Resellers. Currently, only Indian Rupee is supported.

    • Currency Exchange Rate: If the currency you selected in the previous option varies from your Selling Currency, we will have to convert the Invoice value to the PayU Currency, before we send your Customer's / Sub-Reseller's details to PayU. For this purpose, the system needs an exchange rate between the two.

      You may choose to maintain this exchange rate yourselves or let us maintain it for you. We download FOREX rates on a daily basis from a recognized source and update exchange rates for you. If, however, you wish to update the rates yourselves then you may do so by selecting the I would like to Maintain the currency exchange rate myself. checkbox and entering your own conversion rates.

    • Select the types of CREDIT CARDS that your merchant account supports: You need to select the types of credit cards that are supported by your Bank. The credit card types available are - Visa, MasterCard, American Express, Discover, Diners Club and JCB. You can also decide the sequence in which you want your Customers / Sub-Resellers to view these card types on the payment page.

    • Payment Gateway Access Level for Customers / Sub-Resellers: Select appropriate Access Levels for your Customers / Sub-Resellers.

    • Credit a Customer / Sub-Reseller with the Net Amount in an Add Funds transaction.: PayU deducts a fee on a per transaction basis. There are two types of Transactions that can pass through your PayU integration - Invoice/Debit Note Payment and Add Funds.

      In case of an Add Funds Transaction, you have the option of crediting your Customers / Sub-Resellers with the Net amount that PayU credits you with, or choose to credit them with the Gross funds and bear the charges yourselves. The Net amount is calculated by subtracting the Total Variable fee charged per transaction from the Transaction Amount.

    • Total Fixed fee charged per transaction for your merchant account (Per Transaction Fixed Fee charged by your Bank + Per Transaction Fixed Fee charged by PayU): Enter the total fixed fee that is charged per transaction in the given textbox. This information is primarily used to calculate the Net amount that your Merchant Account is credited with, if you choose to credit your Customer / Sub-Reseller with the Net amount in an Add funds Transaction. Your bank and/or your gateway may be charging you a different amount of fixed fee per transaction for different credit card types, e.g., a certain fixed fee per transaction for Visa cards and a different fixed fee for American Express cards. In case, the amount of fixed fee is different per credit card type, then enter the highest amount of fixed fees charged per transaction to your account, e.g., if the total fixed fee for Visa Cards is 25 cents per transaction and the total fixed fee for American Express cards is 30 cents per transaction, then enter 0.30 in the textbox. If there is no fixed fee charged per transaction then enter 0.

    • Total Variable fee charged per transaction for your merchant account: Enter the total variable fee that is charged per transaction in the given textbox. This information is primarily used to calculate the Net amount that your merchant account is credited with, if you choose to credit your Customer / Sub-Reseller with the Net amount in an Add Funds transaction. Your bank and/or your gateway may be charging you a different amount of variable fee per transaction for different credit card types, e.g., a certain variable fee per transaction for Visa cards and a different variable fee for American Express cards. In case, the amount of variable fee is different per credit card type, then enter the highest amount of variable fees charged per transaction to your account, e.g., if the total variable fee for Visa Cards is 2.50% per transaction and the total variable fee for American Express cards is 3.00% per transaction, then enter 3.00 in the textbox. If there is no variable fee charged per transaction then enter 0.

      Note

      If you have selected to credit a Customer / Sub-Reseller with the Net amount in an Add Funds transaction, then you must submit a Variable Transaction fee (greater than 0).

    • Send me a Reminder if a transaction is pending for more than x days: In case you have not yet accepted a payment sent to you via the PayU Payment Gateway, you can get e-mail reminders sent to you daily after x number of days from the payment date, until you either Approve or Decline these payments.

    • Display Position: If you plan on adding multiple Gateways, you can select the position in which you wish to display this Gateway on your Payment Page.

Note

The SuperSite contains information about the various payment options you offer to your Customers, which are presented at the time of purchasing Products and Services. Once you have added a PayU Payment Gateway, it will be included in the payment options on your SuperSite automatically.

Additional Information

SuperSite