{"title":"Apple Pay Drop-in integration","category":"default","creationDate":1677442560,"content":"<p>This page explains how to add Apple Pay to your existing iOS Drop-in integration.<\/p>\n<h2>Requirements<\/h2>\n<p>Select which endpoint you are using:<\/p>\n\n<div id=\"tab1Zzja\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;&lt;code&gt;\\\/sessions&lt;\\\/code&gt;&quot;,&quot;content&quot;:&quot;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th style=\\&quot;text-align: left;\\&quot;&gt;Requirement&lt;\\\/th&gt;\\n&lt;th style=\\&quot;text-align: left;\\&quot;&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;&lt;strong&gt;Integration type&lt;\\\/strong&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;Make sure that you have built a Sessions flow &lt;a href=\\&quot;\\\/pt\\\/online-payments\\\/build-your-integration\\\/sessions-flow?platform=iOS&amp;amp;integration=Drop-in\\&quot;&gt;iOS Drop-in integration&lt;\\\/a&gt;. &lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;&lt;strong&gt;&lt;a href=\\&quot;\\\/pt\\\/development-resources\\\/api-credentials\\\/roles\\\/\\&quot;&gt;API credential roles&lt;\\\/a&gt;&lt;\\\/strong&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;To &lt;a href=\\&quot;#going-live\\&quot;&gt;process live Apple Pay payments&lt;\\\/a&gt; make sure that you have the following role: &lt;ul&gt;&lt;li markdown=\\&quot;1\\&quot;&gt;&lt;strong&gt;API Clientside Encryption Payments role&lt;\\\/strong&gt;.&lt;\\\/li&gt;&lt;\\\/ul&gt;&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;&lt;strong&gt;Setup steps&lt;\\\/strong&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;Before you begin, make sure that you have: &lt;ul&gt;&lt;li markdown=\\&quot;1\\&quot;&gt;&lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/apple-pay\\\/apple-pay-certificate\\\/ios\\&quot;&gt;Set up Apple Pay with your own certificate&lt;\\\/a&gt;.&lt;\\\/li&gt;&lt;li&gt; &lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/apple-pay\\\/apple-pay-certificate\\\/ios#add-apple-pay-as-a-payment-method-ios\\&quot;&gt;Added Apple Pay in your Customer Area&lt;\\\/a&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&quot;,&quot;altTitle&quot;:&quot;sessions&quot;,&quot;oldTabId&quot;:&quot;sessions-requirements_1&quot;,&quot;relation&quot;:&quot;sessions&quot;},{&quot;title&quot;:&quot;&lt;code&gt;\\\/payments&lt;\\\/code&gt;&quot;,&quot;content&quot;:&quot;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th style=\\&quot;text-align: left;\\&quot;&gt;Requirement&lt;\\\/th&gt;\\n&lt;th style=\\&quot;text-align: left;\\&quot;&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;&lt;strong&gt;Integration type&lt;\\\/strong&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;Make sure that you have built an Advanced flow &lt;a href=\\&quot;\\\/pt\\\/online-payments\\\/build-your-integration\\\/advanced-flow?platform=iOS&amp;amp;integration=Drop-in\\&quot;&gt;iOS Drop-in integration&lt;\\\/a&gt;. &lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;&lt;strong&gt;&lt;a href=\\&quot;\\\/pt\\\/development-resources\\\/api-credentials\\\/roles\\\/\\&quot;&gt;API credential roles&lt;\\\/a&gt;&lt;\\\/strong&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;To &lt;a href=\\&quot;#going-live\\&quot;&gt;process live Apple Pay payments&lt;\\\/a&gt; make sure that you have the following role &lt;ul&gt;&lt;li markdown=\\&quot;1\\&quot;&gt;&lt;strong&gt;API Clientside Encryption Payments role&lt;\\\/strong&gt;.&lt;\\\/li&gt;&lt;\\\/ul&gt;&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;&lt;strong&gt;Setup steps&lt;\\\/strong&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: left;\\&quot;&gt;Before you begin, make sure that you have: &lt;ul&gt;&lt;li markdown=\\&quot;1\\&quot;&gt;&lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/apple-pay\\\/apple-pay-certificate\\\/ios\\&quot;&gt;Set up Apple Pay with your own certificate&lt;\\\/a&gt;.&lt;\\\/li&gt;&lt;li&gt; &lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/apple-pay\\\/apple-pay-certificate\\\/ios#add-apple-pay-as-a-payment-method-ios\\&quot;&gt;Added Apple Pay in your Customer Area&lt;\\\/a&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&quot;,&quot;altTitle&quot;:&quot;advanced&quot;,&quot;oldTabId&quot;:&quot;advanced-requirements_2&quot;,&quot;relation&quot;:&quot;advanced&quot;}]\"\n            :should-update-when-url-changes='true'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2>API reference<\/h2>\n<p>You do not need to send additional fields for Apple Pay. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:<\/p>\n<ul>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/sessions\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/sessions<\/a>&#58; This is the default with <a href=\"\/pt\/online-payments\/build-your-integration\/sessions-flow?platform=iOS&amp;integration=Drop-in\">Drop-in v5.0.0<\/a> or later.<\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a>&#58; If you implemented an <a href=\"\/pt\/online-payments\/build-your-integration\">additional use case<\/a>.<\/li>\n<\/ul>\n<p>If you run into an error, refer to <a href=\"\/pt\/payment-methods\/apple-pay\/handle-apple-pay-errors\">Handle Apple Pay errors<\/a>.<\/p>\n<h2>Drop-in configuration<\/h2>\n<p>When you <a href=\"\/pt\/online-payments\/build-your-integration\/sessions-flow?platform=iOS&amp;integration=Drop-in#configure-drop-in\">configure Drop-in<\/a>, you need additional configuration for Apple Pay.<\/p>\n\n<div id=\"tabqog5Y\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;v5.3.0 or later&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;Include the following when you &lt;a href=\\&quot;\\\/pt\\\/online-payments\\\/build-your-integration\\\/sessions-flow?platform=iOS&amp;amp;integration=Drop-in#configure-drop-in\\&quot;&gt;configure Drop-in&lt;\\\/a&gt;:&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;Parameter name&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;paymentRequest&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Your Apple Pay &lt;a href=\\&quot;https:\\\/\\\/developer.apple.com\\\/documentation\\\/passkit\\\/pkpaymentrequest\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;PKPaymentRequest&lt;\\\/a&gt; object.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;merchantIdentifier&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Your Apple Pay &lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/apple-pay\\\/apple-pay-certificate\\\/ios#create-merchant-identifier\\&quot;&gt;merchant identifier&lt;\\\/a&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Create the configuration object&#039;\\&quot; :id=\\&quot;&#039;&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;swift\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;\\\\\\\/\\\\\\\/Initialize a Drop-in configuration object.\\\\nlet dropInConfiguration = DropInComponent.Configuration()\\\\n\\\\\\\/\\\\\\\/Set configuration for Apple Pay.\\\\nlet paymentRequest: PKPaymentRequest\\\\n\\\\\\\/\\\\\\\/ Initiate PKPaymentRequest\\\\ndropInConfiguration.applePay = try? .init(paymentRequest: paymentRequest)\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:&quot;5-3&quot;,&quot;oldTabId&quot;:&quot;required-config-5-3_1&quot;,&quot;relation&quot;:&quot;5-3&quot;},{&quot;title&quot;:&quot;v5.0.0 to v5.2.0&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;Include the following when you &lt;a href=\\&quot;\\\/pt\\\/online-payments\\\/build-your-integration\\\/sessions-flow?platform=iOS&amp;amp;integration=Drop-in#configure-drop-in\\&quot;&gt;configure Drop-in&lt;\\\/a&gt;:&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;Parameter name&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;merchantIdentifier&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Your Apple Pay &lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/apple-pay\\\/apple-pay-certificate\\\/ios#create-merchant-identifier\\&quot;&gt;merchant identifier&lt;\\\/a&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Create the configuration object&#039;\\&quot; :id=\\&quot;&#039;&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;swift\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;\\\\\\\/\\\\\\\/Initialize a Drop-in configuration object.\\\\nlet dropInConfiguration = DropInComponent.Configuration()\\\\n\\\\\\\/\\\\\\\/Set configuration for Apple Pay.\\\\ndropInConfiguration.applePay = .init(payment: applePayment,\\\\n                               merchantIdentifier: \\\\\\&quot;YOUR_APPLE_PAY_MERCHANT_ID\\\\\\&quot;)\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:&quot;5&quot;,&quot;oldTabId&quot;:&quot;required-config-5_2&quot;,&quot;relation&quot;:&quot;5&quot;},{&quot;title&quot;:&quot;v4.x.x&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;If your integration uses Drop-in &lt;a href=\\&quot;\\\/pt\\\/online-payments\\\/release-notes?integration_type=ios&amp;amp;version=4.10.0\\&quot;&gt;v4.10.0&lt;\\\/a&gt; or earlier, include following configuration for Apple Pay:&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;Parameter name&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;merchantIdentifier&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Your Apple Pay &lt;a href=\\&quot;\\\/pt\\\/payment-methods\\\/apple-pay\\\/apple-pay-certificate\\\/ios#create-merchant-identifier\\&quot;&gt;merchant identifier&lt;\\\/a&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;payment&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The amount, currency, and country code of the payment.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;summaryItems&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The items included in the purchase.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Create the configuration object&#039;\\&quot; :id=\\&quot;&#039;&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;swift\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;\\\\\\\/\\\\\\\/ Import this to use the PKPaymentSummaryItem class\\\\n\\\\\\\/\\\\\\\/ See documentation https:\\\\\\\/\\\\\\\/developer.apple.com\\\\\\\/documentation\\\\\\\/passkit\\\\\\\/pkpaymentsummaryitem\\\\nimport PassKit\\\\n\\\\\\\/\\\\\\\/Submit the payment details here, including the amount, currency, and country code\\\\nlet payment = Payment(amount: Amount(value: 15000, currencyCode: \\\\\\&quot;EUR\\\\\\&quot;),\\\\n                      countryCode: \\\\\\&quot;NL\\\\\\&quot;)\\\\n\\\\\\\/\\\\\\\/ A set of line items that explain recurring payments, additional charges, and discounts.\\\\n\\\\\\\/\\\\\\\/ See Apple Pay documentation for sample values.\\\\n\\\\\\\/\\\\\\\/ https:\\\\\\\/\\\\\\\/developer.apple.com\\\\\\\/documentation\\\\\\\/apple_pay_on_the_web\\\\\\\/applepaypaymentrequest\\\\\\\/1916120-lineitems\\\\nlet summaryItems = [\\\\n                     PKPaymentSummaryItem(label: \\\\\\&quot;Jeans\\\\\\&quot;, amount: 98.99, type: .final),\\\\n                     PKPaymentSummaryItem(label: \\\\\\&quot;Bag\\\\\\&quot;, amount: 55.46, type: .final),\\\\n                     PKPaymentSummaryItem(label: \\\\\\&quot;Discount\\\\\\&quot;, amount: -4.45, type: .final),\\\\n                     PKPaymentSummaryItem(label: \\\\\\&quot;Total\\\\\\&quot;, amount: 150, type: .final)\\\\n                   ]\\\\n\\\\\\\/\\\\\\\/ See Apple Pay documentation https:\\\\\\\/\\\\\\\/docs.adyen.com\\\\\\\/payment-methods\\\\\\\/apple-pay\\\\\\\/apple-pay-certificate\\\\\\\/ios#create-merchant-identifier\\\\nlet merchantIdentifier = \\\\\\&quot;merchant.com.{YOUR_MERCHANT_IDENTIFIER}\\\\\\&quot;\\\\nlet applePayConfiguration = ApplePayComponent.Configuration(summaryItems: summaryItems,\\\\n                                                            merchantIdentifier: merchantIdentifier)\\\\n\\\\n\\\\\\\/\\\\\\\/Assign the Apple Pay configuration object you created to your instance of Drop-in.\\\\ndropInConfiguration.applePay = applePayConfiguration\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:&quot;4&quot;,&quot;oldTabId&quot;:&quot;required-config-4_3&quot;,&quot;relation&quot;:&quot;4&quot;}]\"\n            :should-update-when-url-changes='true'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h3>Optional configuration<\/h3>\n\n<div id=\"tabMqszn\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;v5.0.0 or later&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;If your integration uses iOS Drop-in v5.0.0 or later, you can optionally include the following when you &lt;a href=\\&quot;\\\/pt\\\/online-payments\\\/build-your-integration\\\/sessions-flow?platform=iOS&amp;amp;integration=Drop-in#configure-drop-in\\&quot;&gt;configure the Drop-in&lt;\\\/a&gt;:&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;Parameter name&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;a href=\\&quot;https:\\\/\\\/developer.apple.com\\\/documentation\\\/apple_pay_on_the_web\\\/applepaypaymentrequest\\\/2216120-requiredbillingcontactfields\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;\\n  &lt;code&gt;requiredBillingContactFields&lt;\\\/code&gt;\\n&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Billing information fields that you require from the shopper to fulfill the order. Refer to Apple Pay documentation for sample values.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;a href=\\&quot;https:\\\/\\\/developer.apple.com\\\/documentation\\\/apple_pay_on_the_web\\\/applepaypaymentrequest\\\/2216121-requiredshippingcontactfields\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;\\n  &lt;code&gt;requiredShippingContactFields&lt;\\\/code&gt;\\n&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Shipping information fields that you require from the shopper to fulfill the order. Refer to Apple Pay documentation for sample values.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;billingContact&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;A prefilled billing address.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;shippingContact&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;A prefilled shipping address.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;allowOnboarding&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Set to &lt;strong&gt;true&lt;\\\/strong&gt; 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.&lt;br&gt;By default this is set to &lt;strong&gt;false&lt;\\\/strong&gt;, and Apple Pay isn&#039;t shown as an available payment method if there are no cards in their Apple Pay wallet.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;shippingType&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The type of shipping displayed, for example &lt;strong&gt;Pick Up&lt;\\\/strong&gt;, &lt;strong&gt;Ship To&lt;\\\/strong&gt;, or &lt;strong&gt;Deliver To&lt;\\\/strong&gt;. This is localized.&lt;br&gt;Default: &lt;strong&gt;PKShippingTypeShipping = .shipping&lt;\\\/strong&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;allowShippingContact&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Set to &lt;strong&gt;false&lt;\\\/strong&gt; to prevent the shopper from changing the shipping contact field before showing the payment form.&lt;br&gt;Default: &lt;strong&gt;true&lt;\\\/strong&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;shippingMethods&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;An array of supported shipping methods.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;applicationData&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Additional information that you provide about the payment request. For example, an order number or cart identifier.&lt;br&gt;This is signed and included in the resulting &lt;code&gt;PKPaymentToken&lt;\\\/code&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;supportedCountries&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Only allow payments from cards issued in specific countries. This is a list of &lt;a href=\\&quot;https:\\\/\\\/www.iso.org\\\/iso-3166-country-codes.html\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;ISO 3166 country codes&lt;\\\/a&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;supportsCouponCode&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Set to &lt;strong&gt;true&lt;\\\/strong&gt; to let the shopper enter a coupon code which gets validated.&lt;br&gt;Default: &lt;strong&gt;false&lt;\\\/strong&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;couponCode&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;A coupon code that has already been applied to the payment request.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;PKRecurringPaymentRequest&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Required for recurring payments. Include &lt;a href=\\&quot;https:\\\/\\\/developer.apple.com\\\/documentation\\\/passkit\\\/PKRecurringPaymentRequest\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;PKRecurringPaymentRequest&lt;\\\/a&gt; to specify that the payment is a recurring payment.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&quot;,&quot;altTitle&quot;:&quot;5&quot;,&quot;oldTabId&quot;:&quot;optional-config-5_1&quot;,&quot;relation&quot;:&quot;5&quot;},{&quot;title&quot;:&quot;v4.x.x&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;If your integration uses Drop-in v4.x.x, there&#039;s no additional optional configuration.&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:&quot;4&quot;,&quot;oldTabId&quot;:&quot;optional-config-4_2&quot;,&quot;relation&quot;:&quot;4&quot;}]\"\n            :should-update-when-url-changes='true'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2 id=\"recurring-payments\">Recurring payments<\/h2>\n<p>To enable recurring payments, you must include <code>PKRecurringPaymentRequest<\/code> <a href=\"#optional-configuration\">when configuring Apple Pay<\/a>.<\/p>\n<p>To make recurring Apple Pay payments, you have to <a href=\"\/pt\/online-payments\/tokenization\/create-tokens\">create a token<\/a> and then <a href=\"\/pt\/online-payments\/tokenization\/make-token-payments\">make subsequent recurring transactions<\/a> with the token.<\/p>\n<h2 id=\"test-and-go-live\">Test and go live<\/h2>\n<p>Use Apple's test\u00a0card numbers\u00a0to\u00a0test your integration.<\/p>\n<p>For a full list of test cards and instructions how to add these to your test device, see <a href=\"https:\/\/developer.apple.com\/apple-pay\/sandbox-testing\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Sandbox testing<\/a>\u00a0on\u00a0Apple's Developer website.<\/p>\n<p> <\/p>\n<p>Check the status of an Apple Pay test payment in your\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>\u00a0&gt;\u00a0<strong>Transactions<\/strong>\u00a0&gt; <strong>\u00a0Payments<\/strong>.<\/p>\n<h3>Going live<\/h3>\n<p>To process live Apple Pay payments, your API credential needs to have the <strong>API Clientside Encryption Payments role<\/strong>. You can check this in your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a> or ask your Admin user to verify.<\/p>\n<p> <\/p>\n<p><a href=\"\/pt\/payment-methods\/apple-pay\/apple-pay-certificate\/ios\">Set up Apple Pay<\/a> on your Apple Pay Developer account for your live merchant identifier.<\/p>\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/online-payments\/drop-in-web\"\n                        target=\"_self\"\n                        >\n                    Web Drop-in integration guide\n                <\/a><\/li><li><a href=\"\/online-payments\/tokenization\"\n                        target=\"_self\"\n                        >\n                    Tokenization\n                <\/a><\/li><li><a href=\"\/development-resources\/error-codes#apple-pay-error-codes\"\n                        target=\"_self\"\n                        >\n                    Apple Pay error codes\n                <\/a><\/li><li><a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/CheckoutService\/latest\/overview\"\n                        target=\"_blank\"\n                         class=\"external\">\n                    API Explorer\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/apple-pay\/ios-drop-in","articleFields":{"description":"Add Apple Pay to an existing iOS Drop-in integration.","feedback_component":true,"parameters":{"integration":"Drop-in","platform":"iOS","integration_guide_url":"build-your-integration\/sessions-flow?platform=iOS&integration=Drop-in","component_name":"Drop-in","component_name_capitalized":"Drop-in","payment_method":"Apple Pay","payment_method_type":"applepay","integration_type":"mobile"},"last_edit_on":"26-02-2023 21:23"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/apple-pay\/ios-drop-in","title":"Apple Pay Drop-in integration","content":"This page explains how to add Apple Pay to your existing iOS Drop-in integration.\nRequirements\nSelect which endpoint you are using:\n\n\n    \n        \n        \n    \n\n\nAPI reference\nYou do not need to send additional fields for Apple Pay. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:\n\n \/sessions&#58; This is the default with Drop-in v5.0.0 or later.\n \/payments&#58; If you implemented an additional use case.\n\nIf you run into an error, refer to Handle Apple Pay errors.\nDrop-in configuration\nWhen you configure Drop-in, you need additional configuration for Apple Pay.\n\n\n    \n        \n        \n    \n\n\nOptional configuration\n\n\n    \n        \n        \n    \n\n\nRecurring payments\nTo enable recurring payments, you must include PKRecurringPaymentRequest when configuring Apple Pay.\nTo make recurring Apple Pay payments, you have to create a token and then make subsequent recurring transactions with the token.\nTest and go live\nUse Apple's test\u00a0card numbers\u00a0to\u00a0test your integration.\nFor a full list of test cards and instructions how to add these to your test device, see Sandbox testing\u00a0on\u00a0Apple's Developer website.\n \nCheck the status of an Apple Pay test payment in your\u00a0Customer Area\u00a0&gt;\u00a0Transactions\u00a0&gt; \u00a0Payments.\nGoing live\nTo process live Apple Pay payments, your API credential needs to have the API Clientside Encryption Payments role. You can check this in your live Customer Area or ask your Admin user to verify.\n \nSet up Apple Pay on your Apple Pay Developer account for your live merchant identifier.\nSee also\n\n\n                    Web Drop-in integration guide\n                \n                    Tokenization\n                \n                    Apple Pay error codes\n                \n                    API Explorer\n                \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Apple Pay","lvl3":"Apple Pay Drop-in integration"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/pt\/payment-methods\/apple-pay","lvl3":"\/pt\/payment-methods\/apple-pay\/ios-drop-in"},"levels":4,"category":"Payment method","category_color":"green","tags":["Apple","Drop-in","integration"]},"articleFiles":{"apple-pay-api.js":"<p alt=\"\">apple-pay-api.js<\/p>"}}
