Skip to main content

Set up and configure a PayPal Adaptive Payments gateway instance


Set up and configure a PayPal Adaptive Payments gateway instance

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


  • You (the merchant) must have a PayPal Business account set up.
  • Certain Adaptive Payments features (such as Pre-Approved Payments) are considered advanced services by PayPal; these services must be enabled by PayPal in your merchant account before you can use them. 

Any third-party calling the PayPal Adaptive Payments API on your behalf also requires PayPal approval to use advanced services. Zuora has obtained permission from PayPal to use these services on behalf of our merchants who are signed up for PayPal Adaptive Payments.

  • The customer sending the payment to you and the receivers of the payment must also have a PayPal account of any type. The receivers of the payment must have a PayPal account in order for the funds to be deposited into their account.
  • Review the PayPal Adaptive Payments Developer Guide for an understanding of how Adaptive Payments works and how to integrate pre-approved payments with your e-Commerce website.
  • Enable the PayPal Adaptive payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.


Perform the following steps to set up and configure a PayPal Adaptive Payments 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(Adaptive Payments) 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​​


  • Application ID: Your PayPal account's identification. This ID is issued by PayPal.
  • User ID: ​This is your API User Name.
  • Password: This is your API Password for your API User Name (above).
  • Signature: This is your signature.
  • ​Receiver Email: ​This is the email address for the receiver of the payments. Since Zuora only supports Simple Payments where the merchant is the receiver, your (the merchant's) email address for your PayPal account can be used here; this should be the PayPal account in which you will receive the funds for payment transactions processed.
  • Rules: Similar to the Verify credit card rules for other payment gateway configurations, if the Verify new Pre-Approval Key and/or the Verify updated Pre-Approval Key are selected, Zuora will send a verification request (using the PayPal Adaptive Payments Validate()) to check whether or not the Pre-Approval Key is still valid whenever a new payment method is created and/or when the payment method is updated.

Test the configuration 

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

Your credentials will be the same for both test and production environments.


Merchants can test their workflow using the PayPal Sandbox; go to to set up your test environment. The Sandbox App Id that is used is APP-80W284485P519543T. We recommend contacting your PayPal MTS support team for their recommended testing documentation.

General Testing Information

Integration Testing

Zuora has been certified with PayPal as an integration partner and maintains the integration on an ongoing basis, thoroughly testing the integration with every new release. The PayPal integration documentation is helpful if you are integrating PayPal directly with your website (for example, to support the creation of Preapproval Agreements), then you may need to refer to the integration guides. However, you do not need to perform any integration or certification testing to submit transactions to PayPal via the Zuora application. The intended audience for the integration guides are technical integrators, however, these documents can be helpful to non-technical integrators who can refer to it for information on testing and troubleshooting gateway errors (as described below). 

Performance and Volume Testing

In general, gateway testing environments are intended to give merchants the opportunity to test their gateway and integrations to their gateway, in order to work out any bugs before going to the production environment. Some gateway test environments are shared amongst multiple merchants, and other gateways provide unique testing environments for each merchant. Additionally, gateway test environments (also referred to as certification or sandbox environments) do not have the same high availability or performance capability as production environments. As such, they are not intended for load testing. Merchants performing high volumes of load testing that puts a stress on a shared test environment may receive a warning from the gateway or have their access to the testing environment suspended.