reseller

is added when reseller has a customer specific business

Integrating CCAvenue Payement Gateway

CCavenue is a popular Indian payment gateway that allows you to collect payments with Debit cards, Credit Cards and Net Banking. It’s sophisticated transaction processing boast of high success rates, fraud detection capabilities, dynamic switching between banks to complete transactions, mobile payments and lots more.

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

Before you Start

You will need to sign up at CCavenue and obtain a merchant account. If you already have one, it could be of two types - old or new, depending on when you created the account. On 14th January, 2014 CCavenue released a new and improved version of their merchant set up. All merchants who have signed up post this date will be on the new merchant set up and will see additional information in their merchant panel as compared to the older merchants.

Our integration supports both, old and new merchants. Depending on your date of sign up and what information is available in your merchant panel, you can follow the steps below to start collecting payments with CCavenue.

Settings in your CCavenue merchant account

  • Whitelist https://www.foundationapi.com for transaction calls.
  • Whitelist our IP address 209.99.17.61 for API calls. 
  • Enable API support for your account.

You will also need to get the below details identifying your CCAvenue account.

  • Merchant ID (Mandatory)
  • Working Key/ Encryption Key (Mandatory)
  • Access Code (Mandatory, however, if you have an old integration of CCAvenue you can leave this field blank.)

Adding the CCAvenue Gateway in your Reseller Account

  1. Log in to your Reseller Control Panel.
  2. In the menu, navigate to Settings -> Finance & Billing -> Payment Gateway and then click on  List / Add.
  3. Click on the Add a Gateway link.
  4. Click on the Add a CCAvenue Gateway link.
  5. Enter the following details and save your changes by clicking on the Submit button:
    • Member ID: Your CCAvenue Merchant ID.
    • Access Code: Your CCAvenue Access code available in your merchant panel.
      Note

      Be sure to use the code against the whitelisted URL https://foundationapi.com .

    • Encryption Key: Your CCAvenue Encryption Key available in your merchant panel.
    • Gateway Name: This name would be shown to your customers / sub-resellers, when they are about to make a payment. You can use something like Credit Card Payment or Visa/Master Card, etc.
    • Currency: The currency you want to accept payments in. If you are on the old merchant set up, you will need to set this to Indian Rupee only.
      Note

      If you set this currency different from your selling currency, then the system will automatically maintain the exchange rate. Alternatively, you can choose to maintain the rates yourself by checking the I would like to Maintain the currency exchange rate myself checkbox. You will then need to submit a value for the exchange rate in the corresponding field.

    • Enable Gateway For: You can select what type of transactions you would like to accept from your Customers and Sub-Resellers. You can choose from the following options:
      • Do not Allow ANY Transactions: This option will disable the gateway for your customers and sub-resellers.
      • Allow ANY Transactions: This option will accept all types of transactions from your customers and sub-resellers.
      • Allow only Add Funds: This option will allow your customers and sub-resellers to use this gateway to add funds only.
      • Allow only Invoice/Debit Note Payments: This option will allow only Invoice and Debit note payments.
    • Charge Fees for Adding Funds.: In case of an Add Funds transaction, you have the option of passing on the transaction charges to your Customers / Sub-Resellers. The Net amount is calculated by subtracting the per transaction charges from the transaction amount. The per transaction charges are calculated by adding the Total Fixed fee charged per transaction and the Total Variable fee charged per transaction.

    • 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.

    • Total Fixed fee charged per transaction for your merchant account (Per Transaction Fixed Fee charged by your Bank + Per Transaction Fixed Fee charged by the CCAvenue Credit Card Gateway): 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.

    • 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 CCAvenue Payment Gateway, you can get email 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
  • If you are on the old set up , you must select Indian Rupee as your currency. Selecting any other currency will result in an error.

  • By providing or removing the Access Code, you can switch between the old and new set up of CCavenue. While switching, your pending transactions may fail to complete. Hence, you must settle all pending transactions before modifying your gateway set up. Alternatively, you can manually settle these transactions later.

  • The SuperSite contains information about the various Payment options you offer to your Customers and also presents these options at the time of purchasing Products and Services. This data is downloaded to your SuperSite from your Control Panel and cached (stored) on the SuperSite Server. The cache of your SuperSite will be reloaded automatically, once you have completed the above process. This way, the updated details will be downloaded to your SuperSite from your Control Panel.

    Additional Information

    SuperSite

Delete cPanel Blocks

Description

Deletes cPanel blocks addon for the specified order. 

You can use this API to reduce the cPanel accounts available on a plan.

A cPanel block is a collection of cPanel accounts.  (1 cPanel block = 10 cPanel accounts)

Parameters

 

Add cPanel Blocks

Description

Adds cPanel blocks as an addon for the specified order. 

You can use this API to increase cPanel account limit in addition to the cPanel accounts available in the plan. 

A cPanel block is a collection of cPanel accounts.  (1 cPanel block = 10 cPanel accounts)

Parameters

 

Control Panel emails not being sent or marked as spam

If the Email notifications option is enabled, the control panel will automatically send emails to customers on the reseller's behalf for various actions related to an order. However, sometimes these emails get flagged as spam or blocked by certain email clients and the customers do not receive these emails or miss them as they are marked as spam.

To solve this issue you need to add the following SPF record to your domains DNS zone,

yourdomainname.com IN TXT 14400 "v=spf1 include:_spf.myorderbox.com ~all"

Where, 

Transfer admin Tue, 01/01/2019 - 19:24

Description

Transfers a domain name.

Note

You need to ensure that the domain name is not Locked.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-key String Required Authentication Parameter
domain-name String Required Specify the domain name that you want to transfer.
auth-code String Optional

Authorization Code (a.k.a. Domain Secret) of the domain name that you want to transfer.

The Authorization Code would be required to transfer a domain name of any of the following TLDs (extensions):

  • .AU

  • .BIZ

  • .BZ

  • .CA

  • .CC

  • .CO

  • .COM

  • .COOP

  • .DE

  • .EU

  • .IN (including only these Third Level .IN Domains: .CO.IN, .NET.IN, .ORG.IN, .GEN.IN, .FIRM.IN, .IND.IN)

  • .INFO

  • .MN

  • .MOBI

  • .NAME

  • .NET

  • .NL

  • .NZ

  • .ORG

  • .TV

  • .US

  • .WS

  • .XXX

You may fetch the auth-code from your customer and provide it while placing the Transfer Order. Alternatively, you may initially place the Transfer Order without the auth-code. The Administrative Contact can provide it at the time of approving the Transfer Authorization email received from .

It is recommended that you adopt the second option since it leaves out the requirement for an auth-code at the time of placing the Transfer Order and the customer would be more willing to submit it at a later stage.

Domain Name Extensions for which the Authorization Code needs to be compulsorily provided at this stage:

  • .AU

  • .CA

  • .DE

  • .EU

  • .NZ

customer-id Integer Required The Customer for whom the Order should be added.
reg-contact-id Integer Required

The Registrant Contact of the domain name.

The Identity of the Registrant Contact of a .UK domain name must not be changed during the Transfer process. You may modify the Identity once the domain name has been transferred to , by referring to the process listed at https://www.nominet.org.uk/registrants/maintain/transfer/chargeable/.

admin-contact-id Integer Required

The Administrative Contact of the domain name.

.EU, .NZ, .RU and .UK domain names do not have an Administrative Contact associated with them. You need to pass the value of admin-contact-id as -1 for these domain names.

tech-contact-id Integer Required

The Technical Contact of the domain name.

The Technical Contact associated with a .EU domain name cannot be modified while .NZ, .RU and .UK domain names do not have a Technical Contact associated with them. You need to pass the value of tech-contact-id as -1 for these domain names.

billing-contact-id Integer Required

The Billing Contact of the domain name.

The Billing Contact associated with a .EU domain name cannot be modified while .AT, .BERLIN, .CA, .NL, .NZ, .RU and .UK domain names do not have a Billing Contact associated with them. You need to pass the value of billing-contact-id as -1 for these domain names.

invoice-option String Required This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:
  • NoInvoice: This will not raise any Invoice. The Order will be executed.

  • PayInvoice: This will raise an Invoice and:

    • if there are sufficient funds in the Customer's Debit Account, then the Invoice will be paid and the domain name will be transfered.

    • if there are insufficient funds in the Customer's Debit Account, then the Order will remain pending in the system.

  • KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be executed.

  • OnlyAdd: This will raise an Invoice for the Customer to pay later. The transfer action request will remain pending.

purchase-privacy Boolean optional

Adds the Privacy Protection service for the domain name.

Privacy Protection is not supported for the following TLDs (extensions):

  • .ASIA

  • .AT

  • .AU

  • .CA

  • .CN

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .DE

  • .ES

  • .EU

  • .HN

  • .IN

  • .NL

  • .NZ

  • .PRO

  • .RU

  • .SX

  • .TEL

  • .UK

  • .US

protect-privacy Boolean Optional

Enables / Disables the Privacy Protection setting for the domain name.

auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the domain name.

ns Array of Strings Optional List of Name Servers to be associated with the domain name. A maximum of 13 Name Servers can be specified.
attr-name Map[name] Optional Mapping key of the extra details needed to transfer a domain name. Refer the description of attr-value.
attr-value Map[value] Optional

Mapping value of the extra details required to transfer a domain name. This together with attr-name shall contain the extra details.

    To transfer a .ASIA domain name:

    cedcontactid: For a .ASIA domain name, 'Charter Eligibility Declaration Contact ID' is mandatory. This parameter represents the CED
    Contact ID. You may select any one of the Admin, Technical, Billing or Registrant Contacts as a value for this parameter.

    attr-name1=cedcontactid&attr-value1=0

    To transfer a Premium domain name:

    type: For transferring a Premium domain name, you need to pass an additional paramater type. The value for this parameter will be premiumft.

    attr-name1=type&attr-value1=premiumft

    To transfer a .AIRFORCE, .ARMY, .DEGREE, .ENGINEER, .GIVES, .MARKET, .MORTGAGE, .NAVY, .REHAB, .SOFTWARE, .VET domain name:

    TNC: stands for Terms and Conditions

    Any other value for attr-value1 except y or Y will result in an error "Please accept the Terms & Conditions".

    attr-name1=tnc&attr-value1=y

HTTP Method

POST

Example Test URL Request

Example Test URL Request for Transferring a Domain Name with Privacy Protection

https://test.httpapi.com/api/domains/transfer.json?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true

Example Test URL Request for Transferring a .ASIA Domain Name

https://test.httpapi.com/api/domains/transfer.json?auth-userid=0&api-key=key&domain-name=domain.asia&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=cedcontactid&attr-value1=0

Example Test URL Request for Transferring a Registry Premium Domain Name


https://test.httpapi.com/api/domains/transfer.json?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true&attr-name1=premium&attr-value1=true

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Name Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Transfer Action (actiontypedesc)

  • Action ID of the Domain Transfer Action (eaqid)

  • Domain Transfer Action Status (actionstatus)

  • Description of the Domain Transfer Action Status (actionstatusdesc)

  • Invoice ID of the Domain Transfer Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer ID associated with the Domain Name Order (customerid)

  • Privacy Protection Details (privacydetails)

    • Domain Name (description)

    • Order ID of the Domain Registration Order (entityid)

    • Action Type (actiontype)

    • Description of the Privacy Protection Purchase Action (actiontypedesc)

    • Action ID of the Privacy Protection Purchase Action (eaqid)

    • Privacy Protection Purchase Action Status (actionstatus)

    • Description of the Privacy Protection Purchase Action Status (actionstatusdesc)

    • Invoice ID of the Privacy Protection Purchase Invoice (invoiceid)

    • Selling Currency of the Reseller (sellingcurrencysymbol)

    • Transaction Amount in the Selling Currency (sellingamount)

    • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

    • Customer ID associated with the Domain Registration Order (customerid)

Note

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

In case of an error, a status key with value as ERROR alongwith an error message will be returned. However, if the transfer action is waiting on user input or registry response, the value No Error  will be returned.

Access and Authentication

URL

The HTTP API is available at:

https://httpapi.com/

 

Note

For security reasons, you should always send API requests using HTTPS.

Authentication

All requests require the following authentication parameters:

  • auth-userid: Your Live Account Reseller Id (See the instructions below for finding your Reseller Id).