PayPal Redirect Component

On this page, you can find additional configuration for adding PayPal to your Components integration.

Before you begin

This page assumes you have already:

• Built a Components integration.
• Completed the PayPal setup steps.

API reference

Select which endpoint you're integrating:

PayPal risk fields

PayPal requires marketplaces and also merchants in specific verticals to send information about the context of the transaction, for risk mitigation purposes.

Common PayPal risk fields for marketplaces

As an example, the following table shows the most common paypalRisk fields that marketplaces need to send. It is possible that PayPal requires you to send more, less, or other fields.

Component configuration

//Create a payment method object for PayPal.
let paymentMethod = paymentMethods.paymentMethod(ofType: paypalComponentPaymentMethod.self)
//Create a configuration object for the PayPal Component.
var paypalComponentConfiguration = paypalComponent.Configuration()
//Set additional parameters on the configuration object.
paypalComponentConfiguration.localizationParameters = //Optional custom localization parameters.

Recurring payments

To prepare for making recurring payments:

1. Enable recurring payments.
2. Configure webhooks to ensure they include details about recurring payments.

Then you can make recurring payments:

1. In the initial payment request, include specific parameters to create a token.
   This token represents the shopper's stored payment details.
2. In the later recurring payment requests, use the token.

Enable recurring payments

1. Contact PayPal Support to enable Reference Transactions on your seller account. For this, you need your Merchant ID.
2. Enable the recurring permissions on your PayPal account. Follow the steps described in the section Give Adyen access to your PayPal account, and also grant the permissions Charge an existing customer based on a prior transaction and Create and manage Recurring Payments.

Configure webhooks

You can get details about recurring payments in the AUTHORISATION and RECURRING_CONTRACT webhooks.

AUTHORISATION webhook

To receive the recurring.recurringDetailReference and the recurring.shopperReference in the additionalDetails of the AUTHORISATION webhook:

1. Log in to your Customer Area with your company-level account.
2. Go to Developers > Additional data.
3. Under Payment, select Recurring details.

RECURRING_CONTRACT webhook

Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks.
For instructions, see non-default event codes and additional settings.

Create a token

To create a token, include in your initial /payments request:

• shopperReference: Your unique identifier for the shopper
• shopperInteraction: Ecommerce
• recurringProcessingModel: Subscription or UnscheduledCardOnFile
• storePaymentMethod: true
• shopperEmail: Required when making a zero-value authorization request with amount.value: 0. Don't include this parameter if the request is not for a zero-value authorization.

When the payment has been settled, you receive a webhook containing:

• eventCode: RECURRING_CONTRACT
• originalReference: The pspReference of the initial payment.
• pspReference: This is the token for making later recurring payments for this shopper.

Make a payment with a token

To make a later, recurring payment with the token, include in your /payments request:

• paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT.

  You can also get this value by using the /listRecurringDetails endpoint.

• shopperReference: The unique shopper identifier that you specified when creating the token.
• shopperInteraction: ContAuth.
• recurringProcessingModel: Subscription or UnscheduledCardOnFile.

Set up PayPal Seller Protection

If you participate in the PayPal Seller Protection program, make sure that you submit the following fields in your payment requests:

• deliveryAddress
• shopperName

The details provided in these fields will populate the Ship to section of the PayPal checkout.

We recommend that you check that your setup is working correctly with a test payment. Make sure that you submit the correct fields, and that the test payment is marked as eligible for PayPal Seller Protection in the transaction details.

Test and go live

Test your integration

When you are done setting up your integration, use your PayPal sandbox accounts to test the PayPal payment flow. Your business sandbox account lets you simulate your role as a merchant when testing payments. With your personal sandbox account you can simulate the role of a customer.

Refer to the following resources:

You can check the status of a PayPal test payment in your Customer Area > Transactions > Payments.

Before you go live

For live operations, you need to get a live PayPal business account and configure your live environment. See Set up PayPal.

Note that in the live environment, PayPal will only be available if:

• The shopper is logged in to their PayPal account.
• The shopper has at least one valid payment method on their PayPal account.

See also