{"items":[{"type":"link","label":"Parties","link":"/products/parties/openapi","routeSlug":"/products/parties/openapi","content":{"contentType":"overview","meta":{"name":"Parties"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/parties/@20250101/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/parties/@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":"Parties (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":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks."},"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":"Authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set your headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: {your_credentials}\nWP-Api-Version: 2025-01-01\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: {your_credentials}\nWP-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."},"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."},"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":"API collection"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full set of API examples based on different scenarios."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/access/collections/parties/20250101/OpenApiDocExamples.postman_collection.json","download":"wp-parties-api-postman"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download Postman collection "},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/access/collections/parties/20250101/Try environment.postman_environment.json","download":"wp-parties-api-postman-try-env"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download environment config for try env "},"children":[]}]}]}]}]}]}],"sectionId":"/products/parties/openapi"}],"sectionId":"/products/parties/openapi"}]}]}},{"type":"group","label":"Parties","link":"/products/parties/openapi/parties","routeSlug":"/products/parties/openapi/parties","items":[{"label":"Create a party","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/createaccount","routeSlug":"/products/parties/openapi/parties/createaccount","metadata":{"seo":{"title":"Create a party","description":"Create a party"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccount","name":"Create a party","isWebhook":false,"pointer":"/paths/~1parties/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a party","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_419","exampleIds":["paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader with trading address (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company with trading address different than legal address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company without trading address (modular)"]}},"schemaId":"schema_419","exampleIds":["paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader with trading address (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company with trading address different than legal address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company without trading address (modular)"],"pointer":"/paths/~1parties/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/parties","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_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_419","exampleIds":["paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader with trading address (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company with trading address different than legal address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company without trading address (modular)"]}},"responseCodes":["201","400","500","503"],"pointer":"/parties","href":"parties/createaccount","openApiOperationId":"createAccount","summary":"Create a party"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"schema_419","exampleIds":["paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader with trading address (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company with trading address different than legal address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company without trading address (modular)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_419","exampleIds":["paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader with trading address (modular)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company with trading address different than legal address (orchestrated)","paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company without trading address (modular)"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420","exampleIds":["paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person (modular)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader with trading address (modular)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company with tradingAddress different than legalAddress (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company without trading address (modular)"]}},"schemaId":"schema_420","exampleIds":["paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person (modular)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader with trading address (modular)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company with tradingAddress different than legalAddress (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company without trading address (modular)"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties/post/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties/post/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_420","exampleIds":["paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person (modular)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader with trading address (modular)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company with tradingAddress different than legalAddress (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company without trading address (modular)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420","exampleIds":["paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person (modular)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader with trading address (modular)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company with tradingAddress different than legalAddress (orchestrated)","paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company without trading address (modular)"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties/post/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties/post/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/post/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parties/createaccount"}],"panels":[]}]},"httpPath":"/parties"},{"label":"Browse parties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/browseparties","routeSlug":"/products/parties/openapi/parties/browseparties","metadata":{"seo":{"title":"Browse parties","description":"Browse parties and optionally filtered by criteria. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"browseParties","name":"Browse parties","isWebhook":false,"pointer":"/paths/~1parties/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Browse parties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Browse parties and optionally filtered by criteria. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_421","description":"Positive whole number indicating which page of the selected parties to return. Greater than 0.","example":5},{"name":"size","in":"query","schemaId":"schema_422","description":"Number of items listed per page.","example":10},{"name":"entity","in":"query","schemaId":"schema_423","description":"Entity or entities to filter parties by.","example":["Entity123","Entity456"]},{"name":"active","in":"query","schemaId":"schema_424","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns parties that are active when set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"type","in":"query","schemaId":"schema_425","description":"Type of parties to return."}],"pointer":"/paths/~1parties/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/parties","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":5,"schemaId":"schema_421"},{"name":"size","in":"query","required":false,"example":10,"schemaId":"schema_422"},{"name":"entity","in":"query","required":false,"example":["Entity123","Entity456"],"schemaId":"schema_423"},{"name":"active","in":"query","required":false,"example":true,"schemaId":"schema_424"},{"name":"type","in":"query","required":false,"example":["soleTrader","company"],"schemaId":"schema_425"}],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","500","503"],"pointer":"/parties","href":"parties/browseparties","openApiOperationId":"browseParties","summary":"Browse parties"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrowsePartiesPage","exampleIds":["paths/~1parties/get/responses/200/content/application~1json/examples/Browse parties"]}},"schemaId":"components/schemas/BrowsePartiesPage","exampleIds":["paths/~1parties/get/responses/200/content/application~1json/examples/Browse parties"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BrowsePartiesPage","exampleIds":["paths/~1parties/get/responses/200/content/application~1json/examples/Browse parties"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrowsePartiesPage","exampleIds":["paths/~1parties/get/responses/200/content/application~1json/examples/Browse parties"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties/get/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parties/browseparties"}],"panels":[]}]},"httpPath":"/parties"},{"label":"View a party","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/partyquery","routeSlug":"/products/parties/openapi/parties/partyquery","metadata":{"seo":{"title":"View a party","description":"Retrieve information about a party."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partyQuery","name":"View a party","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View a party","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve information about a party."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true,"example":"parV1StGXR8_Z5jdHi6B-myF0"}],"pointer":"/paths/~1parties~1{partyId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/parties/{partyId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"example":"parV1StGXR8_Z5jdHi6B-myF0","schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}","href":"parties/partyquery","openApiOperationId":"partyQuery","summary":"View a party"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427","exampleIds":["paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a person ","paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a sole trader","paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a company"]}},"schemaId":"schema_427","exampleIds":["paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a person ","paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a sole trader","paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a company"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_427","exampleIds":["paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a person ","paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a sole trader","paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a company"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427","exampleIds":["paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a person ","paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a sole trader","paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a company"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parties/partyquery"}],"panels":[]}]},"httpPath":"/parties/{partyId}"},{"label":"Update a party","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/updateparty","routeSlug":"/products/parties/openapi/parties/updateparty","metadata":{"seo":{"title":"Update a party","description":"Update a party"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateParty","name":"Update a party","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a party","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_419","exampleIds":["paths/~1parties~1{partyId}/put/requestBody/content/application~1json/examples/Update a party for a person"]}},"schemaId":"schema_419","exampleIds":["paths/~1parties~1{partyId}/put/requestBody/content/application~1json/examples/Update a party for a person"],"pointer":"/paths/~1parties~1{partyId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/parties/{partyId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_419","exampleIds":["paths/~1parties~1{partyId}/put/requestBody/content/application~1json/examples/Update a party for a person"]}},"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}","href":"parties/updateparty","openApiOperationId":"updateParty","summary":"Update a party"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"schema_419","exampleIds":["paths/~1parties~1{partyId}/put/requestBody/content/application~1json/examples/Update a party for a person"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_419","exampleIds":["paths/~1parties~1{partyId}/put/requestBody/content/application~1json/examples/Update a party for a person"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427","exampleIds":["paths/~1parties~1{partyId}/put/responses/200/content/application~1json/examples/Update Party"]}},"schemaId":"schema_427","exampleIds":["paths/~1parties~1{partyId}/put/responses/200/content/application~1json/examples/Update Party"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_427","exampleIds":["paths/~1parties~1{partyId}/put/responses/200/content/application~1json/examples/Update Party"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427","exampleIds":["paths/~1parties~1{partyId}/put/responses/200/content/application~1json/examples/Update Party"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parties/updateparty"}],"panels":[]}]},"httpPath":"/parties/{partyId}"},{"label":"Deactivate a party","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/deactivateparty","routeSlug":"/products/parties/openapi/parties/deactivateparty","metadata":{"seo":{"title":"Deactivate a party","description":"Deactivate a party"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateParty","name":"Deactivate a party","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1deactivation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a party","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1deactivation/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1deactivation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeactivateParty","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/requestBody/content/application~1json/examples/Deactivate a party"]}},"schemaId":"components/schemas/DeactivateParty","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/requestBody/content/application~1json/examples/Deactivate a party"],"pointer":"/paths/~1parties~1{partyId}~1deactivation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/parties/{partyId}/deactivation","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeactivateParty","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/requestBody/content/application~1json/examples/Deactivate a party"]}},"responseCodes":["200","400","500"],"pointer":"/parties/{partyId}/deactivation","href":"parties/deactivateparty","openApiOperationId":"deactivateParty","summary":"Deactivate a party"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/DeactivateParty","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/requestBody/content/application~1json/examples/Deactivate a party"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeactivateParty","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/requestBody/content/application~1json/examples/Deactivate a party"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeactivateParty","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/responses/200/content/application~1json/examples/Deactivate a party"]}},"schemaId":"components/schemas/DeactivateParty","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/responses/200/content/application~1json/examples/Deactivate a party"]},{"code":"400","description":"Bad Request","mediaType":"application/hal+json","mediaTypes":["application/hal+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/responses/500/content/application~1json/examples/Internal error occurred"]}],"pointer":"/paths/~1parties~1{partyId}~1deactivation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeactivateParty","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/responses/200/content/application~1json/examples/Deactivate a party"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeactivateParty","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/responses/200/content/application~1json/examples/Deactivate a party"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/hal+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1deactivation/post/responses/500/content/application~1json/examples/Internal error occurred"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parties/deactivateparty"}],"panels":[]}]},"httpPath":"/parties/{partyId}/deactivation"},{"label":"Reactivate a party","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/reactivateparty","routeSlug":"/products/parties/openapi/parties/reactivateparty","metadata":{"seo":{"title":"Reactivate a party","description":"Reactivate a party"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reactivateParty","name":"Reactivate a party","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1activation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reactivate a party","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1activation/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1activation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReactivateParty","exampleIds":["paths/~1parties~1{partyId}~1activation/post/requestBody/content/application~1json/examples/Reactivate a party"]}},"schemaId":"components/schemas/ReactivateParty","exampleIds":["paths/~1parties~1{partyId}~1activation/post/requestBody/content/application~1json/examples/Reactivate a party"],"pointer":"/paths/~1parties~1{partyId}~1activation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/parties/{partyId}/activation","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReactivateParty","exampleIds":["paths/~1parties~1{partyId}~1activation/post/requestBody/content/application~1json/examples/Reactivate a party"]}},"responseCodes":["200","400","500"],"pointer":"/parties/{partyId}/activation","href":"parties/reactivateparty","openApiOperationId":"reactivateParty","summary":"Reactivate a party"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/ReactivateParty","exampleIds":["paths/~1parties~1{partyId}~1activation/post/requestBody/content/application~1json/examples/Reactivate a party"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReactivateParty","exampleIds":["paths/~1parties~1{partyId}~1activation/post/requestBody/content/application~1json/examples/Reactivate a party"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReactivateParty","exampleIds":["paths/~1parties~1{partyId}~1activation/post/responses/200/content/application~1json/examples/Reactivate a party"]}},"schemaId":"components/schemas/ReactivateParty","exampleIds":["paths/~1parties~1{partyId}~1activation/post/responses/200/content/application~1json/examples/Reactivate a party"]},{"code":"400","description":"Bad Request","mediaType":"application/hal+json","mediaTypes":["application/hal+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1activation/post/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1activation/post/responses/500/content/application~1json/examples/Internal error occurred"]}],"pointer":"/paths/~1parties~1{partyId}~1activation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReactivateParty","exampleIds":["paths/~1parties~1{partyId}~1activation/post/responses/200/content/application~1json/examples/Reactivate a party"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReactivateParty","exampleIds":["paths/~1parties~1{partyId}~1activation/post/responses/200/content/application~1json/examples/Reactivate a party"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/hal+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1activation/post/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1activation/post/responses/500/content/application~1json/examples/Internal error occurred"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parties/reactivateparty"}],"panels":[]}]},"httpPath":"/parties/{partyId}/activation"}],"content":{"contentType":"group","meta":{"name":"Parties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Parties","showPageActions":true},{"nodeType":"markdoc","content":"Create and maintain parties."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/parties","summary":"Create a party","prefix":{"name":"post","color":"post"},"badges":[],"link":"/parties/createaccount","deprecated":false},{"title":"/parties","summary":"Browse parties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parties/browseparties","deprecated":false},{"title":"/parties/{partyId}","summary":"View a party","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parties/partyquery","deprecated":false},{"title":"/parties/{partyId}","summary":"Update a party","prefix":{"name":"put","color":"put"},"badges":[],"link":"/parties/updateparty","deprecated":false},{"title":"/parties/{partyId}/deactivation","summary":"Deactivate a party","prefix":{"name":"post","color":"post"},"badges":[],"link":"/parties/deactivateparty","deprecated":false},{"title":"/parties/{partyId}/activation","summary":"Reactivate a party","prefix":{"name":"post","color":"post"},"badges":[],"link":"/parties/reactivateparty","deprecated":false}]}]}]}]}},{"type":"group","label":"Payout instruments","link":"/products/parties/openapi/payout-instruments","routeSlug":"/products/parties/openapi/payout-instruments","items":[{"label":"Create a payout instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/payout-instruments/createpayoutinstruments","routeSlug":"/products/parties/openapi/payout-instruments/createpayoutinstruments","metadata":{"seo":{"title":"Create a payout instrument","description":"Create a payout instrument"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPayoutInstruments","name":"Create a payout instrument","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payout instrument","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_428","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of sole trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"]}},"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of sole trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/parties/{partyId}/payoutInstruments","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_428"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of sole trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"]}},"responseCodes":["201","400","500","503"],"pointer":"/parties/{partyId}/payoutInstruments","href":"payout-instruments/createpayoutinstruments","openApiOperationId":"createPayoutInstruments","summary":"Create a payout instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of sole trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of sole trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of sole Trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"]}},"schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of sole Trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of sole Trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of sole Trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments/post/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout-instruments/createpayoutinstruments"}],"panels":[]}]},"httpPath":"/parties/{partyId}/payoutInstruments"},{"label":"View a payout instrument","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/payout-instruments/getpayoutinstrument","routeSlug":"/products/parties/openapi/payout-instruments/getpayoutinstrument","metadata":{"seo":{"title":"View a payout instrument","description":"View a payout instrument"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPayoutInstrument","name":"View a payout instrument","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View a payout instrument","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true},{"name":"payoutInstrumentId","in":"path","schemaId":"schema_430","description":"A unique identifier for the payoutInstrument generated by us. This is sent in the response of your payoutInstrument creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"},{"name":"payoutInstrumentId","in":"path","required":true,"schemaId":"schema_430"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}","href":"payout-instruments/getpayoutinstrument","openApiOperationId":"getPayoutInstrument","summary":"View a payout instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of sole trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of company (modular)"]}},"schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of sole trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of company (modular)"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of sole trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of company (modular)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of person (modular)","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of sole trader (modular)","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of company (modular)"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout-instruments/getpayoutinstrument"}],"panels":[]}]},"httpPath":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}"},{"label":"Update a payout instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/payout-instruments/updatepayoutinstruments","routeSlug":"/products/parties/openapi/payout-instruments/updatepayoutinstruments","metadata":{"seo":{"title":"Update a payout instrument","description":"Update a payout instrument"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePayoutInstruments","name":"Update a payout instrument","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payout instrument","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true},{"name":"payoutInstrumentId","in":"path","schemaId":"schema_430","description":"A unique identifier for the payoutInstrument generated by us. This is sent in the response of your payoutInstrument creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/requestBody/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"]}},"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/requestBody/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"},{"name":"payoutInstrumentId","in":"path","required":true,"schemaId":"schema_430"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/requestBody/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"]}},"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}","href":"payout-instruments/updatepayoutinstruments","openApiOperationId":"updatePayoutInstruments","summary":"Update a payout instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/requestBody/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BankAccount","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/requestBody/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/200/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"]}},"schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/200/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/200/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/200/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout-instruments/updatepayoutinstruments"}],"panels":[]}]},"httpPath":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}"}],"content":{"contentType":"group","meta":{"name":"Payout instruments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payout instruments","showPageActions":true},{"nodeType":"markdoc","content":"Create and maintain payout instruments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/parties/{partyId}/payoutInstruments","summary":"Create a payout instrument","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payout-instruments/createpayoutinstruments","deprecated":false},{"title":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}","summary":"View a payout instrument","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payout-instruments/getpayoutinstrument","deprecated":false},{"title":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}","summary":"Update a payout instrument","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payout-instruments/updatepayoutinstruments","deprecated":false}]}]}]}]}},{"type":"group","label":"Balance accounts","link":"/products/parties/openapi/balance-accounts","routeSlug":"/products/parties/openapi/balance-accounts","items":[{"label":"Create a balance account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/balance-accounts/createbalanceaccount","routeSlug":"/products/parties/openapi/balance-accounts/createbalanceaccount","metadata":{"seo":{"title":"Create a balance account","description":"Create a balance account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBalanceAccount","name":"Create a balance account","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a balance 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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"]}},"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/parties/{partyId}/balanceAccounts","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"]}},"responseCodes":["201","400","500","503"],"pointer":"/parties/{partyId}/balanceAccounts","href":"balance-accounts/createbalanceaccount","openApiOperationId":"createBalanceAccount","summary":"Create a balance 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/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"]}},"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts/post/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance-accounts/createbalanceaccount"}],"panels":[]}]},"httpPath":"/parties/{partyId}/balanceAccounts"},{"label":"View a balance account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/balance-accounts/getbalanceaccount","routeSlug":"/products/parties/openapi/balance-accounts/getbalanceaccount","metadata":{"seo":{"title":"View a balance account","description":"View a balance account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBalanceAccount","name":"View a balance account","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View a balance 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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true},{"name":"balanceAccountId","in":"path","schemaId":"schema_430","description":"A unique identifier for the balanceAccount generated by us. This is sent in the response of your balanceAccount creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/parties/{partyId}/balanceAccounts/{balanceAccountId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"},{"name":"balanceAccountId","in":"path","required":true,"schemaId":"schema_430"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}/balanceAccounts/{balanceAccountId}","href":"balance-accounts/getbalanceaccount","openApiOperationId":"getBalanceAccount","summary":"View a balance account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of company (modular with a daily payout)","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of sole trader (modular with a monthly payout)"]}},"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of company (modular with a daily payout)","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of sole trader (modular with a monthly payout)"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of company (modular with a daily payout)","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of sole trader (modular with a monthly payout)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of company (modular with a daily payout)","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of person (modular with a weekly payout)","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of sole trader (modular with a monthly payout)"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance-accounts/getbalanceaccount"}],"panels":[]}]},"httpPath":"/parties/{partyId}/balanceAccounts/{balanceAccountId}"},{"label":"Update a balance account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/balance-accounts/updatebalanceaccount","routeSlug":"/products/parties/openapi/balance-accounts/updatebalanceaccount","metadata":{"seo":{"title":"Update a balance account","description":"Update a balance account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBalanceAccount","name":"Update a balance account","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a balance 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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true},{"name":"balanceAccountId","in":"path","schemaId":"schema_430","description":"A unique identifier for the balanceAccount generated by us. This is sent in the response of your balanceAccount creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBalanceAccountRequest","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/requestBody/content/application~1json/examples/Update a balance account"]}},"schemaId":"components/schemas/UpdateBalanceAccountRequest","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/requestBody/content/application~1json/examples/Update a balance account"],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/parties/{partyId}/balanceAccounts/{balanceAccountId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"},{"name":"balanceAccountId","in":"path","required":true,"schemaId":"schema_430"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateBalanceAccountRequest","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/requestBody/content/application~1json/examples/Update a balance account"]}},"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}/balanceAccounts/{balanceAccountId}","href":"balance-accounts/updatebalanceaccount","openApiOperationId":"updateBalanceAccount","summary":"Update a balance 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/UpdateBalanceAccountRequest","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/requestBody/content/application~1json/examples/Update a balance account"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBalanceAccountRequest","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/requestBody/content/application~1json/examples/Update a balance 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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/200/content/application~1json/examples/Update balance account"]}},"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/200/content/application~1json/examples/Update balance account"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/200/content/application~1json/examples/Update balance account"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceAccount","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/200/content/application~1json/examples/Update balance account"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance-accounts/updatebalanceaccount"}],"panels":[]}]},"httpPath":"/parties/{partyId}/balanceAccounts/{balanceAccountId}"}],"content":{"contentType":"group","meta":{"name":"Balance accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance accounts","showPageActions":true},{"nodeType":"markdoc","content":"Create and maintain balance accounts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/parties/{partyId}/balanceAccounts","summary":"Create a balance account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance-accounts/createbalanceaccount","deprecated":false},{"title":"/parties/{partyId}/balanceAccounts/{balanceAccountId}","summary":"View a balance account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance-accounts/getbalanceaccount","deprecated":false},{"title":"/parties/{partyId}/balanceAccounts/{balanceAccountId}","summary":"Update a balance account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/balance-accounts/updatebalanceaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Beneficial owners","link":"/products/parties/openapi/beneficial-owners","routeSlug":"/products/parties/openapi/beneficial-owners","items":[{"label":"Create a beneficial owner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/beneficial-owners/createbeneficialowner","routeSlug":"/products/parties/openapi/beneficial-owners/createbeneficialowner","metadata":{"seo":{"title":"Create a beneficial owner","description":"Create a beneficial owner"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBeneficialOwner","name":"Create a beneficial owner","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a beneficial owner","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/requestBody/content/application~1json/examples/Create beneficial owner for existing company (modular)"]}},"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/requestBody/content/application~1json/examples/Create beneficial owner for existing company (modular)"],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/parties/{partyId}/beneficialOwners","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/requestBody/content/application~1json/examples/Create beneficial owner for existing company (modular)"]}},"responseCodes":["201","400","500","503"],"pointer":"/parties/{partyId}/beneficialOwners","href":"beneficial-owners/createbeneficialowner","openApiOperationId":"createBeneficialOwner","summary":"Create a beneficial owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/requestBody/content/application~1json/examples/Create beneficial owner for existing company (modular)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/requestBody/content/application~1json/examples/Create beneficial owner for existing company (modular)"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/201/content/application~1json/examples/Create beneficial owner for existing company (modular)"]}},"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/201/content/application~1json/examples/Create beneficial owner for existing company (modular)"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/201/content/application~1json/examples/Create beneficial owner for existing company (modular)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/201/content/application~1json/examples/Create beneficial owner for existing company (modular)"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners/post/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficial-owners/createbeneficialowner"}],"panels":[]}]},"httpPath":"/parties/{partyId}/beneficialOwners"},{"label":"View a beneficial owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/beneficial-owners/getbeneficialowner","routeSlug":"/products/parties/openapi/beneficial-owners/getbeneficialowner","metadata":{"seo":{"title":"View a beneficial owner","description":"View a beneficial owner"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBeneficialOwner","name":"View a beneficial owner","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View a beneficial owner","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true},{"name":"beneficialOwnerId","in":"path","schemaId":"schema_430","description":"A unique identifier for the beneficialOwner generated by us. This is sent in the response of your beneficialOwner creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"},{"name":"beneficialOwnerId","in":"path","required":true,"schemaId":"schema_430"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","href":"beneficial-owners/getbeneficialowner","openApiOperationId":"getBeneficialOwner","summary":"View a beneficial owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/200/content/application~1json/examples/Get a Beneficial Owner"]}},"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/200/content/application~1json/examples/Get a Beneficial Owner"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/200/content/application~1json/examples/Get a Beneficial Owner"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/200/content/application~1json/examples/Get a Beneficial Owner"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficial-owners/getbeneficialowner"}],"panels":[]}]},"httpPath":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}"},{"label":"Update a beneficial owner","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/beneficial-owners/updatebeneficialowner","routeSlug":"/products/parties/openapi/beneficial-owners/updatebeneficialowner","metadata":{"seo":{"title":"Update a beneficial owner","description":"Update a beneficial owner"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBeneficialOwner","name":"Update a beneficial owner","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a beneficial owner","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true},{"name":"beneficialOwnerId","in":"path","schemaId":"schema_430","description":"A unique identifier for the beneficialOwner generated by us. This is sent in the response of your beneficialOwner creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/requestBody/content/application~1json/examples/Update a Beneficial Owner"]}},"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/requestBody/content/application~1json/examples/Update a Beneficial Owner"],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"},{"name":"beneficialOwnerId","in":"path","required":true,"schemaId":"schema_430"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/requestBody/content/application~1json/examples/Update a Beneficial Owner"]}},"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","href":"beneficial-owners/updatebeneficialowner","openApiOperationId":"updateBeneficialOwner","summary":"Update a beneficial owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/requestBody/content/application~1json/examples/Update a Beneficial Owner"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/requestBody/content/application~1json/examples/Update a Beneficial Owner"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/200/content/application~1json/examples/Update Beneficial Owner"]}},"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/200/content/application~1json/examples/Update Beneficial Owner"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/200/content/application~1json/examples/Update Beneficial Owner"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficialOwners","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/200/content/application~1json/examples/Update Beneficial Owner"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficial-owners/updatebeneficialowner"}],"panels":[]}]},"httpPath":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}"},{"label":"Delete a beneficial owner","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/beneficial-owners/deletebeneficialowner","routeSlug":"/products/parties/openapi/beneficial-owners/deletebeneficialowner","metadata":{"seo":{"title":"Delete a beneficial owner","description":"Delete a beneficial owner"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBeneficialOwner","name":"Delete a beneficial owner","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a beneficial owner","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true},{"name":"beneficialOwnerId","in":"path","schemaId":"schema_430","description":"A unique identifier for the beneficialOwner generated by us. This is sent in the response of your beneficialOwner creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"},{"name":"beneficialOwnerId","in":"path","required":true,"schemaId":"schema_430"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","400","500","503"],"pointer":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","href":"beneficial-owners/deletebeneficialowner","openApiOperationId":"deleteBeneficialOwner","summary":"Delete a beneficial owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficial-owners/deletebeneficialowner"}],"panels":[]}]},"httpPath":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}"}],"content":{"contentType":"group","meta":{"name":"Beneficial owners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Beneficial owners","showPageActions":true},{"nodeType":"markdoc","content":"Create and maintain beneficial owners."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/parties/{partyId}/beneficialOwners","summary":"Create a beneficial owner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/beneficial-owners/createbeneficialowner","deprecated":false},{"title":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","summary":"View a beneficial owner","prefix":{"name":"get","color":"get"},"badges":[],"link":"/beneficial-owners/getbeneficialowner","deprecated":false},{"title":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","summary":"Update a beneficial owner","prefix":{"name":"put","color":"put"},"badges":[],"link":"/beneficial-owners/updatebeneficialowner","deprecated":false},{"title":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","summary":"Delete a beneficial owner","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/beneficial-owners/deletebeneficialowner","deprecated":false}]}]}]}]}},{"type":"group","label":"Identity verification","link":"/products/parties/openapi/identity-verification","routeSlug":"/products/parties/openapi/identity-verification","items":[{"label":"Perform identity verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/identity-verification/performidentityverification","routeSlug":"/products/parties/openapi/identity-verification/performidentityverification","metadata":{"seo":{"title":"Perform identity verification","description":"Perform identity verification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"performIdentityVerification","name":"Perform identity verification","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1identityVerification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Perform identity verification","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1identityVerification/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1identityVerification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityVerification","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/Perform an Identity Verification request for a company with beneficial owners (modular)","paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/IdentityVerification","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/Perform an Identity Verification request for a company with beneficial owners (modular)","paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/URL with invalid value"],"pointer":"/paths/~1parties~1{partyId}~1identityVerification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/parties/{partyId}/identityVerification","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IdentityVerification","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/Perform an Identity Verification request for a company with beneficial owners (modular)","paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/URL with invalid value"]}},"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}/identityVerification","href":"identity-verification/performidentityverification","openApiOperationId":"performIdentityVerification","summary":"Perform identity verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/IdentityVerification","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/Perform an Identity Verification request for a company with beneficial owners (modular)","paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityVerification","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/Perform an Identity Verification request for a company with beneficial owners (modular)","paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/URL with invalid value"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityVerificationResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/200/content/application~1json/examples/Identity Verification response for a company with beneficial owners (modular)"]}},"schemaId":"components/schemas/IdentityVerificationResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/200/content/application~1json/examples/Identity Verification response for a company with beneficial owners (modular)"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1identityVerification/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdentityVerificationResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/200/content/application~1json/examples/Identity Verification response for a company with beneficial owners (modular)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityVerificationResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/200/content/application~1json/examples/Identity Verification response for a company with beneficial owners (modular)"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/Bad request","paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/post/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity-verification/performidentityverification"}],"panels":[]}]},"httpPath":"/parties/{partyId}/identityVerification"},{"label":"View identity verification status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/identity-verification/getidentityverificationstatus","routeSlug":"/products/parties/openapi/identity-verification/getidentityverificationstatus","metadata":{"seo":{"title":"View identity verification status","description":"View identity verification status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdentityVerificationStatus","name":"View identity verification status","isWebhook":false,"pointer":"/paths/~1parties~1{partyId}~1identityVerification/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View identity verification status","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","description":"Basic authentication with user name and password"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partyId","in":"path","schemaId":"schema_426","description":"A unique identifier for the party generated by us. This is sent in the response of your party creation call.","required":true}],"pointer":"/paths/~1parties~1{partyId}~1identityVerification/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_418","description":"The API version.","required":true,"example":"2025-01-01"}],"pointer":"/paths/~1parties~1{partyId}~1identityVerification/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/parties/{partyId}/identityVerification","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"partyId","in":"path","required":true,"schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"example":"2025-01-01","schemaId":"schema_418"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","500","503"],"pointer":"/parties/{partyId}/identityVerification","href":"identity-verification/getidentityverificationstatus","openApiOperationId":"getIdentityVerificationStatus","summary":"View identity verification status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityVerificationResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/200/content/application~1json/examples/Verify an Identity Verification status for a company with beneficial owners (modular)"]}},"schemaId":"components/schemas/IdentityVerificationResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/200/content/application~1json/examples/Verify an Identity Verification status for a company with beneficial owners (modular)"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/400/content/application~1json/examples/URL with invalid value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/400/content/application~1json/examples/URL with invalid value"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/500/content/application~1json/examples/Internal error occurred"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/500/content/application~1json/examples/Internal error occurred"]},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/503/content/application~1json/examples/Service Unavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/503/content/application~1json/examples/Service Unavailable"]}],"pointer":"/paths/~1parties~1{partyId}~1identityVerification/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdentityVerificationResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/200/content/application~1json/examples/Verify an Identity Verification status for a company with beneficial owners (modular)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityVerificationResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/200/content/application~1json/examples/Verify an Identity Verification status for a company with beneficial owners (modular)"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/400/content/application~1json/examples/URL with invalid value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/400/content/application~1json/examples/URL with invalid value"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/500/content/application~1json/examples/Internal error occurred"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/500/content/application~1json/examples/Internal error occurred"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/503/content/application~1json/examples/Service Unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1parties~1{partyId}~1identityVerification/get/responses/503/content/application~1json/examples/Service Unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity-verification/getidentityverificationstatus"}],"panels":[]}]},"httpPath":"/parties/{partyId}/identityVerification"}],"content":{"contentType":"group","meta":{"name":"Identity verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identity verification","showPageActions":true},{"nodeType":"markdoc","content":"Enable identity verification check on a party."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/parties/{partyId}/identityVerification","summary":"Perform identity verification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/identity-verification/performidentityverification","deprecated":false},{"title":"/parties/{partyId}/identityVerification","summary":"View identity verification status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identity-verification/getidentityverificationstatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","description":"Object containing details about the address.","properties":{"address1":{"type":"string","description":"The address.\n\nMust consist of at least two letters, two words, and one number.","example":"1847 Kingsbury Court","maxLength":35,"minLength":2},"address2":{"type":"string","description":"Line two of the address.","example":"Unit 42","maxLength":35,"minLength":2},"city":{"type":"string","description":"The city of this address.","example":"London","maxLength":35,"minLength":1},"state":{"type":"string","description":"The state of this address.","example":"Greater London","maxLength":35,"minLength":2},"countryCode":{"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":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-country-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 Alpha-2 code format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GB","maxLength":2,"minLength":2},"postalCode":{"type":"string","description":"The postal code of this address.","example":"NW9 0RR","maxLength":20,"minLength":1},"type":{"type":"string","description":"Identifies the type of this address.","enum":["home","business","poBox","other"],"example":"home"}},"required":["address1","city","countryCode"]}},"components/schemas/TradingAddress":{"id":"components/schemas/TradingAddress","kind":"json-schema","title":"TradingAddress","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing details about the address."},"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":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isTradingAddressSameAsPrimary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do not provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tradingAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isTradingAddressSameAsPrimary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tradingAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"address1":{"type":"string","description":"The address.\n\nMust consist of at least two letters, two words, and one number.","example":"1847 Kingsbury Court","maxLength":35,"minLength":2},"address2":{"type":"string","description":"Line two of the address.","example":"Unit 42","maxLength":35,"minLength":2},"city":{"type":"string","description":"The city of this address.","example":"London","maxLength":35,"minLength":1},"state":{"type":"string","description":"The state of this address.","example":"Greater London","maxLength":35,"minLength":2},"countryCode":{"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":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-country-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 Alpha-2 code format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GB","maxLength":2,"minLength":2},"postalCode":{"type":"string","description":"The postal code of this address.","example":"NW9 0RR","maxLength":20,"minLength":1},"type":{"type":"string","description":"Identifies the type of this address.","enum":["home","business","poBox","other"],"example":"home"}},"required":["address1","city","countryCode"]}},"components/schemas/BalanceAccount":{"id":"components/schemas/BalanceAccount","kind":"json-schema","title":"BalanceAccount","data":{"type":"object","properties":{"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]*$"},"payoutInstrumentReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created by you. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field holds the beneficiary bank details. Use this to direct payouts to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the relevant beneficiary. This must be unique within an entity."},"children":[]}]}]}],"example":"primaryBusinessAccount"},"scheduledPayoutDay":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled payout day for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must provide this for \"weekly\" and \"monthly\" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["monday","tuesday","wednesday","thursday","friday"],"example":"friday"},"frequency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled payout frequency for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"daily"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payouts are processed every business day"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weekly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - you must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledPayoutDay"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"monthly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - you must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledPayoutDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurrence"},"children":[]}]}]}],"enum":["daily","weekly","monthly"],"example":"weekly"},"recurrence":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The week of the month the payout is paid out. You must provide this for \"monthly\" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["first","second","third","fourth"],"example":"first"},"nextPayoutDate":{"type":"string","description":"The next scheduled payout date for this balance account.","example":"2025-02-14","readOnly":true},"balanceAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID created by us to identify a balance account. This is sent in the response after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}],"readOnly":true},"accountNumber":{"type":"string","description":"The number of your balanceAccount.","readOnly":true},"dateTimeCreated":{"type":"string","description":"The date and time that the balance account was created, as an ISO 8601 zoned date time.","example":"2025-01-23T12:23:445.222Z","readOnly":true},"dateTimeUpdated":{"type":"string","description":"The date and time that the balance account was last updated, as an ISO 8601 zoned date time.","example":"2025-01-25T02:43:499.202Z","readOnly":true},"version":{"type":"integer","format":"int32","readOnly":true}},"required":["currency"]}},"components/schemas/UpdateBalanceAccountRequest":{"id":"components/schemas/UpdateBalanceAccountRequest","kind":"json-schema","title":"UpdateBalanceAccountRequest","data":{"type":"object","description":"Request payload for updating a balance account.","properties":{"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]*$"},"payoutInstrumentReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created by you. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field holds the beneficiary bank details. Use this to direct payouts to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the relevant beneficiary. This must be unique within an entity."},"children":[]}]}]}],"example":"primaryBusinessAccount"},"scheduledPayoutDay":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled payout day for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You must provide this for \"weekly\" and \"monthly\" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["monday","tuesday","wednesday","thursday","friday"],"example":"friday"},"frequency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled payout frequency for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"daily"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - payouts are processed every business day"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weekly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - you must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledPayoutDay"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"monthly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - you must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledPayoutDay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurrence"},"children":[]}]}]}],"enum":["daily","weekly","monthly"],"example":"weekly"},"recurrence":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The week of the month the payout is paid out. You must provide this for \"monthly\" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frequency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["first","second","third","fourth"],"example":"first"},"balanceAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID created by us to identify a balance account. This is sent in the response after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creation."},"children":[]}]}]}]},"dateTimeCreated":{"type":"string","description":"The date and time that the balance account was created, as an ISO 8601 zoned date time.","example":"2025-01-23T12:23:445.222Z"},"dateTimeUpdated":{"type":"string","description":"The date and time that the balance account was last updated, as an ISO 8601 zoned date time.","example":"2025-01-25T02:43:499.202Z"},"version":{"type":"integer","format":"int32"},"accountNumber":{"type":"string","description":"The number of your balanceAccount."},"nextPayoutDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upcoming payout date of the existing schedule for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can retrieve this via our GET endpoint."},"children":[]}]}]}],"example":"2025-02-14"}},"required":["currency","nextPayoutDate","payoutInstrumentReference"]}},"components/schemas/BankAccount":{"id":"components/schemas/BankAccount","kind":"json-schema","title":"BankAccount","data":{"type":"object","properties":{"payoutInstrumentReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created by you. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field holds the beneficiary bank details. Use this to direct payouts to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the relevant beneficiary. This must be unique within an entity."},"children":[]}]}]}],"example":"primaryBusinessAccount","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"},"payoutInstrumentId":{"type":"string","description":"An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.","example":"parOk0YlPtQogrqQdz7_fKXs0","maxLength":25,"minLength":25,"pattern":"^par[a-zA-Z0-9-_]*0$"},"payoutInstrumentType":{"type":"string","description":"The type of the payout instrument.","enum":["bankAccount","wallet","card"]},"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]*$"},"dateTimeCreated":{"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 and time the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created, as an ISO 8601 zoned date time."},"children":[]}]}]}],"readOnly":true},"dateTimeUpdated":{"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 and time the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was updated, as an ISO 8601 zoned date time."},"children":[]}]}]}],"readOnly":true},"version":{"type":"integer","format":"int32"},"accountHolderName":{"type":"string"},"swiftBic":{"type":"string"},"bankCode":{"type":"string","description":"The bankCode must be exactly 6 digits.","example":"184758"},"accountNumber":{"type":"string"},"accountType":{"type":"string","enum":["checking","savings","moneyMarket","certificateOfDeposit","vista","other"]},"iban":{"type":"string"},"bankName":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"branchCode":{"type":"string"}},"required":["currency"]}},"components/schemas/BeneficialOwnerIdentityVerificationInfo":{"id":"components/schemas/BeneficialOwnerIdentityVerificationInfo","kind":"json-schema","title":"BeneficialOwnerIdentityVerificationInfo","data":{"type":"object","properties":{"identityVerificationState":{"type":"string","enum":["verified","notVerified","pending","rejected","notApplicable","started","startedAction","pendingStepUpAction","pendingManualReview - stepUpReceived"],"readOnly":true},"identityVerificationMethod":{"type":"string","enum":["merchantCompliant","identityVerificationService"],"readOnly":true},"identityVerificationDate":{"type":"string","format":"date","description":"A valid date as YYYY-MM-DD","example":"2033-11-22","readOnly":true},"url":{"type":"string","description":"The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.","readOnly":true},"message":{"type":"string","description":"The message associated with link returned from Identity Verification Status (IVS).","readOnly":true},"beneficialOwnerReference":{"type":"string","description":"Your reference for this beneficial owner, must be unique within an entity.\n\n","example":"Hosaka27384910","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"},"beneficialOwnerId":{"type":"string","description":"A unique identifier for the beneficial owner generated by us.","readOnly":true}}}},"components/schemas/BeneficialOwners":{"id":"components/schemas/BeneficialOwners","kind":"json-schema","title":"BeneficialOwners","data":{"type":"object","properties":{"identityVerificationState":{"type":"string","enum":["verified","notVerified","pending","rejected","notApplicable","started","startedAction","pendingStepUpAction","pendingManualReview - stepUpReceived"],"readOnly":true},"identityVerificationMethod":{"type":"string","enum":["merchantCompliant","identityVerificationService"],"readOnly":true},"identityVerificationDate":{"type":"string","format":"date","description":"A valid date as YYYY-MM-DD","example":"2033-11-22","readOnly":true},"url":{"type":"string","description":"The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.","readOnly":true},"message":{"type":"string","description":"The message associated with link returned from Identity Verification Status (IVS).","readOnly":true},"beneficialOwnerReference":{"type":"string","description":"Your reference for this beneficial owner, must be unique within an entity.\n\n","example":"Hosaka27384910","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"},"beneficialOwnerId":{"type":"string","description":"A unique identifier for the beneficial owner generated by us.","readOnly":true},"personalDetails":{"$ref":"#/components/schemas/PersonalDetailsForBeneficialOwner"},"relationshipToBusiness":{"$ref":"#/components/schemas/RelationshipToBusiness"},"email":{"type":"string","format":"email"},"phones":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"identityDocuments":{"type":"array","items":{"$ref":"#/components/schemas/IdentityDocument"}},"dateTimeCreated":{"type":"string","description":"The date and time that the beneficial owner was created, as an ISO 8601 zoned date time.","example":"2025-01-23T12:23:445.222Z","readOnly":true},"version":{"type":"integer","format":"int32","readOnly":true},"dateTimeUpdated":{"type":"string","description":"The date and time that the beneficial owner was last updated, as an ISO 8601 zoned date time.\n\n","example":"2025-01-25T14:57:012.302Z","readOnly":true}},"required":["beneficialOwnerReference","personalDetails","relationshipToBusiness"]}},"components/schemas/BrowsePartiesPage":{"id":"components/schemas/BrowsePartiesPage","kind":"json-schema","title":"BrowsePartiesPage","data":{"type":"object","description":"A page of parties with pagination information.","properties":{"parties":{"type":"array","description":"List of parties on the current page.","items":{"oneOf":[{"$ref":"#/components/schemas/Company"},{"$ref":"#/components/schemas/Person"},{"$ref":"#/components/schemas/SoleTrader"}]},"readOnly":true},"pagination":{"$ref":"#/components/schemas/Pagination"}},"readOnly":true,"required":["pagination","parties"]}},"components/schemas/Card":{"id":"components/schemas/Card","kind":"json-schema","title":"Card","data":{"type":"object","properties":{"payoutInstrumentReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created by you. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field holds the beneficiary bank details. Use this to direct payouts to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the relevant beneficiary. This must be unique within an entity."},"children":[]}]}]}],"example":"primaryBusinessAccount","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"},"payoutInstrumentId":{"type":"string","description":"An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.","example":"parOk0YlPtQogrqQdz7_fKXs0","maxLength":25,"minLength":25,"pattern":"^par[a-zA-Z0-9-_]*0$"},"payoutInstrumentType":{"type":"string","description":"The type of the payout instrument.","enum":["bankAccount","wallet","card"]},"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]*$"},"dateTimeCreated":{"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 and time the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created, as an ISO 8601 zoned date time."},"children":[]}]}]}],"readOnly":true},"dateTimeUpdated":{"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 and time the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was updated, as an ISO 8601 zoned date time."},"children":[]}]}]}],"readOnly":true},"version":{"type":"integer","format":"int32"},"id":{"$ref":"#/components/schemas/NanoId"},"token":{"type":"string"}},"required":["currency"]}},"components/schemas/Company":{"id":"components/schemas/Company","kind":"json-schema","title":"Company","data":{"description":"A party represents the overall party record of your beneficiary (seller, vendor, provider). You can use this to store information about the party, to perform either an identity verification check, a split payment, or a payout.","allOf":[{"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a single person enterprise"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":[]}]}]}],"enum":["company","person","soleTrader"]},"identityVerificationState":{"type":"string","enum":["verified","notVerified","pending","rejected","notApplicable","started","startedAction","pendingStepUpAction","pendingManualReview","stepUpReceived"],"readOnly":true},"identityVerificationMethod":{"type":"string","enum":["merchantCompliant","identityVerificationService"],"readOnly":true},"identityVerificationDate":{"type":"string","format":"date","description":"A valid date as YYYY-MM-DD","example":"2033-11-22","readOnly":true},"url":{"type":"string","description":"The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.","readOnly":true},"message":{"type":"string","description":"The message associated with link returned from Identity Verification Status (IVS).","readOnly":true},"partyReference":{"type":"string","description":"Your reference for this party, must be unique within an entity.\n","example":"Hosaka27384910","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"},"partyType":{"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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the person or business that will receive funds"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a transmitter of funds to a third party"},"children":[]}]}]}],"enum":["beneficiary","payer"]},"partyId":{"type":"string","description":"A unique identifier for the party generated by us.","readOnly":true},"email":{"type":"string","format":"email","description":"An email address for this party."},"merchant":{"$ref":"#/components/schemas/Merchant","description":"An object that contains information about the merchant."},"phones":{"type":"array","description":"A list of phone numbers associated with this party.","items":{"$ref":"#/components/schemas/Phone"}},"identityDocuments":{"type":"array","description":"A list of identity documents for this party.","items":{"$ref":"#/components/schemas/IdentityDocument"}},"balanceAccounts":{"type":"array","description":"A list of balance accounts that have been set up for this party.","items":{"$ref":"#/components/schemas/BalanceAccount"}},"dateTimeCreated":{"type":"string","description":"The date and time that the party was created, as an ISO 8601 zoned date time.","example":"2025-01-23T12:23:445.222Z","readOnly":true},"dateTimeUpdated":{"type":"string","description":"The date and time that the party was last updated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true},"version":{"type":"integer","format":"int32","readOnly":true},"payoutInstruments":{"type":"array","items":{"$ref":"#/components/schemas/BankAccount"}},"performIdentityVerification":{"type":"boolean","writeOnly":true},"active":{"type":"boolean","description":"Indicates whether the party is active or not.","example":true,"readOnly":true},"dateTimeDeactivated":{"type":"string","description":"The date and time that the party was last deactivated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true},"deactivationReason":{"type":"string","description":"The reason for deactivating a party.","example":"partyDormant","readOnly":true},"dispositionOfFunds":{"type":"string","description":"The disposition of funds for deactivated party.","example":"payoutToParty","readOnly":true},"dateTimeActivated":{"type":"string","description":"The date and time that the party was last activated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true},"companyDetails":{"$ref":"#/components/schemas/CompanyDetails"},"beneficialOwners":{"type":"array","items":{"$ref":"#/components/schemas/BeneficialOwners"}}},"required":["companyDetails","merchant","partyReference","partyType","type"]}},"components/schemas/CompanyDetails":{"id":"components/schemas/CompanyDetails","kind":"json-schema","title":"CompanyDetails","data":{"type":"object","description":"Object containing details about a company. Required for company.","properties":{"merchantCategoryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A 4-digit code to represent the merchant category. Only provide this where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"5411","maxLength":4,"minLength":4,"pattern":"^\\d{4}$"},"merchantCategoryCodeDescription":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description to describe the merchant category code. Only provide this where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Grocery Stores","maxLength":255,"minLength":1},"website":{"type":"string","description":"The URL of the merchant's website.","example":"https://example.com/"},"legalName":{"type":"string","description":"The legal name of the company.","example":"Tessier-Ashpool Systems Ltd.","maxLength":140,"minLength":2,"pattern":"^(?: *[\\p{L}\\p{N}+&\\/\\-.()])*+(?: *[\\p{L}\\p{N}\\-.,\\/&()@#']{2,140})*+(?: *[\\p{L}\\p{N}&\\/\\-.()])*+ *$"},"tradingName":{"type":"string","description":"The trading common name of the company.","example":"TASynth.com","maxLength":140,"minLength":2,"pattern":"^(?: *[\\p{L}\\p{N}+&\\/\\-.()])*+(?: *[\\p{L}\\p{N}\\-.,\\/&()@#']{2,140})*+(?: *[\\p{L}\\p{N}&\\/\\-.()])*+ *$"},"registrationNumber":{"type":"string","description":"The registration number for the company. What should be supplied in this field may differ by country, for instance in the United States it will be a Tax ID Number (TIN).","example":"7564389201","maxLength":15,"minLength":1,"pattern":"[a-zA-Z0-9-]*"},"taxIdentifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entity’s tax registration number (VAT, GST, EIN, TIN, or equivalent), depending on jurisdiction."},"children":[]}]}]}],"example":"JP-987654321","maxLength":35,"minLength":2,"pattern":"^[a-zA-Z0-9-]*$"},"companyType":{"type":"string","description":"A description of the type of company.","enum":["charity","government","publicLimitedCompany","limitedCompanyShares","limitedLiabilityPartnership","partnership","limitedCompanyGuarantee","trust","regulatedFinancialAndCreditInstitutions","unlistedCorporate","publicBodies","subsidiaryOfPubliclyListedCorporate","nonProfit","estatesOfDeceasedPerson","secRegistered","clubsOrSocieties","subsidiaryOfRegulatedFinancialAndCreditInstitutions","other"],"example":"publicLimitedCompany"},"dateOfIncorporation":{"type":"string","description":"The incorporation date for the company.","example":"1977-07-04"},"isTradingAddressSameAsPrimary":{"type":"boolean","description":"Indicates whether the trading address is the same as the primary address.","example":true},"legalAddress":{"$ref":"#/components/schemas/Address","description":"The legal address of this company."},"tradingAddress":{"$ref":"#/components/schemas/TradingAddress","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The trading address of this company."},"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":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If \"isTradingAddressSameAsPrimary\" is set to true, no \"tradingAddress\" must be provided. If \"isTradingAddressSameAsPrimary\" is set to  false, \"tradingAddress\" must be provided."},"children":[]}]}]}]},"customerReference":{"type":"string","description":"Unique reference provided by the payee. Only required for certain payout destinations.","example":"7564389201","maxLength":255,"minLength":1},"countryOfIncorporation":{"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":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-country-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 Alpha-2 code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"GB"}},"required":["legalAddress","legalName","tradingName","isTradingAddressSameAsPrimary"]}},"components/schemas/DeactivateParty":{"id":"components/schemas/DeactivateParty","kind":"json-schema","title":"DeactivateParty","data":{"type":"object","description":"Object containing deactivation information.","properties":{"deactivationReason":{"type":"string","description":"The reason for deactivating a party.","enum":["partyDormant","partyClosed","partySanctioned"],"example":"partyDormant"},"dispositionOfFunds":{"type":"string","description":"The disposition of funds for deactivated party.","enum":["payoutToParty"],"example":"payoutToParty"},"active":{"type":"boolean","description":"Indicates whether the party is active or not.","example":false,"readOnly":true},"dateTimeDeactivated":{"type":"string","description":"The date and time that the party was last deactivated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true}},"required":["deactivationReason"]}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"Error Response","data":{"type":"object","properties":{"errorName":{"type":"string","description":"An ordinal error type that is part of the API contract. It is machine readable, but also human readable for clarity and semantic understanding of the error.","example":"bodyDoesNotMatchSchema"},"message":{"type":"string","description":"A human readable message giving a corrective action for the error. THIS IS NOT FOR MACHINE CONSUMPTION."},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorResponseItem"}},"pathParameter":{"type":"string"},"queryParameter":{"type":"string"},"jsonPath":{"type":"string"}},"readOnly":true,"title":"Error Response"}},"components/schemas/ErrorResponseItem":{"id":"components/schemas/ErrorResponseItem","kind":"json-schema","title":"ErrorResponseItem","data":{"type":"object","properties":{"errorName":{"type":"string"},"message":{"type":"string"},"path":{"type":"string"},"jsonPath":{"type":"string"},"queryParameter":{"type":"string"},"pathParameter":{"type":"string"}}}},"components/schemas/IdentityDocument":{"id":"components/schemas/IdentityDocument","kind":"json-schema","title":"identityDocument","data":{"type":"object","description":"An identity document.","properties":{"type":{"type":"string","description":"The type of the identity document.","enum":["passport","nationalId","driverLicence","workPermit","employmentPass","studentPass","permanentResidentCard","companyRegistrationNumber","companyVATNumber","citizenshipCard","taxId","nationalInsurance","other","legalIdentityCard","taxRegistrationCode"]},"number":{"type":"string","minLength":1},"issuingInstitution":{"type":"string","description":"The name of the institution that issued this document.","example":"State Department"},"issuingCountry":{"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 of the issuing country specified in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/reference/supported-countries-currencies#iso-country-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 Alpha-2 code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"JP","minLength":1},"validFrom":{"type":"string","description":"The ISO 8601 date since when this document is valid from.","example":"2023-11-22"},"validTo":{"type":"string","description":"The ISO 8601 date until which this document is valid to.","example":"2023-11-22"}},"required":["issuingCountry","number","type"],"title":"identityDocument"}},"components/schemas/IdentityVerification":{"id":"components/schemas/IdentityVerification","kind":"json-schema","title":"IdentityVerification","data":{"type":"object","properties":{"performIdentityVerification":{"type":"boolean","writeOnly":true}}}},"components/schemas/IdentityVerificationInfo":{"id":"components/schemas/IdentityVerificationInfo","kind":"json-schema","title":"IdentityVerificationInfo","data":{"type":"object","properties":{"identityVerificationState":{"type":"string","enum":["verified","notVerified","pending","rejected","notApplicable","started","startedAction","pendingStepUpAction","pendingManualReview - stepUpReceived"],"readOnly":true},"identityVerificationMethod":{"type":"string","enum":["merchantCompliant","identityVerificationService"],"readOnly":true},"identityVerificationDate":{"type":"string","format":"date","description":"A valid date as YYYY-MM-DD","example":"2033-11-22","readOnly":true},"url":{"type":"string","description":"The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.","readOnly":true},"message":{"type":"string","description":"The message associated with link returned from Identity Verification Status (IVS).","readOnly":true}}}},"components/schemas/IdentityVerificationResponse":{"id":"components/schemas/IdentityVerificationResponse","kind":"json-schema","title":"IdentityVerificationResponse","data":{"type":"object","properties":{"errorName":{"type":"string","description":"An ordinal error type that is part of the API contract. It is machine readable, but also human readable for clarity and semantic understanding of the error.","example":"bodyDoesNotMatchSchema"},"message":{"type":"string","description":"A human readable message giving a corrective action for the error. THIS IS NOT FOR MACHINE CONSUMPTION."},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorResponseItem"}},"pathParameter":{"type":"string"},"queryParameter":{"type":"string"},"jsonPath":{"type":"string"},"overall":{"$ref":"#/components/schemas/IdentityVerificationInfo"},"party":{"$ref":"#/components/schemas/PartyIdentityVerificationInfo"},"beneficialOwners":{"type":"array","items":{"$ref":"#/components/schemas/BeneficialOwnerIdentityVerificationInfo"}}}}},"components/schemas/Merchant":{"id":"components/schemas/Merchant","kind":"json-schema","title":"Merchant","data":{"type":"object","description":"An object that contains information about the merchant.","properties":{"entity":{"type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding.","example":"default","maxLength":36,"minLength":1,"pattern":"[a-zA-Z0-9- ]*"}},"required":["entity"],"title":"Merchant"}},"components/schemas/NanoId":{"id":"components/schemas/NanoId","kind":"json-schema","title":"NanoId","data":{"type":"object","properties":{"nanoPrefix":{"type":"string"},"nanoId":{"type":"string"}}}},"components/schemas/Pagination":{"id":"components/schemas/Pagination","kind":"json-schema","title":"Pagination","data":{"type":"object","description":"Pagination information for browsing.","properties":{"page":{"type":"integer","format":"int32","description":"Positive whole number indicating which page of the selected parties to return. Greater than 0.","example":5,"readOnly":true},"size":{"type":"integer","format":"int32","description":"Number of items listed per page.","example":10,"readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Total number of pages.","example":3,"readOnly":true},"totalNumberOfRecords":{"type":"integer","format":"int64","description":"Total number of records in the database for the selected parties.","example":1227,"readOnly":true}},"readOnly":true,"required":["page","size"]}},"components/schemas/PartyIdentityVerificationInfo":{"id":"components/schemas/PartyIdentityVerificationInfo","kind":"json-schema","title":"PartyIdentityVerificationInfo","data":{"type":"object","properties":{"identityVerificationState":{"type":"string","enum":["verified","notVerified","pending","rejected","notApplicable","started","startedAction","pendingStepUpAction","pendingManualReview","stepUpReceived"],"readOnly":true},"identityVerificationMethod":{"type":"string","enum":["merchantCompliant","identityVerificationService"],"readOnly":true},"identityVerificationDate":{"type":"string","format":"date","description":"A valid date as YYYY-MM-DD","example":"2033-11-22","readOnly":true},"url":{"type":"string","description":"The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.","readOnly":true},"message":{"type":"string","description":"The message associated with link returned from Identity Verification Status (IVS).","readOnly":true},"partyId":{"type":"string","description":"A unique identifier for the party generated by us.","readOnly":true},"partyReference":{"type":"string","description":"Your reference for this party, must be unique within an entity.\n\n","example":"Hosaka27384910","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"}}}},"components/schemas/Person":{"id":"components/schemas/Person","kind":"json-schema","title":"Person","data":{"description":"A party represents the overall party record of your beneficiary (seller, vendor, provider). You can use this to store information about the party, to perform either an identity verification check, a split payment, or a payout.","allOf":[{"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a single person enterprise"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":[]}]}]}],"enum":["company","person","soleTrader"]},"identityVerificationState":{"type":"string","enum":["verified","notVerified","pending","rejected","notApplicable","started","startedAction","pendingStepUpAction","pendingManualReview","stepUpReceived"],"readOnly":true},"identityVerificationMethod":{"type":"string","enum":["merchantCompliant","identityVerificationService"],"readOnly":true},"identityVerificationDate":{"type":"string","format":"date","description":"A valid date as YYYY-MM-DD","example":"2033-11-22","readOnly":true},"url":{"type":"string","description":"The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.","readOnly":true},"message":{"type":"string","description":"The message associated with link returned from Identity Verification Status (IVS).","readOnly":true},"partyReference":{"type":"string","description":"Your reference for this party, must be unique within an entity.\n","example":"Hosaka27384910","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"},"partyType":{"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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the person or business that will receive funds"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a transmitter of funds to a third party"},"children":[]}]}]}],"enum":["beneficiary","payer"]},"partyId":{"type":"string","description":"A unique identifier for the party generated by us.","readOnly":true},"email":{"type":"string","format":"email","description":"An email address for this party."},"merchant":{"$ref":"#/components/schemas/Merchant","description":"An object that contains information about the merchant."},"phones":{"type":"array","description":"A list of phone numbers associated with this party.","items":{"$ref":"#/components/schemas/Phone"}},"identityDocuments":{"type":"array","description":"A list of identity documents for this party.","items":{"$ref":"#/components/schemas/IdentityDocument"}},"balanceAccounts":{"type":"array","description":"A list of balance accounts that have been set up for this party.","items":{"$ref":"#/components/schemas/BalanceAccount"}},"dateTimeCreated":{"type":"string","description":"The date and time that the party was created, as an ISO 8601 zoned date time.","example":"2025-01-23T12:23:445.222Z","readOnly":true},"dateTimeUpdated":{"type":"string","description":"The date and time that the party was last updated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true},"version":{"type":"integer","format":"int32","readOnly":true},"payoutInstruments":{"type":"array","items":{"$ref":"#/components/schemas/BankAccount"}},"performIdentityVerification":{"type":"boolean","writeOnly":true},"active":{"type":"boolean","description":"Indicates whether the party is active or not.","example":true,"readOnly":true},"dateTimeDeactivated":{"type":"string","description":"The date and time that the party was last deactivated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true},"deactivationReason":{"type":"string","description":"The reason for deactivating a party.","example":"partyDormant","readOnly":true},"dispositionOfFunds":{"type":"string","description":"The disposition of funds for deactivated party.","example":"payoutToParty","readOnly":true},"dateTimeActivated":{"type":"string","description":"The date and time that the party was last activated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true},"personalDetails":{"$ref":"#/components/schemas/PersonalDetailsImplForPerson"}},"required":["merchant","partyReference","partyType","personalDetails","type"]}},"components/schemas/PersonalDetailsForBeneficialOwner":{"id":"components/schemas/PersonalDetailsForBeneficialOwner","kind":"json-schema","title":"PersonalDetailsForBeneficialOwner","data":{"type":"object","properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The title for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Mr","Mrs","Miss","Ms","Dr","Mx","Misc"],"example":"Mr"},"firstName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s first name."},"children":[]}]}]}],"example":"Case","maxLength":35,"minLength":2,"pattern":"^[\\p{L}\\-.,'()&]{2,}$"},"middleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s middle name or initial."},"children":[]}]}]}],"example":"Henry","maxLength":35,"minLength":1,"pattern":"^(?:\\p{L}\\.?)*+$"},"lastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s last name."},"children":[]}]}]}],"example":"Mitchell","maxLength":35,"minLength":2,"pattern":"^(?:[\\p{L}\\-.,'()&]{2,} *)*+$"},"alias":{"type":"string","description":"An alternative or commonly-used name for the individual (e.g., preferred or informal name). Does not replace the legal name.","example":"Junior Case","maxLength":35,"minLength":2,"pattern":"^[\\p{L}\\-.,'()&]++(?:\\s++[\\p{L}\\-.,'()&]++)*+$"},"socialSecurityNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The individual’s U.S. Social Security Number (SSN), required for U.S.-based tax or identity checks."},"children":[]}]}]}],"example":"004-54-6578","pattern":"^\\d{3}-\\d{2}-\\d{4}$"},"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":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was born."},"children":[]}]}]}],"example":"1983-10-12"},"address":{"$ref":"#/components/schemas/Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"residentialStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The residential status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["resident","nonResident","other"]},"customerReference":{"type":"string","description":"Unique reference provided by the payee. Only required for certain payout destinations.","example":"7564389201","maxLength":255,"minLength":1},"nationality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nationality of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currentAddressLessThanThreeYears":{"type":"boolean"},"previousHomeAddress":{"$ref":"#/components/schemas/Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The previous home address of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"website":{"type":"string","description":"The URL of the merchant's website.","example":"https://example.com/"}},"required":["address","firstName","lastName","title"]}},"components/schemas/PersonalDetailsImplForPerson":{"id":"components/schemas/PersonalDetailsImplForPerson","kind":"json-schema","title":"PersonalDetailsImplForPerson","data":{"type":"object","properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The title for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Mr","Mrs","Miss","Ms","Dr","Mx","Misc"],"example":"Mr"},"firstName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s first name."},"children":[]}]}]}],"example":"Case","maxLength":35,"minLength":2,"pattern":"^[\\p{L}\\-.,'()&]{2,}$"},"middleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s middle name or initial."},"children":[]}]}]}],"example":"Henry","maxLength":35,"minLength":1,"pattern":"^(?:\\p{L}\\.?)*+$"},"lastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s last name."},"children":[]}]}]}],"example":"Mitchell","maxLength":35,"minLength":2,"pattern":"^(?:[\\p{L}\\-.,'()&]{2,} *)*+$"},"alias":{"type":"string","description":"An alternative or commonly-used name for the individual (e.g., preferred or informal name). Does not replace the legal name.","example":"Junior Henry","maxLength":35,"minLength":2,"pattern":"^[\\p{L}\\-.,'()&]++(?:\\s++[\\p{L}\\-.,'()&]++)*+$"},"socialSecurityNumber":{"type":"string","description":"The individual's U.S. Social Security Number (SSN), required for U.S.-based tax or identity checks.","example":"004-54-6578","pattern":"^\\d{3}-\\d{2}-\\d{4}$"},"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":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was born."},"children":[]}]}]}],"example":"1983-10-12"},"address":{"$ref":"#/components/schemas/Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"residentialStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The residential status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["resident","nonResident","other"]},"customerReference":{"type":"string","description":"Unique reference provided by the payee. Only required for certain payout destinations.","example":"7564389201","maxLength":255,"minLength":1},"nationality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nationality of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currentAddressLessThanThreeYears":{"type":"boolean"},"previousHomeAddress":{"$ref":"#/components/schemas/Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The previous home address of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"website":{"type":"string","description":"The URL of the merchant's website.","example":"https://example.com/"}},"required":["address","firstName","lastName","title"]}},"components/schemas/PersonalDetailsImplForSoleTrader":{"id":"components/schemas/PersonalDetailsImplForSoleTrader","kind":"json-schema","title":"PersonalDetailsImplForSoleTrader","data":{"type":"object","properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The title for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Mr","Mrs","Miss","Ms","Dr","Mx","Misc"],"example":"Mr"},"firstName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s first name."},"children":[]}]}]}],"example":"Case","maxLength":35,"minLength":2,"pattern":"^[\\p{L}\\-.,'()&]{2,}$"},"middleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s middle name or initial."},"children":[]}]}]}],"example":"Henry","maxLength":35,"minLength":1,"pattern":"^(?:\\p{L}\\.?)*+$"},"lastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s last name."},"children":[]}]}]}],"example":"Mitchell","maxLength":35,"minLength":2,"pattern":"^(?:[\\p{L}\\-.,'()&]{2,} *)*+$"},"tradingName":{"type":"string","description":"The trading common name of the SoleTrader.","example":"WorldpayFusion","maxLength":140,"minLength":2,"pattern":"^(?: *[\\p{L}\\p{N}+&\\/\\-.()])*+(?: *[\\p{L}\\p{N}\\-.,\\/&()@#']{2,140})*+(?: *[\\p{L}\\p{N}&\\/\\-.()])*+ *$"},"alias":{"type":"string","description":"An alternative or commonly-used name for the individual (e.g., preferred or informal name). Does not replace the legal name.","example":"WP Mitchell","maxLength":35,"minLength":2,"pattern":"^[\\p{L}\\-.,'()&]++(?:\\s++[\\p{L}\\-.,'()&]++)*+$"},"socialSecurityNumber":{"type":"string","description":"The individual's U.S. Social Security Number (SSN), required for U.S.-based tax or identity checks.","example":"004-54-6578","pattern":"^\\d{3}-\\d{2}-\\d{4}$"},"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":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was born."},"children":[]}]}]}],"example":"1983-10-12"},"address":{"$ref":"#/components/schemas/Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tradingAddress":{"description":"The trading address of this soleTrader.","$ref":"#/components/schemas/TradingAddress"},"residentialStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The residential status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["resident","nonResident","other"]},"customerReference":{"type":"string","description":"Unique reference provided by the payee. Only required for certain payout destinations.","example":"7564389201","maxLength":255,"minLength":1},"nationality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nationality of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currentAddressLessThanThreeYears":{"type":"boolean"},"isTradingAddressSameAsPrimary":{"type":"boolean","description":"Indicates whether the trading address is the same as the primary address.","example":true},"previousHomeAddress":{"$ref":"#/components/schemas/Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The previous home address of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"website":{"type":"string","description":"The URL of the merchant's website.","example":"https://example.com/"},"merchantCategoryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A 4-digit code to represent the merchant category. Only provide this where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"5411","maxLength":4,"minLength":4,"pattern":"^\\d{4}$"},"merchantCategoryCodeDescription":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description to describe the merchant category code. Only provide this where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Grocery Stores","maxLength":255,"minLength":1},"taxIdentifier":{"type":"string","description":"The entity's tax registration number (VAT, GST, EIN, TIN, or equivalent), depending on jurisdiction.","example":"JP-987654321","maxLength":35,"minLength":2,"pattern":"^[a-zA-Z0-9-]*$"}},"required":["address","firstName","lastName","title","tradingName","isTradingAddressSameAsPrimary"]}},"components/schemas/Phone":{"id":"components/schemas/Phone","kind":"json-schema","title":"Phone","data":{"type":"object","description":"Object containing phone information.","properties":{"prefix":{"type":"string","description":"The dialing prefix for the phone number.","example":"44","pattern":"^[0-9]{1,3}$"},"number":{"type":"string","description":"The phone number, without dashes.","example":"4281234","pattern":"[0-9]{1,20}"}},"required":["number","prefix"]}},"components/schemas/ReactivateParty":{"id":"components/schemas/ReactivateParty","kind":"json-schema","title":"ReactivateParty","data":{"type":"object","description":"Object containing party reactivation information.","properties":{"active":{"type":"boolean"},"dateTimeActivated":{"type":"string","description":"The date and time that the party was last activated, as an ISO 8601 zoned date time","example":"2025-01-25T14:57:012.302Z","readOnly":true}}}},"components/schemas/RelationshipToBusiness":{"id":"components/schemas/RelationshipToBusiness","kind":"json-schema","title":"RelationshipToBusiness","data":{"type":"object","properties":{"ownershipPercentage":{"type":"number","description":"Percentage of the ownership of the beneficial owner over the company.","format":"double","maximum":100},"director":{"type":"boolean","description":"A flag indicating if the beneficial owner is also a director for the company.\n"},"isPrincipalOwner":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flag indicating if the beneficial owner is also a principal owner for the company."},"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":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can set no more than "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" beneficial owner per party record of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as principal owner."},"children":[]}]}]}],"example":true},"position":{"type":"string","description":"Type of position of the beneficial owner within the company.","enum":["soleTrader","accountant","bursar","chairman","chairwoman","chiefExecutiveOfficer","clerk","companySecretary","creditController","deputyLeader","generalManager","leader","manager","managingDirector","master","guarantor","mayor","officeManager","operationsManager","president","principal","proprietor","townClerk","director","apportionmentAndOversight","chiefExecutive","complianceOversight","directorUnincorporatedAssociate","nonExecutiveDirector","significantManagement","smallFriendlySociety","chairperson","designatedMember","secretary","trustee","treasurer","businessRepresentative","authorisedSignatory","signatory","technicalContact","contractSignatory","publicOfficer","controller","beneficialOwner","partner","shareholder","chiefFinancialOfficer","chiefOperatingOfficer","beneficiary","charitySecretary","member","protector","settlor","soleProprietor","nonDesignatedMember"]}},"required":["director","ownershipPercentage","position"]}},"components/schemas/SoleTrader":{"id":"components/schemas/SoleTrader","kind":"json-schema","title":"SoleTrader","data":{"description":"A party represents the overall party record of your beneficiary (seller, vendor, provider). You can use this to store information about the party, to perform either an identity verification check, a split payment, or a payout.","allOf":[{"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - an individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soleTrader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a single person enterprise"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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":[]}]}]}],"enum":["company","person","soleTrader"]},"identityVerificationState":{"type":"string","enum":["verified","notVerified","pending","rejected","notApplicable","started","startedAction","pendingStepUpAction","pendingManualReview","stepUpReceived"],"readOnly":true},"identityVerificationMethod":{"type":"string","enum":["merchantCompliant","identityVerificationService"],"readOnly":true},"identityVerificationDate":{"type":"string","format":"date","description":"A valid date as YYYY-MM-DD","example":"2033-11-22","readOnly":true},"url":{"type":"string","description":"The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.","readOnly":true},"message":{"type":"string","description":"The message associated with link returned from Identity Verification Status (IVS).","readOnly":true},"partyReference":{"type":"string","description":"Your reference for this party, must be unique within an entity.\n","example":"Hosaka27384910","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"},"partyType":{"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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the person or business that will receive funds"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a transmitter of funds to a third party"},"children":[]}]}]}],"enum":["beneficiary","payer"]},"partyId":{"type":"string","description":"A unique identifier for the party generated by us.","readOnly":true},"email":{"type":"string","format":"email","description":"An email address for this party."},"merchant":{"$ref":"#/components/schemas/Merchant","description":"An object that contains information about the merchant."},"phones":{"type":"array","description":"A list of phone numbers associated with this party.","items":{"$ref":"#/components/schemas/Phone"}},"identityDocuments":{"type":"array","description":"A list of identity documents for this party.","items":{"$ref":"#/components/schemas/IdentityDocument"}},"balanceAccounts":{"type":"array","description":"A list of balance accounts that have been set up for this party.","items":{"$ref":"#/components/schemas/BalanceAccount"}},"dateTimeCreated":{"type":"string","description":"The date and time that the party was created, as an ISO 8601 zoned date time.","example":"2025-01-23T12:23:445.222Z","readOnly":true},"dateTimeUpdated":{"type":"string","description":"The date and time that the party was last updated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true},"version":{"type":"integer","format":"int32","readOnly":true},"payoutInstruments":{"type":"array","items":{"$ref":"#/components/schemas/BankAccount"}},"performIdentityVerification":{"type":"boolean","writeOnly":true},"active":{"type":"boolean","description":"Indicates whether the party is active or not.","example":true,"readOnly":true},"dateTimeDeactivated":{"type":"string","description":"The date and time that the party was last deactivated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true},"deactivationReason":{"type":"string","description":"The reason for deactivating a party.","example":"partyDormant","readOnly":true},"dispositionOfFunds":{"type":"string","description":"The disposition of funds for deactivated party.","example":"payoutToParty","readOnly":true},"dateTimeActivated":{"type":"string","description":"The date and time that the party was last activated, as an ISO 8601 zoned date time.","example":"2025-01-25T14:57:012.302Z","readOnly":true},"personalDetails":{"$ref":"#/components/schemas/PersonalDetailsImplForSoleTrader"}},"required":["merchant","partyReference","partyType","personalDetails","type"]}},"components/schemas/Wallet":{"id":"components/schemas/Wallet","kind":"json-schema","title":"Wallet","data":{"type":"object","properties":{"payoutInstrumentReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created by you. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field holds the beneficiary bank details. Use this to direct payouts to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the relevant beneficiary. This must be unique within an entity."},"children":[]}]}]}],"example":"personalCheckingAccount","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"},"payoutInstrumentId":{"type":"string","description":"An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.","example":"parOk0YlPtQogrqQdz7_fKXs0","maxLength":25,"minLength":25,"pattern":"^par[a-zA-Z0-9-_]*0$"},"payoutInstrumentType":{"type":"string","description":"The type of the payout instrument.","enum":["bankAccount","wallet","card"]},"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]*$"},"dateTimeCreated":{"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 and time the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created, as an ISO 8601 zoned date time."},"children":[]}]}]}],"readOnly":true},"dateTimeUpdated":{"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 and time the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutInstrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was updated, as an ISO 8601 zoned date time."},"children":[]}]}]}],"readOnly":true},"version":{"type":"integer","format":"int32"}},"required":["currency"]}},"schema_418":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Company"},{"$ref":"#/components/schemas/Person"},{"$ref":"#/components/schemas/SoleTrader"}]},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Person"},{"$ref":"#/components/schemas/SoleTrader"},{"$ref":"#/components/schemas/Company"}]},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0,"description":"Positive whole number indicating which page of the selected parties to return. Greater than 0.","example":5,"minimum":0},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":10,"description":"Number of items listed per page.","example":10,"maximum":100,"minimum":1},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"type":"array","description":"entity or entities to filter parties by","items":{"type":"string","description":"entity or entities to filter parties by","example":"Entity123"}},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return parties that are active when set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"type":"string","enum":["person","soleTrader","company"],"description":"Type of parties to return.","example":["soleTrader","company"]},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"type":"string","maxLength":25,"minLength":25,"pattern":"^par[a-zA-Z0-9-_]*0$"},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Person"},{"$ref":"#/components/schemas/SoleTrader"},{"$ref":"#/components/schemas/Company"}],"title":"party"},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"type":"string"},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/BankAccount"},{"$ref":"#/components/schemas/Wallet"},{"$ref":"#/components/schemas/Card"}],"title":"payout instrument"},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"type":"string","maxLength":25,"minLength":25,"pattern":"par.*0$"},"id":"schema_430"}},"exampleStore":{"components/examples/400":{"id":"components/examples/400","value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]}},"components/examples/500":{"id":"components/examples/500","value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."}},"components/examples/503":{"id":"components/examples/503","value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."}},"components/examples/Browse_Parties_200":{"id":"components/examples/Browse_Parties_200","value":{"parties":[{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"ts6SfP8eNv","partyType":"beneficiary","type":"person","partyId":"parJnf1XbmhV6j2cizaFQ54L0","email":"zH5O.V20XrO71@yWPtULl.cl4","phones":[{"prefix":"44","number":"km86YWLfjyL"}],"identityDocuments":[{"type":"passport","number":"zuggHJuTi","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1901-03-20","validTo":"1931-07-31"},{"type":"nationalId","number":"f1wlKPlz-8mXmh","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"1915-09-06","validTo":"1988-04-03"}],"balanceAccounts":[],"dateTimeCreated":"2025-09-02T15:51:53.868Z","dateTimeUpdated":"2025-09-03T15:51:54.257Z","version":2,"payoutInstruments":[],"active":true,"dateTimeDeactivated":"2025-09-03T15:51:54.211Z","dateTimeActivated":"2025-09-02T15:51:54.257Z","personalDetails":{"title":"Mr","firstName":"sa7h","middleName":"G3d3c","lastName":"eFGwfD84","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"2059-01-03","address":{"address1":"T6cF ubKLq1oMt xWHke","address2":"lDdv v5","city":"Manchester","countryCode":"GB","postalCode":"XF 9wj","type":"home"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false}},{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Z4AS5O3gVA","partyType":"beneficiary","type":"person","partyId":"parBCjKONvmeYaSK--v_NJK40","email":"zH5O.V20XrO71@yWPtULl.cl4","phones":[{"prefix":"44","number":"km86YWLfjyL"}],"identityDocuments":[{"type":"passport","number":"zuggHJuTi","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1901-03-20","validTo":"1931-07-31"},{"type":"nationalId","number":"f1wlKPlz-8mXmh","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"1915-09-06","validTo":"1988-04-03"}],"balanceAccounts":[{"currency":"GBP","payoutInstrumentReference":"UtwzOwGHMM","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parVUdr_mDPwl1EY3Pb5y-Cp0","dateTimeCreated":"2026-03-02T15:51:54.638Z","version":0,"accountNumber":"12343242","nextPayoutDate":"2026-03-19"},{"currency":"EUR","payoutInstrumentReference":"hCpcT6vTPB","scheduledPayoutDay":"thursday","frequency":"monthly","recurrence":"third","balanceAccountId":"paruowtxO9OPFIGjx9gYl5iE0","dateTimeCreated":"2026-03-02T15:51:58.314Z","version":0,"accountNumber":"12343242","nextPayoutDate":"2026-04-19"},{"currency":"INR","payoutInstrumentReference":"hCpcT6vTPB","frequency":"daily","balanceAccountId":"paruowtCO9OPFIGjx9gYl5iE0","dateTimeCreated":"2026-03-02T15:51:54.638Z","version":0,"accountNumber":"12343242","nextPayoutDate":"2026-03-03"}],"dateTimeCreated":"2026-03-02T15:51:54.638Z","version":0,"payoutInstruments":[{"payoutInstrumentReference":"hCpcT6vTPB","payoutInstrumentId":"par35uirx_fJZ9bjGu24UBB50","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-09-02T15:51:56.889Z","version":0,"accountHolderName":"UVfn D. kQdAzJRB","swiftBic":"1i08of9G","bankCode":"b4ZM5E","accountNumber":"xL60ChVg","accountType":"checking","iban":"WU0jAupifqjpgZ8pPIYb","bankName":"Metro Bank","address":{"address1":"bY o7a-IOeFVa rsxklGj8g 5FCB7","address2":"ohXty YYBO","city":"London","countryCode":"GB","postalCode":"Bs4j IqO","type":"business"},"branchCode":"Barclays Branch"},{"payoutInstrumentReference":"UtwzOwGHMM","payoutInstrumentId":"parAh7-5xjnkGUp4TmvJ0Vj00","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-09-02T15:51:54.638Z","version":0,"accountHolderName":"UVfn D. kQdAzJRB","swiftBic":"1i08of9G","bankCode":"b4ZM5E","accountNumber":"xL60ChVg","accountType":"checking","iban":"WU0jAupifqjpgZ8pPIYb","bankName":"HSBC UK BANK PLC","address":{"address1":"bY o7a-IOeFVa rsxklGj8g 5FCB7","address2":"ohXty YYBO","city":"London","countryCode":"GB","postalCode":"Bs4j IqO","type":"business"},"branchCode":"Taunton Branch"}],"active":true,"dateTimeActivated":"2026-03-02T15:51:54.638Z","personalDetails":{"title":"Mr","firstName":"sa7h","middleName":"G3d3c","lastName":"eFGwfD84","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"2059-01-03","address":{"address1":"T6cF ubKLq1oMt xWHke","address2":"lDdv v5","city":"Manchester","countryCode":"GB","postalCode":"XF 9wj","type":"home"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false}},{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"xHyFiJS9zo","partyType":"beneficiary","type":"soleTrader","partyId":"parqZvn1ritjWZbD4yRxEpCd0","email":"A4P.X6MrD@4zKMG8L.AeB","phones":[{"prefix":"81","number":"mSaIgVfwZw"}],"identityDocuments":[{"type":"taxRegistrationCode","number":"jdZ","issuingInstitution":"HMRC","issuingCountry":"GB","validFrom":"1945-06-07","validTo":"2078-12-08"},{"type":"passport","number":"7P6","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2060-03-27","validTo":"2067-03-22"}],"balanceAccounts":[{"currency":"GBP","balanceAccountId":"pare151tM6polLGHRMSQsWeO0","dateTimeCreated":"2025-09-02T15:51:55.144Z","version":0,"accountNumber":"0000550000085002"},{"currency":"USD","payoutInstrumentReference":"kNiuKzkNlO","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parr9a1J5alvURV2KrWFi8880","dateTimeCreated":"2025-09-02T15:51:58.578Z","version":0,"accountNumber":"0000550000085002","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-09-02T15:51:55.144Z","version":0,"payoutInstruments":[{"payoutInstrumentReference":"kNiuKzkNlO","payoutInstrumentId":"parlnjkdCvxRKCEdXO6QWbYG0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-09-02T15:51:57.484Z","version":0,"accountHolderName":"UVfn D. kQdAzJRB","swiftBic":"1i08of9G","bankCode":"b4ZM5E","accountNumber":"xL60ChVg","accountType":"checking","iban":"WU0jAupifqjpgZ8pPIYb","bankName":"Metro Bank","address":{"address1":"bY o7a-IOeFVa rsxklGj8g 5FCB7","address2":"ohXty YYBO","city":"London","countryCode":"GB","postalCode":"Bs4j IqO","type":"business"},"branchCode":"Barclays Branch"},{"payoutInstrumentReference":"O6zUzth3o6","payoutInstrumentId":"parrTlcspjYj2bqeYIez_tMz0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-09-02T15:51:55.144Z","version":0,"accountHolderName":"51B6k qmw","swiftBic":"n45SZCRQ","bankCode":"6c1tT8","accountNumber":"utJkHSus","accountType":"savings","iban":"mUWBqpkz8lHlBLKAF5WdUR5","bankName":"Lloyds Bank","address":{"address1":"roQ UHnZ87 V5x52Q","address2":"xpWWt 6I","city":"London","countryCode":"GB","postalCode":"AD 9Tz","type":"other"},"branchCode":"Bradford Branch"}],"active":true,"dateTimeActivated":"2025-09-02T15:51:55.144Z","personalDetails":{"title":"Ms","firstName":"hm70O","middleName":"OSoc","lastName":"52M","tradingName":"Linda Lee","alias":"John bailey","socialSecurityNumber":"333-55-1666","taxIdentifier":"TX-12354567","dateOfBirth":"2040-01-09","address":{"address1":"yWh bzP9Fa luw8GI","address2":"sqdo Rtt","city":"Chester","countryCode":"GB","postalCode":"Ib4 VJk","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"lw","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"xQ6 ZfG8qm YD0fTH","address2":"SWMR G2f","city":"Chester","countryCode":"GB","postalCode":"gV5 35W","type":"other"},"website":"https://www.example.com/","merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets"}},{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"G5ohEB3lUc","partyType":"beneficiary","type":"company","partyId":"par7anQCsbhS0yKZNIFpUtkI0","email":"info@example.com","phones":[{"prefix":"81","number":"8475932"}],"identityDocuments":[],"balanceAccounts":[{"currency":"EUR","payoutInstrumentReference":"mHWwfCJRCS","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parKwY5ezX2R4QaUGQ47cGYi0","dateTimeCreated":"2025-09-02T15:51:55.678Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1,"accountNumber":"12343242","nextPayoutDate":"2026-03-19"},{"currency":"USD","payoutInstrumentReference":"u8MamGFmEo","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parUoWq2uerKMrdAPFeBLqy80","dateTimeCreated":"2025-09-02T15:51:58.849Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1,"accountNumber":"12343242","nextPayoutDate":"2026-03-19"},{"currency":"GBP","balanceAccountId":"parfnsCbzM7Og3xIdfa48tAZ0","dateTimeCreated":"2025-09-02T15:51:55.678Z","version":0,"accountNumber":"12343242"}],"dateTimeCreated":"2025-09-02T15:51:56.295Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":2,"payoutInstruments":[{"payoutInstrumentReference":"u8MamGFmEo","payoutInstrumentId":"parSALwf8D8drIikDp0aQTrG0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-09-02T15:51:57.887Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1,"accountHolderName":"f3T5owE-5hZQQVR rYYIJel eOt.","swiftBic":"pogwBatv","bankCode":"b4ZM5E","accountNumber":"iZOB5YkF","accountType":"savings","iban":"5YHuGEWGF61PlsAUAKkryp","bankName":"Freeside Financial Corporation","address":{"address1":"q fbyli 0kyimLrIfq","address2":"7NOmwxh7","city":"York","state":"NA","countryCode":"GB","postalCode":"HJMW DKJn","type":"business"},"branchCode":"Muswell Hill Branch"},{"payoutInstrumentReference":"mHWwfCJRCS","payoutInstrumentId":"parpxxzfRTafscKcMwvERKGf0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-09-02T15:51:55.677Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1,"accountHolderName":"f3T5owE-5hZQQVR rYYIJel eOt.","swiftBic":"QnDYJdbt","bankCode":"b4ZM5E","accountNumber":"utJkHSus","accountType":"savings","iban":"5YHuGEWGF61PlsAUAKkryp","bankName":"Freeside Financial Corporation","address":{"address1":"q fbyli 0kyimLrIfq","address2":"7NOmwxh7","city":"London","countryCode":"GB","postalCode":"Bs4j IqO","type":"business"},"branchCode":"Barclays Branch"}],"active":true,"dateTimeActivated":"2025-09-02T15:51:56.295Z","companyDetails":{"merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","website":"https://www.example.com","legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"tradingAddress":{"address1":"789 Freeside Blvd","address2":"Villa Straylight","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"poBox"},"customerReference":"CustRefZA98765"},"beneficialOwners":[{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"GJbPJVtqFz","beneficialOwnerId":"par5BsbOKDecm8uWVgzYUor-0","personalDetails":{"title":"Ms","firstName":"John","middleName":"LVrVLk","lastName":"Bailer","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"1946-09-13","address":{"address1":"YZ7 1V7iJh xnZhNA","address2":"8DD6 7fg","city":"Burbank","countryCode":"GB","postalCode":"rmL v0W"},"residentialStatus":"resident","nationality":"lw","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"xgi osd16 bsMJ 1nnj","address2":"SWMR G2f","city":"Night City","countryCode":"GB","postalCode":"s2W CV6"}},"relationshipToBusiness":{"ownershipPercentage":25,"director":false,"isPrincipalOwner":true,"position":"officeManager"},"email":"UucOR.ppaJ1rdP@4BLu9KX.54i","phones":[{"prefix":"44","number":"km86YWLfjyL"}],"identityDocuments":[{"type":"passport","number":"sJCY65PyZ","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1922-10-07","validTo":"2043-06-08"}],"dateTimeCreated":"2025-09-02T15:51:55.678Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1},{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"YezTTwoVHR","beneficialOwnerId":"parIrzObRP9_nc7Y5R29fgoC0","personalDetails":{"title":"Dr","firstName":"Johny","middleName":"tusFSTLKvR","lastName":"pkw1XH1","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"2062-04-19","address":{"address1":"AI6 TyzGI5B YprQ7Y","address2":"05uX xGG","city":"London","countryCode":"GB","postalCode":"Dv4T erT","type":"home"},"residentialStatus":"nonResident","nationality":"lw","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"CIo U0wJ3a 1k3rwN","address2":"8DD6 7fg","city":"London","countryCode":"GB","postalCode":"bZX TqF","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"position":"partner"},"email":"PuDnv.iX8XrhV@X8RQ3S5.4IC","phones":[{"prefix":"44","number":"Z0avBNjMlS"}],"identityDocuments":[{"type":"passport","number":"v2OhZxguD","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1989-06-06","validTo":"2028-03-19"}],"dateTimeCreated":"2025-09-02T15:51:55.678Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1},{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"zHCxMG8x4T","beneficialOwnerId":"parT4dazXixMu5npZGQL0iwH0","personalDetails":{"title":"Dr","firstName":"Jenly","middleName":"tusFSTLKvR","lastName":"Morris","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"1918-01-01","address":{"address1":"NLv QCTjBRt P4cpVy","address2":"05uX xGG","city":"London","countryCode":"GB","postalCode":"Dv4T erT","type":"home"},"residentialStatus":"nonResident","nationality":"lw","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"ceR 7DcVj9 qP6wd4","address2":"8DD6 7fg","city":"London","countryCode":"GB","postalCode":"bZX TqF","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"position":"partner"},"email":"9UFJ.oVZsgU@laUTWaJ.rs0","phones":[{"prefix":"44","number":"Z0avBNjMlS"}],"identityDocuments":[{"type":"passport","number":"v2OhZxguD","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1989-06-06","validTo":"2028-03-19"}],"dateTimeCreated":"2025-09-02T15:51:56.294Z","dateTimeUpdated":"2025-09-03T15:51:56.294Z","version":1}]}],"pagination":{"page":0,"size":10,"pageCount":1,"totalNumberOfRecords":4}},"description":"Browse parties"},"components/examples/400_Invalid_Url":{"id":"components/examples/400_Invalid_Url","value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]}},"components/examples/Create_Party_Person_modular":{"id":"components/examples/Create_Party_Person_modular","value":{"merchant":{"entity":"default"},"partyReference":"5htNU0XQ7V","partyType":"beneficiary","type":"person","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Henry Smith","socialSecurityNumber":"333-75-6666","residentialStatus":"resident","dateOfBirth":"1983-10-12","address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","type":"home","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"}},"email":"case.mitchell@example.com","phones":[{"number":"02079461234","prefix":"44"}]}},"components/examples/Create_Party_Person_orchestrated":{"id":"components/examples/Create_Party_Person_orchestrated","value":{"merchant":{"entity":"default"},"partyReference":"VuzvLew4y7","partyType":"beneficiary","type":"person","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"333-55-9666","residentialStatus":"resident","dateOfBirth":"1983-10-12","currentAddressLessThanThreeYears":true,"address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","type":"home","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"},"previousHomeAddress":{"address1":"1847 Morrison Court","address2":"Unit 55","type":"home","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"}},"email":"case.mitchell@example.com","phones":[{"number":"02079461234","prefix":"44"}],"balanceAccounts":[{"currency":"GBP","scheduledPayoutDay":"thursday","frequency":"weekly","payoutInstrumentReference":"personalCheckingAccount"}],"payoutInstruments":[{"accountHolderName":"Case H. Mitchell","payoutInstrumentType":"bankAccount","swiftBic":"BUKBGB22","bankCode":"045110","branchCode":"Taunton Branch","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"HSBC UK BANK PLC","payoutInstrumentReference":"personalCheckingAccount","currency":"GBP","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}],"performIdentityVerification":true}},"components/examples/Create_Party_SoleTrader_with_TradingAddress_modular":{"id":"components/examples/Create_Party_SoleTrader_with_TradingAddress_modular","value":{"merchant":{"entity":"default"},"partyReference":"CGeC6vSmyb","partyType":"beneficiary","type":"soleTrader","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","tradingName":"Linda's Supplies","alias":"Linda Smith","socialSecurityNumber":"333-57-6666","taxIdentifier":"GB-123456789","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"isTradingAddressSameAsPrimary":false,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"},"tradingAddress":{"address1":"999 Sprawl lane","address2":"Flat 509","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}]}},"components/examples/Create_Party_SoleTrader_without_TradingAddress_orchestrated":{"id":"components/examples/Create_Party_SoleTrader_without_TradingAddress_orchestrated","value":{"merchant":{"entity":"default"},"partyReference":"Anderson736","partyType":"beneficiary","type":"soleTrader","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","tradingName":"Linda's Supplies","alias":"Linda Smith","socialSecurityNumber":"333-57-6666","taxIdentifier":"GB-123456789","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"isTradingAddressSameAsPrimary":true,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}],"identityDocuments":[{"type":"passport","number":"789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2021-01-01","validTo":"2031-01-01"},{"type":"taxRegistrationCode","number":"123","issuingInstitution":"HMRC","issuingCountry":"GB","validFrom":"2023-11-30","validTo":"2030-12-30"}],"balanceAccounts":[{"currency":"GBP","frequency":"daily","payoutInstrumentReference":"primaryBusinessAccount"}],"payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentType":"bankAccount","currency":"GBP","accountHolderName":"Linda Lee","swiftBic":"LLOYGB21","bankCode":"000112","branchCode":"Bradford Branch","accountNumber":"12345678","accountType":"savings","iban":"JP123000400003123456789","bankName":"Lloyds Bank","address":{"address1":"789 Sakura Street","address2":"Suite 5A","city":"London","countryCode":"GB","postalCode":"E1 6AN","type":"other"}}]}},"components/examples/Create_Party_Company_with_TradingAddress_orchestrated":{"id":"components/examples/Create_Party_Company_with_TradingAddress_orchestrated","value":{"merchant":{"entity":"default"},"partyReference":"BGy1nSxvSw","partyType":"beneficiary","type":"company","companyDetails":{"legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","customerReference":"CustRefZA98765","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":false,"website":"https://www.example.com","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"},"tradingAddress":{"address1":"789 Freeside Blvd","address2":"Villa Straylight","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"poBox"}},"email":"info@example.com","phones":[{"number":"8475932","prefix":"81"}],"balanceAccounts":[{"currency":"GBP"},{"currency":"EUR","scheduledPayoutDay":"thursday","frequency":"monthly","recurrence":"third","payoutInstrumentReference":"primaryBusinessAccount2"}],"payoutInstruments":[{"accountHolderName":"Tessier-Ashpool Systems Ltd.","payoutInstrumentType":"bankAccount","swiftBic":"FSFCGB33","bankCode":"045110","branchCode":"Barclays Branch","accountNumber":"12345678","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","payoutInstrumentReference":"primaryBusinessAccount2","currency":"EUR","address":{"address1":"3 Villa Straylight","address2":"Freeside","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}}],"beneficialOwners":[{"beneficialOwnerReference":"39XaAW8hCf","personalDetails":{"title":"Dr","firstName":"Peter","middleName":"Illusionet","lastName":"Riviera","alias":"Peter Smith","socialSecurityNumber":"383-55-6666","residentialStatus":"nonResident","dateOfBirth":"1972-03-22","nationality":"GB","address":{"address1":"789 Downing Street","address2":"Flat 404","city":"London","type":"home","countryCode":"GB","postalCode":"SW1A 2AA"},"currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"123 Oxford Street","address2":"Flat 101","city":"London","type":"home","countryCode":"GB","postalCode":"W1D 1LP"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"position":"partner"},"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"email":"peter.riviera@example.com","phones":[{"number":"0205556789","prefix":"44"}]},{"beneficialOwnerReference":"A9CuJNpryM","personalDetails":{"title":"Ms","firstName":"Molly","middleName":"Puppet","lastName":"Millions","alias":"Molly Smith","socialSecurityNumber":"313-55-6666","residentialStatus":"resident","dateOfBirth":"1980-05-15","nationality":"GB","address":{"address1":"456 Sprawl Street","address2":"Flat 101","city":"Burbank","countryCode":"GB","postalCode":"RM1 4PL"},"currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"789 Night City Blvd","address2":"Flat 303","city":"Night City","countryCode":"GB","postalCode":"RM2 3PL"}},"relationshipToBusiness":{"ownershipPercentage":25,"director":false,"position":"officeManager"},"identityDocuments":[{"type":"passport","number":"A12345678","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2020-01-01","validTo":"2030-01-01"}],"email":"molly.millions@example.com","phones":[{"number":"02079461234","prefix":"44"}]}]}},"components/examples/Create_Party_Company_without_TradingAddress_modular":{"id":"components/examples/Create_Party_Company_without_TradingAddress_modular","value":{"merchant":{"entity":"default"},"partyReference":"BGy1nSxvSw","partyType":"beneficiary","type":"company","companyDetails":{"legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","customerReference":"CustRefZA98765","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":true,"website":"https://www.example.com","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}},"email":"info@example.com","phones":[{"number":"8475932","prefix":"81"}]}},"components/examples/Person_created_201_modular":{"id":"components/examples/Person_created_201_modular","value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Frank118","partyType":"beneficiary","type":"person","partyId":"parpI1tAL2bK8Lb-52Rfblg30","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"353-55-6666","dateOfBirth":"1983-10-12","address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"home"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false},"email":"case.mitchell@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[],"balanceAccounts":[],"dateTimeCreated":"2025-04-07T20:42:17.292Z","version":0,"active":true,"dateTimeActivated":"2025-04-07T20:42:17.292Z","payoutInstruments":[]},"description":"Create a party for a person (modular)"},"components/examples/Person_created_201_orchestrated":{"id":"components/examples/Person_created_201_orchestrated","value":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Heidi197","partyType":"beneficiary","type":"person","partyId":"parMbuHucAsLeLL0BhDpWdjE0","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"333-55-6656","dateOfBirth":"1983-10-12","address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"home"},"previousHomeAddress":{"address1":"1847 Morrison Court","address2":"Unit 55","type":"home","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"},"residentialStatus":"resident","currentAddressLessThanThreeYears":true},"email":"case.mitchell@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}],"balanceAccounts":[{"currency":"GBP","payoutInstrumentReference":"personalCheckingAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"par3GymZO5MtP18qe5NFaaPp0","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"active":true,"dateTimeActivated":"2025-04-16T20:46:24.122Z","payoutInstruments":[{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parclOAFlaOX-H_2UBp9tWbd0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"HSBC UK BANK PLC","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Taunton Branch"}]},"description":"Create party for a person with previous home address (orchestrated)"},"components/examples/SoleTrader_with_TradingAddress_created_201_modular":{"id":"components/examples/SoleTrader_with_TradingAddress_created_201_modular","value":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"CGeC6vSmyb","partyType":"beneficiary","type":"soleTrader","partyId":"parUbyQnnkuOPHFiHsVutAru0","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","isTradingAddressSameAsPrimary":false,"website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","tradingName":"Linda's Supplies","alias":"Linda Smith","socialSecurityNumber":"343-55-6666","taxIdentifier":"GB-123456789","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"tradingAddress":{"address1":"999 Sprawl lane","address2":"Flat 509","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}],"identityDocuments":[],"balanceAccounts":[],"payoutInstruments":[],"dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"active":true,"dateTimeActivated":"2025-04-16T20:46:25.444Z"},"description":"Create a party for a sole trader with trading address (modular)"},"components/examples/SoleTrader_without_TradingAddress_created_201_orchestrated":{"id":"components/examples/SoleTrader_without_TradingAddress_created_201_orchestrated","value":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Anderson736","partyType":"beneficiary","type":"soleTrader","partyId":"parUbyQnnkuOPHFiHsVutAru0","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","tradingName":"Linda's Supplies","alias":"Linda Smith","socialSecurityNumber":"343-55-6666","taxIdentifier":"GB-123456789","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"isTradingAddressSameAsPrimary":true,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}],"identityDocuments":[{"type":"passport","number":"789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2021-01-01","validTo":"2031-01-01"},{"type":"taxRegistrationCode","number":"123","issuingInstitution":"HMRC","issuingCountry":"GB","validFrom":"2023-11-30","validTo":"2030-12-30"}],"balanceAccounts":[{"currency":"GBP","payoutInstrumentReference":"primaryBusinessAccount","frequency":"daily","balanceAccountId":"par3GymZO5MtP18qe5NFaaPp0","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"active":true,"dateTimeActivated":"2025-04-16T20:46:25.444Z","payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parclOAFlaOX-H_2UBp9tWbd0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountHolderName":"Linda Lee","swiftBic":"LLOYGB21","bankCode":"000112","branchCode":"Bradford Branch","accountNumber":"12345678","accountType":"savings","iban":"P123000400003123456789","bankName":"Lloyds Bank","address":{"address1":"789 Sakura Street","address2":"Suite 5A","city":"London","countryCode":"GB","postalCode":"E1 6AN","type":"other"}}]},"description":"Create a party for a sole trader without trading address (orchestrated)"},"components/examples/Company_with_TradingAddress_created_201_orchestrated":{"id":"components/examples/Company_with_TradingAddress_created_201_orchestrated","value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Genesis829","partyType":"beneficiary","type":"company","partyId":"par1Gya_pV7rRYUMI3Ep_ssX0","companyDetails":{"merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":true,"website":"https://www.example.com","legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"customerReference":"CustRefZA98765"},"email":"info@example.com","phones":[{"prefix":"81","number":"8475932"}],"identityDocuments":[],"balanceAccounts":[{"currency":"GBP","balanceAccountId":"parFwA0DbiCax4y5mzj6207T0","dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"accountNumber":"23198765"},{"currency":"EUR","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"monthly","recurrence":"third","balanceAccountId":"parKXSsjAGYuzsJ6AnD_NSCD0","dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"active":true,"dateTimeActivated":"2025-04-24T18:05:40.908Z","payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parxYYu5sdO559Yo60Ud4ep50","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCGB33","bankCode":"045110","accountNumber":"1234567890","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"}],"beneficialOwners":[{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Jennings377","beneficialOwnerId":"parrLsIhp6pE9VQmWG2Y8wKm0","personalDetails":{"title":"Dr","firstName":"Peter","middleName":"Illusionet","alias":"Peter Smith","socialSecurityNumber":"333-15-6666","lastName":"Riviera","dateOfBirth":"1972-03-22","address":{"address1":"789 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"123 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":true,"position":"partner"},"email":"peter.riviera@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0},{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Dana455","beneficialOwnerId":"parC3Po42KDFr1SRgu351Ncy0","personalDetails":{"title":"Ms","firstName":"Molly","middleName":"Puppet","lastName":"Millions","alias":"Molly Smith","socialSecurityNumber":"353-55-6666","dateOfBirth":"1980-05-15","address":{"address1":"456 Sprawl Street","address2":"Flat 101","city":"Burbank","countryCode":"GB","postalCode":"RM1 4PL"},"residentialStatus":"resident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"789 Night City Blvd","address2":"Flat 303","city":"Night City","countryCode":"GB","postalCode":"RM2 3PL"}},"relationshipToBusiness":{"ownershipPercentage":25,"director":false,"isPrincipalOwner":true,"position":"officeManager"},"email":"molly.millions@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"A12345678","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2020-01-01","validTo":"2030-01-01"}],"dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0}]},"description":"Party for a Company with trading address different than legal address (orchestrated)"},"components/examples/Company_without_TradingAddress_created_201_modular":{"id":"components/examples/Company_without_TradingAddress_created_201_modular","value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Genesis829","partyType":"beneficiary","type":"company","partyId":"par1Gya_pV7rRYUMI3Ep_ssX0","companyDetails":{"merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":true,"website":"https://www.example.com","legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"customerReference":"CustRefZA98765"},"email":"info@example.com","phones":[{"prefix":"81","number":"8475932"}],"identityDocuments":[],"balanceAccounts":[],"dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"active":true,"dateTimeActivated":"2025-04-24T18:05:40.908Z","payoutInstruments":[],"beneficialOwners":[]},"description":"party for a company without trading address (modular)"},"components/examples/Get_Party_Person_200_orchestrated":{"id":"components/examples/Get_Party_Person_200_orchestrated","value":{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Heidi197","partyType":"beneficiary","type":"person","partyId":"parMbuHucAsLeLL0BhDpWdjE0","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Henry Smith","socialSecurityNumber":"333-55-6666","dateOfBirth":"1983-10-12","address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"home"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false},"email":"case.mitchell@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}],"balanceAccounts":[{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"pareBH4YMkUx7MA2X7bnS4750","dateTimeCreated":"2025-04-16T20:46:26.727Z","version":0,"accountNumber":"12645678","nextPayoutDate":"2026-03-19"},{"currency":"GBP","payoutInstrumentReference":"personalCheckingAccount2","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"par3GymZO5MtP18qe5NFaaPp0","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountNumber":"2319876543210","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"active":true,"dateTimeActivated":"2025-04-24T17:55:56.283Z","payoutInstruments":[{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parclOAFlaOX-H_2UBp9tWbd0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"HSBC UK BANK PLC","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Taunton Branch"},{"payoutInstrumentReference":"personalCheckingAccount2","payoutInstrumentId":"parKsh3dSA_VRckwEDRHLzOR0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-16T20:46:26.235Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"2319876543210","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"}]},"description":"Get a party for person"},"components/examples/Get_Party_SoleTrader_200_orchestrated":{"id":"components/examples/Get_Party_SoleTrader_200_orchestrated","value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Anderson736","partyType":"beneficiary","type":"soleTrader","partyId":"parUbyQnnkuOPHFiHsVutAru0","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","isTradingAddressSameAsPrimary":true,"website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","alias":"Linda Smith","socialSecurityNumber":"133-55-6666","taxIdentifier":"GB-123456789","tradingName":"Linda's Supplies","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}],"identityDocuments":[{"type":"taxRegistrationCode","number":"123","issuingInstitution":"HMRC","issuingCountry":"GB","validFrom":"2023-11-30","validTo":"2030-12-30"},{"type":"passport","number":"789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2021-01-01","validTo":"2031-01-01"}],"balanceAccounts":[{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},{"currency":"GBP","balanceAccountId":"parQj9Y4leX3ysLFSQ7DXm1z0","dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"accountNumber":"12345676"}],"dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"active":true,"dateTimeActivated":"2025-04-24T17:55:56.283Z","payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parFrc7XcecQ7zVXbAodFe6m0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"accountHolderName":"Linda Lee","swiftBic":"LLOYGB21","bankCode":"000112","accountNumber":"12345678","accountType":"savings","iban":"JP123000400003123456789","bankName":"Lloyds Bank","address":{"address1":"789 Sakura Street","address2":"Suite 5A","city":"London","countryCode":"GB","postalCode":"E1 6AN","type":"other"},"branchCode":"Bradford Branch"},{"payoutInstrumentReference":"primaryBusinessAccount2","payoutInstrumentId":"parnHhcim1r9IYtG8I7Twbbc0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-16T20:46:26.420Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"}]},"description":"Get a party for soleTrader"},"components/examples/Get_Party_Company_200_orchestrated":{"id":"components/examples/Get_Party_Company_200_orchestrated","value":{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Genesis829","partyType":"beneficiary","type":"company","partyId":"par1Gya_pV7rRYUMI3Ep_ssX0","companyDetails":{"merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":false,"website":"https://www.example.com","legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","registrationNumber":"7564389201","taxIdentifier":"GB987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"tradingAddress":{"address1":"789 Freeside Blvd","address2":"Villa Straylight","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"poBox"},"customerReference":"CustRefZA98765"},"email":"info@example.com","phones":[{"prefix":"81","number":"8475932"}],"identityDocuments":[],"balanceAccounts":[{"currency":"GBP","balanceAccountId":"parFwA0DbiCax4y5mzj6207T0","dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"accountNumber":"12345678"},{"currency":"EUR","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parKXSsjAGYuzsJ6AnD_NSCD0","dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"accountNumber":"123459978","nextPayoutDate":"2026-04-30"},{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount2","frequency":"daily","balanceAccountId":"par0yJR1v3RBd8B1CrEYDpTx0","dateTimeCreated":"2026-04-24T18:05:40.908Z","dateTimeUpdated":"2026-04-25T18:05:40.908Z","version":1,"accountNumber":"1234567128","nextPayoutDate":"2026-04-27"}],"dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"active":true,"dateTimeActivated":"2026-04-24T18:05:40.908Z","payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parxYYu5sdO559Yo60Ud4ep50","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCGB33","bankCode":"045110","accountNumber":"1234567890","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},{"payoutInstrumentReference":"primaryBusinessAccount2","payoutInstrumentId":"parbLmHCft8cLP8XXsay63fQ0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCUS33","bankCode":"045110","accountNumber":"2276581","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54","type":"business"},"branchCode":"Muswell Hill Branch"}],"beneficialOwners":[{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Jennings377","beneficialOwnerId":"parrLsIhp6pE9VQmWG2Y8wKm0","personalDetails":{"title":"Dr","firstName":"Peter","middleName":"Illusionet","lastName":"Riviera","alias":"Peter Smith","socialSecurityNumber":"323-55-6666","dateOfBirth":"1972-03-22","address":{"address1":"789 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"123 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":false,"position":"partner"},"email":"peter.riviera@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0},{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Orpha684","beneficialOwnerId":"parjDSIhcZTkdGD31KwawOrn0","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John Smith","socialSecurityNumber":"343-55-6666","dateOfBirth":"1972-05-22","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"425 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":true,"position":"partner"},"email":"John.bailey@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0},{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Dana455","beneficialOwnerId":"parC3Po42KDFr1SRgu351Ncy0","personalDetails":{"title":"Ms","firstName":"Molly","middleName":"Puppet","lastName":"Millions","alias":"Molly Smith","socialSecurityNumber":"332-55-6666","dateOfBirth":"1980-05-15","address":{"address1":"456 Sprawl Street","address2":"Flat 101","city":"Burbank","countryCode":"GB","postalCode":"RM1 4PL"},"residentialStatus":"resident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"789 Night City Blvd","address2":"Flat 303","city":"Night City","countryCode":"GB","postalCode":"RM2 3PL"}},"relationshipToBusiness":{"ownershipPercentage":25,"director":false,"isPrincipalOwner":true,"position":"officeManager"},"email":"molly.millions@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"A12345678","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2020-01-01","validTo":"2030-01-01"}],"dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0}]},"description":"Get a party for company"},"components/examples/Update_Party_Person_orchestrated":{"id":"components/examples/Update_Party_Person_orchestrated","value":{"merchant":{"entity":"default"},"partyReference":"8X87XwQ7Fv","partyType":"beneficiary","type":"person","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"393-55-6666","residentialStatus":"resident","dateOfBirth":"1983-10-12","address":{"address1":"2025 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"}},"email":"case.mitchell@example.com","phones":[{"number":"02079461234","prefix":"44"}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}]}},"components/examples/Update_Party_Person_200_orchestrated":{"id":"components/examples/Update_Party_Person_200_orchestrated","value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Lela300","partyType":"beneficiary","type":"person","partyId":"par4733xO8y2YI9HSOTG-kba0","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"343-55-6666","dateOfBirth":"1983-10-12","address":{"address1":"2025 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false},"email":"case.mitchell@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}],"balanceAccounts":[{"currency":"GBP","payoutInstrumentReference":"personalCheckingAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parXRSh-RDDLU5NyGZpQhyNb0","dateTimeCreated":"2025-04-21T20:11:08.699Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"},{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount2","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parBTwBk8J3s3nhgbo1vNyvJ0","dateTimeCreated":"2025-04-21T20:11:12.991Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-21T20:11:08.695Z","dateTimeUpdated":"2025-04-21T20:11:15.341Z","version":1,"active":true,"dateTimeActivated":"2025-04-24T17:55:56.283Z","payoutInstruments":[{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"paru47L8iaV-cm7doWxO7oWm0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-21T20:11:08.698Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"HSBC UK BANK PLC","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Taunton Branch"},{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parbQkpoZT3adRASZB9Zp9e-0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-21T20:11:11.251Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"}]},"description":"Update party of a person (orchestrated)"},"components/examples/Deactivate_Party_Person_modular":{"id":"components/examples/Deactivate_Party_Person_modular","value":{"deactivationReason":"partyDormant","dispositionOfFunds":"payoutToParty"}},"components/examples/Deactivate_Party_Person_200_modular":{"id":"components/examples/Deactivate_Party_Person_200_modular","value":{"deactivationReason":"partyDormant","dispositionOfFunds":"payoutToParty","active":false,"dateTimeDeactivated":"2025-07-29T17:34:01.621Z"},"description":"Deactivate an active party (modular)"},"components/examples/Reactivate_Party_Person_modular":{"id":"components/examples/Reactivate_Party_Person_modular","value":{"active":true}},"components/examples/Reactivate_Party_Person_200_modular":{"id":"components/examples/Reactivate_Party_Person_200_modular","value":{"active":true,"dateTimeActivated":"2025-07-29T17:34:01.621Z"},"description":"Activate an deactivated party (modular)"},"components/examples/Create_BalanceAccount_Person_modular":{"id":"components/examples/Create_BalanceAccount_Person_modular","value":{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount2","scheduledPayoutDay":"friday","frequency":"weekly"}},"components/examples/Create_BalanceAccount_SoleTrader_modular":{"id":"components/examples/Create_BalanceAccount_SoleTrader_modular","value":{"currency":"USD","scheduledPayoutDay":"friday","frequency":"monthly","recurrence":"first","payoutInstrumentReference":"primaryBusinessAccount"}},"components/examples/Create_BalanceAccount_Company_modular":{"id":"components/examples/Create_BalanceAccount_Company_modular","value":{"currency":"USD","frequency":"daily","payoutInstrumentReference":"primaryBusinessAccount"}},"components/examples/BalanceAccount_Person_created_201_modular":{"id":"components/examples/BalanceAccount_Person_created_201_modular","value":{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount2","scheduledPayoutDay":"friday","frequency":"weekly","balanceAccountId":"pareBH4YMkUx7MA2X7bnS4750","dateTimeCreated":"2025-04-16T20:46:26.727Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"description":"Balance account for a party of an existing person (modular)"},"components/examples/BalanceAccount_SoleTrader_created_201_modular":{"id":"components/examples/BalanceAccount_SoleTrader_created_201_modular","value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"friday","frequency":"monthly","recurrence":"first","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"description":"Balance account for a party of an existing soleTrader (modular)"},"components/examples/BalanceAccount_Company_created_201_modular":{"id":"components/examples/BalanceAccount_Company_created_201_modular","value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","frequency":"daily","balanceAccountId":"parGWfE__Xr1F-AmY0v72fwR0","dateTimeCreated":"2025-04-16T20:46:27.014Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"description":"Balance account for a party of an existing company (modular)"},"components/examples/Get_BalanceAccount_Company_200_modular":{"id":"components/examples/Get_BalanceAccount_Company_200_modular","value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","frequency":"daily","balanceAccountId":"parGWfE__Xr1F-AmY0v72fwR0","dateTimeCreated":"2025-04-16T20:46:27.014Z","dateTimeUpdated":"2025-04-17T20:46:27.014Z","version":1,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"description":"Balance account for a party of type company (modular)"},"components/examples/Get_BalanceAccount_Person_200_modular":{"id":"components/examples/Get_BalanceAccount_Person_200_modular","value":{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount","scheduledPayoutDay":"friday","frequency":"weekly","balanceAccountId":"pareBH4YMkUx7MA2X7bnS4750","dateTimeCreated":"2025-04-16T20:46:26.727Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"description":"Balance account for a party of type person (modular)"},"components/examples/Get_BalanceAccount_SoleTrader_200_modular":{"id":"components/examples/Get_BalanceAccount_SoleTrader_200_modular","value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"friday","frequency":"monthly","recurrence":"first","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"description":"Balance account for a party of type sole trader (modular)"},"components/examples/Update_Balance_Account_SoleTrader_modular":{"id":"components/examples/Update_Balance_Account_SoleTrader_modular","value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","dateTimeUpdated":"2025-04-16T20:46:29.901Z","version":1,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"}},"components/examples/Update_Balance_Account_SoleTrader_200_modular":{"id":"components/examples/Update_Balance_Account_SoleTrader_200_modular","value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","dateTimeUpdated":"2025-04-18T20:46:29.901Z","version":2,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"description":"Update balance account for existing party of a sole trader (modular)"},"components/examples/Create_Beneficial_Owner_modular":{"id":"components/examples/Create_Beneficial_Owner_modular","value":{"beneficialOwnerReference":"xdl12goH60","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John Smith","socialSecurityNumber":"333-55-6666","residentialStatus":"nonResident","dateOfBirth":"1972-05-22","nationality":"GB","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","type":"home","countryCode":"GB","postalCode":"SW1A 2AA"},"currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"425 Oxford Street","address2":"Flat 101","city":"London","type":"home","countryCode":"GB","postalCode":"W1D 1LP"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":false,"position":"partner"},"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"email":"John.bailey@example.com","phones":[{"number":"0205556789","prefix":"44"}]}},"components/examples/Beneficial_owner_created_201_modular":{"id":"components/examples/Beneficial_owner_created_201_modular","value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"owner28","beneficialOwnerId":"parNtJbNC8_fd_HRKyQRekiN0","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"1972-05-22","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"425 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":false,"position":"partner"},"email":"John.bailey@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2025-03-20T18:33:41.480Z","version":0},"description":"Beneficial owner for existing party type company (modular)"},"components/examples/Get_Beneficial_Owner_200_modular":{"id":"components/examples/Get_Beneficial_Owner_200_modular","value":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Santino227","beneficialOwnerId":"parNKRss9vllWyX1MUVOj7b-0","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John bailey","socialSecurityNumber":"373-55-6666","dateOfBirth":"1972-05-22","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"425 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":false,"position":"partner"},"email":"John.bailey@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2025-04-07T20:47:59.479Z","dateTimeUpdated":"2025-04-08T20:47:59.479Z","version":1},"description":"Get a beneficial owner"},"components/examples/Update_Beneficial_Owner_modular":{"id":"components/examples/Update_Beneficial_Owner_modular","value":{"beneficialOwnerReference":"uWBzL2nzx3","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John bailey","socialSecurityNumber":"333-55-6566","residentialStatus":"nonResident","dateOfBirth":"1972-05-22","nationality":"GB","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","type":"home","countryCode":"GB","postalCode":"SW1A 2AA"},"currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"200 Oxford Street","address2":"Flat 101","city":"London","type":"home","countryCode":"GB","postalCode":"W1D 1LP"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":true,"position":"partner"},"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"email":"John.bailey@example.com","phones":[{"number":"0205556789","prefix":"44"}]}},"components/examples/Update_Beneficial_Owner_200_modular":{"id":"components/examples/Update_Beneficial_Owner_200_modular","value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Gerson337","beneficialOwnerId":"pardPhiwdlp8VcnS8U7LHVbE0","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John Bailey","socialSecurityNumber":"393-55-6666","dateOfBirth":"1972-05-22","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"200 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":true,"position":"partner"},"email":"John.bailey@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2025-04-10T15:45:06.349Z","version":2,"dateTimeUpdated":"2025-04-10T15:45:09.389Z"},"description":"Update the beneficial owner for a party company (modular)"},"components/examples/Get_IVS_Company_200_modular":{"id":"components/examples/Get_IVS_Company_200_modular","value":{"overall":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService"},"party":{"identityVerificationState":"started","partyReference":"Linnea474","partyId":"parWcAyq5G2-1KwvsEkFAKwz0"},"beneficialOwners":[{"identityVerificationState":"started","beneficialOwnerReference":"Mac551","beneficialOwnerId":"parAZo80iViOTdKRJi4Oq14Z0"},{"identityVerificationState":"started","beneficialOwnerReference":"Thea799","beneficialOwnerId":"parB5ON-IEK4olrLuHvjEDpE0"},{"identityVerificationState":"started","beneficialOwnerReference":"Santino227","beneficialOwnerId":"parNKRss9vllWyX1MUVOj7b-0"}]},"description":"Get Identiy Verification Status on a party of a company (modular)"},"components/examples/Perform_IVS_Company_modular":{"id":"components/examples/Perform_IVS_Company_modular","value":{"performIdentityVerification":true}},"components/examples/Perform_IVS_Company_200_modular":{"id":"components/examples/Perform_IVS_Company_200_modular","value":{"overall":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService"},"party":{"identityVerificationState":"started","partyReference":"Euna925","partyId":"par1Bbf6r80Q3mEvhp_xBKNM0"},"beneficialOwners":[{"identityVerificationState":"started","beneficialOwnerReference":"Floy829","beneficialOwnerId":"parsH2dSCcczQveB-GQNx0qq0"},{"identityVerificationState":"started","beneficialOwnerReference":"Christina843","beneficialOwnerId":"parbQR-8sRkYASaOzOVPX5d10"},{"identityVerificationState":"started","beneficialOwnerReference":"Arlo912","beneficialOwnerId":"pargosUuzW0vv8HrWsCTuadb0"}]},"description":"Identity Verification Status on a party of a company (modular)"},"components/examples/Create_PayoutInstrument_Person_modular":{"id":"components/examples/Create_PayoutInstrument_Person_modular","value":{"accountHolderName":"Case H. Mitchell","payoutInstrumentType":"bankAccount","swiftBic":"BUKBGB22","bankCode":"045110","branchCode":"Barclays Branch","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","payoutInstrumentReference":"personalCheckingAccount","currency":"EUR","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}}},"components/examples/Create_PayoutInstrument_SoleTrader_modular":{"id":"components/examples/Create_PayoutInstrument_SoleTrader_modular","value":{"accountHolderName":"Case H. Mitchell","payoutInstrumentType":"bankAccount","swiftBic":"BUKBGB22","bankCode":"045110","branchCode":"Barclays Branch","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","payoutInstrumentReference":"primaryBusinessAccount","currency":"USD","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}}},"components/examples/Create_PayoutInstrument_Company_modular":{"id":"components/examples/Create_PayoutInstrument_Company_modular","value":{"accountHolderName":"Tessier-Ashpool Systems Ltd.","payoutInstrumentType":"bankAccount","swiftBic":"FSFCUS33","bankCode":"045110","branchCode":"Muswell Hill Branch","accountNumber":"22765819","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","payoutInstrumentReference":"primaryBusinessAccount","currency":"USD","address":{"address1":"3 Villa Straylight","address2":"Freeside","type":"business","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54"}}},"components/examples/PayoutInstrument_Person_created_201_modular":{"id":"components/examples/PayoutInstrument_Person_created_201_modular","value":{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parF4BlVTN_zIcADcyBpXK6J0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-07T20:42:24.408Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},"description":"PayoutInstrument for a person (modular)"},"components/examples/PayoutInstrument_SoleTrader_created_201_modular":{"id":"components/examples/PayoutInstrument_SoleTrader_created_201_modular","value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parC_x1lzotG7wnqx1_Den9E0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-07T20:42:24.759Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},"description":"PayoutInstrument for a soleTrader (modular)"},"components/examples/PayoutInstrument_Company_created_201_modular":{"id":"components/examples/PayoutInstrument_Company_created_201_modular","value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parbLmHCft8cLP8XXsay63fQ0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-24T18:05:41.525Z","version":0,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCUS33","bankCode":"045110","accountNumber":"22765819","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54","type":"business"},"branchCode":"Muswell Hill Branch"},"description":"PayoutInstrument for a company (modular)"},"components/examples/Get_PayoutInstrument_Person_200_modular":{"id":"components/examples/Get_PayoutInstrument_Person_200_modular","value":{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parVID57-ep4PqX6J-25AkZk0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-07T20:48:00.227Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},"description":"Get a payoutInstrument for a party of person  (modular)"},"components/examples/Get_PayoutInstrument_SoleTrader_200_modular":{"id":"components/examples/Get_PayoutInstrument_SoleTrader_200_modular","value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"partA3SpNddFfGPV0fYk_zI-0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-07T20:48:00.660Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},"description":"Get a payoutInstrument for a party of soleTrader  (modular)"},"components/examples/Get_PayoutInstrument_Company_200_modular":{"id":"components/examples/Get_PayoutInstrument_Company_200_modular","value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parRI-eYCnF_sOAK59-38hUF0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-24T18:22:16.393Z","dateTimeUpdated":"2025-04-25T18:22:16.393Z","version":1,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCUS33","bankCode":"045110","accountNumber":"22765819","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54","type":"business"},"branchCode":"Muswell Hill Branch"},"description":"Get a payoutInstrument for a party of company (modular)"},"components/examples/Update_PayoutInstrument_Company_modular":{"id":"components/examples/Update_PayoutInstrument_Company_modular","value":{"accountHolderName":"Tessier-Ashpool Systems Ltd.","payoutInstrumentType":"bankAccount","swiftBic":"FSFCUS33","bankCode":"045110","branchCode":"Muswell Hill Branch","accountNumber":"2276581","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","payoutInstrumentReference":"primaryBusinessAccount","currency":"EUR","address":{"address1":"9105 Villa Straylight","address2":"Freeside","type":"business","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54"}}},"components/examples/Update_PayoutInstrument_Company_200_modular":{"id":"components/examples/Update_PayoutInstrument_Company_200_modular","value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parWm7eF6Dfwry4EYQdpXSSB0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-22T19:24:07.680Z","dateTimeUpdated":"2025-04-22T19:24:11.462Z","version":2,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCUS33","bankCode":"045110","accountNumber":"2276581","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"9105 Villa Straylight","address2":"Freeside","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54","type":"business"},"branchCode":"Muswell Hill Branch"},"description":"Update payout instrument for existing party of a company (modular)"},"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person (modular)":{"value":{"merchant":{"entity":"default"},"partyReference":"5htNU0XQ7V","partyType":"beneficiary","type":"person","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Henry Smith","socialSecurityNumber":"333-75-6666","residentialStatus":"resident","dateOfBirth":"1983-10-12","address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","type":"home","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"}},"email":"case.mitchell@example.com","phones":[{"number":"02079461234","prefix":"44"}]},"key":"Create a party for a person (modular)","summary":"Create a party for a person (modular)","id":"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person (modular)"},"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)":{"value":{"merchant":{"entity":"default"},"partyReference":"VuzvLew4y7","partyType":"beneficiary","type":"person","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"333-55-9666","residentialStatus":"resident","dateOfBirth":"1983-10-12","currentAddressLessThanThreeYears":true,"address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","type":"home","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"},"previousHomeAddress":{"address1":"1847 Morrison Court","address2":"Unit 55","type":"home","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"}},"email":"case.mitchell@example.com","phones":[{"number":"02079461234","prefix":"44"}],"balanceAccounts":[{"currency":"GBP","scheduledPayoutDay":"thursday","frequency":"weekly","payoutInstrumentReference":"personalCheckingAccount"}],"payoutInstruments":[{"accountHolderName":"Case H. Mitchell","payoutInstrumentType":"bankAccount","swiftBic":"BUKBGB22","bankCode":"045110","branchCode":"Taunton Branch","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"HSBC UK BANK PLC","payoutInstrumentReference":"personalCheckingAccount","currency":"GBP","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}],"performIdentityVerification":true},"key":"Create a party for a person with previous home address (orchestrated)","summary":"Create a party for a person with previous home address (orchestrated)","id":"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)"},"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader with trading address (modular)":{"value":{"merchant":{"entity":"default"},"partyReference":"CGeC6vSmyb","partyType":"beneficiary","type":"soleTrader","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","tradingName":"Linda's Supplies","alias":"Linda Smith","socialSecurityNumber":"333-57-6666","taxIdentifier":"GB-123456789","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"isTradingAddressSameAsPrimary":false,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"},"tradingAddress":{"address1":"999 Sprawl lane","address2":"Flat 509","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}]},"key":"Create a party for a sole trader with trading address (modular)","summary":"Create a party for a sole trader with trading address (modular)","id":"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader with trading address (modular)"},"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)":{"value":{"merchant":{"entity":"default"},"partyReference":"Anderson736","partyType":"beneficiary","type":"soleTrader","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","tradingName":"Linda's Supplies","alias":"Linda Smith","socialSecurityNumber":"333-57-6666","taxIdentifier":"GB-123456789","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"isTradingAddressSameAsPrimary":true,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}],"identityDocuments":[{"type":"passport","number":"789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2021-01-01","validTo":"2031-01-01"},{"type":"taxRegistrationCode","number":"123","issuingInstitution":"HMRC","issuingCountry":"GB","validFrom":"2023-11-30","validTo":"2030-12-30"}],"balanceAccounts":[{"currency":"GBP","frequency":"daily","payoutInstrumentReference":"primaryBusinessAccount"}],"payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentType":"bankAccount","currency":"GBP","accountHolderName":"Linda Lee","swiftBic":"LLOYGB21","bankCode":"000112","branchCode":"Bradford Branch","accountNumber":"12345678","accountType":"savings","iban":"JP123000400003123456789","bankName":"Lloyds Bank","address":{"address1":"789 Sakura Street","address2":"Suite 5A","city":"London","countryCode":"GB","postalCode":"E1 6AN","type":"other"}}]},"key":"Create a party for a sole trader without trading address (orchestrated)","summary":"Create a party for a sole trader without trading address (orchestrated)","id":"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)"},"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company with trading address different than legal address (orchestrated)":{"value":{"merchant":{"entity":"default"},"partyReference":"BGy1nSxvSw","partyType":"beneficiary","type":"company","companyDetails":{"legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","customerReference":"CustRefZA98765","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":false,"website":"https://www.example.com","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"},"tradingAddress":{"address1":"789 Freeside Blvd","address2":"Villa Straylight","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"poBox"}},"email":"info@example.com","phones":[{"number":"8475932","prefix":"81"}],"balanceAccounts":[{"currency":"GBP"},{"currency":"EUR","scheduledPayoutDay":"thursday","frequency":"monthly","recurrence":"third","payoutInstrumentReference":"primaryBusinessAccount2"}],"payoutInstruments":[{"accountHolderName":"Tessier-Ashpool Systems Ltd.","payoutInstrumentType":"bankAccount","swiftBic":"FSFCGB33","bankCode":"045110","branchCode":"Barclays Branch","accountNumber":"12345678","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","payoutInstrumentReference":"primaryBusinessAccount2","currency":"EUR","address":{"address1":"3 Villa Straylight","address2":"Freeside","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}}],"beneficialOwners":[{"beneficialOwnerReference":"39XaAW8hCf","personalDetails":{"title":"Dr","firstName":"Peter","middleName":"Illusionet","lastName":"Riviera","alias":"Peter Smith","socialSecurityNumber":"383-55-6666","residentialStatus":"nonResident","dateOfBirth":"1972-03-22","nationality":"GB","address":{"address1":"789 Downing Street","address2":"Flat 404","city":"London","type":"home","countryCode":"GB","postalCode":"SW1A 2AA"},"currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"123 Oxford Street","address2":"Flat 101","city":"London","type":"home","countryCode":"GB","postalCode":"W1D 1LP"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"position":"partner"},"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"email":"peter.riviera@example.com","phones":[{"number":"0205556789","prefix":"44"}]},{"beneficialOwnerReference":"A9CuJNpryM","personalDetails":{"title":"Ms","firstName":"Molly","middleName":"Puppet","lastName":"Millions","alias":"Molly Smith","socialSecurityNumber":"313-55-6666","residentialStatus":"resident","dateOfBirth":"1980-05-15","nationality":"GB","address":{"address1":"456 Sprawl Street","address2":"Flat 101","city":"Burbank","countryCode":"GB","postalCode":"RM1 4PL"},"currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"789 Night City Blvd","address2":"Flat 303","city":"Night City","countryCode":"GB","postalCode":"RM2 3PL"}},"relationshipToBusiness":{"ownershipPercentage":25,"director":false,"position":"officeManager"},"identityDocuments":[{"type":"passport","number":"A12345678","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2020-01-01","validTo":"2030-01-01"}],"email":"molly.millions@example.com","phones":[{"number":"02079461234","prefix":"44"}]}]},"key":"Create a party for a company with trading address different than legal address (orchestrated)","summary":"Create a party for a company with trading address different than legal address (orchestrated)","id":"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company with trading address different than legal address (orchestrated)"},"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company without trading address (modular)":{"value":{"merchant":{"entity":"default"},"partyReference":"BGy1nSxvSw","partyType":"beneficiary","type":"company","companyDetails":{"legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","customerReference":"CustRefZA98765","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":true,"website":"https://www.example.com","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}},"email":"info@example.com","phones":[{"number":"8475932","prefix":"81"}]},"key":"Create a party for a company without trading address (modular)","summary":"Create a party for a company without trading address (modular)","id":"paths/~1parties/post/requestBody/content/application~1json/examples/Create a party for a company without trading address (modular)"},"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person (modular)":{"value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Frank118","partyType":"beneficiary","type":"person","partyId":"parpI1tAL2bK8Lb-52Rfblg30","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"353-55-6666","dateOfBirth":"1983-10-12","address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"home"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false},"email":"case.mitchell@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[],"balanceAccounts":[],"dateTimeCreated":"2025-04-07T20:42:17.292Z","version":0,"active":true,"dateTimeActivated":"2025-04-07T20:42:17.292Z","payoutInstruments":[]},"key":"Create a party for a person (modular)","summary":"Create a party for a person (modular)","description":"Create a party for a person (modular)","id":"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person (modular)"},"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)":{"value":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Heidi197","partyType":"beneficiary","type":"person","partyId":"parMbuHucAsLeLL0BhDpWdjE0","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"333-55-6656","dateOfBirth":"1983-10-12","address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"home"},"previousHomeAddress":{"address1":"1847 Morrison Court","address2":"Unit 55","type":"home","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"},"residentialStatus":"resident","currentAddressLessThanThreeYears":true},"email":"case.mitchell@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}],"balanceAccounts":[{"currency":"GBP","payoutInstrumentReference":"personalCheckingAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"par3GymZO5MtP18qe5NFaaPp0","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"active":true,"dateTimeActivated":"2025-04-16T20:46:24.122Z","payoutInstruments":[{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parclOAFlaOX-H_2UBp9tWbd0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"HSBC UK BANK PLC","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Taunton Branch"}]},"key":"Create a party for a person with previous home address (orchestrated)","summary":"Create a party for a person with previous home address (orchestrated)","description":"Create party for a person with previous home address (orchestrated)","id":"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a person with previous home address (orchestrated)"},"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader with trading address (modular)":{"value":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"CGeC6vSmyb","partyType":"beneficiary","type":"soleTrader","partyId":"parUbyQnnkuOPHFiHsVutAru0","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","isTradingAddressSameAsPrimary":false,"website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","tradingName":"Linda's Supplies","alias":"Linda Smith","socialSecurityNumber":"343-55-6666","taxIdentifier":"GB-123456789","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"tradingAddress":{"address1":"999 Sprawl lane","address2":"Flat 509","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}],"identityDocuments":[],"balanceAccounts":[],"payoutInstruments":[],"dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"active":true,"dateTimeActivated":"2025-04-16T20:46:25.444Z"},"key":"Create a party for a sole trader with trading address (modular)","summary":"Create a party for a sole trader with trading address (modular)","description":"Create a party for a sole trader with trading address (modular)","id":"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader with trading address (modular)"},"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)":{"value":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Anderson736","partyType":"beneficiary","type":"soleTrader","partyId":"parUbyQnnkuOPHFiHsVutAru0","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","tradingName":"Linda's Supplies","alias":"Linda Smith","socialSecurityNumber":"343-55-6666","taxIdentifier":"GB-123456789","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"isTradingAddressSameAsPrimary":true,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}],"identityDocuments":[{"type":"passport","number":"789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2021-01-01","validTo":"2031-01-01"},{"type":"taxRegistrationCode","number":"123","issuingInstitution":"HMRC","issuingCountry":"GB","validFrom":"2023-11-30","validTo":"2030-12-30"}],"balanceAccounts":[{"currency":"GBP","payoutInstrumentReference":"primaryBusinessAccount","frequency":"daily","balanceAccountId":"par3GymZO5MtP18qe5NFaaPp0","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"active":true,"dateTimeActivated":"2025-04-16T20:46:25.444Z","payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parclOAFlaOX-H_2UBp9tWbd0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountHolderName":"Linda Lee","swiftBic":"LLOYGB21","bankCode":"000112","branchCode":"Bradford Branch","accountNumber":"12345678","accountType":"savings","iban":"P123000400003123456789","bankName":"Lloyds Bank","address":{"address1":"789 Sakura Street","address2":"Suite 5A","city":"London","countryCode":"GB","postalCode":"E1 6AN","type":"other"}}]},"key":"Create a party for a sole trader without trading address (orchestrated)","summary":"Create a party for a sole trader without trading address (orchestrated)","description":"Create a party for a sole trader without trading address (orchestrated)","id":"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a sole trader without trading address (orchestrated)"},"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company with tradingAddress different than legalAddress (orchestrated)":{"value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Genesis829","partyType":"beneficiary","type":"company","partyId":"par1Gya_pV7rRYUMI3Ep_ssX0","companyDetails":{"merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":true,"website":"https://www.example.com","legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"customerReference":"CustRefZA98765"},"email":"info@example.com","phones":[{"prefix":"81","number":"8475932"}],"identityDocuments":[],"balanceAccounts":[{"currency":"GBP","balanceAccountId":"parFwA0DbiCax4y5mzj6207T0","dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"accountNumber":"23198765"},{"currency":"EUR","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"monthly","recurrence":"third","balanceAccountId":"parKXSsjAGYuzsJ6AnD_NSCD0","dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"active":true,"dateTimeActivated":"2025-04-24T18:05:40.908Z","payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parxYYu5sdO559Yo60Ud4ep50","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCGB33","bankCode":"045110","accountNumber":"1234567890","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"}],"beneficialOwners":[{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Jennings377","beneficialOwnerId":"parrLsIhp6pE9VQmWG2Y8wKm0","personalDetails":{"title":"Dr","firstName":"Peter","middleName":"Illusionet","alias":"Peter Smith","socialSecurityNumber":"333-15-6666","lastName":"Riviera","dateOfBirth":"1972-03-22","address":{"address1":"789 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"123 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":true,"position":"partner"},"email":"peter.riviera@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0},{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Dana455","beneficialOwnerId":"parC3Po42KDFr1SRgu351Ncy0","personalDetails":{"title":"Ms","firstName":"Molly","middleName":"Puppet","lastName":"Millions","alias":"Molly Smith","socialSecurityNumber":"353-55-6666","dateOfBirth":"1980-05-15","address":{"address1":"456 Sprawl Street","address2":"Flat 101","city":"Burbank","countryCode":"GB","postalCode":"RM1 4PL"},"residentialStatus":"resident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"789 Night City Blvd","address2":"Flat 303","city":"Night City","countryCode":"GB","postalCode":"RM2 3PL"}},"relationshipToBusiness":{"ownershipPercentage":25,"director":false,"isPrincipalOwner":true,"position":"officeManager"},"email":"molly.millions@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"A12345678","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2020-01-01","validTo":"2030-01-01"}],"dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0}]},"key":"Create a party for a company with tradingAddress different than legalAddress (orchestrated)","summary":"Create a party for a company with tradingAddress different than legalAddress (orchestrated)","description":"Party for a Company with trading address different than legal address (orchestrated)","id":"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company with tradingAddress different than legalAddress (orchestrated)"},"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company without trading address (modular)":{"value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Genesis829","partyType":"beneficiary","type":"company","partyId":"par1Gya_pV7rRYUMI3Ep_ssX0","companyDetails":{"merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":true,"website":"https://www.example.com","legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"customerReference":"CustRefZA98765"},"email":"info@example.com","phones":[{"prefix":"81","number":"8475932"}],"identityDocuments":[],"balanceAccounts":[],"dateTimeCreated":"2025-04-24T18:05:40.908Z","version":0,"active":true,"dateTimeActivated":"2025-04-24T18:05:40.908Z","payoutInstruments":[],"beneficialOwners":[]},"key":"Create a party for a company without trading address (modular)","summary":"Create a party for a company without trading address (modular)","description":"party for a company without trading address (modular)","id":"paths/~1parties/post/responses/201/content/application~1json/examples/Create a party for a company without trading address (modular)"},"paths/~1parties/post/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties/post/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties/post/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties/post/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties/post/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties/post/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties/post/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties/post/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties/get/responses/200/content/application~1json/examples/Browse parties":{"value":{"parties":[{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"ts6SfP8eNv","partyType":"beneficiary","type":"person","partyId":"parJnf1XbmhV6j2cizaFQ54L0","email":"zH5O.V20XrO71@yWPtULl.cl4","phones":[{"prefix":"44","number":"km86YWLfjyL"}],"identityDocuments":[{"type":"passport","number":"zuggHJuTi","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1901-03-20","validTo":"1931-07-31"},{"type":"nationalId","number":"f1wlKPlz-8mXmh","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"1915-09-06","validTo":"1988-04-03"}],"balanceAccounts":[],"dateTimeCreated":"2025-09-02T15:51:53.868Z","dateTimeUpdated":"2025-09-03T15:51:54.257Z","version":2,"payoutInstruments":[],"active":true,"dateTimeDeactivated":"2025-09-03T15:51:54.211Z","dateTimeActivated":"2025-09-02T15:51:54.257Z","personalDetails":{"title":"Mr","firstName":"sa7h","middleName":"G3d3c","lastName":"eFGwfD84","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"2059-01-03","address":{"address1":"T6cF ubKLq1oMt xWHke","address2":"lDdv v5","city":"Manchester","countryCode":"GB","postalCode":"XF 9wj","type":"home"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false}},{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Z4AS5O3gVA","partyType":"beneficiary","type":"person","partyId":"parBCjKONvmeYaSK--v_NJK40","email":"zH5O.V20XrO71@yWPtULl.cl4","phones":[{"prefix":"44","number":"km86YWLfjyL"}],"identityDocuments":[{"type":"passport","number":"zuggHJuTi","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1901-03-20","validTo":"1931-07-31"},{"type":"nationalId","number":"f1wlKPlz-8mXmh","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"1915-09-06","validTo":"1988-04-03"}],"balanceAccounts":[{"currency":"GBP","payoutInstrumentReference":"UtwzOwGHMM","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parVUdr_mDPwl1EY3Pb5y-Cp0","dateTimeCreated":"2026-03-02T15:51:54.638Z","version":0,"accountNumber":"12343242","nextPayoutDate":"2026-03-19"},{"currency":"EUR","payoutInstrumentReference":"hCpcT6vTPB","scheduledPayoutDay":"thursday","frequency":"monthly","recurrence":"third","balanceAccountId":"paruowtxO9OPFIGjx9gYl5iE0","dateTimeCreated":"2026-03-02T15:51:58.314Z","version":0,"accountNumber":"12343242","nextPayoutDate":"2026-04-19"},{"currency":"INR","payoutInstrumentReference":"hCpcT6vTPB","frequency":"daily","balanceAccountId":"paruowtCO9OPFIGjx9gYl5iE0","dateTimeCreated":"2026-03-02T15:51:54.638Z","version":0,"accountNumber":"12343242","nextPayoutDate":"2026-03-03"}],"dateTimeCreated":"2026-03-02T15:51:54.638Z","version":0,"payoutInstruments":[{"payoutInstrumentReference":"hCpcT6vTPB","payoutInstrumentId":"par35uirx_fJZ9bjGu24UBB50","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-09-02T15:51:56.889Z","version":0,"accountHolderName":"UVfn D. kQdAzJRB","swiftBic":"1i08of9G","bankCode":"b4ZM5E","accountNumber":"xL60ChVg","accountType":"checking","iban":"WU0jAupifqjpgZ8pPIYb","bankName":"Metro Bank","address":{"address1":"bY o7a-IOeFVa rsxklGj8g 5FCB7","address2":"ohXty YYBO","city":"London","countryCode":"GB","postalCode":"Bs4j IqO","type":"business"},"branchCode":"Barclays Branch"},{"payoutInstrumentReference":"UtwzOwGHMM","payoutInstrumentId":"parAh7-5xjnkGUp4TmvJ0Vj00","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-09-02T15:51:54.638Z","version":0,"accountHolderName":"UVfn D. kQdAzJRB","swiftBic":"1i08of9G","bankCode":"b4ZM5E","accountNumber":"xL60ChVg","accountType":"checking","iban":"WU0jAupifqjpgZ8pPIYb","bankName":"HSBC UK BANK PLC","address":{"address1":"bY o7a-IOeFVa rsxklGj8g 5FCB7","address2":"ohXty YYBO","city":"London","countryCode":"GB","postalCode":"Bs4j IqO","type":"business"},"branchCode":"Taunton Branch"}],"active":true,"dateTimeActivated":"2026-03-02T15:51:54.638Z","personalDetails":{"title":"Mr","firstName":"sa7h","middleName":"G3d3c","lastName":"eFGwfD84","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"2059-01-03","address":{"address1":"T6cF ubKLq1oMt xWHke","address2":"lDdv v5","city":"Manchester","countryCode":"GB","postalCode":"XF 9wj","type":"home"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false}},{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"xHyFiJS9zo","partyType":"beneficiary","type":"soleTrader","partyId":"parqZvn1ritjWZbD4yRxEpCd0","email":"A4P.X6MrD@4zKMG8L.AeB","phones":[{"prefix":"81","number":"mSaIgVfwZw"}],"identityDocuments":[{"type":"taxRegistrationCode","number":"jdZ","issuingInstitution":"HMRC","issuingCountry":"GB","validFrom":"1945-06-07","validTo":"2078-12-08"},{"type":"passport","number":"7P6","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2060-03-27","validTo":"2067-03-22"}],"balanceAccounts":[{"currency":"GBP","balanceAccountId":"pare151tM6polLGHRMSQsWeO0","dateTimeCreated":"2025-09-02T15:51:55.144Z","version":0,"accountNumber":"0000550000085002"},{"currency":"USD","payoutInstrumentReference":"kNiuKzkNlO","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parr9a1J5alvURV2KrWFi8880","dateTimeCreated":"2025-09-02T15:51:58.578Z","version":0,"accountNumber":"0000550000085002","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-09-02T15:51:55.144Z","version":0,"payoutInstruments":[{"payoutInstrumentReference":"kNiuKzkNlO","payoutInstrumentId":"parlnjkdCvxRKCEdXO6QWbYG0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-09-02T15:51:57.484Z","version":0,"accountHolderName":"UVfn D. kQdAzJRB","swiftBic":"1i08of9G","bankCode":"b4ZM5E","accountNumber":"xL60ChVg","accountType":"checking","iban":"WU0jAupifqjpgZ8pPIYb","bankName":"Metro Bank","address":{"address1":"bY o7a-IOeFVa rsxklGj8g 5FCB7","address2":"ohXty YYBO","city":"London","countryCode":"GB","postalCode":"Bs4j IqO","type":"business"},"branchCode":"Barclays Branch"},{"payoutInstrumentReference":"O6zUzth3o6","payoutInstrumentId":"parrTlcspjYj2bqeYIez_tMz0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-09-02T15:51:55.144Z","version":0,"accountHolderName":"51B6k qmw","swiftBic":"n45SZCRQ","bankCode":"6c1tT8","accountNumber":"utJkHSus","accountType":"savings","iban":"mUWBqpkz8lHlBLKAF5WdUR5","bankName":"Lloyds Bank","address":{"address1":"roQ UHnZ87 V5x52Q","address2":"xpWWt 6I","city":"London","countryCode":"GB","postalCode":"AD 9Tz","type":"other"},"branchCode":"Bradford Branch"}],"active":true,"dateTimeActivated":"2025-09-02T15:51:55.144Z","personalDetails":{"title":"Ms","firstName":"hm70O","middleName":"OSoc","lastName":"52M","tradingName":"Linda Lee","alias":"John bailey","socialSecurityNumber":"333-55-1666","taxIdentifier":"TX-12354567","dateOfBirth":"2040-01-09","address":{"address1":"yWh bzP9Fa luw8GI","address2":"sqdo Rtt","city":"Chester","countryCode":"GB","postalCode":"Ib4 VJk","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"lw","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"xQ6 ZfG8qm YD0fTH","address2":"SWMR G2f","city":"Chester","countryCode":"GB","postalCode":"gV5 35W","type":"other"},"website":"https://www.example.com/","merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets"}},{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"G5ohEB3lUc","partyType":"beneficiary","type":"company","partyId":"par7anQCsbhS0yKZNIFpUtkI0","email":"info@example.com","phones":[{"prefix":"81","number":"8475932"}],"identityDocuments":[],"balanceAccounts":[{"currency":"EUR","payoutInstrumentReference":"mHWwfCJRCS","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parKwY5ezX2R4QaUGQ47cGYi0","dateTimeCreated":"2025-09-02T15:51:55.678Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1,"accountNumber":"12343242","nextPayoutDate":"2026-03-19"},{"currency":"USD","payoutInstrumentReference":"u8MamGFmEo","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parUoWq2uerKMrdAPFeBLqy80","dateTimeCreated":"2025-09-02T15:51:58.849Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1,"accountNumber":"12343242","nextPayoutDate":"2026-03-19"},{"currency":"GBP","balanceAccountId":"parfnsCbzM7Og3xIdfa48tAZ0","dateTimeCreated":"2025-09-02T15:51:55.678Z","version":0,"accountNumber":"12343242"}],"dateTimeCreated":"2025-09-02T15:51:56.295Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":2,"payoutInstruments":[{"payoutInstrumentReference":"u8MamGFmEo","payoutInstrumentId":"parSALwf8D8drIikDp0aQTrG0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-09-02T15:51:57.887Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1,"accountHolderName":"f3T5owE-5hZQQVR rYYIJel eOt.","swiftBic":"pogwBatv","bankCode":"b4ZM5E","accountNumber":"iZOB5YkF","accountType":"savings","iban":"5YHuGEWGF61PlsAUAKkryp","bankName":"Freeside Financial Corporation","address":{"address1":"q fbyli 0kyimLrIfq","address2":"7NOmwxh7","city":"York","state":"NA","countryCode":"GB","postalCode":"HJMW DKJn","type":"business"},"branchCode":"Muswell Hill Branch"},{"payoutInstrumentReference":"mHWwfCJRCS","payoutInstrumentId":"parpxxzfRTafscKcMwvERKGf0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-09-02T15:51:55.677Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1,"accountHolderName":"f3T5owE-5hZQQVR rYYIJel eOt.","swiftBic":"QnDYJdbt","bankCode":"b4ZM5E","accountNumber":"utJkHSus","accountType":"savings","iban":"5YHuGEWGF61PlsAUAKkryp","bankName":"Freeside Financial Corporation","address":{"address1":"q fbyli 0kyimLrIfq","address2":"7NOmwxh7","city":"London","countryCode":"GB","postalCode":"Bs4j IqO","type":"business"},"branchCode":"Barclays Branch"}],"active":true,"dateTimeActivated":"2025-09-02T15:51:56.295Z","companyDetails":{"merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","website":"https://www.example.com","legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","registrationNumber":"7564389201","taxIdentifier":"GB-987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"tradingAddress":{"address1":"789 Freeside Blvd","address2":"Villa Straylight","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"poBox"},"customerReference":"CustRefZA98765"},"beneficialOwners":[{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"GJbPJVtqFz","beneficialOwnerId":"par5BsbOKDecm8uWVgzYUor-0","personalDetails":{"title":"Ms","firstName":"John","middleName":"LVrVLk","lastName":"Bailer","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"1946-09-13","address":{"address1":"YZ7 1V7iJh xnZhNA","address2":"8DD6 7fg","city":"Burbank","countryCode":"GB","postalCode":"rmL v0W"},"residentialStatus":"resident","nationality":"lw","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"xgi osd16 bsMJ 1nnj","address2":"SWMR G2f","city":"Night City","countryCode":"GB","postalCode":"s2W CV6"}},"relationshipToBusiness":{"ownershipPercentage":25,"director":false,"isPrincipalOwner":true,"position":"officeManager"},"email":"UucOR.ppaJ1rdP@4BLu9KX.54i","phones":[{"prefix":"44","number":"km86YWLfjyL"}],"identityDocuments":[{"type":"passport","number":"sJCY65PyZ","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1922-10-07","validTo":"2043-06-08"}],"dateTimeCreated":"2025-09-02T15:51:55.678Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1},{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"YezTTwoVHR","beneficialOwnerId":"parIrzObRP9_nc7Y5R29fgoC0","personalDetails":{"title":"Dr","firstName":"Johny","middleName":"tusFSTLKvR","lastName":"pkw1XH1","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"2062-04-19","address":{"address1":"AI6 TyzGI5B YprQ7Y","address2":"05uX xGG","city":"London","countryCode":"GB","postalCode":"Dv4T erT","type":"home"},"residentialStatus":"nonResident","nationality":"lw","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"CIo U0wJ3a 1k3rwN","address2":"8DD6 7fg","city":"London","countryCode":"GB","postalCode":"bZX TqF","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"position":"partner"},"email":"PuDnv.iX8XrhV@X8RQ3S5.4IC","phones":[{"prefix":"44","number":"Z0avBNjMlS"}],"identityDocuments":[{"type":"passport","number":"v2OhZxguD","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1989-06-06","validTo":"2028-03-19"}],"dateTimeCreated":"2025-09-02T15:51:55.678Z","dateTimeUpdated":"2025-09-03T15:51:55.678Z","version":1},{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"zHCxMG8x4T","beneficialOwnerId":"parT4dazXixMu5npZGQL0iwH0","personalDetails":{"title":"Dr","firstName":"Jenly","middleName":"tusFSTLKvR","lastName":"Morris","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"1918-01-01","address":{"address1":"NLv QCTjBRt P4cpVy","address2":"05uX xGG","city":"London","countryCode":"GB","postalCode":"Dv4T erT","type":"home"},"residentialStatus":"nonResident","nationality":"lw","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"ceR 7DcVj9 qP6wd4","address2":"8DD6 7fg","city":"London","countryCode":"GB","postalCode":"bZX TqF","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"position":"partner"},"email":"9UFJ.oVZsgU@laUTWaJ.rs0","phones":[{"prefix":"44","number":"Z0avBNjMlS"}],"identityDocuments":[{"type":"passport","number":"v2OhZxguD","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"1989-06-06","validTo":"2028-03-19"}],"dateTimeCreated":"2025-09-02T15:51:56.294Z","dateTimeUpdated":"2025-09-03T15:51:56.294Z","version":1}]}],"pagination":{"page":0,"size":10,"pageCount":1,"totalNumberOfRecords":4}},"key":"Browse parties","summary":"Browse parties","description":"Browse parties","id":"paths/~1parties/get/responses/200/content/application~1json/examples/Browse parties"},"paths/~1parties/get/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties/get/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties/get/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties/get/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties/get/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties/get/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a person ":{"value":{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Heidi197","partyType":"beneficiary","type":"person","partyId":"parMbuHucAsLeLL0BhDpWdjE0","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Henry Smith","socialSecurityNumber":"333-55-6666","dateOfBirth":"1983-10-12","address":{"address1":"1847 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"home"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false},"email":"case.mitchell@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}],"balanceAccounts":[{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"pareBH4YMkUx7MA2X7bnS4750","dateTimeCreated":"2025-04-16T20:46:26.727Z","version":0,"accountNumber":"12645678","nextPayoutDate":"2026-03-19"},{"currency":"GBP","payoutInstrumentReference":"personalCheckingAccount2","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"par3GymZO5MtP18qe5NFaaPp0","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountNumber":"2319876543210","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"active":true,"dateTimeActivated":"2025-04-24T17:55:56.283Z","payoutInstruments":[{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parclOAFlaOX-H_2UBp9tWbd0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-16T20:46:24.122Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"HSBC UK BANK PLC","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Taunton Branch"},{"payoutInstrumentReference":"personalCheckingAccount2","payoutInstrumentId":"parKsh3dSA_VRckwEDRHLzOR0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-16T20:46:26.235Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"2319876543210","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"}]},"key":"Get a party for a person ","summary":"Get a party for a person ","description":"Get a party for person","id":"paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a person "},"paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a sole trader":{"value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Anderson736","partyType":"beneficiary","type":"soleTrader","partyId":"parUbyQnnkuOPHFiHsVutAru0","personalDetails":{"merchantCategoryCode":"5411","merchantCategoryCodeDescription":"Grocery Stores, Supermarkets","isTradingAddressSameAsPrimary":true,"website":"https://www.example.com/","title":"Ms","firstName":"Linda","middleName":"Liam","lastName":"Lee","alias":"Linda Smith","socialSecurityNumber":"133-55-6666","taxIdentifier":"GB-123456789","tradingName":"Linda's Supplies","dateOfBirth":"1990-07-15","address":{"address1":"123 Sprawl Avenue","address2":"Flat 202","city":"Chester","countryCode":"GB","postalCode":"CH1 4PL","type":"home"},"residentialStatus":"resident","customerReference":"customerrefSoleTrader","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"456 Sprawl Avenue","address2":"Flat 303","city":"Chester","countryCode":"GB","postalCode":"CH2 4PL","type":"other"}},"email":"lee.linda@example.com","phones":[{"prefix":"81","number":"9098765432"}],"identityDocuments":[{"type":"taxRegistrationCode","number":"123","issuingInstitution":"HMRC","issuingCountry":"GB","validFrom":"2023-11-30","validTo":"2030-12-30"},{"type":"passport","number":"789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2021-01-01","validTo":"2031-01-01"}],"balanceAccounts":[{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},{"currency":"GBP","balanceAccountId":"parQj9Y4leX3ysLFSQ7DXm1z0","dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"accountNumber":"12345676"}],"dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"active":true,"dateTimeActivated":"2025-04-24T17:55:56.283Z","payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parFrc7XcecQ7zVXbAodFe6m0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-16T20:46:25.444Z","version":0,"accountHolderName":"Linda Lee","swiftBic":"LLOYGB21","bankCode":"000112","accountNumber":"12345678","accountType":"savings","iban":"JP123000400003123456789","bankName":"Lloyds Bank","address":{"address1":"789 Sakura Street","address2":"Suite 5A","city":"London","countryCode":"GB","postalCode":"E1 6AN","type":"other"},"branchCode":"Bradford Branch"},{"payoutInstrumentReference":"primaryBusinessAccount2","payoutInstrumentId":"parnHhcim1r9IYtG8I7Twbbc0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-16T20:46:26.420Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"}]},"key":"Get a party for a sole trader","summary":"Get a party for a sole trader","description":"Get a party for soleTrader","id":"paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a sole trader"},"paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a company":{"value":{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Genesis829","partyType":"beneficiary","type":"company","partyId":"par1Gya_pV7rRYUMI3Ep_ssX0","companyDetails":{"merchantCategoryCode":"5734","merchantCategoryCodeDescription":"Computer Software Stores","isTradingAddressSameAsPrimary":false,"website":"https://www.example.com","legalName":"Tessier-Ashpool Systems Ltd.","tradingName":"Example.co.uk","registrationNumber":"7564389201","taxIdentifier":"GB987654321","companyType":"publicLimitedCompany","dateOfIncorporation":"1977-07-04","legalAddress":{"address1":"7 Straylight Complex","address2":"Corporate District, Level 99","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"tradingAddress":{"address1":"789 Freeside Blvd","address2":"Villa Straylight","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA","type":"poBox"},"customerReference":"CustRefZA98765"},"email":"info@example.com","phones":[{"prefix":"81","number":"8475932"}],"identityDocuments":[],"balanceAccounts":[{"currency":"GBP","balanceAccountId":"parFwA0DbiCax4y5mzj6207T0","dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"accountNumber":"12345678"},{"currency":"EUR","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parKXSsjAGYuzsJ6AnD_NSCD0","dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"accountNumber":"123459978","nextPayoutDate":"2026-04-30"},{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount2","frequency":"daily","balanceAccountId":"par0yJR1v3RBd8B1CrEYDpTx0","dateTimeCreated":"2026-04-24T18:05:40.908Z","dateTimeUpdated":"2026-04-25T18:05:40.908Z","version":1,"accountNumber":"1234567128","nextPayoutDate":"2026-04-27"}],"dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"active":true,"dateTimeActivated":"2026-04-24T18:05:40.908Z","payoutInstruments":[{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parxYYu5sdO559Yo60Ud4ep50","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCGB33","bankCode":"045110","accountNumber":"1234567890","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},{"payoutInstrumentReference":"primaryBusinessAccount2","payoutInstrumentId":"parbLmHCft8cLP8XXsay63fQ0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCUS33","bankCode":"045110","accountNumber":"2276581","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54","type":"business"},"branchCode":"Muswell Hill Branch"}],"beneficialOwners":[{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Jennings377","beneficialOwnerId":"parrLsIhp6pE9VQmWG2Y8wKm0","personalDetails":{"title":"Dr","firstName":"Peter","middleName":"Illusionet","lastName":"Riviera","alias":"Peter Smith","socialSecurityNumber":"323-55-6666","dateOfBirth":"1972-03-22","address":{"address1":"789 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"123 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":false,"position":"partner"},"email":"peter.riviera@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0},{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Orpha684","beneficialOwnerId":"parjDSIhcZTkdGD31KwawOrn0","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John Smith","socialSecurityNumber":"343-55-6666","dateOfBirth":"1972-05-22","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"425 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":true,"position":"partner"},"email":"John.bailey@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0},{"identityVerificationState":"pending","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Dana455","beneficialOwnerId":"parC3Po42KDFr1SRgu351Ncy0","personalDetails":{"title":"Ms","firstName":"Molly","middleName":"Puppet","lastName":"Millions","alias":"Molly Smith","socialSecurityNumber":"332-55-6666","dateOfBirth":"1980-05-15","address":{"address1":"456 Sprawl Street","address2":"Flat 101","city":"Burbank","countryCode":"GB","postalCode":"RM1 4PL"},"residentialStatus":"resident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"789 Night City Blvd","address2":"Flat 303","city":"Night City","countryCode":"GB","postalCode":"RM2 3PL"}},"relationshipToBusiness":{"ownershipPercentage":25,"director":false,"isPrincipalOwner":true,"position":"officeManager"},"email":"molly.millions@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"A12345678","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2020-01-01","validTo":"2030-01-01"}],"dateTimeCreated":"2026-04-24T18:05:40.908Z","version":0}]},"key":"Get a party for a company","summary":"Get a party for a company","description":"Get a party for company","id":"paths/~1parties~1{partyId}/get/responses/200/content/application~1json/examples/Get a party for a company"},"paths/~1parties~1{partyId}/get/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}/get/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}/get/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}/get/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}/get/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}/get/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}/put/requestBody/content/application~1json/examples/Update a party for a person":{"value":{"merchant":{"entity":"default"},"partyReference":"8X87XwQ7Fv","partyType":"beneficiary","type":"person","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"393-55-6666","residentialStatus":"resident","dateOfBirth":"1983-10-12","address":{"address1":"2025 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"}},"email":"case.mitchell@example.com","phones":[{"number":"02079461234","prefix":"44"}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}]},"key":"Update a party for a person","summary":"Update a party for a person","id":"paths/~1parties~1{partyId}/put/requestBody/content/application~1json/examples/Update a party for a person"},"paths/~1parties~1{partyId}/put/responses/200/content/application~1json/examples/Update Party":{"value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","merchant":{"entity":"default"},"partyReference":"Lela300","partyType":"beneficiary","type":"person","partyId":"par4733xO8y2YI9HSOTG-kba0","personalDetails":{"title":"Mr","firstName":"Case","middleName":"Henry","lastName":"Mitchell","alias":"Case Smith","socialSecurityNumber":"343-55-6666","dateOfBirth":"1983-10-12","address":{"address1":"2025 Kingsbury Court","address2":"Unit 42","city":"Manchester","countryCode":"GB","postalCode":"M1 1AA"},"residentialStatus":"resident","currentAddressLessThanThreeYears":false},"email":"case.mitchell@example.com","phones":[{"prefix":"44","number":"02079461234"}],"identityDocuments":[{"type":"passport","number":"NEO456789","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2022-08-01","validTo":"2032-08-01"},{"type":"nationalId","number":"ZAIBATSU-00792","issuingInstitution":"Zaibatsu Holding HR Dept.","issuingCountry":"GB","validFrom":"2025-01-01","validTo":"2030-12-31"}],"balanceAccounts":[{"currency":"GBP","payoutInstrumentReference":"personalCheckingAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parXRSh-RDDLU5NyGZpQhyNb0","dateTimeCreated":"2025-04-21T20:11:08.699Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"},{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount2","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parBTwBk8J3s3nhgbo1vNyvJ0","dateTimeCreated":"2025-04-21T20:11:12.991Z","version":0,"accountNumber":"23198765","nextPayoutDate":"2026-03-19"}],"dateTimeCreated":"2025-04-21T20:11:08.695Z","dateTimeUpdated":"2025-04-21T20:11:15.341Z","version":1,"active":true,"dateTimeActivated":"2025-04-24T17:55:56.283Z","payoutInstruments":[{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"paru47L8iaV-cm7doWxO7oWm0","payoutInstrumentType":"bankAccount","currency":"GBP","dateTimeCreated":"2025-04-21T20:11:08.698Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"HSBC UK BANK PLC","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Taunton Branch"},{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parbQkpoZT3adRASZB9Zp9e-0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-21T20:11:11.251Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"}]},"key":"Update Party","summary":"Update Party","description":"Update party of a person (orchestrated)","id":"paths/~1parties~1{partyId}/put/responses/200/content/application~1json/examples/Update Party"},"paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}/put/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}/put/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}/put/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}/put/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}/put/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1deactivation/post/requestBody/content/application~1json/examples/Deactivate a party":{"value":{"deactivationReason":"partyDormant","dispositionOfFunds":"payoutToParty"},"key":"Deactivate a party","summary":"Deactivate a party","id":"paths/~1parties~1{partyId}~1deactivation/post/requestBody/content/application~1json/examples/Deactivate a party"},"paths/~1parties~1{partyId}~1deactivation/post/responses/200/content/application~1json/examples/Deactivate a party":{"value":{"deactivationReason":"partyDormant","dispositionOfFunds":"payoutToParty","active":false,"dateTimeDeactivated":"2025-07-29T17:34:01.621Z"},"key":"Deactivate a party","summary":"Deactivate a party","description":"Deactivate an active party (modular)","id":"paths/~1parties~1{partyId}~1deactivation/post/responses/200/content/application~1json/examples/Deactivate a party"},"paths/~1parties~1{partyId}~1deactivation/post/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1deactivation/post/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1activation/post/requestBody/content/application~1json/examples/Reactivate a party":{"value":{"active":true},"key":"Reactivate a party","summary":"Reactivate a party","id":"paths/~1parties~1{partyId}~1activation/post/requestBody/content/application~1json/examples/Reactivate a party"},"paths/~1parties~1{partyId}~1activation/post/responses/200/content/application~1json/examples/Reactivate a party":{"value":{"active":true,"dateTimeActivated":"2025-07-29T17:34:01.621Z"},"key":"Reactivate a party","summary":"Reactivate a party","description":"Activate an deactivated party (modular)","id":"paths/~1parties~1{partyId}~1activation/post/responses/200/content/application~1json/examples/Reactivate a party"},"paths/~1parties~1{partyId}~1activation/post/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1activation/post/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of person (modular)":{"value":{"accountHolderName":"Case H. Mitchell","payoutInstrumentType":"bankAccount","swiftBic":"BUKBGB22","bankCode":"045110","branchCode":"Barclays Branch","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","payoutInstrumentReference":"personalCheckingAccount","currency":"EUR","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}},"key":"Create a payout instrument for existing party of person (modular)","summary":"Create a payout instrument for existing party of person (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of person (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of sole trader (modular)":{"value":{"accountHolderName":"Case H. Mitchell","payoutInstrumentType":"bankAccount","swiftBic":"BUKBGB22","bankCode":"045110","branchCode":"Barclays Branch","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","payoutInstrumentReference":"primaryBusinessAccount","currency":"USD","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","type":"business","city":"London","countryCode":"GB","postalCode":"EC1A 1BB"}},"key":"Create a payout instrument for existing party of sole trader (modular)","summary":"Create a payout instrument for existing party of sole trader (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of sole trader (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of company (modular)":{"value":{"accountHolderName":"Tessier-Ashpool Systems Ltd.","payoutInstrumentType":"bankAccount","swiftBic":"FSFCUS33","bankCode":"045110","branchCode":"Muswell Hill Branch","accountNumber":"22765819","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","payoutInstrumentReference":"primaryBusinessAccount","currency":"USD","address":{"address1":"3 Villa Straylight","address2":"Freeside","type":"business","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54"}},"key":"Create a payout instrument for existing party of company (modular)","summary":"Create a payout instrument for existing party of company (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/requestBody/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of person (modular)":{"value":{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parF4BlVTN_zIcADcyBpXK6J0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-07T20:42:24.408Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},"key":"Create a payout instrument for existing party of person (modular)","summary":"Create a payout instrument for existing party of person (modular)","description":"PayoutInstrument for a person (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of person (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of sole Trader (modular)":{"value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parC_x1lzotG7wnqx1_Den9E0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-07T20:42:24.759Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},"key":"Create a payout instrument for existing party of sole Trader (modular)","summary":"Create a payout instrument for existing party of sole Trader (modular)","description":"PayoutInstrument for a soleTrader (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of sole Trader (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of company (modular)":{"value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parbLmHCft8cLP8XXsay63fQ0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-24T18:05:41.525Z","version":0,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCUS33","bankCode":"045110","accountNumber":"22765819","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54","type":"business"},"branchCode":"Muswell Hill Branch"},"key":"Create a payout instrument for existing party of company (modular)","summary":"Create a payout instrument for existing party of company (modular)","description":"PayoutInstrument for a company (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/201/content/application~1json/examples/Create a payout instrument for existing party of company (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1payoutInstruments/post/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of person (modular)":{"value":{"payoutInstrumentReference":"personalCheckingAccount","payoutInstrumentId":"parVID57-ep4PqX6J-25AkZk0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-07T20:48:00.227Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},"key":"Get a payout instrument for existing party of person (modular)","summary":"Get a payout instrument for existing party of person (modular)","description":"Get a payoutInstrument for a party of person  (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of person (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of sole trader (modular)":{"value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"partA3SpNddFfGPV0fYk_zI-0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-07T20:48:00.660Z","version":0,"accountHolderName":"Case H. Mitchell","swiftBic":"BUKBGB22","bankCode":"045110","accountNumber":"23198765","accountType":"checking","iban":"GB892019000123456789","bankName":"Metro Bank","address":{"address1":"17 Neo-London Financial Tower","address2":"Suite 1288","city":"London","countryCode":"GB","postalCode":"EC1A 1BB","type":"business"},"branchCode":"Barclays Branch"},"key":"Get a payout instrument for existing party of sole trader (modular)","summary":"Get a payout instrument for existing party of sole trader (modular)","description":"Get a payoutInstrument for a party of soleTrader  (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of sole trader (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of company (modular)":{"value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parRI-eYCnF_sOAK59-38hUF0","payoutInstrumentType":"bankAccount","currency":"USD","dateTimeCreated":"2025-04-24T18:22:16.393Z","dateTimeUpdated":"2025-04-25T18:22:16.393Z","version":1,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCUS33","bankCode":"045110","accountNumber":"22765819","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"3 Villa Straylight","address2":"Freeside","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54","type":"business"},"branchCode":"Muswell Hill Branch"},"key":"Get a payout instrument for existing party of company (modular)","summary":"Get a payout instrument for existing party of company (modular)","description":"Get a payoutInstrument for a party of company (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/200/content/application~1json/examples/Get a payout instrument for existing party of company (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/get/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/requestBody/content/application~1json/examples/Update a payout instrument for existing party of company (modular)":{"value":{"accountHolderName":"Tessier-Ashpool Systems Ltd.","payoutInstrumentType":"bankAccount","swiftBic":"FSFCUS33","bankCode":"045110","branchCode":"Muswell Hill Branch","accountNumber":"2276581","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","payoutInstrumentReference":"primaryBusinessAccount","currency":"EUR","address":{"address1":"9105 Villa Straylight","address2":"Freeside","type":"business","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54"}},"key":"Update a payout instrument for existing party of company (modular)","summary":"Update a payout instrument for existing party of company (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/requestBody/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/200/content/application~1json/examples/Update a payout instrument for existing party of company (modular)":{"value":{"payoutInstrumentReference":"primaryBusinessAccount","payoutInstrumentId":"parWm7eF6Dfwry4EYQdpXSSB0","payoutInstrumentType":"bankAccount","currency":"EUR","dateTimeCreated":"2025-04-22T19:24:07.680Z","dateTimeUpdated":"2025-04-22T19:24:11.462Z","version":2,"accountHolderName":"Tessier-Ashpool Systems Ltd.","swiftBic":"FSFCUS33","bankCode":"045110","accountNumber":"2276581","accountType":"savings","iban":"GB33TASS12345678901234","bankName":"Freeside Financial Corporation","address":{"address1":"9105 Villa Straylight","address2":"Freeside","city":"York","state":"NA","countryCode":"GB","postalCode":"L502 MK54","type":"business"},"branchCode":"Muswell Hill Branch"},"key":"Update a payout instrument for existing party of company (modular)","summary":"Update a payout instrument for existing party of company (modular)","description":"Update payout instrument for existing party of a company (modular)","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/200/content/application~1json/examples/Update a payout instrument for existing party of company (modular)"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1payoutInstruments~1{payoutInstrumentId}/put/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)":{"value":{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount2","scheduledPayoutDay":"friday","frequency":"weekly"},"key":"Create a balance account for existing party of person (modular with a weekly payout)","summary":"Create a balance account for existing party of person (modular with a weekly payout)","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)"},"paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)":{"value":{"currency":"USD","scheduledPayoutDay":"friday","frequency":"monthly","recurrence":"first","payoutInstrumentReference":"primaryBusinessAccount"},"key":"Create a balance account for existing party of sole trader (modular with a monthly payout)","summary":"Create a balance account for existing party of sole trader (modular with a monthly payout)","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)"},"paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)":{"value":{"currency":"USD","frequency":"daily","payoutInstrumentReference":"primaryBusinessAccount"},"key":"Create a balance account for existing party of company (modular with a daily payout)","summary":"Create a balance account for existing party of company (modular with a daily payout)","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/requestBody/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"},"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)":{"value":{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount2","scheduledPayoutDay":"friday","frequency":"weekly","balanceAccountId":"pareBH4YMkUx7MA2X7bnS4750","dateTimeCreated":"2025-04-16T20:46:26.727Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"key":"Create a balance account for existing party of person (modular with a weekly payout)","summary":"Create a balance account for existing party of person (modular with a weekly payout)","description":"Balance account for a party of an existing person (modular)","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of person (modular with a weekly payout)"},"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)":{"value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"friday","frequency":"monthly","recurrence":"first","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"key":"Create a balance account for existing party of sole trader (modular with a monthly payout)","summary":"Create a balance account for existing party of sole trader (modular with a monthly payout)","description":"Balance account for a party of an existing soleTrader (modular)","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of sole trader (modular with a monthly payout)"},"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)":{"value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","frequency":"daily","balanceAccountId":"parGWfE__Xr1F-AmY0v72fwR0","dateTimeCreated":"2025-04-16T20:46:27.014Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"key":"Create a balance account for existing party of company (modular with a daily payout)","summary":"Create a balance account for existing party of company (modular with a daily payout)","description":"Balance account for a party of an existing company (modular)","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/201/content/application~1json/examples/Create a balance account for existing party of company (modular with a daily payout)"},"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1balanceAccounts/post/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of company (modular with a daily payout)":{"value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","frequency":"daily","balanceAccountId":"parGWfE__Xr1F-AmY0v72fwR0","dateTimeCreated":"2025-04-16T20:46:27.014Z","dateTimeUpdated":"2025-04-17T20:46:27.014Z","version":1,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"key":"Get a balance account for existing party of company (modular with a daily payout)","summary":"Get a balance account for existing party of company (modular with a daily payout)","description":"Balance account for a party of type company (modular)","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of company (modular with a daily payout)"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of person (modular with a weekly payout)":{"value":{"currency":"EUR","payoutInstrumentReference":"personalCheckingAccount","scheduledPayoutDay":"friday","frequency":"weekly","balanceAccountId":"pareBH4YMkUx7MA2X7bnS4750","dateTimeCreated":"2025-04-16T20:46:26.727Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"key":"Get a balance account for existing party of person (modular with a weekly payout)","summary":"Get a balance account for existing party of person (modular with a weekly payout)","description":"Balance account for a party of type person (modular)","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of person (modular with a weekly payout)"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of sole trader (modular with a monthly payout)":{"value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"friday","frequency":"monthly","recurrence":"first","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","version":0,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"key":"Get a balance account for existing party of sole trader (modular with a monthly payout)","summary":"Get a balance account for existing party of sole trader (modular with a monthly payout)","description":"Balance account for a party of type sole trader (modular)","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/200/content/application~1json/examples/Get a balance account for existing party of sole trader (modular with a monthly payout)"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/get/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/requestBody/content/application~1json/examples/Update a balance account":{"value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","dateTimeUpdated":"2025-04-16T20:46:29.901Z","version":1,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"key":"Update a balance account","summary":"Update a balance account","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/requestBody/content/application~1json/examples/Update a balance account"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/200/content/application~1json/examples/Update balance account":{"value":{"currency":"USD","payoutInstrumentReference":"primaryBusinessAccount","scheduledPayoutDay":"thursday","frequency":"weekly","balanceAccountId":"parApcraCq1bmBuCotAMoyss0","dateTimeCreated":"2025-04-16T20:46:26.852Z","dateTimeUpdated":"2025-04-18T20:46:29.901Z","version":2,"accountNumber":"12345678","nextPayoutDate":"2026-03-19"},"key":"Update balance account","summary":"Update balance account","description":"Update balance account for existing party of a sole trader (modular)","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/200/content/application~1json/examples/Update balance account"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1balanceAccounts~1{balanceAccountId}/put/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1beneficialOwners/post/requestBody/content/application~1json/examples/Create beneficial owner for existing company (modular)":{"value":{"beneficialOwnerReference":"xdl12goH60","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John Smith","socialSecurityNumber":"333-55-6666","residentialStatus":"nonResident","dateOfBirth":"1972-05-22","nationality":"GB","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","type":"home","countryCode":"GB","postalCode":"SW1A 2AA"},"currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"425 Oxford Street","address2":"Flat 101","city":"London","type":"home","countryCode":"GB","postalCode":"W1D 1LP"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":false,"position":"partner"},"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"email":"John.bailey@example.com","phones":[{"number":"0205556789","prefix":"44"}]},"key":"Create beneficial owner for existing company (modular)","summary":"Create beneficial owner for existing company (modular)","id":"paths/~1parties~1{partyId}~1beneficialOwners/post/requestBody/content/application~1json/examples/Create beneficial owner for existing company (modular)"},"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/201/content/application~1json/examples/Create beneficial owner for existing company (modular)":{"value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"owner28","beneficialOwnerId":"parNtJbNC8_fd_HRKyQRekiN0","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John bailey","socialSecurityNumber":"333-55-1666","dateOfBirth":"1972-05-22","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"425 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":false,"position":"partner"},"email":"John.bailey@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2025-03-20T18:33:41.480Z","version":0},"key":"Create beneficial owner for existing company (modular)","summary":"Create beneficial owner for existing company (modular)","description":"Beneficial owner for existing party type company (modular)","id":"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/201/content/application~1json/examples/Create beneficial owner for existing company (modular)"},"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1beneficialOwners/post/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/200/content/application~1json/examples/Get a Beneficial Owner":{"value":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Santino227","beneficialOwnerId":"parNKRss9vllWyX1MUVOj7b-0","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John bailey","socialSecurityNumber":"373-55-6666","dateOfBirth":"1972-05-22","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"425 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":false,"position":"partner"},"email":"John.bailey@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2025-04-07T20:47:59.479Z","dateTimeUpdated":"2025-04-08T20:47:59.479Z","version":1},"key":"Get a Beneficial Owner","summary":"Get a Beneficial Owner","description":"Get a beneficial owner","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/200/content/application~1json/examples/Get a Beneficial Owner"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/get/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/requestBody/content/application~1json/examples/Update a Beneficial Owner":{"value":{"beneficialOwnerReference":"uWBzL2nzx3","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John bailey","socialSecurityNumber":"333-55-6566","residentialStatus":"nonResident","dateOfBirth":"1972-05-22","nationality":"GB","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","type":"home","countryCode":"GB","postalCode":"SW1A 2AA"},"currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"200 Oxford Street","address2":"Flat 101","city":"London","type":"home","countryCode":"GB","postalCode":"W1D 1LP"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":true,"position":"partner"},"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"email":"John.bailey@example.com","phones":[{"number":"0205556789","prefix":"44"}]},"key":"Update a Beneficial Owner","summary":"Update a Beneficial Owner","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/requestBody/content/application~1json/examples/Update a Beneficial Owner"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/200/content/application~1json/examples/Update Beneficial Owner":{"value":{"identityVerificationState":"notVerified","identityVerificationMethod":"identityVerificationService","beneficialOwnerReference":"Gerson337","beneficialOwnerId":"pardPhiwdlp8VcnS8U7LHVbE0","personalDetails":{"title":"Dr","firstName":"John","middleName":"Illusionet","lastName":"Bailey","alias":"John Bailey","socialSecurityNumber":"393-55-6666","dateOfBirth":"1972-05-22","address":{"address1":"200 Downing Street","address2":"Flat 404","city":"London","countryCode":"GB","postalCode":"SW1A 2AA","type":"home"},"residentialStatus":"nonResident","nationality":"GB","currentAddressLessThanThreeYears":true,"previousHomeAddress":{"address1":"200 Oxford Street","address2":"Flat 101","city":"London","countryCode":"GB","postalCode":"W1D 1LP","type":"home"}},"relationshipToBusiness":{"ownershipPercentage":10,"director":false,"isPrincipalOwner":true,"position":"partner"},"email":"John.bailey@example.com","phones":[{"prefix":"44","number":"0205556789"}],"identityDocuments":[{"type":"passport","number":"B98765432","issuingInstitution":"UK Passport Office","issuingCountry":"GB","validFrom":"2018-05-15","validTo":"2028-05-15"}],"dateTimeCreated":"2025-04-10T15:45:06.349Z","version":2,"dateTimeUpdated":"2025-04-10T15:45:09.389Z"},"key":"Update Beneficial Owner","summary":"Update Beneficial Owner","description":"Update the beneficial owner for a party company (modular)","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/200/content/application~1json/examples/Update Beneficial Owner"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/put/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1beneficialOwners~1{beneficialOwnerId}/delete/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/Perform an Identity Verification request for a company with beneficial owners (modular)":{"value":{"performIdentityVerification":true},"key":"Perform an Identity Verification request for a company with beneficial owners (modular)","summary":"Perform an Identity Verification request for a company with beneficial owners (modular)","id":"paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/Perform an Identity Verification request for a company with beneficial owners (modular)"},"paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1identityVerification/post/requestBody/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1identityVerification/post/responses/200/content/application~1json/examples/Identity Verification response for a company with beneficial owners (modular)":{"value":{"overall":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService"},"party":{"identityVerificationState":"started","partyReference":"Euna925","partyId":"par1Bbf6r80Q3mEvhp_xBKNM0"},"beneficialOwners":[{"identityVerificationState":"started","beneficialOwnerReference":"Floy829","beneficialOwnerId":"parsH2dSCcczQveB-GQNx0qq0"},{"identityVerificationState":"started","beneficialOwnerReference":"Christina843","beneficialOwnerId":"parbQR-8sRkYASaOzOVPX5d10"},{"identityVerificationState":"started","beneficialOwnerReference":"Arlo912","beneficialOwnerId":"pargosUuzW0vv8HrWsCTuadb0"}]},"key":"Identity Verification response for a company with beneficial owners (modular)","summary":"Identity Verification response for a company with beneficial owners (modular)","description":"Identity Verification Status on a party of a company (modular)","id":"paths/~1parties~1{partyId}~1identityVerification/post/responses/200/content/application~1json/examples/Identity Verification response for a company with beneficial owners (modular)"},"paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/Bad request":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"There were field validation errors. The errors that occurred are within the validationErrors array.","validationErrors":[{"errorName":"fieldIsNotAllowed","message":"The identified field is present when it is explicitly not allowed in the request.","jsonPath":"$.additionalData"}]},"key":"Bad request","summary":"Bad request","id":"paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/Bad request"},"paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1identityVerification/post/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1identityVerification/post/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1identityVerification/post/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1identityVerification/post/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1identityVerification/post/responses/503/content/application~1json/examples/Service Unavailable"},"paths/~1parties~1{partyId}~1identityVerification/get/responses/200/content/application~1json/examples/Verify an Identity Verification status for a company with beneficial owners (modular)":{"value":{"overall":{"identityVerificationState":"started","identityVerificationMethod":"identityVerificationService"},"party":{"identityVerificationState":"started","partyReference":"Linnea474","partyId":"parWcAyq5G2-1KwvsEkFAKwz0"},"beneficialOwners":[{"identityVerificationState":"started","beneficialOwnerReference":"Mac551","beneficialOwnerId":"parAZo80iViOTdKRJi4Oq14Z0"},{"identityVerificationState":"started","beneficialOwnerReference":"Thea799","beneficialOwnerId":"parB5ON-IEK4olrLuHvjEDpE0"},{"identityVerificationState":"started","beneficialOwnerReference":"Santino227","beneficialOwnerId":"parNKRss9vllWyX1MUVOj7b-0"}]},"key":"Verify an Identity Verification status for a company with beneficial owners (modular)","summary":"Verify an Identity Verification status for a company with beneficial owners (modular)","description":"Get Identiy Verification Status on a party of a company (modular)","id":"paths/~1parties~1{partyId}~1identityVerification/get/responses/200/content/application~1json/examples/Verify an Identity Verification status for a company with beneficial owners (modular)"},"paths/~1parties~1{partyId}~1identityVerification/get/responses/400/content/application~1json/examples/URL with invalid value":{"value":{"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid.","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.","jsonPath":"$.partyId"}]},"key":"URL with invalid value","summary":"URL with invalid value","id":"paths/~1parties~1{partyId}~1identityVerification/get/responses/400/content/application~1json/examples/URL with invalid value"},"paths/~1parties~1{partyId}~1identityVerification/get/responses/500/content/application~1json/examples/Internal error occurred":{"value":{"errorName":"internalErrorOccurred","message":"An error occurred within the service (potentially due to an interaction with a downstream service)."},"key":"Internal error occurred","summary":"Internal error occurred","id":"paths/~1parties~1{partyId}~1identityVerification/get/responses/500/content/application~1json/examples/Internal error occurred"},"paths/~1parties~1{partyId}~1identityVerification/get/responses/503/content/application~1json/examples/Service Unavailable":{"value":{"errorName":"serviceUnavailable","message":"Service cannot fulfil the request even though service functions witout internal errors."},"key":"Service Unavailable","summary":"Service Unavailable","id":"paths/~1parties~1{partyId}~1identityVerification/get/responses/503/content/application~1json/examples/Service Unavailable"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":"Basic authentication with user name and password"}},"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/parties/@20250101/openapi.json?download"},{"url":"/access/_bundle/products/parties/@20250101/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Parties","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.\n\n__Authentication__\n\nSet your headers\n\n```\nAuthorization: {your_credentials}\nWP-Api-Version: 2025-01-01\n```\n\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password.\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.\n\n__API collection__\n\nA full set of API examples based on different scenarios.\n\n- <a href=\"/collections/parties/20250101/OpenApiDocExamples.postman_collection.json\" download=\"wp-parties-api-postman\">Download Postman collection </a>\n- <a href=\"/collections/parties/20250101/Try environment.postman_environment.json\" download=\"wp-parties-api-postman-try-env\">Download environment config for try env </a>\n","catalog-list":true,"business":["Marketplaces"],"category":["Parties"],"generated":true}},"baseSlug":"/products/parties/openapi","routesMapping":{}}