SchemaFundingFunding Recipients

List funding recipients

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of funding recipients linked to your account. Note: If you want to view the details of a specific funding recipient and you have its recipientId, use our [Retrieve Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/retrieve) method. Our gateway returns the following information about each funding recipient in the list: - Tax ID and Doing Business As (DBA) name. - Address and contact details. - Funding accounts linked to the funding recipient. For each funding recipient, we also return the recipientId, which you can use to perform follow-on actions.

Authentication

AuthorizationBearer

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

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 paginated list of all funding recipients.
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
An array of funding recipients
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