{"title":"PayPal Drop-in integration","category":"default","creationDate":1776961628,"content":"

This page explains how to add PayPal to your existing Web Drop-in integration.<\/p>\n

\n

The PayPal Smart Payment Buttons are available from Drop-in

\n \n v 3.7.0\n <\/tag>\n<\/div>\n and later.<\/p>\n<\/div>\n

Requirements<\/h2>\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nMake sure that you have built your Drop-in integration<\/a>.<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\nBefore you begin, complete the PayPal setup steps<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

API reference<\/h2>\n

Select which endpoint you are using:<\/p>\n\n

\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

Amounts in Hungarian Forints (HUF)<\/h3>\n

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. <\/p>\n

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.<\/p>\n

PayPal risk fields<\/h3>\n

PayPal requires marketplaces<\/em> and also merchants in specific verticals<\/em> to send information about the context of the transaction, for risk mitigation purposes.<\/p>\n

Not all businesses need to send risk fields. Contact your PayPal account manager to verify.<\/div><\/div><\/p>\n

Common PayPal risk fields for marketplaces<\/h4>\n

As an example, the following table shows the most common paypalRisk<\/code> fields that marketplaces need to send. It is possible that PayPal requires you to send more, less, or other fields.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PayPal risk field<\/th>\nDescription<\/th>\nData type\/format<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
Sender profile<\/strong> fields:<\/td>\n<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
sender_account_id<\/td>\nThe unique identifier of the buyer's account on the marketplace platform.<\/td>\nString, alphanumeric<\/td>\nA12345N343<\/td>\n<\/tr>\n
sender_first_name<\/td>\nThe buyer's first name registered with their marketplace account.<\/td>\nString, alphanumeric<\/td>\nJohn<\/td>\n<\/tr>\n
sender_last_name<\/td>\nThe buyer's last name registered with their marketplace account.<\/td>\nString, alphanumeric<\/td>\nSmith<\/td>\n<\/tr>\n
sender_email<\/td>\nThe buyer's email address registered with their marketplace account.<\/td>\nString in E.123<\/a> email address format<\/td>\njohn.smith@email.com<\/td>\n<\/tr>\n
sender_phone<\/td>\nThe buyer's phone number registered with their marketplace account.<\/td>\nString in E.123<\/a> telephone number format, national notation<\/td>\n0687164125<\/td>\n<\/tr>\n
sender_address_zip<\/td>\nUS only<\/strong>. The buyer's postal code registered with their marketplace account.<\/td>\nString, alphanumeric<\/td>\n60661<\/td>\n<\/tr>\n
sender_country_code<\/td>\nThe buyer's country registered with their marketplace account.<\/td>\nString in two-character ISO-3166-1<\/a> alpha-2 country code format. Exception: QZ<\/em> (Kosovo).<\/td>\nUS<\/td>\n<\/tr>\n
sender_create_date<\/td>\nThe date that the buyer's marketplace account was created.<\/td>\nString in ISO 8601<\/a> date format<\/td>\n2012-12-09T19:14:55.277-0:00<\/td>\n<\/tr>\n
sender_signup_ip<\/td>\nThe IP address that the buyer used when signing up on the marketplace platform.<\/td>\nString in IPv4 or IPv6 format<\/td>\n213.52.172.120<\/td>\n<\/tr>\n
sender_popularity_score<\/td>\nIf you need to provide this field, ask your PayPal account manager for instructions.<\/td>\nString, possible values: high<\/strong>, medium<\/strong>, low<\/strong><\/td>\nhigh<\/td>\n<\/tr>\n
Receiver profile<\/strong> fields:<\/td>\n<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
receiver_account_id<\/td>\nThe unique identifier of the seller's account on the marketplace platform.<\/td>\nString, alphanumeric<\/td>\nAH00000000000000000000001<\/td>\n<\/tr>\n
receiver_create_date<\/td>\nThe date that the seller's marketplace account was created.<\/td>\nString in ISO 8601<\/a> date format<\/td>\n2012-12-09T19:14:55.277-0:00<\/td>\n<\/tr>\n
receiver_email<\/td>\nThe seller's email address registered with their marketplace account.<\/td>\nString in E.123<\/a> email address format<\/td>\njohn.smith@email.com<\/td>\n<\/tr>\n
receiver_address_country_code<\/td>\nThe seller's country registered with their marketplace account.<\/td>\nString in two-character ISO-3166-1<\/a> alpha-2 country code format. Exception: QZ<\/strong> (Kosovo).<\/td>\nUS<\/td>\n<\/tr>\n
business_name<\/td>\nThe seller's business name registered with their marketplace account.<\/td>\nString, alphanumeric<\/td>\n<\/td>\n<\/tr>\n
recipient_popularity_score<\/td>\nIf you need to provide this field, ask your PayPal account manager for instructions.<\/td>\nString, possible values: high<\/strong>, medium<\/strong>, low<\/strong><\/td>\nhigh<\/td>\n<\/tr>\n
Sender-Receiver interaction<\/strong>:<\/td>\n<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
first_interaction_date<\/td>\nThe date of the first interaction between the buyer and the seller. The marketplace defines what an interaction<\/em> is. For example, a payment transaction, a buyer choosing to follow a seller, and so on.<\/td>\nString in ISO 8601<\/a> date format<\/td>\n2012-12-09T19:14:55.277-0:00<\/td>\n<\/tr>\n
Transaction information<\/strong>:<\/td>\n<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
txn_count_total<\/td>\nThe total number of transactions that the buyer has made on the platform. These can be PayPal payments, or payments using a different payment method.<\/td>\nNumber<\/td>\n<\/td>\n<\/tr>\n
Payment Flow\/Model\/Type<\/strong>:<\/td>\n<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
vertical<\/td>\nIf the seller is active in more than one business vertical, this field indicates the vertical that applies to the transaction.<\/td>\nString, alphanumeric<\/td>\nHousehold goods<\/td>\n<\/tr>\n
transaction_is_tangible<\/td>\nIndicates if the transaction is for tangible goods.<\/td>\nBoolean in string format. Possible values: 0<\/strong> (false), or 1<\/strong> (true)<\/td>\n0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Formatting<\/h4>\n

To send PayPal risk fields, you must use the additionalData.paypalRisk<\/code> field, and specify the risk fields as a stringified additional_data<\/code> array. Each array item consists of:<\/p>\n