{"items":[{"type":"link","label":"Beneficiary Account Verifications (BAV)","link":"/products/account-verifications/openapi","routeSlug":"/products/account-verifications/openapi","content":{"contentType":"overview","meta":{"name":"Beneficiary Account Verifications (BAV)"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/account-verifications/@20250101/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/account-verifications/@20250101/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"csharp","title":"C#","lang":"C#"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Beneficiary Account Verifications (BAV) (2025-01-01)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify that the bank details of your beneficiary are valid before sending a payout."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Authorization: {your_credentials}\n  WP-Api-Version: 2025-01-01\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Authorization: {your_credentials}\n  WP-Api-Version: 2025-01-01\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{your_credentials}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for any request you send to our Beneficiary Account Verifications API, unless you are using client certificate "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/security"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authenticating with SSL/TLS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS whitelisting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist the following URLs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://try.access.worldpay.com/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay.com/"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned."},"children":[]}]}]}]}],"sectionId":"/products/account-verifications/openapi"}],"sectionId":"/products/account-verifications/openapi"}]}]}},{"label":"Verify a beneficiary account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/account-verifications/openapi/other/postaccountverifications","routeSlug":"/products/account-verifications/openapi/other/postaccountverifications","metadata":{"seo":{"title":"Verify a beneficiary account","description":"Verify a beneficiary account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAccountVerifications","name":"Verify a beneficiary account","isWebhook":false,"pointer":"/paths/~1accountVerifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a beneficiary account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_304","required":true,"example":"2025-01-01"},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_304","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1accountVerifications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/postRequestItems","exampleIds":["paths/~1accountVerifications/post/requestBody/content/application~1json/examples/Validate an account"]}},"schemaId":"components/schemas/postRequestItems","exampleIds":["paths/~1accountVerifications/post/requestBody/content/application~1json/examples/Validate an account"],"pointer":"/paths/~1accountVerifications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accountVerifications","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_304"},{"name":"WP-CorrelationId","in":"header","required":false,"example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_304"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/postRequestItems","exampleIds":["paths/~1accountVerifications/post/requestBody/content/application~1json/examples/Validate an account"]}},"responseCodes":["200","400","401","403","500"],"pointer":"/accountVerifications","href":"other/postaccountverifications","openApiOperationId":"postAccountVerifications","summary":"Verify a beneficiary account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/postRequestItems","exampleIds":["paths/~1accountVerifications/post/requestBody/content/application~1json/examples/Validate an account"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/postRequestItems","exampleIds":["paths/~1accountVerifications/post/requestBody/content/application~1json/examples/Validate an account"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK response if the request is valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BAV200response","exampleIds":["paths/~1accountVerifications/post/responses/200/content/application~1json/examples/fullMatch","paths/~1accountVerifications/post/responses/200/content/application~1json/examples/partialMatch","paths/~1accountVerifications/post/responses/200/content/application~1json/examples/noMatch"]}},"schemaId":"components/schemas/BAV200response","exampleIds":["paths/~1accountVerifications/post/responses/200/content/application~1json/examples/fullMatch","paths/~1accountVerifications/post/responses/200/content/application~1json/examples/partialMatch","paths/~1accountVerifications/post/responses/200/content/application~1json/examples/noMatch"]},{"code":"400","description":"BAD REQUEST response if the request is not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BAV400response","exampleIds":["paths/~1accountVerifications/post/responses/400/content/application~1json/examples/AccountType is not provided","paths/~1accountVerifications/post/responses/400/content/application~1json/examples/IBAN or AccountNumber is not provided","paths/~1accountVerifications/post/responses/400/content/application~1json/examples/Party.Type is not provided"]}},"schemaId":"components/schemas/BAV400response","exampleIds":["paths/~1accountVerifications/post/responses/400/content/application~1json/examples/AccountType is not provided","paths/~1accountVerifications/post/responses/400/content/application~1json/examples/IBAN or AccountNumber is not provided","paths/~1accountVerifications/post/responses/400/content/application~1json/examples/Party.Type is not provided"]},{"code":"401","description":"UNAUTHORIZED response if credentials are invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"FORBIDDEN response if Entitlements are not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/403/content/application~1json/examples/forbidden"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1accountVerifications/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BAV200response","exampleIds":["paths/~1accountVerifications/post/responses/200/content/application~1json/examples/fullMatch","paths/~1accountVerifications/post/responses/200/content/application~1json/examples/partialMatch","paths/~1accountVerifications/post/responses/200/content/application~1json/examples/noMatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BAV200response","exampleIds":["paths/~1accountVerifications/post/responses/200/content/application~1json/examples/fullMatch","paths/~1accountVerifications/post/responses/200/content/application~1json/examples/partialMatch","paths/~1accountVerifications/post/responses/200/content/application~1json/examples/noMatch"]}}},{"code":"400","schemaId":"components/schemas/BAV400response","exampleIds":["paths/~1accountVerifications/post/responses/400/content/application~1json/examples/AccountType is not provided","paths/~1accountVerifications/post/responses/400/content/application~1json/examples/IBAN or AccountNumber is not provided","paths/~1accountVerifications/post/responses/400/content/application~1json/examples/Party.Type is not provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BAV400response","exampleIds":["paths/~1accountVerifications/post/responses/400/content/application~1json/examples/AccountType is not provided","paths/~1accountVerifications/post/responses/400/content/application~1json/examples/IBAN or AccountNumber is not provided","paths/~1accountVerifications/post/responses/400/content/application~1json/examples/Party.Type is not provided"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accountVerifications/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/postaccountverifications"}],"panels":[]}]},"httpPath":"/accountVerifications"}],"store":{"schemaStore":{"components/schemas/postRequestItems":{"id":"components/schemas/postRequestItems","kind":"json-schema","title":"postRequestItems","data":{"required":["merchant","instructions"],"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/merchantItems"},"instructions":{"items":{"$ref":"#/components/schemas/instructionsItems"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently only one instruction is accepted."},"children":[]}]}]}]}}}},"components/schemas/merchantItems":{"id":"components/schemas/merchantItems","kind":"json-schema","title":"merchantItems","data":{"required":["entity"],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" View our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/account-verifications/coverage"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank coverage guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for country specific requirements."},"children":[]}]}]}],"properties":{"entity":{"type":"string","description":"Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay.","example":"default"}}}},"components/schemas/instructionsItems":{"id":"components/schemas/instructionsItems","kind":"json-schema","title":"instructionsItems","data":{"required":["party"],"type":"object","properties":{"party":{"$ref":"#/components/schemas/partyItems"},"expandableKeyValuePairs":{"type":"object","description":"JSON object of key-value pairs used to supply additional data. The keys and values that you might need to process an account payout to a specific destination, are communicated during the on-boarding process. Duplicate key names are not allowed.","nullable":true}}}},"components/schemas/partyItems":{"id":"components/schemas/partyItems","kind":"json-schema","title":"partyItems","data":{"required":["type","payoutInstrument","personalDetails"],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of this party. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type is accepted."},"children":[]}]}]}],"example":"beneficiary"},"payoutInstrument":{"$ref":"#/components/schemas/payoutInstrumentItems"},"personalDetails":{"$ref":"#/components/schemas/personalDetailsItems"}}}},"components/schemas/payoutInstrumentItems":{"id":"components/schemas/payoutInstrumentItems","kind":"json-schema","title":"payoutInstrumentItems","data":{"required":["accountType","address"],"type":"object","description":"An object that holds details of your payout instrument.\n\n","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"bankAccount"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GBP","maxLength":3,"minLength":3,"pattern":"^[A-Z]*$"},"iban":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary IBAN. You must either provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iban"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GB41CITI18500818404062"},"accountNumber":{"type":"number","example":123456},"accountHolderName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full name of the beneficiary. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a mandatory element of the request body when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are missing."},"children":[]}]}]}],"example":"John Smith"},"accountType":{"type":"string","description":"Type of the account bank.","enum":["checking","savings","moneyMarket","certificateOfDeposit","vista","other"]},"bankCode":{"type":"string","description":"The code of the bank which must be exactly six digits.","example":"184758"},"bankName":{"type":"string","example":"Demo Bank"},"branchCode":{"type":"string","example":1234},"swiftBic":{"type":"string","example":"DBbic01"},"address":{"$ref":"#/components/schemas/payoutInstrumentAddressItems"}}}},"components/schemas/payoutInstrumentAddressItems":{"id":"components/schemas/payoutInstrumentAddressItems","kind":"json-schema","title":"payoutInstrumentAddressItems","data":{"required":["countryCode"],"type":"object","properties":{"type":{"type":"string","description":"Identifies the type of this address.","enum":["home","business","poBox","other"]},"address1":{"type":"string","description":"The address. Must consist of at least two letters, two words, and one number."},"address2":{"type":"string","description":"Line two of the address."},"city":{"type":"string","description":"The city of this address."},"postalCode":{"type":"string","description":"The postal code of this address."},"countryCode":{"maxLength":2,"minLength":2,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code specified in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/access/products/reference/supported-countries-currencies#iso-country-currencies"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 Alpha-2 country code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GB"}}}},"components/schemas/personalDetailsItems":{"id":"components/schemas/personalDetailsItems","kind":"json-schema","title":"personalDetailsItems","data":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the party represents:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an individual"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a corporation     or partnership with multiple owners.."},"children":[]}]}]}],"example":"personal"},"title":{"type":"string","description":"The title for this person.","enum":["mr","mrs","miss","ms","dr","mx","misc"],"example":"mr"},"firstName":{"type":"string","maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name of the beneficiary. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mandatory elements of the request body when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing."},"children":[]}]}]}],"example":"John"},"middleName":{"type":"string","maxLength":35,"description":"Middle name name of the beneficiary."},"lastName":{"type":"string","maxLength":35,"description":"Last name name of the beneficiary.","example":"Smith"},"dateOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was born."},"children":[]}]}]}]},"companyName":{"type":"string","maxLength":70,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company name. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountHolderName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not present and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"dateOfIncorporation":{"type":"string","description":"The incorporation date for the company."},"email":{"type":"string","description":"An email address for this party."},"phones":{"type":"array","description":"A list of phone numbers associated with this party.","items":{"$ref":"#/components/schemas/phoneItems"}}}}},"components/schemas/phoneItems":{"id":"components/schemas/phoneItems","kind":"json-schema","title":"phoneItems","data":{"type":"object","description":"Object containing phone information.","properties":{"number":{"type":"string","description":"The phone number, without dashes.","example":"4281234","pattern":"[0-9]{1,20}"},"prefix":{"type":"string","description":"The dialing prefix for the phone number.","example":"44","pattern":"^[0-9]{1,3}$"}}}},"components/schemas/BAV200response":{"id":"components/schemas/BAV200response","kind":"json-schema","title":"BAV200response","data":{"required":["outcome"],"type":"object","properties":{"outcome":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All possible outcomes and description can be found in the below table: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outcome"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fullMatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Details Matched"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessAccountNameMatched"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account name matches but the account is a business account, not a personal account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partialMatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Close match found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"businessAccountCloseMatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Close match found for account name but the account is a business account, not a personal account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"noMatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account name and account type do not match"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountDoesNotExist"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account does not exist"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"noResponse"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bank did not respond to the account name check request. Try again later."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected system error occurred. Try again later."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountNotSupported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account does not support account name check requests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountSwitched"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account has been switched using the Current Account Switching Service"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notEnrolled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account name check could not be completed as the bank does not accept account name check requests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wrongParticipant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account name check cannot be completed for the account number and sort code provided"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secondaryAccountIdNotFound"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The secondary account id is not valid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalAccountNameMatched"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account name matches but the account is a personal account, not a business account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalAccountCloseMatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Close match found for account name but the account is a personal account, not a business account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountActive"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account is active but Name match unavailable for this account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannotValidate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unable to Validate the Account Details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountClosed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Account is either Closed or Unavailable to receive payments"},"children":[]}]}]}]}]}]}],"type":"string"},"message":{"description":"Description message.","type":"string"},"actualAccountHolderName":{"description":"Account owner name after the payload is processed. Availability is subject to market standard.","type":"string"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"description":"The unique error name.","type":"string"},"message":{"description":"Error description message.","type":"string"}}}},"components/schemas/BAV400response":{"id":"components/schemas/BAV400response","kind":"json-schema","title":"BAV400response","data":{"type":"object","required":["validationErrors","errorName","message"],"properties":{"validationErrors":{"description":"Object containing details of validation errors occurred","type":"array","items":{"$ref":"#/components/schemas/ErrorResponse400Item"}},"errorName":{"description":"The unique error name.","type":"string"},"message":{"description":"Error description message.","type":"string"}}}},"components/schemas/ErrorResponse400Item":{"id":"components/schemas/ErrorResponse400Item","kind":"json-schema","title":"ErrorResponse400Item","data":{"type":"object","required":["queryParameter","errorName","message"],"properties":{"queryParameter":{"description":"Parameter for which the error occurred.","type":"string"},"errorName":{"description":"Unique name of the validation error.","type":"string"},"message":{"description":"Error description message.","type":"string"}}}},"schema_304":{"kind":"json-schema","data":{"type":"string"},"id":"schema_304"}},"exampleStore":{"paths/~1accountVerifications/post/requestBody/content/application~1json/examples/Validate an account":{"value":{"merchant":{"entity":"default"},"instructions":[{"party":{"type":"beneficiary","payoutInstrument":{"type":"bankAccount","currency":"GBP","iban":"GB41CITI18500818404062","accountHolderName":"John Smith","accountNumber":"123456","bankCode":"184758","bankName":"Demo Bank","branchCode":"1234","swiftBic":"DBbic01","accountType":"checking","address":{"type":"personal","address1":"Main Bvd","address2":"No 1","city":"London","postalCode":"012345","countryCode":"GB"}},"personalDetails":{"type":"personal","title":"Mr","firstName":"John","middleName":"","lastName":"Smith","dateOfBirth":"2000-01-01","companyName":"Co Name","dateOfIncorporation":"2025-01-01","email":"john@domain.com","phones":[{"number":"7777777777","prefix":"44"}]}},"expandableKeyValuePairs":{"key":"value"}}]},"key":"Validate an account","summary":"Validate an account","id":"paths/~1accountVerifications/post/requestBody/content/application~1json/examples/Validate an account"},"paths/~1accountVerifications/post/responses/200/content/application~1json/examples/fullMatch":{"value":{"outcome":"fullMatch","message":"Account Details Matched","actualAccountHolderName":""},"key":"fullMatch","summary":"fullMatch","id":"paths/~1accountVerifications/post/responses/200/content/application~1json/examples/fullMatch"},"paths/~1accountVerifications/post/responses/200/content/application~1json/examples/partialMatch":{"value":{"outcome":"partialMatch","message":"Close match found","actualAccountHolderName":"John Smith"},"key":"partialMatch","summary":"partialMatch","id":"paths/~1accountVerifications/post/responses/200/content/application~1json/examples/partialMatch"},"paths/~1accountVerifications/post/responses/200/content/application~1json/examples/noMatch":{"value":{"outcome":"noMatch","message":"Account name and account type do not match","actualAccountHolderName":"John Smith"},"key":"noMatch","summary":"noMatch","id":"paths/~1accountVerifications/post/responses/200/content/application~1json/examples/noMatch"},"paths/~1accountVerifications/post/responses/400/content/application~1json/examples/AccountType is not provided":{"value":{"validationErrors":[{"jsonPath":"$.instructions[0].party.payoutInstrument.accountType","errorName":"fieldHasInvalidValue","message":"Invalid AccountType value."}],"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema"},"key":"AccountType is not provided","summary":"AccountType is not provided","id":"paths/~1accountVerifications/post/responses/400/content/application~1json/examples/AccountType is not provided"},"paths/~1accountVerifications/post/responses/400/content/application~1json/examples/IBAN or AccountNumber is not provided":{"value":{"validationErrors":[{"jsonPath":"$.instructions[0].party.payoutInstrument.iban","errorName":"fieldIsMissing","message":"The identified field is missing. Iban is a mandatory element of the request body when accountNumber is missing."}],"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema"},"key":"IBAN or AccountNumber is not provided","summary":"IBAN or AccountNumber is not provided","id":"paths/~1accountVerifications/post/responses/400/content/application~1json/examples/IBAN or AccountNumber is not provided"},"paths/~1accountVerifications/post/responses/400/content/application~1json/examples/Party.Type is not provided":{"value":{"validationErrors":[{"jsonPath":"$.instructions[0].party.type","errorName":"fieldIsMissing","message":"The identified field is missing. This field is a mandatory element of the request body."}],"errorName":"bodyDoesNotMatchSchema,","message":"The json body provided does not match the expected schema"},"key":"Party.Type is not provided","summary":"Party.Type is not provided","id":"paths/~1accountVerifications/post/responses/400/content/application~1json/examples/Party.Type is not provided"},"paths/~1accountVerifications/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"errorName":"unauthorizedRequest","message":"User is not authorized to access this resource"},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1accountVerifications/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1accountVerifications/post/responses/403/content/application~1json/examples/forbidden":{"value":{"errorName":"forbidden","message":"User is not entitled to access this resource"},"key":"forbidden","summary":"forbidden","id":"paths/~1accountVerifications/post/responses/403/content/application~1json/examples/forbidden"},"paths/~1accountVerifications/post/responses/500/content/application~1json/example":{"value":{"errorName":"internalErrorOccurred","message":"An unexpected error occured while processing the request"},"id":"paths/~1accountVerifications/post/responses/500/content/application~1json/example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":7,"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"Python"},{"lang":"Java"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"C#"}]},"feedback":{"type":"sentiment","settings":{"label":"Do you like our page?","submitText":"Thanks for your feedback","comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/access/_bundle/products/account-verifications/@20250101/openapi.json?download"},{"url":"/access/_bundle/products/account-verifications/@20250101/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Beneficiary Account Verifications (BAV)","description":"\nVerify that the bank details of your beneficiary are valid before sending a payout.<br><br>\n__Authentication header__\n  ```\n    Authorization: {your_credentials}\n    WP-Api-Version: 2025-01-01\n  ```\n  Replace `{your_credentials}` with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.\n  <br /> <br />\n  You **must** use the `Authorization` header for any request you send to our Beneficiary Account Verifications API, unless you are using client certificate [authenticating with SSL/TLS](/products/reference/security).\n  <br /><br />\n\n\n__DNS whitelisting__\n\nWhitelist the following URLs:\n* `https://try.access.worldpay.com/`\n* `https://access.worldpay.com/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","category":["Verifications"],"business":["Enterprise","Marketplaces"],"catalog-list":true}},"baseSlug":"/products/account-verifications/openapi","routesMapping":{}}