No momento, esta página não está disponível em português
Payment-method icon

PayPal Redirect Component

Add PayPal to an existing iOS Components integration.

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

Before you begin

This page assumes you have already:

API reference

Select which endpoint you're integrating:

This is the default with Components v5.0.0 or later.

Parameter name Required Description
lineItems Price and product information about the purchased items. For each item, you only need to send quantity, description, itemCategory, sku, amountExcludingTax, and taxAmount.
The allowed values for itemCategory are:
  • DIGITAL_GOODS: goods that are stored, delivered, and used in electronic format.
  • PHYSICAL_GOODS: tangible goods that can be shipped with proof of delivery.
  • DONATION: a contribution or gift for which no goods or services are exchanged, usually to a not-for-profit organization.
additionalData.paypalPairingId Only if you use the Magnes SDK and pass the same pairing ID to Magnes and Adyen.
A unique ID determined by you, to link a transaction to a Magnes PayPal risk session.
PayPal refers to this ID as pairing ID, CMID, or tracking ID.
additionalData.paypalRisk Only for marketplaces and for merchants in specific verticals.
A stringified additional_data array with the PayPal risk fields that PayPal told you to send. Each array item consists of:
  • key: the name of the PayPal risk field.
  • value: the value of the PayPal risk field for the current transaction.
Contact your PayPal account manager to learn which paypalRisk fields apply in your case and what happens if you don't populate a specific field. For a list of example fields, refer to the common risk fields for marketplaces.

The following example shows a payment request with the lineItems fields you can use for PayPal, and a few paypalRisk keys and values in additionalData.

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.

Not all businesses need to send risk fields. Contact your PayPal account manager to verify.

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.

PayPal risk field Description Data type/format Example
Sender profile fields:
sender_account_id The unique identifier of the buyer's account on the marketplace platform. String, alphanumeric A12345N343
sender_first_name The buyer's first name registered with their marketplace account. String, alphanumeric John
sender_last_name The buyer's last name registered with their marketplace account. String, alphanumeric Smith
sender_email The buyer's email address registered with their marketplace account. String in E.123 email address format john.smith@email.com
sender_phone The buyer's phone number registered with their marketplace account. String in E.123 telephone number format, national notation 0687164125
sender_address_zip US only. The buyer's postal code registered with their marketplace account. String, alphanumeric 60661
sender_country_code The buyer's country registered with their marketplace account. String in two-character ISO-3166-1 alpha-2 country code format US
sender_create_date The date that the buyer's marketplace account was created. String in ISO 8601 date format 2012-12-09T19:14:55.277-0:00
sender_signup_ip The IP address that the buyer used when signing up on the marketplace platform. String in IPv4 or IPv6 format 213.52.172.120
sender_popularity_score If you need to provide this field, ask your PayPal account manager for instructions. String, possible values: high, medium, low high
Receiver profile fields:
receiver_account_id The unique identifier of the seller's account on the marketplace platform. String, alphanumeric AH00000000000000000000001
receiver_create_date The date that the seller's marketplace account was created. String in ISO 8601 date format 2012-12-09T19:14:55.277-0:00
receiver_email The seller's email address registered with their marketplace account. String in E.123 email address format john.smith@email.com
receiver_address_country_code The seller's country registered with their marketplace account. String in two-character ISO-3166-1 alpha-2 country code format US
business_name The seller's business name registered with their marketplace account. String, alphanumeric
recipient_popularity_score If you need to provide this field, ask your PayPal account manager for instructions. String, possible values: high, medium, low high
Sender-Receiver interaction:
first_interaction_date The date of the first interaction between the buyer and the seller. The marketplace defines what an interaction is. For example, a payment transaction, a buyer choosing to follow a seller, and so on. String in ISO 8601 date format 2012-12-09T19:14:55.277-0:00
Transaction information:
txn_count_total The total number of transactions that the buyer has made on the platform. These can be PayPal payments, or payments using a different payment method. Number
Payment Flow/Model/Type:
vertical If the seller is active in more than one business vertical, this field indicates the vertical that applies to the transaction. String, alphanumeric Household goods
transaction_is_tangible Indicates if the transaction is for tangible goods. Boolean in string format. Possible values: 0 (false), or 1 (true) 0

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.

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

To enable recurring payments for PayPal, follow these steps:
  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:

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

PayPal Seller Protection only applies to physical goods.

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

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:

  • For instructions to create sandbox accounts, see Set up PayPal.
  • For testing instructions, see the PayPal sandbox testing guide.

    • 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