Skip to content

Parties (2025-01-01)

Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.

Authentication

Set your headers

Authorization: {your_credentials}
WP-Api-Version: 2025-01-01

Replace {your_credentials} with your base64-encoded Basic Auth username and password.

DNS whitelisting

Whitelist the following URLs:

  • https://try.access.worldpay.com/
  • https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting.

API collection

A full set of API examples based on different scenarios.

Download OpenAPI description
Overview
Languages
Servers
Live

https://access.worldpay.com/

Try

https://try.access.worldpay.com/

Parties

Create and maintain parties.

Operations

Create a party

Request

Security
basicAuth
Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
Bodyapplication/jsonrequired
One of:

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.

companyDetailsobjectrequired
merchantCategoryCodestring= 4 characters^\d{4}$

A 4-digit code to represent the merchant category. Only provide this where typeCode is soleTrader or company.

Example: "5411"
merchantCategoryCodeDescriptionstring[ 1 .. 255 ] characters

A description to describe the merchant category code. Only provide this where typeCode is soleTrader or company.

Example: "Grocery Stores"
websitestring

The URL of the merchant's website.

Example: "https://example.com/"
legalNamestring[ 2 .. 140 ] characters^(?: *[\p{L}\p{N}+&\/\-.()])*+(?: *[\p{L}\p{N...required

The legal name of the company.

Example: "Tessier-Ashpool Systems Ltd."
tradingNamestring[ 2 .. 140 ] characters^(?: *[\p{L}\p{N}+&\/\-.()])*+(?: *[\p{L}\p{N...

The trading common name of the company.

Example: "TASynth.com"
registrationNumberstring[ 1 .. 15 ] characters[a-zA-Z0-9-]*

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"
vatNumberstring[ 1 .. 15 ] characters[a-zA-Z0-9-]*

The Value Added Tax (VAT) number of the company.

Example: "JP987654321"
companyTypestring

A description of the type of company.

Enum"charity""government""publicLimitedCompany""limitedCompanyShares""limitedLiabilityPartnership""partnership""limitedCompanyGuarantee""trust""regulatedFinancialAndCreditInstitutions""unlistedCorporate"
Example: "publicLimitedCompany"
dateOfIncorporationstring

The incorporation date for the company.

Example: "1977-07-04"
legalAddressobjectrequired
tradingAddressobject
customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"
countryOfIncorporationstring

The country code specified in ISO 3166-1 Alpha-2 code format.

Example: "GB"
beneficialOwnersArray of objects
beneficialOwnerReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$required

Your reference for this beneficial owner, must be unique within an entity.

Example: "Hosaka27384910"
personalDetailsobjectrequired
relationshipToBusinessobjectrequired
emailstring(email)
phonesArray of objects
identityDocumentsArray of objects
merchantobjectrequired
entitystring[ 1 .. 36 ] characters[a-zA-Z0-9- ]*required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"
partyReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$required

Your reference for this party, must be unique within an entity.

Example: "Hosaka27384910"
partyTypestringrequired

The type of this party.

beneficiary - the person or business that will receive funds

payer - a transmitter of funds to a third party

Enum"beneficiary""payer"
typestringrequired

What the party represents:

person - an individual

soleTrader - a single person enterprise

company - a corporation or partnership with multiple owners

Enum"company""person""soleTrader"
emailstring(email)

An email address for this party.

phonesArray of objects

A list of phone numbers associated with this party.

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"
numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"
identityDocumentsArray of objects

A list of identity documents for this party.

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"
numberstringnon-emptyrequired
issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"
issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"
validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"
validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"
balanceAccountsArray of objects

A list of balance accounts that have been set up for this party.

currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
payoutInstrumentReferencestring

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
overallAccountStatusstring

The overallStatus provides an complete view of the parties identityVerificationState.

payoutInstrumentsArray of objects
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

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"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject
branchCodestring
performIdentityVerificationbooleanwrite-only
application/json

Create a party for a person (orchestrated)

{ "merchant": { "entity": "default" }, "partyReference": "VuzvLew4y7", "partyType": "beneficiary", "type": "person", "personalDetails": { "title": "Mr", "firstName": "Case", "middleName": "Henry", "lastName": "Mitchell", "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" } ], "balanceAccounts": [ { "currency": "GBP", "scheduledPayoutDay": "tuesday", "payoutInstrumentReference": "MyPayoutInstrument1" } ], "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": "MyPayoutInstrument1", "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 }

Responses

Created

Bodyapplication/json
One of:

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.

identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview""stepUpReceived"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

messagestringread-only

The message associated with link returned from Identity Verification Status (IVS).

merchantobjectrequired
entitystring[ 1 .. 36 ] characters[a-zA-Z0-9- ]*required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"
partyReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$required

Your reference for this party, must be unique within an entity.

Example: "Hosaka27384910"
partyTypestringrequired

The type of this party.

beneficiary - the person or business that will receive funds

payer - a transmitter of funds to a third party

Enum"beneficiary""payer"
typestringrequired

What the party represents:

person - an individual

soleTrader - a single person enterprise

company - a corporation or partnership with multiple owners

Enum"company""person""soleTrader"
partyIdstringread-only

A unique identifier for the party generated by us.

emailstring(email)

An email address for this party.

phonesArray of objects

A list of phone numbers associated with this party.

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"
numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"
identityDocumentsArray of objects

A list of identity documents for this party.

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"
numberstringnon-emptyrequired
issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"
issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"
validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"
validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"
balanceAccountsArray of objects

A list of balance accounts that have been set up for this party.

currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
payoutInstrumentReferencestring

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
balanceAccountIdstringread-only

Unique ID created by us to identify a balance account. This sent in the response after balanceAccount creation.

dateTimeCreatedstringread-only

The date and time that the balance account was created, as an ISO 8601 zoned date time.

Example: "2025-01-23T12:23:445.222Z"
dateTimeUpdatedstringread-only

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"
versioninteger(int32)read-only
overallAccountStatusstring

The overallStatus provides an complete view of the parties identityVerificationState.

dateTimeCreatedstringread-only

The date and time that the party was created, as an ISO 8601 zoned date time.

Example: "2025-01-23T12:23:445.222Z"
dateTimeUpdatedstringread-only

The date and time that the party was last updated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
versioninteger(int32)read-only
payoutInstrumentsArray of objects
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

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"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
dateTimeCreatedstringread-only

The date and time the payoutInstrument was created, as an ISO 8601 zoned date time.

dateTimeUpdatedstringread-only

The date and time the payoutInstrument was updated, as an ISO 8601 zoned date time.

versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject
branchCodestring
activebooleanread-only

Indicates whether the party is active or not.

Example: true
dateTimeDeactivatedstringread-only

The date and time that the party was last deactivated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
deactivationReasonstringread-only

The reason for deactivating a party.

Example: "partyDormant"
dispositionOfFundsstringread-only

The disposition of funds for deactivated party.

Example: "payoutToParty"
dateTimeActivatedstringread-only

The date and time that the party was last activated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
personalDetailsobjectrequired
titlestringrequired

The title for this person/soleTrader.

Enum"Mr""Mrs""Miss""Ms""Dr""Mx""Misc"
Example: "Mr"
firstNamestring[ 2 .. 35 ] characters^[\p{L}\-.,'()&]{2,}$required

The person's/soleTrader's first name.

Example: "Case"
middleNamestring[ 1 .. 35 ] characters^(?:\p{L}\.?)*+$

The person's/soleTrader's middle name or initial.

Example: "Henry"
lastNamestring[ 2 .. 35 ] characters^(?:[\p{L}\-.,'()&]{2,} *)*+$required

The person's/soleTrader's last name.

Example: "Mitchell"
dateOfBirthstring

The date the person/soleTrader was born.

Example: "1983-10-12"
addressobjectrequired
residentialStatusstring

The residential status of the person/soleTrader.

Enum"resident""nonResident""other"
customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"
nationalitystring

The nationality of the person/soleTrader.

currentAddressLessThanThreeYearsboolean
previousHomeAddressobject
websitestring

The URL of the merchant's website.

Example: "https://example.com/"
Response
application/json

Party for a person (orchestrated)

{ "identityVerificationState": "started", "identityVerificationMethod": "identityVerificationService", "merchant": { "entity": "default" }, "partyReference": "Heidi197", "partyType": "beneficiary", "type": "person", "partyId": "parMbuHucAsLeLL0BhDpWdjE0", "personalDetails": { "title": "Mr", "firstName": "Case", "middleName": "Henry", "lastName": "Mitchell", "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": "GBP", "payoutInstrumentReference": "MyPayoutInstrument1", "scheduledPayoutDay": "tuesday", "balanceAccountId": "par3GymZO5MtP18qe5NFaaPp0", "dateTimeCreated": "2025-04-16T20:46:24.122Z", "version": 0 } ], "dateTimeCreated": "2025-04-16T20:46:24.122Z", "version": 0, "active": true, "dateTimeActivated": "2025-04-24T17:55:56.283Z", "payoutInstruments": [ { "payoutInstrumentReference": "MyPayoutInstrument1", "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" } ] }

Browse parties

Request

Browse parties and optionally filtered by criteria. Results are paginated.

Security
basicAuth
Query
pageinteger(int32)>= 0

Positive whole number indicating which page of the selected parties to return. Greater than 0.

Default 0
Example: page=5
sizeinteger(int32)[ 1 .. 100 ]

Number of items listed per page.

Default 10
Example: size=10
entityArray of strings

Entity or entities to filter parties by.

Example: entity=Entity123&entity=Entity456
activeboolean

Returns parties that are active when set to true.

Example: active=true
typestring

Type of parties to return.

Enum"person""soleTrader""company"
Example: type=soleTrader&type=company
Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
No request payload

Responses

OK

Bodyapplication/json
partiesArray of objectsread-onlyrequired

List of parties on the current page.

One of:

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.

companyDetailsobjectrequired
beneficialOwnersArray of objects
identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview""stepUpReceived"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

messagestringread-only

The message associated with link returned from Identity Verification Status (IVS).

merchantobjectrequired
partyReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$required

Your reference for this party, must be unique within an entity.

Example: "Hosaka27384910"
partyTypestringrequired

The type of this party.

beneficiary - the person or business that will receive funds

payer - a transmitter of funds to a third party

Enum"beneficiary""payer"
typestringrequired

What the party represents:

person - an individual

soleTrader - a single person enterprise

company - a corporation or partnership with multiple owners

Enum"company""person""soleTrader"
partyIdstringread-only

A unique identifier for the party generated by us.

emailstring(email)

An email address for this party.

phonesArray of objects

A list of phone numbers associated with this party.

identityDocumentsArray of objects

A list of identity documents for this party.

balanceAccountsArray of objects

A list of balance accounts that have been set up for this party.

overallAccountStatusstring

The overallStatus provides an complete view of the parties identityVerificationState.

dateTimeCreatedstringread-only

The date and time that the party was created, as an ISO 8601 zoned date time.

Example: "2025-01-23T12:23:445.222Z"
dateTimeUpdatedstringread-only

The date and time that the party was last updated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
versioninteger(int32)read-only
payoutInstrumentsArray of objects
activebooleanread-only

Indicates whether the party is active or not.

Example: true
dateTimeDeactivatedstringread-only

The date and time that the party was last deactivated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
deactivationReasonstringread-only

The reason for deactivating a party.

Example: "partyDormant"
dispositionOfFundsstringread-only

The disposition of funds for deactivated party.

Example: "payoutToParty"
dateTimeActivatedstringread-only

The date and time that the party was last activated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
paginationobjectread-onlyrequired
pageinteger(int32)read-onlyrequired

Positive whole number indicating which page of the selected parties to return. Greater than 0.

Example: 5
sizeinteger(int32)read-onlyrequired

Number of items listed per page.

Example: 10
pageCountinteger(int32)read-only

Total number of pages.

Example: 3
totalNumberOfRecordsinteger(int64)read-only

Total number of records in the database for the selected parties.

Example: 1227
Response
application/json

Browse parties

{ "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-02T15:51:54.257Z", "version": 2, "payoutInstruments": [], "active": true, "dateTimeDeactivated": "2025-09-02T15:51:54.211Z", "dateTimeActivated": "2025-09-02T15:51:54.257Z", "personalDetails": { "title": "Mr", "firstName": "sa7h", "middleName": "G3d3c", "lastName": "eFGwfD84", "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": "tuesday", "balanceAccountId": "parVUdr_mDPwl1EY3Pb5y-Cp0", "dateTimeCreated": "2025-09-02T15:51:54.638Z", "version": 0 }, { "currency": "EUR", "payoutInstrumentReference": "hCpcT6vTPB", "scheduledPayoutDay": "friday", "balanceAccountId": "paruowtCO9OPFIGjx9gYl5iE0", "dateTimeCreated": "2025-09-02T15:51:58.314Z", "version": 0 } ], "dateTimeCreated": "2025-09-02T15:51:54.635Z", "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": "2025-09-02T15:51:54.635Z", "personalDetails": { "title": "Mr", "firstName": "sa7h", "middleName": "G3d3c", "lastName": "eFGwfD84", "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 }, { "currency": "USD", "payoutInstrumentReference": "kNiuKzkNlO", "scheduledPayoutDay": "friday", "balanceAccountId": "parr9a1J5alvURV2KrWFi8880", "dateTimeCreated": "2025-09-02T15:51:58.578Z", "version": 0 } ], "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", "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": "monday", "balanceAccountId": "parKwY5ezX2R4QaUGQ47cGYi0", "dateTimeCreated": "2025-09-02T15:51:55.678Z", "version": 1 }, { "currency": "USD", "payoutInstrumentReference": "u8MamGFmEo", "scheduledPayoutDay": "thursday", "balanceAccountId": "parUoWq2uerKMrdAPFeBLqy80", "dateTimeCreated": "2025-09-02T15:51:58.849Z", "version": 1 }, { "currency": "GBP", "balanceAccountId": "parfnsCbzM7Og3xIdfa48tAZ0", "dateTimeCreated": "2025-09-02T15:51:55.678Z", "version": 1 } ], "dateTimeCreated": "2025-09-02T15:51:56.295Z", "version": 2, "payoutInstruments": [ { "payoutInstrumentReference": "u8MamGFmEo", "payoutInstrumentId": "parSALwf8D8drIikDp0aQTrG0", "payoutInstrumentType": "bankAccount", "currency": "USD", "dateTimeCreated": "2025-09-02T15:51:57.887Z", "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", "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", "vatNumber": "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" }, "beneficialOwners": [ { "identityVerificationState": "started", "identityVerificationMethod": "identityVerificationService", "beneficialOwnerReference": "GJbPJVtqFz", "beneficialOwnerId": "par5BsbOKDecm8uWVgzYUor-0", "personalDetails": { "title": "Ms", "firstName": "hNCtN", "middleName": "LVrVLk", "lastName": "Sx0yl4x7", "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, "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", "version": 1 }, { "identityVerificationState": "started", "identityVerificationMethod": "identityVerificationService", "beneficialOwnerReference": "YezTTwoVHR", "beneficialOwnerId": "parIrzObRP9_nc7Y5R29fgoC0", "personalDetails": { "title": "Dr", "firstName": "umxv2", "middleName": "tusFSTLKvR", "lastName": "pkw1XH1", "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", "version": 1 }, { "identityVerificationState": "started", "identityVerificationMethod": "identityVerificationService", "beneficialOwnerReference": "zHCxMG8x4T", "beneficialOwnerId": "parT4dazXixMu5npZGQL0iwH0", "personalDetails": { "title": "Dr", "firstName": "JbJI", "middleName": "tusFSTLKvR", "lastName": "PKfI0z", "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", "version": 1 } ] } ], "pagination": { "page": 0, "size": 10, "pageCount": 1, "totalNumberOfRecords": 4 } }

View a party

Request

Retrieve information about a party.

Security
basicAuth
Path
partyIdstring= 25 characters^par[a-zA-Z0-9-_]*0$required

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

Example: parV1StGXR8_Z5jdHi6B-myF0
Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
No request payload

Responses

OK

Bodyapplication/json
One of:

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.

identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview""stepUpReceived"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

messagestringread-only

The message associated with link returned from Identity Verification Status (IVS).

merchantobjectrequired
entitystring[ 1 .. 36 ] characters[a-zA-Z0-9- ]*required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"
partyReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$required

Your reference for this party, must be unique within an entity.

Example: "Hosaka27384910"
partyTypestringrequired

The type of this party.

beneficiary - the person or business that will receive funds

payer - a transmitter of funds to a third party

Enum"beneficiary""payer"
typestringrequired

What the party represents:

person - an individual

soleTrader - a single person enterprise

company - a corporation or partnership with multiple owners

Enum"company""person""soleTrader"
partyIdstringread-only

A unique identifier for the party generated by us.

emailstring(email)

An email address for this party.

phonesArray of objects

A list of phone numbers associated with this party.

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"
numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"
identityDocumentsArray of objects

A list of identity documents for this party.

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"
numberstringnon-emptyrequired
issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"
issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"
validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"
validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"
balanceAccountsArray of objects

A list of balance accounts that have been set up for this party.

currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
payoutInstrumentReferencestring

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
balanceAccountIdstringread-only

Unique ID created by us to identify a balance account. This sent in the response after balanceAccount creation.

dateTimeCreatedstringread-only

The date and time that the balance account was created, as an ISO 8601 zoned date time.

Example: "2025-01-23T12:23:445.222Z"
dateTimeUpdatedstringread-only

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"
versioninteger(int32)read-only
overallAccountStatusstring

The overallStatus provides an complete view of the parties identityVerificationState.

dateTimeCreatedstringread-only

The date and time that the party was created, as an ISO 8601 zoned date time.

Example: "2025-01-23T12:23:445.222Z"
dateTimeUpdatedstringread-only

The date and time that the party was last updated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
versioninteger(int32)read-only
payoutInstrumentsArray of objects
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

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"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
dateTimeCreatedstringread-only

The date and time the payoutInstrument was created, as an ISO 8601 zoned date time.

dateTimeUpdatedstringread-only

The date and time the payoutInstrument was updated, as an ISO 8601 zoned date time.

versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject
branchCodestring
activebooleanread-only

Indicates whether the party is active or not.

Example: true
dateTimeDeactivatedstringread-only

The date and time that the party was last deactivated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
deactivationReasonstringread-only

The reason for deactivating a party.

Example: "partyDormant"
dispositionOfFundsstringread-only

The disposition of funds for deactivated party.

Example: "payoutToParty"
dateTimeActivatedstringread-only

The date and time that the party was last activated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
personalDetailsobjectrequired
titlestringrequired

The title for this person/soleTrader.

Enum"Mr""Mrs""Miss""Ms""Dr""Mx""Misc"
Example: "Mr"
firstNamestring[ 2 .. 35 ] characters^[\p{L}\-.,'()&]{2,}$required

The person's/soleTrader's first name.

Example: "Case"
middleNamestring[ 1 .. 35 ] characters^(?:\p{L}\.?)*+$

The person's/soleTrader's middle name or initial.

Example: "Henry"
lastNamestring[ 2 .. 35 ] characters^(?:[\p{L}\-.,'()&]{2,} *)*+$required

The person's/soleTrader's last name.

Example: "Mitchell"
dateOfBirthstring

The date the person/soleTrader was born.

Example: "1983-10-12"
addressobjectrequired
residentialStatusstring

The residential status of the person/soleTrader.

Enum"resident""nonResident""other"
customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"
nationalitystring

The nationality of the person/soleTrader.

currentAddressLessThanThreeYearsboolean
previousHomeAddressobject
websitestring

The URL of the merchant's website.

Example: "https://example.com/"
Response
application/json

Get a party for person

{ "identityVerificationState": "pending", "identityVerificationMethod": "identityVerificationService", "merchant": { "entity": "default" }, "partyReference": "Heidi197", "partyType": "beneficiary", "type": "person", "partyId": "parMbuHucAsLeLL0BhDpWdjE0", "personalDetails": { "title": "Mr", "firstName": "Case", "middleName": "Henry", "lastName": "Mitchell", "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": "MyPayoutInstrument1", "scheduledPayoutDay": "friday", "balanceAccountId": "pareBH4YMkUx7MA2X7bnS4750", "dateTimeCreated": "2025-04-16T20:46:26.727Z", "version": 0 }, { "currency": "GBP", "payoutInstrumentReference": "MyPayoutInstrument2", "scheduledPayoutDay": "tuesday", "balanceAccountId": "par3GymZO5MtP18qe5NFaaPp0", "dateTimeCreated": "2025-04-16T20:46:24.122Z", "version": 0 } ], "dateTimeCreated": "2025-04-16T20:46:24.122Z", "version": 0, "active": true, "dateTimeActivated": "2025-04-24T17:55:56.283Z", "payoutInstruments": [ { "payoutInstrumentReference": "MyPayoutInstrument1", "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": "MyPayoutInstrument2", "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" } ] }

Update a party

Request

Security
basicAuth
Path
partyIdstring= 25 characters^par[a-zA-Z0-9-_]*0$required

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
Bodyapplication/jsonrequired
One of:

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.

companyDetailsobjectrequired
merchantCategoryCodestring= 4 characters^\d{4}$

A 4-digit code to represent the merchant category. Only provide this where typeCode is soleTrader or company.

Example: "5411"
merchantCategoryCodeDescriptionstring[ 1 .. 255 ] characters

A description to describe the merchant category code. Only provide this where typeCode is soleTrader or company.

Example: "Grocery Stores"
websitestring

The URL of the merchant's website.

Example: "https://example.com/"
legalNamestring[ 2 .. 140 ] characters^(?: *[\p{L}\p{N}+&\/\-.()])*+(?: *[\p{L}\p{N...required

The legal name of the company.

Example: "Tessier-Ashpool Systems Ltd."
tradingNamestring[ 2 .. 140 ] characters^(?: *[\p{L}\p{N}+&\/\-.()])*+(?: *[\p{L}\p{N...

The trading common name of the company.

Example: "TASynth.com"
registrationNumberstring[ 1 .. 15 ] characters[a-zA-Z0-9-]*

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"
vatNumberstring[ 1 .. 15 ] characters[a-zA-Z0-9-]*

The Value Added Tax (VAT) number of the company.

Example: "JP987654321"
companyTypestring

A description of the type of company.

Enum"charity""government""publicLimitedCompany""limitedCompanyShares""limitedLiabilityPartnership""partnership""limitedCompanyGuarantee""trust""regulatedFinancialAndCreditInstitutions""unlistedCorporate"
Example: "publicLimitedCompany"
dateOfIncorporationstring

The incorporation date for the company.

Example: "1977-07-04"
legalAddressobjectrequired
tradingAddressobject
customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"
countryOfIncorporationstring

The country code specified in ISO 3166-1 Alpha-2 code format.

Example: "GB"
beneficialOwnersArray of objects
beneficialOwnerReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$required

Your reference for this beneficial owner, must be unique within an entity.

Example: "Hosaka27384910"
personalDetailsobjectrequired
relationshipToBusinessobjectrequired
emailstring(email)
phonesArray of objects
identityDocumentsArray of objects
merchantobjectrequired
entitystring[ 1 .. 36 ] characters[a-zA-Z0-9- ]*required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"
partyReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$required

Your reference for this party, must be unique within an entity.

Example: "Hosaka27384910"
partyTypestringrequired

The type of this party.

beneficiary - the person or business that will receive funds

payer - a transmitter of funds to a third party

Enum"beneficiary""payer"
typestringrequired

What the party represents:

person - an individual

soleTrader - a single person enterprise

company - a corporation or partnership with multiple owners

Enum"company""person""soleTrader"
emailstring(email)

An email address for this party.

phonesArray of objects

A list of phone numbers associated with this party.

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"
numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"
identityDocumentsArray of objects

A list of identity documents for this party.

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"
numberstringnon-emptyrequired
issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"
issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"
validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"
validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"
balanceAccountsArray of objects

A list of balance accounts that have been set up for this party.

currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
payoutInstrumentReferencestring

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
overallAccountStatusstring

The overallStatus provides an complete view of the parties identityVerificationState.

payoutInstrumentsArray of objects
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

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"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject
branchCodestring
performIdentityVerificationbooleanwrite-only
application/json

Update a party for a person

{ "merchant": { "entity": "default" }, "partyReference": "8X87XwQ7Fv", "partyType": "beneficiary", "type": "person", "personalDetails": { "title": "Mr", "firstName": "Case", "middleName": "Henry", "lastName": "Mitchell", "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" } ] }

Responses

OK

Bodyapplication/json
One of:

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.

identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview""stepUpReceived"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

messagestringread-only

The message associated with link returned from Identity Verification Status (IVS).

merchantobjectrequired
entitystring[ 1 .. 36 ] characters[a-zA-Z0-9- ]*required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"
partyReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$required

Your reference for this party, must be unique within an entity.

Example: "Hosaka27384910"
partyTypestringrequired

The type of this party.

beneficiary - the person or business that will receive funds

payer - a transmitter of funds to a third party

Enum"beneficiary""payer"
typestringrequired

What the party represents:

person - an individual

soleTrader - a single person enterprise

company - a corporation or partnership with multiple owners

Enum"company""person""soleTrader"
partyIdstringread-only

A unique identifier for the party generated by us.

emailstring(email)

An email address for this party.

phonesArray of objects

A list of phone numbers associated with this party.

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"
numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"
identityDocumentsArray of objects

A list of identity documents for this party.

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"
numberstringnon-emptyrequired
issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"
issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"
validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"
validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"
balanceAccountsArray of objects

A list of balance accounts that have been set up for this party.

currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
payoutInstrumentReferencestring

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
balanceAccountIdstringread-only

Unique ID created by us to identify a balance account. This sent in the response after balanceAccount creation.

dateTimeCreatedstringread-only

The date and time that the balance account was created, as an ISO 8601 zoned date time.

Example: "2025-01-23T12:23:445.222Z"
dateTimeUpdatedstringread-only

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"
versioninteger(int32)read-only
overallAccountStatusstring

The overallStatus provides an complete view of the parties identityVerificationState.

dateTimeCreatedstringread-only

The date and time that the party was created, as an ISO 8601 zoned date time.

Example: "2025-01-23T12:23:445.222Z"
dateTimeUpdatedstringread-only

The date and time that the party was last updated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
versioninteger(int32)read-only
payoutInstrumentsArray of objects
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

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"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
dateTimeCreatedstringread-only

The date and time the payoutInstrument was created, as an ISO 8601 zoned date time.

dateTimeUpdatedstringread-only

The date and time the payoutInstrument was updated, as an ISO 8601 zoned date time.

versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject
branchCodestring
activebooleanread-only

Indicates whether the party is active or not.

Example: true
dateTimeDeactivatedstringread-only

The date and time that the party was last deactivated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
deactivationReasonstringread-only

The reason for deactivating a party.

Example: "partyDormant"
dispositionOfFundsstringread-only

The disposition of funds for deactivated party.

Example: "payoutToParty"
dateTimeActivatedstringread-only

The date and time that the party was last activated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
personalDetailsobjectrequired
titlestringrequired

The title for this person/soleTrader.

Enum"Mr""Mrs""Miss""Ms""Dr""Mx""Misc"
Example: "Mr"
firstNamestring[ 2 .. 35 ] characters^[\p{L}\-.,'()&]{2,}$required

The person's/soleTrader's first name.

Example: "Case"
middleNamestring[ 1 .. 35 ] characters^(?:\p{L}\.?)*+$

The person's/soleTrader's middle name or initial.

Example: "Henry"
lastNamestring[ 2 .. 35 ] characters^(?:[\p{L}\-.,'()&]{2,} *)*+$required

The person's/soleTrader's last name.

Example: "Mitchell"
dateOfBirthstring

The date the person/soleTrader was born.

Example: "1983-10-12"
addressobjectrequired
residentialStatusstring

The residential status of the person/soleTrader.

Enum"resident""nonResident""other"
customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"
nationalitystring

The nationality of the person/soleTrader.

currentAddressLessThanThreeYearsboolean
previousHomeAddressobject
websitestring

The URL of the merchant's website.

Example: "https://example.com/"
Response
application/json

Update party of a person (orchestrated)

{ "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", "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": "MyPayoutInstrument1", "scheduledPayoutDay": "tuesday", "balanceAccountId": "parXRSh-RDDLU5NyGZpQhyNb0", "dateTimeCreated": "2025-04-21T20:11:08.699Z", "version": 0 }, { "currency": "EUR", "payoutInstrumentReference": "MyPayoutInstrument2", "scheduledPayoutDay": "friday", "balanceAccountId": "parBTwBk8J3s3nhgbo1vNyvJ0", "dateTimeCreated": "2025-04-21T20:11:12.991Z", "version": 0 } ], "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": "MyPayoutInstrument1", "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": "MyPayoutInstrument2", "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" } ] }

Deactivate a party

Request

Security
basicAuth
Path
partyIdstring= 25 characters^par[a-zA-Z0-9-_]*0$required

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
Bodyapplication/jsonrequired
deactivationReasonstringrequired

The reason for deactivating a party.

Enum"partyDormant""partyClosed""partySanctioned"
Example: "partyDormant"
dispositionOfFundsstring

The disposition of funds for deactivated party.

Value"payoutToParty"
Example: "payoutToParty"
application/json

Deactivate an active party (modular)

{ "deactivationReason": "partyDormant", "dispositionOfFunds": "payoutToParty" }

Responses

OK

Bodyapplication/json
deactivationReasonstringrequired

The reason for deactivating a party.

Enum"partyDormant""partyClosed""partySanctioned"
Example: "partyDormant"
dispositionOfFundsstring

The disposition of funds for deactivated party.

Value"payoutToParty"
Example: "payoutToParty"
activebooleanread-only

Indicates whether the party is active or not.

Example: false
dateTimeDeactivatedstringread-only

The date and time that the party was last deactivated, as an ISO 8601 zoned date time.

Example: "2025-01-25T14:57:012.302Z"
Response
application/json

Deactivate an active party (modular)

{ "deactivationReason": "partyDormant", "dispositionOfFunds": "payoutToParty", "active": false, "dateTimeDeactivated": "2025-07-29T17:34:01.621Z" }

Reactivate a party

Request

Security
basicAuth
Path
partyIdstring= 25 characters^par[a-zA-Z0-9-_]*0$required

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
Bodyapplication/jsonrequired
activeboolean
application/json

Reactivate an inactive party (modular)

{ "active": true }

Responses

OK

Bodyapplication/json
activeboolean
dateTimeActivatedstringread-only

The date and time that the party was last activated, as an ISO 8601 zoned date time

Example: "2025-01-25T14:57:012.302Z"
Response
application/json

Activate an deactivated party (modular)

{ "active": true, "dateTimeActivated": "2025-07-29T17:34:01.621Z" }

Payout instruments

Create and maintain payout instruments.

Operations

Balance accounts

Create and maintain balance accounts.

Operations

Beneficial owners

Create and maintain beneficial owners.

Operations

Identity Verification

Enable Identity Verification check on a party.

Operations