PayPal Redirect Component

This page explains how to add PayPal to your existing iOS Components integration.

Requirements

API reference

Select which endpoint you are using:

Amounts in Hungarian Forints (HUF)

In case of a transaction in HUF, PayPal expects the transaction amount and the line item amounts to be rounded to the nearest whole amount. For example, an amount of HUF 74499 must be rounded to HUF 74500. PayPal also expects the rounded line item amounts to add up to the rounded transaction amount.

If you do not round the amounts, Adyen will do that. However, a discrepancy can occur between the transaction amount and the total of the line item amounts. When this happens, PayPal doesn't accept the transaction. To avoid that problem, we recommend that you round all HUF amounts yourself and check that they add up.

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

v5.0.0 or later

If your integration uses iOS Components v5.0.0 or later, configure and create an instance of the PayPal Component:

v4.x.x

If your integration uses an earlier version of iOS Components:

There are no configuration steps specific to PayPal required for Components.

Get the payment outcome

You can use the resultCode from the API response to show the shopper the current payment status. The resultCode values you can receive for PayPal are:

However, the synchronous API response doesn't give you the final outcome. To learn the final status of a payment and determine how to proceed with the order, you should wait for webhooks. This is especially important if you use any standard risk rules or custom risk rules that trigger after authorisation.

The webhooks you can receive for PayPal are:

Include more information in webhooks

For PayPal, we recommend adding the following information to your standard webhooks:

• OFFER_CLOSED event code: informs you if the shopper failed to complete the payment. To enable receiving this event code, follow the instructions for non-default event codes.

• PayPal specific details. When enabled, your standard webhooks return the following details as additionalData:

  • paypalEmail: the email address of the shopper's PayPal account.
  • paypalPayerId: the shopper's PayPal Payer ID.
  • paypalPayerStatus: indicates if the shopper's account has been verified by PayPal.
  • paypalAddressStatus: indicates if the shopper's address has been confirmed by PayPal.
  • paypalProtectionEligibility: indicates if the payment is eligible for PayPal Seller Protection.
  • paypalPayerResidenceCountry: the shopper's country or region of residence.

  To enable receiving these details, follow the instructions for additional settings, making sure to select Include PayPal Details.

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

Add the following information to your standard webhooks:

• recurring.recurringDetailReference and recurring.shopperReference. To enable receiving these details as additionalData in the AUTHORISATION webhook:

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

• RECURRING_CONTRACT event code: informs you that a recurring contract has been created. To enable receiving this event code, follow the instructions for non-default event codes.

Create a token

To create a token, include the following parameters in your initial /sessions or /paymentspayment request:

• recurringProcessingModel: Subscription or UnscheduledCardOnFile
• shopperInteraction: Ecommerce
• shopperReference: Your unique identifier for the shopper
• storePaymentMethod: true
• shopperEmail: Required when making a zero-value authorization request with amount.value: 0. Do not 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: The token for the stored payment details. Use this to make later recurring payments for the shopper.
• additionalData.recurring.shopperReference: your unique shopper reference. Use this to associate the shopper with the token.

Make a payment with a token

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

• paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT.

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

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

Refunds

If you have not captured a PayPal payment, you can cancel it. If you have captured the payment and you want to return the funds to the shopper, you need to refund it.

For partial refunds, the instructions differ depending on your capture settings:

• If payments are captured immediately after authorization you need to include lineItems in your partial refund request.
• If payments are captured later you need to include a capturePspReference in your partial refund request.

Partial refund when payments are captured immediately

If you are using the default setup where PayPal payments are captured immediately after authorization, partially refund a PayPal payment as follows:

1. In your /payments/{paymentPspReference}/refunds request, specify:

   Parameter	Required	Description
   amount		The amount that is refunded to the shopper.
   lineItems		Price and product information for the items that the shopper should pay for. The sum of the lineItems must match the amount. If they do not match, Adyen will add a dummy lineItem entry to account for the difference.

   Only specify the items that you are refunding the money for.

   The following example shows how to make a partial refund for item #1 of the above order.

2. Note that in the response, the pspReference is specifically for the refund transaction, not for the original payment.

Partial refund when payments are captured later

Your request for a partial refund must include a capturePspReference if all of the following is true:

• You configured capturing payments later, instead of immediately after authorization.
• Multiple partial captures are enabled for your account.
• You are going to do more than one partial capture.

PayPal uses this unique capture reference to locate the transaction in their systems. Without it, the refund can fail.

To partially refund a PayPal payment if payments are captured later:

1. Get the pspReference from the /payments/{paymentPspReference}/captures response for the payment that you want to partially refund. This is the reference to the capture that PayPal needs.

2. In your /payments/{paymentPspReference}/refunds request, specify:

   Parameter	Required	Description
   capturePspReference		The pspReference from the /payments/{paymentPspReference}/captures response. Do not use the paymentPspReference.

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
• lineItems

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