{"templateId":"markdown","versions":[{"version":"v2","label":"v2","link":"/products/account-payouts/v2/migration","default":false,"active":false,"folderId":"7d817e0b"},{"version":"20250101","label":"2025-01-01 (Latest)","link":"/products/account-payouts/migration","default":true,"active":true,"folderId":"7d817e0b"}],"sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"custom_product":"Account Payouts","type":"markdown"},"seo":{"title":"Migration Account Payouts","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay-bsh.securedataplatform.co.uk","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-bsh.securedataplatform.co.uk/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/**/*"]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"]},{"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/**/*"]},{"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/**/*"]},{"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/**/*"]},{"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/**/*"]},{"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/**/*"]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"]},{"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/**/*"]},{"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/**/*"]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"]},{"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/**/*"]}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"migration-account-payouts","__idx":0},"children":["Migration Account Payouts"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"version-2-to-version-2025-01-01","__idx":1},"children":["\"Version 2\" to \"Version 2025-01-01\""]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"details-that-have-changed-in-version-2025-01-01-from-v2","__idx":2},"children":["Details that have changed in version 2025-01-01 from v2:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Version is now date-based and has a specific header (rather than part of Accept/Content-Type)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["we have removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiRequestReference"]}," from the request body (replaced by the header key)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["we have removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instructingTreasuryId"]}," from the request body (now derived from the supplied credentials)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requester"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}," moved under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant"]}," object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}," value regex has changed"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instruction"]}," with the remaining payload"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["narrative"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purposeOfPayment"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["currencies and amounts moved under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["narrative"]}," object now has ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purposeOfPaymentCode"]}," is now under the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purposeOfPayment"]}," object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purposeOfPaymentNarrative"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," and under the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purposeOfPayment"]}," object"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["we have removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notificationUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bankDetails"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["beneficiaryBankDetails"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["beneficiaryAccountNumber"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountNumber"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["beneficiaryAccountTypeCode"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountType"]}," and is a string"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Address fields are updated",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["street"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalAddressLine"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postcodeOrZipCode"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postalCode"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addressTypeCode"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," (value is now a string)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["residentialStatusTypeCode"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["residentialStatus"]}," (value is now a string)"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partyTypeCode"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partyType"]}," (value is now a string)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["we have added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfIncorporation"]}," for companies"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["personalDetails ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["typeCode"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["values are now a string (\"individual\" is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["person"]},", \"company\" is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["company"]},", we have added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["soleTrader"]},")"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["titleCode"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}," (value is now a string)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["telephony"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phones"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phoneNumber"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identity"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identityDocuments"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identityTypeCode"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," (value is now a string)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identityNumber"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startDate"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endDate"]}," in the identity section are now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validFrom"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validTo"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerPartyId"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerReference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionTypeCode"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionType"]}," (value is now a string)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"for-the-store-beneficiary-data-we-have-added","__idx":3},"children":["For the store beneficiary data we have added:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrumentReference"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrumentId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partyReference"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"responses","__idx":4},"children":["Responses:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["we have amended response structure by removing codes and replacing with messages"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ubr"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutRequestId"]}]}]}]},"headings":[{"value":"Migration Account Payouts","id":"migration-account-payouts","depth":1},{"value":"\"Version 2\" to \"Version 2025-01-01\"","id":"version-2-to-version-2025-01-01","depth":2},{"value":"Details that have changed in version 2025-01-01 from v2:","id":"details-that-have-changed-in-version-2025-01-01-from-v2","depth":4},{"value":"For the store beneficiary data we have added:","id":"for-the-store-beneficiary-data-we-have-added","depth":4},{"value":"Responses:","id":"responses","depth":4}],"frontmatter":{"breadcrumbs":{"hide":true},"seo":{"title":"Migration Account Payouts"}},"lastModified":"2025-09-22T09:15:26.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/account-payouts/migration","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}