WOworldpay
Parties

View a party

Retrieve information about a party.

get/parties/{partyId}

Request

Path parameters

partyIdstring 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.

Response

OK

OR
OR

Example response

{
  "identityVerificationDate": "2033-11-22",
  "partyReference": "Hosaka27384910",
  "merchant": {
    "entity": "default"
  },
  "phones": [
    {
      "prefix": "44",
      "number": "4281234"
    }
  ],
  "identityDocuments": [
    {
      "issuingInstitution": "State Department",
      "issuingCountry": "JP",
      "validFrom": "2023-11-22",
      "validTo": "2023-11-22"
    }
  ],
  "balanceAccounts": [
    {
      "currency": "GBP",
      "payoutInstrumentReference": "primaryBusinessAccount",
      "scheduledPayoutDay": "friday",
      "frequency": "weekly",
      "recurrence": "first",
      "nextPayoutDate": "2025-02-14",
      "dateTimeCreated": "2025-01-23T12:23:445.222Z",
      "dateTimeUpdated": "2025-01-25T02:43:499.202Z"
    }
  ],
  "dateTimeCreated": "2025-01-23T12:23:445.222Z",
  "dateTimeUpdated": "2025-01-25T14:57:012.302Z",
  "payoutInstruments": [
    {
      "payoutInstrumentReference": "primaryBusinessAccount",
      "payoutInstrumentId": "parOk0YlPtQogrqQdz7_fKXs0",
      "currency": "GBP",
      "bankCode": "184758",
      "address": {
        "address1": "1847 Kingsbury Court",
        "address2": "Unit 42",
        "city": "London",
        "state": "Greater London",
        "countryCode": "GB",
        "postalCode": "NW9 0RR",
        "type": "home"
      }
    }
  ],
  "active": true,
  "dateTimeDeactivated": "2025-01-25T14:57:012.302Z",
  "deactivationReason": "partyDormant",
  "dispositionOfFunds": "payoutToParty",
  "dateTimeActivated": "2025-01-25T14:57:012.302Z",
  "personalDetails": {
    "title": "Mr",
    "firstName": "Case",
    "middleName": "Henry",
    "lastName": "Mitchell",
    "alias": "Junior Henry",
    "socialSecurityNumber": "004-54-6578",
    "dateOfBirth": "1983-10-12",
    "address": {
      "address1": "1847 Kingsbury Court",
      "address2": "Unit 42",
      "city": "London",
      "state": "Greater London",
      "countryCode": "GB",
      "postalCode": "NW9 0RR",
      "type": "home"
    },
    "customerReference": "7564389201",
    "previousHomeAddress": {
      "address1": "1847 Kingsbury Court",
      "address2": "Unit 42",
      "city": "London",
      "state": "Greater London",
      "countryCode": "GB",
      "postalCode": "NW9 0RR",
      "type": "home"
    },
    "website": "https://example.com/"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.