Retrieve Party Details

Overview

This guide explains how to retrieve the details of a party using the Party API. By following these steps, you can obtain comprehensive information about a party, including their bank account details. The request requires partyReferenceId, and the response will include the latest details submitted during the create or update party API calls.

Step 1: Prepare the Request

To retrieve the details of a party, you need to prepare a GET request to the Party API endpoint. Ensure you have the partyReferenceId of the party whose details you want to retrieve.

  • Endpoint: party/v1/{partyReferenceId}. Replace {partyReferenceId} with the unique identifier of the party whose details you want to retrieve.

  • Method: GET

Step 2: Send the GET API request

Using your preferred method (command line, Postman, or a script), send the GET request to the endpoint. 

Step 3: Handle the Response

The API will respond with the details of the Party, including the information submitted during the creation of the party. The response will include the following fields:

  • partyId: The internal ID of the party created in the Party API.

  • partyReferenceId: The unique identifier of the party.

  • globalBusinessId: The Global Business ID associated with the party.

  • firstName: The first name of the party (for the individuals).

  • middleName: The middle name of the party (for the individuals).

  • lastName: The last name of the party (for the individuals).

  • businessName: The name of the business (if a business entity).

  • partyEmailAddress: The email address of the party.

  • phoneNumber: The phone number of the party.

  • addressLine1: The first line of the party's address.

  • addressLine2: The second line of the party's address.

  • addressLine3: The third line of the party's address.

  • countrySubdivision: The subdivision of the country (state, province).

  • isoCountryCode: The ISO country code of the party.

  • townName: The town name of the party.

  • postalCode: The postal code of the party.

  • isBusiness: Indicates if the party is a business.

  • isActive: Indicates if the party is active.

  • bankAccountDetails: Bank accounts associated with the party. Each bank account in the bankAccountDetails array includes the following fields:

    1. accountReferenceId: The unique identifier for the bank account. This account shoudl be used for the payment.

    2. accountName: The name on the bank account.

    3. accountNumberLast4Digits: The last 4 digits of the bank account number (full details are not provided for security reasons).

    4. routingNumberLast4Digits: The last 4 digits of the bank routing number (full details are not provided for security reasons).

    5. canRtp: Indicates in the bank account can accept RTP payments.

    6. canWire: Indicates if the bank account can accept Wire payments.

    7. canCheck: Indicates if the bank account can process Check payments.

Example

{
"partyId": 9233,
"partyReferenceId": "81566451-a775-4f52-a6de-4319be3645e2",
"globalBusinessId": 2565,
"firstName": "Laisha",
"middleName": "",
"lastName": "Kihn",
"businessName": "Stark LLC",
"partyEmailAddress": "laisha.kihn@example.com",
"phoneNumber": "7572119665",
"addressLine1": "0240 Alysson Islands",
"addressLine2": "Sunny Drive",
"addressLine3": "10 B",
"countrySubdivision": "TX",
"isoCountryCode": "USA",
"townName": "Dallas",
"postalCode": "75247",
"isBusiness": false,
"isActive": true,
"bankAccountDetails": [
{
"accountReferenceId": "4388bb6f-dd18-4f55-b71e-ceab05be077d",
"accountName": "Laisha Kihn",
"accountNumberLast4Digits": "0012",
"routingNumberLast4Digits": "5079",
"canRtp": true,
"canWire": false,
"canCheck": false
},
{
"accountReferenceId": "70e39bdc-bada-4352-b9b7-4cfb3cd34612",
"accountName": "Laisha Kihn",
"accountNumberLast4Digits": "0760",
"routingNumberLast4Digits": "5079",
"canRtp": true,
"canWire": false,
"canCheck": false
}
]
}