PApayroc
fundingRecipients

List funding recipient owners

Changed on

Use this method to return a list of owners of a funding recipient.

Note: If you want to view the details of a specific owner and you have their ownerId, use our Retrieve Owner method.

To list the owners of a funding recipient, you need its recipientId. Our gateway returned the recipientId in the response of the Create Funding Recipient method. If you don't have the recipientId, use our List Funding Recipients method to search for the funding recipient.

Our gateway returns the following information about each owner in the list:

  • Name, date of birth, and address.
  • Contact details, including their email address.
  • Relationship to the funding recipient.

Our gateway also returns the ownerId, which you can use to perform follow-on actions.

get/funding-recipients/{recipientId}/owners

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/funding-recipients/{recipientId}/owners
  • Auth
    HTTP bearer

Path parameters

recipientIdinteger required

Unique identifier that we assigned to the funding recipient.

Response

Successful request. Returns a list of all owners associated with the funding recipient.

ownerIdinteger

Unique identifier that we assigned to the owner.

firstNamestring required

Owner's first name.

middleNamestring

Owner's middle name.

lastNamestring required

Owner's last name.

dateOfBirthstring date required

Owner's date of birth. The format of this value is YYYY-MM-DD.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id listOwners removed and replaced with fundingRecipients_listOwners