{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/card-payments/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/card-payments/openapi"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Mobile wallets - Card Payments API | Worldpay Developer","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":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"mobile-wallets","__idx":0},"children":["Mobile wallets"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A secure and easy way for your customers to pay. Integrate ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallets/applepay"},"children":["Apple Pay"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallets/googlepay"},"children":["Google Pay"]}," into your business."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"why-offer-mobile-wallets","__idx":1},"children":["Why offer mobile wallets?"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fast-track your customer to the payment without requiring an account/registration."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Mobile wallet providers share the billing and shipping address on your customer's behalf."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Low PCI requirements."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["SCA (Strong Customer Authentication) compliant - built-in two-factor authentication."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["We decrypt, ensuring a simpler integration with the mobile wallet providers."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"capabilities","__idx":2},"children":["Capabilities"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%","data-label":"- we decrypt"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Take a payment"]}," - we decrypt "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%","data-label":"- we decrypt"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payout to a wallet"]}," - we decrypt "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integrate with your mobile wallet provider: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallets/applepay"},"children":["Apple Pay"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallets/googlepay"},"children":["Google Pay"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integrate with our Card Payments API:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the encrypted payload in a request to our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/openapi/other/authorize"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerInitiatedTransactions"]}," endpoint"]}," and include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerAgreement"]}," object to receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokens:token"]}," if you want to take recurring payments."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You can then use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokens:token"]}," to take recurring payments in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/openapi/other/recurring"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantInitiatedTransactions"]}," endpoint"]},"."]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integrate with your mobile wallet provider: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallets/applepay"},"children":["Apple Pay"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallets/googlepay"},"children":["Google Pay"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integrate with our Card Payments API:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/openapi/other/authorize"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerInitiatedTransactions"]}," endpoint"]}," with your encrypted payload, including the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerAgreement"]}," object."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokens:token"]}," in your response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integrate with our Card Payouts API and use your token to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payouts/payouts"},"children":["make a payout"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrument"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"type\": \"card/tokenized\""]},"."]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payouts to a wallet is currently only supported for Visa and Mastercard branded payouts."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"card-metadata","__idx":3},"children":["Card metadata"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Mobile wallet payment authorizations use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/create-a-network-token"},"children":["network tokens"]}," for increased security and risk reduction benefits. These payment instruments are sometimes referred to as a Device Primary Account Number (DPAN), or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallets/applepay#apple-pay-merchant-tokens-mpan"},"children":["Merchant Primary Account Number (MPAN)"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This means that the last four digits returned in your payment authorization response contains the last four digits of the network token, rather than the actual (or funding) card number. The funding card number (commonly referred to as the funding PAN, or FPAN) is the number of the card that was added to your customer's Apple or Google wallet."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You may optionally send the last four digits of the funding card number where this is returned to you by the mobile wallet provider."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"apple-pay","__idx":4},"children":["Apple Pay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apple returns the last four digits of the FPAN along with the card brand in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentMethod.displayName"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"paymentMethod\": {\n        \"type\": \"credit\",\n        \"network\": \"Visa\",\n        \"displayName\": \"Visa 1111\"\n    },\n    \"paymentData\": {\n        \"data\": \"JcSb4dG6H5ELVet3oJiYBO=\",\n        \"signature\": \"MIAGVSqGRICB+lelK0RexAAAA==\",\n        \"header\": {\n            \"publicKeyHash\": \"h/ffJj1ZUo=\",\n            \"ephemeralPublicKey\": \"MFkwEwYOHWZ/Xmx3iyA==\",\n            \"transactionId\": \"4d3cf2d31a\"\n        },\n        \"version\": \"EC_v1\"\n    },\n    \"transactionIdentifier\": \"4d2cf2d73a0621cf5d7ee5f35546d562ec5b6401d9b38ae92f866f9ea210001b\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"google-pay","__idx":5},"children":["Google Pay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Google returns the last four digits of the FPAN in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["info.cardDetails"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"CARD\",\n  \"description\": \"Visa •••• 1234\",\n  \"info\": {\n    \"cardNetwork\": \"VISA\",\n    \"cardDetails\": \"1234\"\n  },\n  \"tokenizationData\": {\n    \"type\": \"PAYMENT_GATEWAY\",\n    \"token\": \"examplePaymentMethodToken\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Neither Apple nor Google guarantee that the last four digits of the FPAN will be returned in every payment response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"submitting-card-metadata-to-worldpay","__idx":6},"children":["Submitting card metadata to Worldpay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Coming soon"},"children":["Preview only. Not yet available in production."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fpanLastFour"]}," in your payment request:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"instruction\": {\n    ...\n    \"paymentInstrument\": {\n      \"type\": \"card/wallet+applepay\",\n      \"walletToken\": \"{\\\"version\\\": \\\"EC_v1\\\",\\\"data\\\": \\\"kdHd..GQ==\\\",\\\"signature\\\": \\\"MIAGCSqGSIb3DQEH...AAA\\\",\\\"header\\\": {\\\"transactionId\\\": \\\"d3b28af..f8\\\",\\\"ephemeralPublicKey\\\": \\\"MFkwE..Q==\\\",\\\"publicKeyHash\\\": \\\"dxCK..6o=\\\" }}\",\n      \"fpanLastFour\": \"1111\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query","__idx":7},"children":["Query"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Coming soon"},"children":["Preview only. Not yet available in production."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payment-queries/openapi/other/querybydaterange"},"children":["Payment Queries API"]}," returns the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payment-queries/openapi/other/retrievebypaymentid#other/retrievebypaymentid/t=response&c=200&path=paymentinstrument/card/number/fpanlastfour"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fpanLastFour"]}]}," where this was submitted in your authorization request."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next steps"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"we-decrypt","__idx":8},"children":["We decrypt"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/authorize-a-payment"},"children":["Take a payment with a wallet"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payouts/wallets"},"children":["Payout to a wallet"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"you-decrypt","__idx":9},"children":["You decrypt"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you want to send the decrypted payload yourself, you can use the decrypted model outlined in our guides."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallets/decrypted-apple"},"children":["Apple Pay - create a payment/payout with a decrypted payload"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallets/decrypted-google"},"children":["Google Pay - create a payment with a decrypted payload"]}]}]},"headings":[{"value":"Mobile wallets","id":"mobile-wallets","depth":1},{"value":"Why offer mobile wallets?","id":"why-offer-mobile-wallets","depth":2},{"value":"Capabilities","id":"capabilities","depth":2},{"value":"Card metadata","id":"card-metadata","depth":2},{"value":"Apple Pay","id":"apple-pay","depth":3},{"value":"Google Pay","id":"google-pay","depth":3},{"value":"Submitting card metadata to Worldpay","id":"submitting-card-metadata-to-worldpay","depth":3},{"value":"Query","id":"query","depth":3},{"value":"We decrypt","id":"we-decrypt","depth":4},{"value":"You decrypt","id":"you-decrypt","depth":4}],"frontmatter":{"seo":{"title":"Mobile wallets - Card Payments API | Worldpay Developer"}},"lastModified":"2026-07-01T14:20:52.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/wallets","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}