{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Raw Response Codes | 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":"formatting","__idx":0},"children":["Formatting"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transactionreference-format","__idx":1},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}," format"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}," must be a ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["uniquely"]}," generated identifier"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Our Try (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/"]},") environment returns a bad request error if a duplicate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}," is supplied"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["64"]}," characters max. We recommend your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}," contains between 9-20 characters for ease of onward processing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This safeguards you against acquirers who truncate the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported format, structure and limits for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]},":"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Valid characters:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hyphen ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Underscore ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Forward Slash ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Exclamation mark ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["At ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Pound, number sign, sharp or hash ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["#"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Dollar ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Percent ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["%"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Parenthesis ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["()"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Asterisk ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Equal ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["="]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Full stop ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Colon ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":[":"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Semi-colon ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":[";"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Question mark ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Brackets ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Braces or Curly braces ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{}"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tilde ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["~"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Plus ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["+"]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Caution"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some characters, for example: Parenthesis ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["()"]}]}," or Semi-colon ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":[";"]}]},", can trigger our Web Application Firewall (WAF) rules to block your requests, if used in a combination that might be interpreted as an attempt to inject a command."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference-format","__idx":2},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]}," format"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This format applies for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]}," parameter in partial settlement and partial refund requests"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]}," must be between 1-128 characters"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Valid characters:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hyphen ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-"]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"narrative-format","__idx":3},"children":["Narrative format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["narrative"]}," object helps your customers to better identify you on their statement."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"narrative-line1","__idx":4},"children":["Narrative ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line1"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line1"]}," is used to provide basic details about the merchant."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line1"]}," is mandatory and must be included in your request."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported format, structure and limits for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line1"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["this has to be a consistent identifier"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["there is a limit of ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["24"]}," characters (25 characters for Payouts v1)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["it is not guaranteed that the bank will show this on the customer's statement"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z (these may appear as upper case in the statement)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["hyphen ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["full stop ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["commas ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":[","]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["space"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"narrative-line2","__idx":5},"children":["Narrative ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line2"]}," is used for additional context about the payment or merchant. eg Order number or Merchant phone number."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line2"]}," is not mandatory."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported format, structure and limits for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line2"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["free form"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["there is a limit of ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["24"]}," characters"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z (these may appear as upper case in the statement)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["hyphen ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["full stop ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["commas ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":[","]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["space"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"narrative-payouts-api-only","__idx":6},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["narrative"]}," (Payouts API only)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported format, structure and limits for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["narrative"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["free form"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["there is a limit of ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["24"]}," characters"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payment-facilitator-format","__idx":7},"children":["Payment facilitator format"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schemeId"]}," - Your payment facilitator ID received from Mastercard, Visa or Amex."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Please ensure you add the correct ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schemeId"]}," to the right brand."]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["independentSalesOrganizationId"]}," - Independent Sales Organization (ISO) ID provided by Mastercard. If an ISO is involved in the transaction, you must send this information."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant"]}," - your sub-merchant's details which includes:"]}]}]},{"$$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":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of your subMerchants company.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["space"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Max 25 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.reference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The subMerchant ID. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Max 15 digits."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The address of your subMerchant company."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.city"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["hyphen(-)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["space"]}]},"Max 13 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.state"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]}]}," Max 3 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.postalCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["space"]}]},"Max 10 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.countryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO 3166-1 alpha-2 code. Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]}]},"E.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GB"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Max 2 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.street"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["space"]}]},"Max 50 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.taxReference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The subMerchant's tax reference. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["space"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["hyphen(-)"]}]},"Max 20 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The subMerchant's email address. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["@"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["space"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["hyphen(-)"]}]},"Max 40 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.phoneNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The subMerchant's phone number. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["0-9"]}]},"Max 20 characters."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"marketplace-format","__idx":8},"children":["Marketplace format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Marketplaces can optionally provide further information in both full and partial settlement calls."]},{"$$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":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["marketplace.sellerCountryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The country where the seller is domiciled.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Max 2 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["marketplace.splitFundingreference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your reference for split funding.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Valid characters:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A-Z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a-z"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["hyphen(-)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["space"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Max 256 characters."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"name-field-formatting-account-payouts-api","__idx":9},"children":["Name field formatting (Account Payouts API)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["First, middle, last and company names must follow specific field requirements for length and content. Below are regular expressions for permissible values of these fields:"]},{"$$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":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data type/format"},"children":["Data type/format"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Length requirement"},"children":["Length requirement"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Regular expression"},"children":["Regular expression"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["parties.personalDetails.companyName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Max 140"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Failure to provide the full name could result in delays and potential rejection of your payment. This should consist of 2 words, separated by a space. If the value is a one-word business name please contact your Relationship Manager."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["parties.personalDetails.firstName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Max 50"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The full name (firstName + middleName + lastName) should not be longer than 140 characters in total."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["parties.personalDetails.middleName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Max 50"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The full name (firstName + middleName + lastName) should not be longer than 140 characters in total."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["parties.personalDetails.lastName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Max 50"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The full name (firstName + middleName + lastName) should not be longer than 140 characters in total."]}]}]}]}]}]},"headings":[{"value":"Formatting","id":"formatting","depth":1},{"value":"transactionReference format","id":"transactionreference-format","depth":2},{"value":"reference format","id":"reference-format","depth":2},{"value":"Narrative format","id":"narrative-format","depth":2},{"value":"Narrative line1","id":"narrative-line1","depth":3},{"value":"Narrative line2","id":"narrative-line2","depth":3},{"value":"narrative (Payouts API only)","id":"narrative-payouts-api-only","depth":3},{"value":"Payment facilitator format","id":"payment-facilitator-format","depth":2},{"value":"Marketplace format","id":"marketplace-format","depth":2},{"value":"Name field formatting (Account Payouts API)","id":"name-field-formatting-account-payouts-api","depth":2}],"frontmatter":{"seo":{"title":"Raw Response Codes | Worldpay Developer"},"sidebar":{"path":"../../sidebars.yaml"}},"lastModified":"2025-09-22T09:15:26.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/reference/formatting","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}