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

This page explains how to add Apple Pay to your existing React-Native Drop-in integration.<\/p>\n

Requirements<\/h2>\n

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

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

API reference<\/h2>\n

You do not need to send additional fields for Apple Pay. See the \/payments<\/a> endpoint API reference for the optional fields you can send.<\/p>\n

If you run into an error, refer to Handle Apple Pay errors<\/a>.<\/p>\n

Drop-in configuration<\/h2>\n

When you create configuration object for AdyenCheckout<\/code><\/a>, you must add additional properties for Apple Pay.<\/p>\n\n\n\n\n\n\n
Property<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
merchantID<\/code><\/td>\nYour Apple Pay merchant identifier<\/a>.<\/td>\n<\/tr>\n
merchantName<\/code><\/td>\nYour merchant name. This is used to generate \n PKPaymentSummaryItem<\/code>\n<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n <\/code-sample>\n<\/div>\n

Optional configuration<\/h3>\n

You can optionally include the following properties when you configure AdyenCheckout<\/code><\/a>:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Property<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
allowOnboarding<\/code><\/td>\nSet to true<\/strong> to let the shopper add new cards to their Apple Pay wallet if there are none or if their cards are not supported for the payment.
By default this is set to false<\/strong>, and Apple Pay isn't shown as an available payment method if there are no cards in their Apple Pay wallet.<\/td>\n<\/tr>\n
\n summaryItems<\/code>\n<\/a><\/td>\nAn array of the items included in the purchase that summarize the payment amount. The last item must have the same value as the amount<\/code> you send in your \/payments<\/a> request.<\/td>\n<\/tr>\n
\n requiredShippingContactFields<\/code>\n<\/a><\/td>\nShipping information fields that you require from the shopper to fulfill the order. Refer to Apple Pay documentation for sample values.<\/td>\n<\/tr>\n
\n requiredBillingContactFields<\/code>\n<\/a><\/td>\nBilling information fields that you require from the shopper to process the transaction. Refer to Apple Pay documentation for sample values.<\/td>\n<\/tr>\n
\n billingContact<\/code>\n<\/a><\/td>\nA prefilled billing address.<\/td>\n<\/tr>\n
\n shippingContact<\/code>\n<\/a><\/td>\nA prefilled shipping address.<\/td>\n<\/tr>\n
\n shippingType<\/code>\n<\/a><\/td>\nThe type of shipping displayed, for example Pick Up<\/strong>, Ship To<\/strong>, or Deliver To<\/strong>. This is localized.
Default: PKShippingTypeShipping<\/strong> = .shipping<\/strong>.<\/td>\n<\/tr>\n
\n supportedCountries<\/code>\n<\/a><\/td>\nSpecify the ISO 3166 country codes<\/a> if you only support payments from cards issued in specific countries.<\/td>\n<\/tr>\n
\n shippingMethods<\/code>\n<\/a><\/td>\nList of available methods for shipping physical goods. Refer to Apple Pay documentation for sample values.<\/td>\n<\/tr>\n
recurringPaymentRequest<\/code><\/td>\nRequired for recurring payments<\/a> to specify that the payment is a recurring payment. Corresponds to \n PKRecurringPaymentRequest<\/code>\n<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Recurring payments<\/h2>\n

To enable recurring payments, you must include recurringPaymentRequest<\/code> when configuring Apple Pay<\/a>, and include the recurring payment properties<\/a>.<\/p>\n

To make recurring Apple Pay payments, you have to create a token<\/a> and then make subsequent recurring transactions<\/a> with the token.<\/p>\n

Recurring payment properties<\/h3>\n

In the recurringPaymentRequest<\/code> property, include the following:<\/p>\n\n\n\n\n\n\n\n\n\n\n
Property<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n paymentDescription<\/code>\n<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe description of the recurring payment that Apple Pay shows to the user in the payment sheet.<\/td>\n<\/tr>\n
\n regularBilling<\/code>\n<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe regular billing cycle for the recurring payment, including start and end dates, an interval, and an interval count.<\/td>\n<\/tr>\n
\n managementURL<\/code>\n<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nA URL to a web page where the user can update or delete the payment method for the recurring payment.<\/td>\n<\/tr>\n
\n trialBilling<\/code>\n<\/a><\/td>\n<\/td>\nIf the recurring payment has a trial period, the trial billing cycle for the recurring payment.<\/td>\n<\/tr>\n
\n tokenNotificationURL<\/code>\n<\/a><\/td>\n<\/td>\nA URL you provide for receiving lifecycle updates from Apple Pay about the merchant token, for example, when the card issuer or the user deletes the merchant token.<\/td>\n<\/tr>\n
\n billingAgreement<\/code>\n<\/a><\/td>\n<\/td>\nA localized billing agreement that the payment sheet shows to the user before the user authorizes the payment.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

For example:<\/p>\n

\n <\/code-sample>\n<\/div>\n

Test and go live<\/h2>\n

Use Apple's test\u00a0card numbers\u00a0to\u00a0test your integration.<\/p>\n

For a full list of test cards and instructions how to add these to your test device, see Sandbox testing<\/a>\u00a0on\u00a0Apple's Developer website.<\/p>\n

<\/p>\n

Check the status of an Apple Pay test payment in your\u00a0Customer Area<\/a>\u00a0>\u00a0Transactions<\/strong>\u00a0> \u00a0Payments<\/strong>.<\/p>\n

Going live<\/h3>\n

To process live Apple Pay payments, your API credential needs to have the API Clientside Encryption Payments role<\/strong>. You can check this in your live Customer Area<\/a> or ask your Admin user to verify.<\/p>\n

<\/p>\n

Set up Apple Pay<\/a> on your Apple Pay Developer account for your live merchant identifier.<\/p>\n

See also<\/h2>\n