reseller

is added when reseller has a customer specific business

Validate EU VAT ID

Description

Validates the EU VAT ID.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
vat-id String Required The VAT ID that needs to be validated
country String Required Country Code as per ISO 3166-1 alpha-2

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/billing/validate-vat-id.json?auth-userid=0&api-key=key&vat-id=0&country=GB

Response

Returns true (String) if the VAT ID is valid. Returns false otherwise.

How do I stop charging EU VAT?

Follow the steps below to stop charging EU VAT to your Customers and Sub-Resellers.

Step 1: Log in to your control panel. Learn how

Step 2: Navigate to the Configure Tax Rules page

In the menu, click on Settings > Finance & Billing> Configure Tax Rules.

Step 3: Disable EU VAT

  • Uncheck the box next to Charge EU VAT on Domain Registration. to disable EU VAT for Domain Registration.


  • Click on the Yes, stop charging VAT on Domains button to confirm.


  • Click on the ON / OFF toggle next to Charge EU VAT Taxes to completely disable EU VAT.


  • Click on the Yes, disable EU VAT button to confirm.

How do I start charging EU VAT?

Follow the steps below to start charging EU VAT to your Customers and Sub-Resellers.

Step 1: Log in to your control panel. Learn how

Step 2: Navigate to the Configure Tax Rules page

In the menu, click on Settings > Finance & Billing> Configure Tax Rules.

Step 3: Enable EU VAT

  • Click on the ON / OFF toggle next to Charge EU VAT Taxes.


  • Click on Yes, enable EU VAT button to confirm. If you wish to charge EU VAT on Domain Registration as well, click on the check box next to Charge EU VAT on Domain Registration.


  • Optionally, you can enter your VAT ID by clicking on edit.


  • Click on Save to save your VAT ID.

Note

EU VAT will be applicable in conjunction with any Tax Rules you have added in your Reseller account. If you have manually added any Tax Rules for charging EU VAT, you should disable them to avoid additionally charging your customers.

Authenticating a Reseller

Description

Authenticates the Sub-Reseller and returns the Reseller ID, if authenticated.

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 Sub-Reseller
passwd String Required Password of the Sub-Reseller

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/resellers/authenticate.json?auth-userid=0&api-key=key&[email protected]&passwd=subresellerpassword

Response

Returns a hash map containing the below details, if the Sub-Reseller is authenticated successfully:

  • Reseller Id (resellerid)

  • 2-Step Verification status (twofactorauth_enabled)

Authenticating a Customer

Description

Authenticates the Customer 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
username String Required Username of the Customer
passwd String Required Password of the Customer

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/customers/authenticate.json?auth-userid=0&api-key=key&[email protected]&passwd=customerpassword

Response

Returns a hash map containing the below details, if the Customer is authenticated successfully:

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

  • 2-Step Verification status (twofactorauth_enabled)

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

Auto-Renewal of Orders

What is Auto-Renewal?

The Auto-Renewal feature is a convenient way of having your customers' orders renewed prior to expiration, without having to remember the date or go through the entire purchase and activation process.

How does Auto-Renewal work?

For those orders that have the Auto-Renewal setting enabled, Auto-Renewal will be attempted:

  • 7 days in advance, for orders which have a tenure less than 3 months

  • 30 days in advance, for orders which have a tenure greater than 3 months

The system will use the customer's available balance to complete the renewal process. Should the balance fall short at the time of attempting Auto-Renewal, the customer's payment method at Paypal will be charged to complete the process. Should the cards not work, the customer must manually renew the orders to avoid losing them.

Note

An Order will be Auto-Renewed for a duration equivalent to the tenure for which the order was purchased or last renewed.

How do I setup Auto-Renewal for my customers? (Anchor: setup)

The Auto-Renewal feature is currently available only on Paypal Express Checkout payment gateway. While setting up this gateway you can enable Auto-Renewal for your customers.

Additional Information

Setting up Paypal Express Checkout

How do I disable Auto-Renewal? (Anchor: disable)

The Auto-Renewal setting can be managed for each order from within the customer / reseller control panel.
Auto-Renewal setting can be turned ON / OFF for a particular order from the Order Information view See details, using the ON / OFF toggle.




A customer/reseller can also turn Auto-Renewal ON for a particular order while manually renewing it. If the customer/reseller turns Auto-Renewal ON, then the system will attempt to Auto-Renewal that order next renewal cycle onwards. Hence, the customer/reseller must complete the current process of manual renewal.

Will my customer receive any notifications when the order is automatically renewed? (Anchor: notifications)

Email notifications regarding Auto-Renewal are sent as follows:

  • To Customers:

    • Advance notice about attempting Auto-Renewal for orders that are about to expire (sent 3 days in advance of attempting Auto-Renewal)

    • Confirmation email when Customer's Advance Account or payment method has been successfully charged to renew the Order(s)

    • OR

    • Failure notice, if Account Balance was found to be insufficient or payment methods were invalid.

    • Action completion email once the Renewal process completes.

  • To Resellers:

    • Failure notice, when Auto-Renewal could not be completed for customers' orders

    • Note

      If Auto-Renewal fails, the system will include the orders in the Renewal Reminder emails for manual renewal.

    Why Auto-Renewal Could Fail? (Anchor: failure)

    Auto-Renewal may fail due to any of the following reasons:

    • Customer's Advance Account does not have sufficient balance to cover the total Renewal cost.

    • Note

      While attempting Auto-Renewal for a set of Orders, if funds fall short, the system will NOT use the existing funds to renew only a few Orders . Hence, Auto-Renewal will fail for an entire set of orders if the balance in the account is insufficient.

    • The Order is Suspended.

    • The Order is Locked by firstfoot Interactive Pvt Ltd..

    • Auto-Renewal is not supported for a specific Product category.

    • The Order has a pending action associated with it, waiting to be processed.

    Note

    Auto-Renewal is not available for SSL Certificate orders.

  • Integrating a PayPal Express Checkout payment gateway

    The Paypal Express Checkout  payment gateway is a mobile optimised payment solution which allows you to accept credit and debit cards as well as bank transfers.This gateway promises a short and seamless payment process and is touted to have one of the best success rates.

    Moreover, this gateway also equips you to set up automatic order renewal,  whereby prior to expiry your customers’ orders will be automatically renewed by charging the payment method available in their Paypal account.

    Before you Start

    You will need to sign up at Paypal or use your existing merchant account to obtain the below information:

    • API Username

    • API Password

    • API Signature

    Setting Up the  Paypal Express Checkout gateway for 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  Paypal Express Checkout link.

    5. On the following page you need to enter:

      1. Your Merchant Details :

        • API Username
        • API Signature
        • API Password
      2. Your Gateway Settings :

        • Gateway Name: This name will be shown to your customers / sub-resellers, when they are about to make a payment. If you would like to be more specific, you can use something like Credit Card Payment or Visa/Mastercard, etc.
        • Collect Payments in: The currency you want to accept payments in.

          Note:

          If you set this currency different from your selling currency, then the system will automatically maintain the exchange rate. This exchange rate is derived from a trusted source and updated daily. 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.

        • Types of Cards You Accept: Depending on which cards are supported by your merchant account, select whether you would like to accept Visa, MasterCard, American Express, Discover, Diner's Club or JCB credit cards.
        • Enable Gateway For: You can choose to enable the gateway for certain types of transactions only (like Adding Funds or Payments for Invoices/Debit Notes). Moreover, you can restrict the gateway for either Customers or Sub-Resellers, depending on your business model. You can choose from the following options:
          •  Type of Transactions :
            • All Transactions: accept all types of transactions from your  customers and sub-resellers.
            • Invoices/Debit Notes Only: allow only Invoice and Debit note payments.
            • Adding Funds only: allow your customers and sub-resellers to use this gateway to add funds only.
            • No Transactions: will disable the gateway for your customers and sub-resellers.
          • Enabled For :

            • All Customers/ All Resellers
            • Specific Customers/ Specific Resellers
            • Customers from certain countries/ Resellers from certain countries
        • Charge Fees for Adding Funds: Your bank and Paypal Express Checkout may charge a fee per transaction. While you will have to bear these charges when a customer purchases something from you, you can pass them on when they add funds. Hence, the net amount (after deducting these charges) will be added to their respective accounts.

        • Verify Transactions:  PayPal has two types of account holders: verified and unverified. You can choose to manually verify transactions with unverified members. Such transactions will be left pending until you approve or cancel them.
        • Auto-Renew Orders:  If you enable this option your customers can select to have their orders automatically renewed prior to expiry.

          IMPORTANT: In order to enable this option you need to first enable reference transactions for your PayPal merchant account.

        • Approve Pending Transactions: If you would like to receive emails for transactions that need to be manually approved then you  can selectSend me a Reminder if a transaction is pending for more than x days and enter the number of days.
          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.

    Submit Authcode

    Description

    Submit the Domain Secret (also known as Authorization Code) for a domain name that is currently being
    transferred in to firstfoot Interactive Pvt Ltd..

    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 name being transferred in
    auth-code String Required Domain Secret or Authorization Code, for the domain name being transferred.

    HTTP Method

    POST

    Example Test URL Request


    https://test.httpapi.com/api/domains/transfer/submit-auth-code.xml?auth-userid=0&api-key=0&order-id=12345678&auth-code=authcodegoeshere

    Response

    Returns success (String) if the authorization code provided is accurate, and the transfer process continues.

    If there are any errors, a status key with value as Error is returned, along with an appropriate description of the problem.

    Integrating an Ebanx Payment Gateway

    Ebanx is the leading payment solutions provider for International Merchants to accept payments in Brazil. It’s features include risk analysis, 5 business day settlements, zero fraud guarantee for customers and much more.

    Before you Start

    You will need to sign up for a Merchant account at Ebanx and obtain the below information:

    You will also need to modify the below settings in your Ebanx account:

     

    Adding the Ebanx 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 Ebanx Gateway link.
    5. Enter the following details and save your changes by clicking on the Submit button:
      • 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.
        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.

      • Select the types of CREDIT CARDS that your merchant account supports: Depending on which cards are supported by your merchant account, select whether you would like to accept Visa, MasterCard, Amex, Discover, Diners Card or JCB credit cards.
      • Payment Gateway Access Level for Customers /Sub-Resellers: 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.
      • Total Fixed fee charged per transaction for your merchant account (Per Transaction Fixed Fee charged by your Bank + Per Transaction Fixed Fee charged byEbanx): Your bank andEbanx may charge a fixed fee per transaction, if you choose to pass on this fee to your customers and sub-resellers then you can set the amount in this field
      • Total Variable fee charged per transaction for your merchant account: Similar to the field above, you can pass the variable fee charged to you to your customers and sub-resellers by filling this field.
      • Credit a Customer with the Net Amount in an Add Funds transaction.: Select this option if you want to pass on the fees charged to you by your bank andEbanx to your customer.
      • Credit a Sub-Reseller with the Net Amount in an Add Funds transaction.: Select this option if you want to pass on the fees charged to you by your bank andEbanx to your sub-reseller.
      • 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 theEbanx 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
    • 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