{"templateId":"markdown","versions":[{"version":"20240601","label":"2024-06-01 (Latest)","link":"/products/payments/apple-pay","default":true,"active":true,"folderId":"15ab58d6"}],"sharedDataIds":{"sidebar":"sidebar-products/payments/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/payments/openapi","oas-products/payments/@20240601/openapi.yaml":"oas-products/payments/@20240601/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","tabs","tab","openapi-code-sample","cards","card","openapi-response-sample"]},"custom_product":"Payments","type":"markdown"},"seo":{"title":"Apple Pay | Payments API","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 16 July 2026 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"apple-pay","__idx":0},"children":["Apple Pay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.apple.com/apple-pay/"},"children":["Apple Pay"]}," to iOS apps, watchOS apps and to websites for ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.apple.com/ios/feature-availability/#apple-pay"},"children":["these supported countries"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make an Apple Pay payment by providing the encrypted payload (wallet token) in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments/openapi/"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments"]}]}," request."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Mastercard, Visa, Amex and Discover branded Apple Pay payments receive liability shift."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Coming soon"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Apple Pay when ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments/recurring-first"},"children":["setting up a recurring payment"]}]}]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Encrypted","disable":false,"icon":"brands apple"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-get-started","__idx":1},"children":["1. Get started"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read through ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.apple.com/apple-pay/implementation/"},"children":["Apple's overview"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create an Apple Merchant ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ask your Worldpay Worldpay Implementation Manager to enable Apple Pay."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Get your Certificate Signing Request (CSR) from your Worldpay Implementation Manager."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use your CSR to get your payment processing certificate from Apple."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"enable","__idx":2},"children":["Enable ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.apple.com/documentation/passkit/apple_pay/"},"children":["Apple Pay in-app"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enable Apple Pay in Xcode."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantCapabilities"]}]}," to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PKMerchantCapability3DS"]}]},", as Worldpay only supports 3DS."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"enable-1","__idx":3},"children":["Enable ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.apple.com/documentation/apple_pay_on_the_web"},"children":["Apple Pay on the web"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Register and verify any domains that will host Apple Pay."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a merchant identity certificate. This is used to establish a secure connection between your servers and Apple's servers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantCapabilities"]}]}," to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PKMerchantCapability3DS"]}]},", as Worldpay only supports 3DS."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-basic-request","__idx":4},"children":["2. Basic request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.walletToken"]}," is taken from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment.paymentToken.paymentData"]}," in the Apple Pay ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.apple.com/documentation/apple_pay_on_the_web/payment_request_api"},"children":["payment request"]},"."]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/payments/@20240601/openapi.yaml","operationId":"payment","exampleKey":"Apple Pay - encrypted","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Decrypted","disable":false,"icon":"brands apple"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-getting-started","__idx":5},"children":["1. Getting started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To send a payment request with a decrypted payload, you must follow the instructions on ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.apple.com/library/archive/documentation/PassKit/Reference/PaymentTokenJSON/PaymentTokenJSON.html"},"children":["Apple Pay's developer site"]}," first."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-request","__idx":6},"children":["2. Request"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/payments/@20240601/openapi.yaml","operationId":"payment","exampleKey":"Apple Pay - decrypted","parameters":{},"environments":{}},"children":[]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"View the full API Request schema","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"center","variant":"filled","to":"/products/payments/openapi/payment"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-add-additional-features","__idx":7},"children":["3. Add additional features"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":4,"cardMinWidth":100},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Auto settlement","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/products/payments/enable-features/auto-settlement"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Automatically settle a payment following the authorization.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","fontSize":"0.8rem","fontWeight":"bold","color":"var(--wp-colour-black)","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"#E0D5FC"},"children":["Enterprise"]}," ",{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","fontSize":"0.8rem","fontWeight":"bold","color":"var(--wp-colour-black)","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"#A5EFFF"},"children":["Worldpay eCommerce"]}]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Risk assessment","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/products/payments/enable-features/fraud-assessment"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We assess the payment for fraud before proceeding with authorization.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","fontSize":"0.8rem","fontWeight":"bold","color":"var(--wp-colour-black)","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"#E0D5FC"},"children":["Enterprise"]}]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Account Funding Transactions (AFT)","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/products/payments/enable-features/account-funding-transactions"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Transfer funds from a card account to another destination, rather than for the provision of goods or services.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","fontSize":"0.8rem","fontWeight":"bold","color":"var(--wp-colour-black)","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"#E0D5FC"},"children":["Enterprise"]}]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Financial Services (MCC 6012/6051)","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/products/payments/enable-features/financial-services-mcc6012-mcc6051"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For domestic Financial Services providers (MCC 6012) based in the Visa Europe Region, you must supply this additional data."," ",{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","fontSize":"0.8rem","fontWeight":"bold","color":"var(--wp-colour-black)","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"#E0D5FC"},"children":["Enterprise"]}]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Payment Facilitators (PayFacs)","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/products/payments/enable-features/payment-facilitator"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Facilitate transactions on behalf of your sub-merchants.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","fontSize":"0.8rem","fontWeight":"bold","color":"var(--wp-colour-black)","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"#E0D5FC"},"children":["Enterprise"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-response","__idx":8},"children":["4. Response"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Features that change the API flow"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Certain features add additional requests and responses:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments/enable-features/auto-settlement"},"children":["Auto Settlement"]}," - automatic ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]}," - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForSettlement"]}," following authorization.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If any of the AVS/CVC response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskFactors"]}," are marked as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notMatched"]}," the payment is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForCancellation"]}," automatically by default but we can disable this."]}]}]}]}]},{"$$mdtype":"Tag","name":"OpenApiResponseSample","attributes":{"descriptionFile":"oas-products/payments/@20240601/openapi.yaml","operationId":"payment","exampleKey":"authorized (basic)"},"children":[]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"View the full API Response schema","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"center","variant":"outlined","to":"/products/payments/openapi/payment/payment#payment/payment/response&c=201"},"children":[]}]}]},"headings":[{"value":"Apple Pay","id":"apple-pay","depth":1},{"value":"1. Get started","id":"1-get-started","depth":2},{"value":"Enable","id":"enable","depth":3},{"value":"Enable","id":"enable-1","depth":3},{"value":"2. Basic request","id":"2-basic-request","depth":2},{"value":"1. Getting started","id":"1-getting-started","depth":2},{"value":"2. Request","id":"2-request","depth":2},{"value":"3. Add additional features","id":"3-add-additional-features","depth":2},{"value":"4. Response","id":"4-response","depth":2}],"frontmatter":{"seo":{"title":"Apple Pay | Payments API"},"markdown":{"toc":{"hide":true}}},"lastModified":"2026-05-13T07:59:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments/apple-pay","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}