Skip to main content

Set up and configure a PayPal Payflow payment gateway instance

Zuora

Set up and configure a PayPal Payflow payment gateway instance

Set up and configure a PayPal Payflow payment gateway instance by using the information in this article, including the configuration procedure, descriptions of the configuration fields, and reference for testing the payment gateway.

Prerequisites

Enable the PayPal Payflow payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.

Procedure 

Perform the following steps to set up and configure a PayPal Payflow gateway instance in Zuora:

  1. Click your username in the upper right and navigate to Settings > Payments > Setup Payment Gateway
  2. On the Configure Gateway Instance tab, select PayPal Payflow from the Gateway Type drop-down list.
  3. Click Create Gateway.
  4. On the gateway settings page, specify values for the configuration fields. See below for more information on the fields.
  5. Click Save Gateway Information.

Configuration fields

Common configuration fields

There are some common fields you must complete for every gateway configuration. We recommend reviewing our Setup Payment Gateway documentation for information on these common fields: 

  • Name
  • Use Gateway Test Environment
  • Cards Accepted
  • Default Authorization Amount
    PayPal payment processor does not accept $0.00 authorization amounts.
  • Verify new payment method (optional)
  • Verify updated payment method (optional)

Credentials

In addition to the common fields, every gateway has unique requirements and information (such as credentials) that you must provide to configure the gateway in Zuora. The credentials to configure the gateway in Zuora will be the same as your login credentials for PayPal Manager.

The following table describes the credential fields in Zuora UI and what they correspond to in PayPal.

Field in Zuora UI PayPal Term Description
User ID User Typically, this is the same as the Merchant Login.
Transaction Password Transaction Password This is the transaction password you get when registering with CardinalCommerce. This field is required if you want to enable 3DS2.
Processor ID Processor ID You can get this information after registering with CardinalCommerce. This field is required if you want to enable 3DS2.
Password Password  Your merchant account password.
Partner Partner Typically Paypal is the partner, but may also be Verisign depending on how your account is set up by PayPal.
Org Unit ID Org Unit Id

GUID to identify the merchant organization within Cardinal systems. This field is required if you want to enable 3DS2.

See Cardinal Cruise SSO Credentials for more information.

Merchant ID for PSD2 Merchant ID  This is the merchant ID for Cardinal. You can get this information after registering with CardinalCommerce. This field is required if you want to enable 3DS2.
Merchant ID Merchant Login or Vendor Your merchant ID to your PayPal Payflow gateway account.
API Key Api Key

A shared secret value between the merchant and Cardinal. This value should never be exposed to the public. This field is required if you want to enable 3DS2.

See Cardinal Cruise SSO Credentials for more information.

API Identifier Api Identifier

GUID used to identify the specific API Key. This field is required if you want to enable 3DS2.

See Cardinal Cruise SSO Credentials for more information.

Test the configuration

Access Your Gateway's Test Environment

When configuring the PayPal payment gateway in Zuora, you can indicate whether you would like to use the PayPal test environment or the PayPal Production (Live) environment. 

  • If Use Gateway Test Environment is selected, Zuora will direct payment transactions to the following test environment which is a test simulator at https://pilot-payflowpro.paypal.com (This URL is the API entry point for a test environment dedicated to PayFlow)
  • If Use Gateway Test Environment is not selected (disabled), Zuora will direct payment transactions to the following production environment: https://payflowpro.paypal.com (API entry point).
    Your credentials will be the same for both test and production environments, which both require Payflow credentials. Zuora ensures your payment transactions are routed to the right environment based on whether the Use Gateway Test Environment is selected. 

    The UI entry point for https://pilot-payflowpro.paypal.com and https://payflowpro.paypal.com is at https://manager.paypal.com.

Test Credit Cards and Testing Scenarios

When testing transactions through the Zuora integration of PayPal Payflow gateway integration, you should refer to Payflow Gateway Developer Guide (see the "Test Transactions" section) for more information.

The integration uses the https://pilot-payflowpro.paypal.com simulator for testing, thus we refer you to the instructions in the Payflow guides. The developer's guides include information on generating payment errors based on the transaction amount used for testing. If you use a different credit card number for testing that is not listed in the developer's guide, it may also fail the transaction.

Test Credit Cards and Test Scenarios Will Depend on the Sandbox Used

By default, any merchant testing transactions via Zuora will be using the https://pilot-payflowpro.paypal.com test simulator.

Most merchants will use https://pilot-payflowpro.paypal.com when testing in Zuora, unless PayPal has approved and linked your https://www.sandbox.paypal.com account to https://pilot-payflowpro.paypal.com (for example: if you have a Sandbox Pro account). Check with Payflow Operations team to determine if you have a PayPal sandbox account linked to Payflow. 

The PayPal Sandbox does not have a list of specific credit cards to use, however, these are your options:

  • You can follow the instructions to add a credit card account to a test account. 
  • You can generate credit card numbers in sandbox.paypal.com.
  • You can use a live card in your www.sandbox.com account for testing. This transaction will not go to a live environment it will only be sent to the Sandbox test environment.

Viewing Test Transactions in UI

Test transactions sent to the Payflow Sandbox can be viewed in the UI by logging into manager.paypal.com. If your PayPal sandbox account linked to Payflow, then you can view your transactions in https://www.sandbox.paypal.com.