Skip to content
APIs/Parties/
/
View a party

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
curl -i -X GET \
  -u '<username>:<password>' \
  https://try.access.worldpay.com/parties/parV1StGXR8_Z5jdHi6B-myF0 \
  -H 'WP-Api-Version: 2025-01-01'

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.

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"
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).

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"
partyIdstringread-only

A unique identifier for the party generated by us.

emailstring, (email)

An email address for this party.

merchantobjectrequired

An object that contains information about the merchant.

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.

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"
personalDetailsobjectrequired
Response

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",
    "alias": "Henry Smith",
    "socialSecurityNumber": "333-55-6666",
    "dateOfBirth": "1983-10-12",
    "address": {
      "address1": "1847 Kingsbury Court",
      "address2": "Unit 42",
      "city": "Manchester",
      "countryCode": "GB",
      "postalCode": "M1 1AA",
      "type": "home"
    },
    "residentialStatus": "resident",
    "currentAddressLessThanThreeYears": false
  },
  "email": "case.mitchell@example.com",
  "phones": [
    {
      "prefix": "44",
      "number": "02079461234"
    }
  ],
  "identityDocuments": [
    {
      "type": "passport",
      "number": "NEO456789",
      "issuingInstitution": "UK Passport Office",
      "issuingCountry": "GB",
      "validFrom": "2022-08-01",
      "validTo": "2032-08-01"
    },
    {
      "type": "nationalId",
      "number": "ZAIBATSU-00792",
      "issuingInstitution": "Zaibatsu Holding HR Dept.",
      "issuingCountry": "GB",
      "validFrom": "2025-01-01",
      "validTo": "2030-12-31"
    }
  ],
  "balanceAccounts": [
    {
      "currency": "EUR",
      "payoutInstrumentReference": "personalCheckingAccount",
      "scheduledPayoutDay": "thursday",
      "frequency": "weekly",
      "balanceAccountId": "pareBH4YMkUx7MA2X7bnS4750",
      "dateTimeCreated": "2025-04-16T20:46:26.727Z",
      "version": 0,
      "accountNumber": "12645678",
      "nextPayoutDate": "2026-03-19"
    },
    {
      "currency": "GBP",
      "payoutInstrumentReference": "personalCheckingAccount2",
      "scheduledPayoutDay": "thursday",
      "frequency": "weekly",
      "balanceAccountId": "par3GymZO5MtP18qe5NFaaPp0",
      "dateTimeCreated": "2025-04-16T20:46:24.122Z",
      "version": 0,
      "accountNumber": "2319876543210",
      "nextPayoutDate": "2026-03-19"
    }
  ],
  "dateTimeCreated": "2025-04-16T20:46:24.122Z",
  "version": 0,
  "active": true,
  "dateTimeActivated": "2025-04-24T17:55:56.283Z",
  "payoutInstruments": [
    {
      "payoutInstrumentReference": "personalCheckingAccount",
      "payoutInstrumentId": "parclOAFlaOX-H_2UBp9tWbd0",
      "payoutInstrumentType": "bankAccount",
      "currency": "GBP",
      "dateTimeCreated": "2025-04-16T20:46:24.122Z",
      "version": 0,
      "accountHolderName": "Case H. Mitchell",
      "swiftBic": "BUKBGB22",
      "bankCode": "045110",
      "accountNumber": "23198765",
      "accountType": "checking",
      "iban": "GB892019000123456789",
      "bankName": "HSBC UK BANK PLC",
      "address": {
        "address1": "17 Neo-London Financial Tower",
        "address2": "Suite 1288",
        "city": "London",
        "countryCode": "GB",
        "postalCode": "EC1A 1BB",
        "type": "business"
      },
      "branchCode": "Taunton Branch"
    },
    {
      "payoutInstrumentReference": "personalCheckingAccount2",
      "payoutInstrumentId": "parKsh3dSA_VRckwEDRHLzOR0",
      "payoutInstrumentType": "bankAccount",
      "currency": "EUR",
      "dateTimeCreated": "2025-04-16T20:46:26.235Z",
      "version": 0,
      "accountHolderName": "Case H. Mitchell",
      "swiftBic": "BUKBGB22",
      "bankCode": "045110",
      "accountNumber": "2319876543210",
      "accountType": "checking",
      "iban": "GB892019000123456789",
      "bankName": "Metro Bank",
      "address": {
        "address1": "17 Neo-London Financial Tower",
        "address2": "Suite 1288",
        "city": "London",
        "countryCode": "GB",
        "postalCode": "EC1A 1BB",
        "type": "business"
      },
      "branchCode": "Barclays Branch"
    }
  ]
}