Create and maintain parties.
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.
https://access.worldpay.com/
https://try.access.worldpay.com/
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.
A 4-digit code to represent the merchant category. Only provide this where typeCode
is soleTrader
or company
.
A description to describe the merchant category code. Only provide this where typeCode
is soleTrader
or company
.
The legal name of the company.
The trading common name of the company.
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).
The Value Added Tax (VAT) number of the company.
A description of the type of company.
Unique reference provided by the payee. Only required for certain payout destinations.
The country code specified in ISO 3166-1 Alpha-2 code format.
Your reference for this beneficial owner, must be unique within an entity.
Your reference for this party, must be unique within an entity.
The type of this party.
beneficiary
- the person or business that will receive funds
payer
- a transmitter of funds to a third party
What the party represents:
person
- an individual
soleTrader
- a single person enterprise
company
- a corporation or partnership with multiple owners
A list of phone numbers associated with this party.
A list of identity documents for this party.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
A list of balance accounts that have been set up for this party.
The currency in ISO 4217 currency format.
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.
The overallStatus provides an complete view of the parties identityVerificationState.
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
- Live
https://access.worldpay.com/parties
- Try
https://try.access.worldpay.com/parties
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
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 }
Created
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.
The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.
The message associated with link returned from Identity Verification Status (IVS).
Your reference for this party, must be unique within an entity.
The type of this party.
beneficiary
- the person or business that will receive funds
payer
- a transmitter of funds to a third party
What the party represents:
person
- an individual
soleTrader
- a single person enterprise
company
- a corporation or partnership with multiple owners
A list of phone numbers associated with this party.
A list of identity documents for this party.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
A list of balance accounts that have been set up for this party.
The currency in ISO 4217 currency format.
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.
The scheduled payout day for this balanceAccount
.
Unique ID created by us to identify a balance account. This sent in the response after balanceAccount
creation.
The date and time that the balance account was created, as an ISO 8601 zoned date time.
The date and time that the balance account was last updated, as an ISO 8601 zoned date time.
The overallStatus provides an complete view of the parties identityVerificationState.
The date and time that the party was created, as an ISO 8601 zoned date time.
The date and time that the party was last updated, as an ISO 8601 zoned date time.
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
The date and time the payoutInstrument
was created, as an ISO 8601 zoned date time.
The date and time the payoutInstrument
was updated, as an ISO 8601 zoned date time.
The date and time that the party was last deactivated, as an ISO 8601 zoned date time.
The disposition of funds for deactivated party.
The date and time that the party was last activated, as an ISO 8601 zoned date time.
The title for this person
/soleTrader
.
The person
's/soleTrader
's first name.
The person
's/soleTrader
's middle name or initial.
The person
's/soleTrader
's last name.
The residential status of the person
/soleTrader
.
Unique reference provided by the payee. Only required for certain payout destinations.
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" } ] }
- Live
https://access.worldpay.com/parties
- Try
https://try.access.worldpay.com/parties
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
No request payload
OK
List of parties on the current page.
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.
The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.
The message associated with link returned from Identity Verification Status (IVS).
Your reference for this party, must be unique within an entity.
The type of this party.
beneficiary
- the person or business that will receive funds
payer
- a transmitter of funds to a third party
What the party represents:
person
- an individual
soleTrader
- a single person enterprise
company
- a corporation or partnership with multiple owners
The overallStatus provides an complete view of the parties identityVerificationState.
The date and time that the party was created, as an ISO 8601 zoned date time.
The date and time that the party was last updated, as an ISO 8601 zoned date time.
The date and time that the party was last deactivated, as an ISO 8601 zoned date time.
The disposition of funds for deactivated party.
Positive whole number indicating which page of the selected parties to return. Greater than 0.
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 } }
- Live
https://access.worldpay.com/parties/{partyId}
- Try
https://try.access.worldpay.com/parties/{partyId}
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
No request payload
OK
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.
The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.
The message associated with link returned from Identity Verification Status (IVS).
Your reference for this party, must be unique within an entity.
The type of this party.
beneficiary
- the person or business that will receive funds
payer
- a transmitter of funds to a third party
What the party represents:
person
- an individual
soleTrader
- a single person enterprise
company
- a corporation or partnership with multiple owners
A list of phone numbers associated with this party.
A list of identity documents for this party.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
A list of balance accounts that have been set up for this party.
The currency in ISO 4217 currency format.
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.
The scheduled payout day for this balanceAccount
.
Unique ID created by us to identify a balance account. This sent in the response after balanceAccount
creation.
The date and time that the balance account was created, as an ISO 8601 zoned date time.
The date and time that the balance account was last updated, as an ISO 8601 zoned date time.
The overallStatus provides an complete view of the parties identityVerificationState.
The date and time that the party was created, as an ISO 8601 zoned date time.
The date and time that the party was last updated, as an ISO 8601 zoned date time.
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
The date and time the payoutInstrument
was created, as an ISO 8601 zoned date time.
The date and time the payoutInstrument
was updated, as an ISO 8601 zoned date time.
The date and time that the party was last deactivated, as an ISO 8601 zoned date time.
The disposition of funds for deactivated party.
The date and time that the party was last activated, as an ISO 8601 zoned date time.
The title for this person
/soleTrader
.
The person
's/soleTrader
's first name.
The person
's/soleTrader
's middle name or initial.
The person
's/soleTrader
's last name.
The residential status of the person
/soleTrader
.
Unique reference provided by the payee. Only required for certain payout destinations.
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" } ] }
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.
A 4-digit code to represent the merchant category. Only provide this where typeCode
is soleTrader
or company
.
A description to describe the merchant category code. Only provide this where typeCode
is soleTrader
or company
.
The legal name of the company.
The trading common name of the company.
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).
The Value Added Tax (VAT) number of the company.
A description of the type of company.
Unique reference provided by the payee. Only required for certain payout destinations.
The country code specified in ISO 3166-1 Alpha-2 code format.
Your reference for this beneficial owner, must be unique within an entity.
Your reference for this party, must be unique within an entity.
The type of this party.
beneficiary
- the person or business that will receive funds
payer
- a transmitter of funds to a third party
What the party represents:
person
- an individual
soleTrader
- a single person enterprise
company
- a corporation or partnership with multiple owners
A list of phone numbers associated with this party.
A list of identity documents for this party.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
A list of balance accounts that have been set up for this party.
The currency in ISO 4217 currency format.
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.
The overallStatus provides an complete view of the parties identityVerificationState.
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
- Live
https://access.worldpay.com/parties/{partyId}
- Try
https://try.access.worldpay.com/parties/{partyId}
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
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" } ] }
OK
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.
The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.
The message associated with link returned from Identity Verification Status (IVS).
Your reference for this party, must be unique within an entity.
The type of this party.
beneficiary
- the person or business that will receive funds
payer
- a transmitter of funds to a third party
What the party represents:
person
- an individual
soleTrader
- a single person enterprise
company
- a corporation or partnership with multiple owners
A list of phone numbers associated with this party.
A list of identity documents for this party.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
A list of balance accounts that have been set up for this party.
The currency in ISO 4217 currency format.
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.
The scheduled payout day for this balanceAccount
.
Unique ID created by us to identify a balance account. This sent in the response after balanceAccount
creation.
The date and time that the balance account was created, as an ISO 8601 zoned date time.
The date and time that the balance account was last updated, as an ISO 8601 zoned date time.
The overallStatus provides an complete view of the parties identityVerificationState.
The date and time that the party was created, as an ISO 8601 zoned date time.
The date and time that the party was last updated, as an ISO 8601 zoned date time.
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
The date and time the payoutInstrument
was created, as an ISO 8601 zoned date time.
The date and time the payoutInstrument
was updated, as an ISO 8601 zoned date time.
The date and time that the party was last deactivated, as an ISO 8601 zoned date time.
The disposition of funds for deactivated party.
The date and time that the party was last activated, as an ISO 8601 zoned date time.
The title for this person
/soleTrader
.
The person
's/soleTrader
's first name.
The person
's/soleTrader
's middle name or initial.
The person
's/soleTrader
's last name.
The residential status of the person
/soleTrader
.
Unique reference provided by the payee. Only required for certain payout destinations.
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" } ] }
The reason for deactivating a party.
- Live
https://access.worldpay.com/parties/{partyId}/deactivation
- Try
https://try.access.worldpay.com/parties/{partyId}/deactivation
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
Deactivate an active party (modular)
{ "deactivationReason": "partyDormant", "dispositionOfFunds": "payoutToParty" }
Deactivate an active party (modular)
{ "deactivationReason": "partyDormant", "dispositionOfFunds": "payoutToParty", "active": false, "dateTimeDeactivated": "2025-07-29T17:34:01.621Z" }
- Live
https://access.worldpay.com/parties/{partyId}/activation
- Try
https://try.access.worldpay.com/parties/{partyId}/activation
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
Reactivate an inactive party (modular)
{ "active": true }
Activate an deactivated party (modular)
{ "active": true, "dateTimeActivated": "2025-07-29T17:34:01.621Z" }