{"templateId":"markdown","versions":[{"version":"20240601","label":"2024-06-01 (Latest)","link":"/products/payments/enable-features/account-updater","default":true,"active":true,"folderId":"15ab58d6"}],"sharedDataIds":{"sidebar":"sidebar-products/payments/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/payments/openapi"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","tabs","tab","json-schema"]},"custom_product":"Payments","type":"markdown"},"seo":{"title":"Account Updater | 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":"account-updater","__idx":0},"children":["Account Updater"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your customer's card details may change due to expiration, loss, or other account changes. This may result in refused outcomes if you attempt subsequent Customer Initiated Transactions (CITs) or Merchant Initiated Transactions (MITs) using outdated credentials."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your customer's card details can either be stored by you, or by us in a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens"},"children":["Worldpay token"]},". When you submit payment requests using these card details, we can check if updated card details are available before attempting a payment authorization."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-enable","__idx":1},"children":["How to enable"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We have two offerings available:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Managed - we apply merchant configuration to your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}," and automatically check for updated card details when you attempt qualifying payments. No changes are required to your payment requests."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Request a real-time account update in your payment request by setting the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instruction.requestAccountUpdater"]}," boolean to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In both cases, if updated card details are available, we apply them before requesting payment authorization. We return updated card details in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedPaymentInstrument"]}," object in our response."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can only supply ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestAccountUpdater"]}," where ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerAgreement.storedCardUsage"]}," is set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subsequent"]}," for either CITs or MITs."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"requestaccountupdater-object-required","__idx":2},"children":["requestAccountUpdater object (Required)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"\"instruction\": {\n    \"paymentInstrument\": {\n        \"type\": \"card/plain\",\n        \"cardNumber\": \"4444333322221111\",\n        \"expiryDate\": {\n            \"month\": 5,\n            \"year\": 2035\n        }\n    },\n    \"customerAgreement\":{\n        \"type\": \"cardOnFile\",\n        \"storedCardUsage\": \"subsequent\"\n    },\n    \"requestAccountUpdater\": true,\n    ....\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"outcome-details","__idx":3},"children":["Outcome details"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"card/plain","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"...\n\"updatedPaymentInstrument\": {\n    \"type\": \"card/plain\",\n    \"cardNumber\": \"8888777766665555\",\n    \"expiryDate\": {\n        \"month\": 9,\n        \"year\": 2031\n    },\n    \"cardBrand\": \"visa\",\n    \"fundingType\": \"credit\",\n    \"accountUpdaterMessage\": \"The account number was changed\"\n},\n...\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"card/plain+masked","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"...\n\"updatedPaymentInstrument\": {\n    \"type\": \"card/plain+masked\",\n    \"cardBin\": \"888877\",\n    \"lastFour\": \"5555\",\n    \"expiryDate\": {\n        \"month\": 9,\n        \"year\": 2031\n    },\n    \"cardBrand\": \"visa\",\n    \"fundingType\": \"credit\",\n    \"accountUpdaterMessage\": \"The account number was changed\"\n},\n...\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"schema","__idx":4},"children":["Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi.yaml#/components/schemas/PaymentsUpdatedPaymentInstrument"},"options":{"schemasExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/PaymentsUpdatedPaymentInstrument"},"PaymentsUpdatedPaymentInstrument":{"type":"object","discriminator":{"propertyName":"type","mapping":{"card/plain":"#/components/schemas/PaymentsPlainUpdatedPaymentInstrument","card/plain+masked":"#/components/schemas/PaymentsPlainMaskedUpdatedPaymentInstrument"}},"properties":{"type":{"type":"string","description":"The type of updated instrument."}},"required":["type"]},"ExpiryDate":{"type":"object","description":"Contains your customer's card or token expiry date.","properties":{"year":{"type":"integer","format":"int32","example":2028},"month":{"type":"integer","format":"int32","example":6}},"required":["month","year"]},"PaymentsPlainUpdatedPaymentInstrument":{"allOf":[{"$ref":"#/components/schemas/PaymentsUpdatedPaymentInstrument"},{"type":"object","properties":{"appliedNetworkToken":{"type":"boolean"},"type":{"type":"string","enum":["card/plain"]},"cardNumber":{"type":"string"},"accountUpdaterMessage":{"type":"string","description":"Details on the type of payment instrument update.","enum":["The merchant is not registered in the update program","The account number was changed","The account was closed","The expiry was changed","The issuing bank does not participate in the update program","Contact the cardholder for updated information","No match found","No changes found"],"example":"The account number was changed","x-enumDescriptions":{"The issuing bank does not participate in the update program":"Returned for Real Time Account Updater only. It is not known whether an account update is available.","Contact the cardholder for updated information":"A match was found but you may need to contact the cardholder for updated card details. This could be due to cardholder opt-out or other reasons.","The account number was changed":"A new card has been issued with a change in the card number.","No changes found":"No changes to the card account were found.","The account was closed":"The account is closed and the card is no longer valid. Ask your customer for an alternative payment method.","The merchant is not registered in the update program":"Returned for Real Time Account Updater only. Contact Worldpay to enroll in the service.","The expiry was changed":"A new card has been issued with an updated expiry date. In most cases the card number remains unchanged.","No match found":"The BIN range is enrolled for account updates, but no match was found for the card account. One reason for this may be that the card issuer has recently changed."}},"expiryDate":{"$ref":"#/components/schemas/ExpiryDate"},"cardBrand":{"type":"string","description":"The brand of the updated card. In rare circumstances a card may be reissued under a different brand."},"fundingType":{"type":"string","description":"How the card is funded."},"countryCode":{"type":"string"}}}],"discriminator":{"propertyName":"type"},"required":["type"]},"PaymentsPlainMaskedUpdatedPaymentInstrument":{"allOf":[{"$ref":"#/components/schemas/PaymentsUpdatedPaymentInstrument"},{"type":"object","properties":{"appliedNetworkToken":{"type":"boolean"},"type":{"type":"string","enum":["card/plain+masked"]},"cardBin":{"type":"string","description":"The updated card BIN (Bank Identification Number).","example":"444433"},"lastFour":{"type":"string","description":"The four digits of the updated card. Some characters may be obfuscated with a * if the PAN length is less than 16 characters.","example":"1111"},"accountUpdaterMessage":{"type":"string","description":"Details on the type of payment instrument update.","enum":["The merchant is not registered in the update program","The account number was changed","The account was closed","The expiry was changed","The issuing bank does not participate in the update program","Contact the cardholder for updated information","No match found","No changes found"],"example":"The account number was changed","x-enumDescriptions":{"The issuing bank does not participate in the update program":"Returned for Real Time Account Updater only. It is not known whether an account update is available.","Contact the cardholder for updated information":"A match was found but you may need to contact the cardholder for updated card details. This could be due to cardholder opt-out or other reasons.","The account number was changed":"A new card has been issued with a change in the card number.","No changes found":"No changes to the card account were found.","The account was closed":"The account is closed and the card is no longer valid. Ask your customer for an alternative payment method.","The merchant is not registered in the update program":"Returned for Real Time Account Updater only. Contact Worldpay to enroll in the service.","The expiry was changed":"A new card has been issued with an updated expiry date. In most cases the card number remains unchanged.","No match found":"The BIN range is enrolled for account updates, but no match was found for the card account. One reason for this may be that the card issuer has recently changed."}},"expiryDate":{"$ref":"#/components/schemas/ExpiryDate"},"cardBrand":{"type":"string","description":"The brand of the updated card. In rare circumstances a card may be reissued under a different brand."},"fundingType":{"type":"string","description":"How the card is funded."},"countryCode":{"type":"string"}}}],"discriminator":{"propertyName":"type"},"required":["type"]}}}},"schemaResolvedErrors":[]},"children":[]}]},"headings":[{"value":"Account Updater","id":"account-updater","depth":1},{"value":"How to enable","id":"how-to-enable","depth":2},{"value":"requestAccountUpdater object (Required)","id":"requestaccountupdater-object-required","depth":3},{"value":"Outcome details","id":"outcome-details","depth":2},{"value":"Schema","id":"schema","depth":3}],"frontmatter":{"seo":{"title":"Account Updater | Payments API"}},"lastModified":"2026-02-04T05:52:53.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments/enable-features/account-updater","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}