Solution Point

Adding / Modifying a PayPal Direct Payment API Gateway allows quick integration of the PayPal Website Payment Pro (PayPal Direct Payment API) payment gateway, within the system. By mentioning a few details in the interface and your Business PayPal account, you can safely and securely collect money from your Customers and Sub-Resellers.

The advantage of using this payment gateway is that your Customers/Sub-Resellers do not get redirected to some Payment Gateway website, when they add funds to their account or pay you online. The system simply collects all Credit Card details from your Customers/Sub-Resellers over SSL and sends all the variables via an API Call to the PayPal Server, to get the transaction authenticated.

Before you Start


Apply for the Website Payment Pro Payment Gateway (Anchor: apply)

  1. Login to your Business PayPal account. 1

  2. Click the Merchant Services tab.

  3. Click the Learn more link under the PayPal Payments Pro section.

  4. Click the Get Started! button.

  5. Complete the process to activate this Gateway.

At this point, your account will undergo an approval process by PayPal, that generally takes 2-3 days. Once your application to activate Website Payments Pro has been approved, you need to accept the Billing Agreement (Anchor: billing):

  1. Login to your Business PayPal account. 2

  2. Click the Merchant Services tab.

  3. In the top right corner, click Accept Billing Agreement.

  4. Click Agree.

Generate API Credentials (Anchor: api)

  1. Login to your Business PayPal account. 3

  2. Click the Profile link under the My Account tab.

  3. Click the API Access link under the Account Information section.

  4. Click the Request API Credentials link.

  5. Select the Request API signature radio button and click the Agree and Submit button.

    • Do not click the Request API certificate radio button instead.

    • If you have created an API Certificate, you need to remove it by clicking the Remove button. Confirm the deletion by clicking the Remove button again.

  6. Carefully note (Anchor: note) down the following details and save it for future use:

    • API Username

    • API Password

    • Signature

  7. Click the Done button to complete the process

Authorize your API Username to make API calls through your Reseller Account (Anchor: apikey)

  1. Login to your Business PayPal account. 4

  2. Click the Profile link under My Account.

  3. Click the Add or edit API permissions link.

  4. Click the Add New Permission button.

  5. Click the Configure a custom API authorisation. link.

  6. In the textbox besides Partner API Username mention the API Username you created in the above-mentioned instructions.

  7. Click the checkbox besides the following calls and click the Submit button:

    • RefundTransaction

    • GetTransactionDetails

    • TransactionSearch

    • DoCapture

    • DoVoid

    • DoDirectPayment

    • DoAuthorization

  8. Click the Give Permission button.

Setup the PayPal Direct Payment API Gateway in your Reseller Account (Anchor: setup)

  1. Login to your Reseller Control Panel. 5

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

  3. Click the Add a Gateway link.

  4. Click the Add a PayPal Direct Payment API Gateway link.

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

    • Gateway Name: This represents the name that would be displayed to your Customers/Sub-Resellers, choose to pay online and choose from the available payment gateways that you have configured.


      • Credit Card Payment

      • Visa/Master Card

    • PayPal Username: The Username (typically email address) you use to login into your PayPal Business account.

    • API Username: This is the same API Username you generated in the above-mentioned instructions.

    • API Password: This is the same API Password you generated in the above-mentioned instructions.

    • API Signature: This is the same Signature you generated in the above-mentioned instructions.

    • Currency: PayPal allows you to charge your Customers/Sub-Resellers in 22 different Currencies. Select the Currency from the drop-down menu:

      • US Dollar (USD)

      • United Kingdom Pound (GBP)

      • Euro (EUR)

      • Canadian Dollar (CAD)

      • Japanese Yen (JPY)

      • Australian Dollar (AUD)

      • Swiss Franc (CHF)

      • Czech Koruna (CZK)

      • Danish Krone (DKK)

      • Hong Kong Dollar (HKD)

      • Hungarian Forint (HUF)

      • Norwegian Kroner (NOK)

      • New Zealand Dollar (NZD)

      • Polish Zloty (PLN)

      • Swedish Krona (SEK)

      • Singapore Dollar (SGD)

      • Mexican Pesos (MXN)

      • Brazilian Real (BRL)

      • Malaysian Ringgits (MYR)

      • Philippine Pesos (PHP)

      • Taiwan New Dollars (TWD)

      • Thai Baht (THB)


      The Currency selected here should match the Currency that you have set within your PayPal account.

    • Currency Exchange Rate: If your Selling Currency differs from USD, we will have to convert the Order Value to the PayPal Currency before we send your Customer/Sub-Reseller to PayPal. 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 Card that are supported by your PayPal Account. The credit card types available are - Visa, MasterCard, American Express and Discover. 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 and Sub-Resellers: Select appropriate Access Levels for your Customers / Sub-Resellers.

    • Deciding whether a Sub-Reseller and Customer is Credited with the Gross Amount or Net: PayPal deducts a fee per transaction. There are two types of Transactions that can pass through your PayPal 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 PayPal credits you with, or choose to credit them with the Gross funds and bear the charges yourselves.

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

  • Review the PayPal Integration Caveats

  • PayPal's Legal mandate requires you to continue using the PayPal Standard Checkout Gateway.

  • 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