fundingRecipients

List funding recipients

Changed on

Use this method to return a paginated 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 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.

get/funding-recipients

Request

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

Query parameters

beforestring

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.

afterstring

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.

limitinteger

Limit the maximum number of results that we return for each page.

Response

Successful request. Returns a paginated list of all funding recipients.

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

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

hasMoreboolean

Indicates whether there is another page of results available.

Changes