List owners

Use this method to return a list of owners of a processing account. **Note:** If you want to view the details of a specific owner and you have the ownerId, go to our [Retrieve Owner](https://docs.payroc.com/api/schema/boarding/owners/retrieve) method. To list the owners of a processing account, you need its processingAccountId. If you don't have the processingAccountId, use our [List Merchant Platform's Processing Accounts](https://docs.payroc.com/api/schema/boarding/merchant-platforms/list-processing-accounts) method to search for the processing account. 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 business, including whether they are a control prong or authorized signatory, and their equity stake in the business.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

processingAccountIdstringRequired
Unique identifier that we assigned to the processing account.

Query parameters

beforestringOptional

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstringOptional

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.

Response

Successful request. Returns a list of owners associated with the processing account.
countdouble or null

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

datalist of objects or null
Array of owner objects.
hasMoreboolean or null
Indicates whether there is another page of results available.
limitdouble or null
Maximum number of results that we return for each page.

Errors