PayPal Payflow Pro Payment Gateway

Last Updated: 17 Dec 2015

This entire chapter refers to a feature that was added in version 4.14.2

The PayPal Payflow Pro Payment Gateway allows you to create a PayPal payment gateway, integrated directly within your site (rather than through the PayPal website, as is the case with the PayPal Payment Gateway). In order to use the PayPal Payflow Pro Payment Gateway, you will need an Internet Merchant Account with an acquiring financial institution.

The PayPal Payflow Pro Payment Gateway currently supports credit and debit card payment processing only.

The PayPal Payflow Pro Payment Gateway accepts the following card types:

  • American Express
  • American Express Corporate
  • Diners Club
  • Visa Delta
  • Discover
  • JCB
  • Laser
  • Maestro
  • MasterCard
  • Solo
  • Visa Electron
  • Visa

Bookmarks to the headings on this page:

  1. Details Screen
  2. Display Formatting Screen

Once you have added a PayPal Payflow Pro Payment Gateway, you can configure its settings on its associated asset screens. The majority of these screens are the same or similar to those for a Standard Page and are described in the Asset Screens manual. In this chapter, we will describe the Details and Display Formatting screens, which are different for a PayPal Payflow Pro Payment Gateway.

Details Screen

The Details screen allows you to configure the settings of the PayPal Payflow Pro Payment Gateway. For more information about the Status, Future Status, Thumbnail and Details sections, refer to the Details Screen chapter in the Assets Screens manual.

Payflow Account Details

This section allows you to enter your account details, allowing you to accept payments from the payment gateway.

The Payflow Account Details section of the Details screen
The Payflow Account Details section of the Details screen

The fields that are available in this section are described below. The information required for these fields can be obtained when created and configuring your Payflow account. For more information, refer to the PayPal Payflow Payment Gateway website.

  • Merchant ID: enter the merchant login ID of your Payflow account.
  • User ID: enter the user ID that is authorised to process transactions on the PayPal Payflow Pro Payment Gateway. If you have not set up additional users on your Payflow account, this User ID will be the same as the Merchant ID.
  • Partner ID: enter the ID provided to you by the authorised PayPal reseller who you registered your Payflow account with. If you purchased your account directly from PayPal, use the value PayPal in this field.
  • Password: enter the password of your Payflow account.
  • Currency: select the currency that will be used in all e-commerce transactions processed by the PayPal Payflow Pro Payment Gateway. The following currencies are available:
    • Great British Pound (GBP)
    • Australian Dollar (AUD)
    • United States Dollar (USD)
    • Euro (EUR)
    • Japanese Yen (JPY)
    • Canadian Dollar (CAD)
    By default, this field is set to AUD.
  • Card Types: select the card types that will be available on the PayPal Payflow Pro Payment Gateway. If a card type is not selected, users will not be able to select that card type during the transaction process. By default, all card types are selected.
  • Timeout: select the amount of time in seconds that the payment gateway will wait for the user's response before returning an error. By default, this field is set 60 seconds.
  • Custom Reference: this field allows you to send a custom merchant reference on the payflow transaction. You can use both regular and global keyword replacements in this field, for example, to send information on the current e-commerce order (e.g. to send the order ID).
CV2/AVS Options

This section allows you to use the Card Verification Value (CV2) and Address Verification (AVS) systems as added security for credit and debit card transactions made on the PayPal Payflow Pro Payment Gateway.

The CV2/AVS section of the Details screen
The CV2/AVS section of the Details screen

The following fields are available:

  • Enable CV2: select whether or not to enable Card Verification Value checks for transactions made on the PayPal Payflow Pro Payment Gateway. If this field is set to Yes, the CV2 field should be included on the payment gateway using keyword replacements. For more information, refer to the Display Formatting Screen section in this chapter.
  • Enable AVS:  select whether or not to enable Address Verification System checks for transactions made on the PayPal Payflow Pro Payment Gateway. If this field is set to Yes, pass through variables should be configured to source the address from the user's e-commerce form responses. For more information, refer to the Pass through Variables section below.
Test Mode

This section allows you to modify the payment gateway to function in Test Mode. The Test Mode section of the Details screen is shown in the figure below.

The Test Mode section of the Details screen
The Testing Mode section of the Details screen

In the Enable Test Mode field, select whether or not to use the payment gateway for testing purposes only. If this field is set to Yes, the payment gateway will not process any payments and the Card Number field on the PayPal Payflow Pro Payment Gateway form will be replaced with the test drop down menu, as shown in the figure below.

The PayPal Payflow Pro Payment Gateway in Test Mode
The PayPal Payflow Pro Payment Gateway running in Test Mode

Pass through Variables

This section allows you to source address information for the Address Verification Service (AVS) from the user's e-commerce form responses. For example, a user's response to a Postcode question on an e-commerce form could be passed through to the PayPal Payflow Pro Payment Gateway to provide the postcode for the AVS. The Pass through Variables section of the Details screen is shown in the figure below.

The Pass Through Variables section of the Details screen
The Pass through Variables section of the Details screen

In the available fields, enter the pass through variable keys for the corresponding questions. These keys must be configured on the Ecommerce Rules screen of the Ecommerce Form Page. For more information, refer to the Ecommerce Rules Screen section of the Ecommerce Form Page chapter in this manual. The fields that are available in this section are as follows:

  • First Name Variable Name: enter the pass through variable key for the first name of the billing address.
  • Last Name Variable Name: enter the pass through variable key for the last name of the billing address.
  • Street Variable Name: enter the pass through variable key for the street of the billing address.
  • City Variable Name: enter the pass through variable key for the city of the billing address.
  • Postcode Variable Name: enter the pass through variable key for the postcode the billing address.
  • State Variable Name: enter the pass through variable key for the state of the billing address.
  • Country Variable Name: enter the pass through variable key for the country of the billing address. 
Interface Options

This section allows you to change the button and error text for the payment gateway. The Interface Options section of the Details screen is shown in the figure below.

The Interface Options section of the Details screen
The Interface Options section of the Details screen

The fields that are available in this section are as follows:

  • Submit Button Text: enter the text to display as the submit button. By default, this button will read Pay. This button is displayed when the keyword replacement Submit Button is used on the Display Format Bodycopy.
  • Reset Button Text: enter the text to display as the reset button. By default, this button will read Reset. This button is displayed when the keyword replacement Reset Button is used on the Display Format Bodycopy.
  • Cancel Button Text: enter the text to display as the cancel button. By default, this button will read Cancel. This button is displayed when the keyword replacement Cancel Button is used on the Display Format Bodycopy.

Display Formatting Screen

The Display Formatting screen allows you to edit the Display Format Bodycopy. Please note that this Bodycopy can also be edited by right clicking on the Display Format Bodycopy in the Asset Map and selecting Edit Contents.

Display Format Bodycopy

The Display Format Bodycopy is used to define the layout of the PayPal Payflow Pro Payment Gateway page. The default layout of the payment gateway is shown in the figure below.

The default layout on the PayPal Payflow Pro Payment Gateway
The default layout of the PayPal Payflow Pro Payment Gateway 

To change the information that is being shown, click on the edit icon icon – the WYSIWYG Editor will appear where you can use the keyword replacements and formatting to set the layout of the information to show on the payment gateway page. By default, the information shown in the figure below will appear in the WYSIWYG Editor.

The WYSIWYG Editor on the Display Format Bodycopy
The WYSIWYG Editor on the Display Format Bodycopy

Tip: By default, the transaction amount on the PayPal Payflow Pro Payment Gateway will be listed in dollars. This may need to be changed depending on the currency you have selected on the Details screen. 

Keyword Replacements on the Display Format Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor tool bar on the Edit Contents screen of the Display Format Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to configure the layout of the payment gateway page. The standard keyword replacements that are available include the following:

  • Card Number: this will show the credit card number field.
  • Card Expiry Month (Text Box): this will show the credit card expiry month text box field.
  • Card Expiry Month (Dropdown Box): this will show the credit card expiry month drop-down box field. 
  • Card Expiry Year (Text Box): this will show the credit card expiry year text box field.
  • Card Expiry Year (Text Box): this will show the credit card expiry year drop-down box field. 
  • Card CV2: this will show the Card Verification Value (CV2) field. This is required for CV2 verification checks.
  • Card Holder's First Name: this will show the card holder first name field.
  • Card Holder's Last Name: this will show the card holder last name field.
  • Billing Address Street (Street Number, Name and Type): this will show the street field of the billing address.
  • Billing Address City: this will show the city field of the billing address.
  • Billing Address State: this will show the state field of the billing address. 
  • Billing Address Postcode: this will show the postcode field of the billing address.
  • Billing Address Country: this will show the country field of the billing address.
  • Submit Button: this will show the submit button.
  • Cancel Button: this will show the cancel button.
  • Reset Button: this will show the reset button.
  • Transaction Amount: this will show the amount of money that is to be paid in the transaction.
  • Transaction Currency: this will show the transaction currency. For example, AUD.
  • Processing Error (Empty If No Error): this will show any processing errors. For example, if the user forgets to fill out a field.

Tip: A number of these fields are compulsory when creating a working payment gateway. If the required fields are not available to the user,the transaction will not be able to be completed.


Previous Chapter Next Chapter

The Latest

Let Us Know What You Think

Let us know if you spot any errors or if you have any ideas on how we can improve the Matrix Community Website.

Contact Squiz for Demo

Let us show you the true power of Squiz Matrix by giving you a personalised demonstration.