{"templateId":"markdown","versions":[{"version":"v5","label":"v5","link":"/products/card-payments/v5/features/account-updater","default":false,"active":false,"folderId":"5e391095"},{"version":"v6","label":"v6","link":"/products/card-payments/v6/features/account-updater","default":false,"active":false,"folderId":"5e391095"},{"version":"v7","label":"v7 (Latest)","link":"/products/card-payments/features/account-updater","default":true,"active":true,"folderId":"5e391095"}],"sharedDataIds":{"sidebar":"sidebar-products/card-payments/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/card-payments/openapi"},"props":{"metadata":{"markdoc":{"tagList":["admonition","tab","code-snippet","json-schema"]},"custom_product":"Card Payments","type":"markdown"},"seo":{"title":"Account Updater | Card 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":"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":"Heading","attributes":{"level":2,"id":"receive-real-time-account-updates","__idx":1},"children":["Receive real-time account updates"]},{"$$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":"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 supply ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestAccountUpdater"]}," in MITs and only those CITs where ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerAgreement.storedCardUsage"]}," is set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subsequent"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request","__idx":2},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instruction.requestAccountUpdater"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," to request updated card details for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}," supplied. If the stored card details, that you have provided for the transaction, are no longer valid and new credentials are available, the authorization is processed with the new card and its details are returned in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedPaymentInstrument"]}," object in our response."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No changes are required in the request body if you are using our \"Managed Account Updater\" offering."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To trigger specific scenarios in testing, use the magic values available in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/testing#real-time-account-updater-test-values"},"children":["Account Updater testing guidance"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-example","__idx":3},"children":["Request example"]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Account Updater (Request)","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../code/cit/requests/cit-request-account-updater.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"Memory265-13/08/1876\",\n    \"channel\": \"ecom\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"requestAutoSettlement\": {\n            \"enabled\": false\n        },\n        \"narrative\": {\n            \"line1\": \"Mind Palace\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\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":"response","__idx":4},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If updated card details have been applied in your request, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedPaymentInstrument"]}," object is returned in the response."]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../openapi.yaml#/components/schemas/updatedPaymentInstrument"},"options":{"schemaExpansionLevel":1},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/updatedPaymentInstrument"},"updatedPaymentInstrument":{"type":"object","description":"Details of the updated payment instrument.","properties":{"appliedNetworkToken":{"type":"boolean","description":"Returned if the payment instrument was swapped for a network token."},"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","TThe expiration date was changed","The issuing bank does not participate in the update program","Contact the cardholder for updated information","No match found","No changes found"],"x-enumDescriptions":{"The account number was changed":"A new card has been issued with a change in the card number. Returned for both Real-Time and Managed Account Updater.","The account was closed":"The account is closed and the card is no longer valid. Ask your customer for an alternative payment method. Returned for both Real-Time and Managed Account Updater.","The expiration date was changed":"A new card has been issued with an updated expiry date. In most cases the card number remains unchanged. Returned for both Real-Time and Managed Account Updater.","The issuing bank does not participate in the update program":"It is not known whether an account update is available. Returned for Managed Account Updater only.","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. Returned for both Real-Time and Managed Account Updater."},"example":"The account number was changed"},"type":{"type":"string","example":"card/plain+masked"},"cardBin":{"pattern":"^[0-9*]+$","type":"string","description":"The updated card BIN (Bank Identification Number).","example":"444433"},"lastFour":{"pattern":"^[0-9*]+$","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},"cardNumber":{"type":"string","description":"The full card number of the updated card. Returned only for merchants configured to receive card numbers that are not obfuscated.","maxLength":19,"minLength":12,"pattern":"^[0-9]+$"},"expiryDate":{"type":"object","properties":{"month":{"type":"integer"},"year":{"type":"integer"}}},"cardBrand":{"type":"string","description":"The brand of the updated card. In rare circumstances a card may be reissued under a different brand."},"countryCode":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]*$","description":"Country code of the updated card in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes).","example":"GB"},"fundingType":{"type":"string","description":"How the card is funded."}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-examples","__idx":5},"children":["Response examples"]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Account Updater (Response)","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../code/cit/responses/account-updater.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"authorized\",\n    \"paymentId\": \"pay28NdG68sv-13_sDcu5Bwt0\",\n    \"commandId\": \"cmd8hJcb20_sh2-sbRjx88wL0\",\n    \"riskFactors\": [\n        {\n            \"type\": \"cvc\",\n            \"risk\": \"notSupplied\"\n        },\n        {\n            \"type\": \"avs\",\n            \"risk\": \"notChecked\",\n            \"detail\": \"address\"\n        },\n        {\n            \"type\": \"avs\",\n            \"risk\": \"notChecked\",\n            \"detail\": \"postcode\"\n        }\n    ],\n    \"issuer\": {\n        \"authorizationCode\": \"12345A\"\n    },\n    \"scheme\": {\n        \"reference\": \"060720116005060\"\n    },\n    \"updatedPaymentInstrument\": {\n        \"cardBin\": \"491183\",\n        \"lastFour\": \"0000\",\n        \"expiryDate\": {\n            \"month\": 9,\n            \"year\": 2031\n        },\n        \"cardBrand\": \"visa\",\n        \"fundingType\": \"credit\",\n        \"accountUpdaterMessage\": \"The account number was changed\",\n        \"type\": \"card/plain+masked\"\n    },\n    \"paymentInstrument\": {\n        \"type\": \"card/plain+masked\",\n        \"cardBin\": \"444433\",\n        \"lastFour\": \"1111\",\n        \"category\": \"consumer\",\n        \"expiryDate\": {\n            \"month\": 5,\n            \"year\": 2023\n        },\n        \"cardBrand\": \"visa\",\n        \"fundingType\": \"credit\",\n        \"issuerName\": \"Some Issuer PLC\",\n        \"paymentAccountReference\": \"Q1HJZ28RKA1EBL470G9XYG90R5D3E\"\n    },\n    \"_links\": {\n        \"cardPayments:cancel\": {\n            \"href\": \"https://try.access.worldpay.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiI=\"\n        },\n        \"cardPayments:partialCancel\": {\n            \"href\": \"https://try.access.worldpay.com/payments/authorizations/cancellations/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"cardPayments:settle\": {\n            \"href\": \"https://try.access.worldpay.com/payments/settlements/full/eyJrIjoiazNhYjYzMiI=\"\n        },\n        \"cardPayments:partialSettle\": {\n            \"href\": \"https://try.access.worldpay.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiI=\"\n        },\n        \"cardPayments:events\": {\n            \"href\": \"https://try.access.worldpay.com/payments/events/eyJrIjoiazNhYjYzMiI=\"\n        },\n        \"curies\": [\n            {\n                \"name\": \"cardPayments\",\n                \"href\": \"https://try.access.worldpay.com/rels/cardPayments/{rel}\",\n                \"templated\": true\n            }\n        ]\n    }\n}\n"},"children":[]}]}]},"headings":[{"value":"Account Updater","id":"account-updater","depth":1},{"value":"Receive real-time account updates","id":"receive-real-time-account-updates","depth":2},{"value":"Request","id":"request","depth":2},{"value":"Request example","id":"request-example","depth":3},{"value":"Response","id":"response","depth":2},{"value":"Response examples","id":"response-examples","depth":3}],"frontmatter":{"seo":{"title":"Account Updater | Card Payments API"}},"lastModified":"2025-09-22T09:15:26.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/card-payments/features/account-updater","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}