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.
What the party represents:
person - an individual
soleTrader - a single person enterprise
company - a corporation or partnership with multiple owners
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
- Test (Try)https://try.access.worldpay.com/parties/{partyId}
- Livehttps://access.worldpay.com/parties/{partyId}
{ "merchant": { "entity": "default" }, "partyReference": "8X87XwQ7Fv", "partyType": "beneficiary", "type": "person", "personalDetails": { "title": "Mr", "firstName": "Case", "middleName": "Henry", "lastName": "Mitchell", "alias": "Case Smith", "socialSecurityNumber": "393-55-6666", "residentialStatus": "resident", "dateOfBirth": "1983-10-12", "address": { "address1": "2025 Kingsbury Court", "address2": "Unit 42", "city": "Manchester", "countryCode": "GB", "postalCode": "M1 1AA" } }, "email": "case.mitchell@example.com", "phones": [ { "number": "02079461234", "prefix": "44" } ], "identityDocuments": [ { "type": "passport", "number": "NEO456789", "issuingInstitution": "UK Passport Office", "issuingCountry": "GB", "validFrom": "2022-08-01", "validTo": "2032-08-01" }, { "type": "nationalId", "number": "ZAIBATSU-00792", "issuingInstitution": "Zaibatsu Holding HR Dept.", "issuingCountry": "GB", "validFrom": "2025-01-01", "validTo": "2030-12-31" } ] }
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.
What the party represents:
person - an individual
soleTrader - a single person enterprise
company - a corporation or partnership with multiple owners
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
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.
The date and time that the party was last activated, as an ISO 8601 zoned date time.
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", "alias": "Case Smith", "socialSecurityNumber": "343-55-6666", "dateOfBirth": "1983-10-12", "address": { "address1": "2025 Kingsbury Court", "address2": "Unit 42", "city": "Manchester", "countryCode": "GB", "postalCode": "M1 1AA" }, "residentialStatus": "resident", "currentAddressLessThanThreeYears": false }, "email": "case.mitchell@example.com", "phones": [ { "prefix": "44", "number": "02079461234" } ], "identityDocuments": [ { "type": "passport", "number": "NEO456789", "issuingInstitution": "UK Passport Office", "issuingCountry": "GB", "validFrom": "2022-08-01", "validTo": "2032-08-01" }, { "type": "nationalId", "number": "ZAIBATSU-00792", "issuingInstitution": "Zaibatsu Holding HR Dept.", "issuingCountry": "GB", "validFrom": "2025-01-01", "validTo": "2030-12-31" } ], "balanceAccounts": [ { "currency": "GBP", "payoutInstrumentReference": "personalCheckingAccount", "scheduledPayoutDay": "thursday", "frequency": "weekly", "balanceAccountId": "parXRSh-RDDLU5NyGZpQhyNb0", "dateTimeCreated": "2025-04-21T20:11:08.699Z", "version": 0, "accountNumber": "23198765", "nextPayoutDate": "2026-03-19" }, { "currency": "EUR", "payoutInstrumentReference": "personalCheckingAccount2", "scheduledPayoutDay": "thursday", "frequency": "weekly", "balanceAccountId": "parBTwBk8J3s3nhgbo1vNyvJ0", "dateTimeCreated": "2025-04-21T20:11:12.991Z", "version": 0, "accountNumber": "23198765", "nextPayoutDate": "2026-03-19" } ], "dateTimeCreated": "2025-04-21T20:11:08.695Z", "dateTimeUpdated": "2025-04-21T20:11:15.341Z", "version": 1, "active": true, "dateTimeActivated": "2025-04-24T17:55:56.283Z", "payoutInstruments": [ { "payoutInstrumentReference": "personalCheckingAccount", "payoutInstrumentId": "paru47L8iaV-cm7doWxO7oWm0", "payoutInstrumentType": "bankAccount", "currency": "GBP", "dateTimeCreated": "2025-04-21T20:11:08.698Z", "version": 0, "accountHolderName": "Case H. Mitchell", "swiftBic": "BUKBGB22", "bankCode": "045110", "accountNumber": "23198765", "accountType": "checking", "iban": "GB892019000123456789", "bankName": "HSBC UK BANK PLC", "address": { "address1": "17 Neo-London Financial Tower", "address2": "Suite 1288", "city": "London", "countryCode": "GB", "postalCode": "EC1A 1BB", "type": "business" }, "branchCode": "Taunton Branch" }, { "payoutInstrumentReference": "personalCheckingAccount", "payoutInstrumentId": "parbQkpoZT3adRASZB9Zp9e-0", "payoutInstrumentType": "bankAccount", "currency": "EUR", "dateTimeCreated": "2025-04-21T20:11:11.251Z", "version": 0, "accountHolderName": "Case H. Mitchell", "swiftBic": "BUKBGB22", "bankCode": "045110", "accountNumber": "23198765", "accountType": "checking", "iban": "GB892019000123456789", "bankName": "Metro Bank", "address": { "address1": "17 Neo-London Financial Tower", "address2": "Suite 1288", "city": "London", "countryCode": "GB", "postalCode": "EC1A 1BB", "type": "business" }, "branchCode": "Barclays Branch" } ] }