SchemaFundingFunding Recipients

List funding recipient's funding accounts

Use this method to return a list of funding accounts associated with a funding recipient. **Note:** If you want to view the details of a specific funding account and you have its fundingAccountId, use our [Retrieve Funding Account](https://docs.payroc.com/api/schema/funding/funding-accounts/retrieve) method. To retrieve the funding accounts associated with a funding recipient, you need the recipientId. If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. Our gateway returns the following information about each funding account: - Name of the account holder. - ACH details for the account. - Status of the account. Our gateway also returns the fundingAccountId, which you can use to run follow-on actions.

Authentication

AuthorizationBearer

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

Path Parameters

recipientIdintegerRequired
Unique identifier that we assigned to the funding recipient.

Response

Successful request. Returns a list of all funding accounts associated with the funding recipient.
typeenum
Type of funding account.
Allowed values:
useenum
Indicates if we send funds or withdraw funds from the account. - `credit` - Send funds to the account. - `debit` - Withdraw funds from the account. - `creditAndDebit` - Send funds and withdraw funds from the account. **Note:** If the funding account is associated with a funding recipient, we accept only a value of `credit`.
Allowed values:
nameOnAccountstring
Name of the account holder.
paymentMethodslist of objects
Array of paymentMethod objects.
fundingAccountIdinteger or null
Unique identifier that we assigned to the funding account.
createdDatedatetime or null
Date and time that we received your request to create the funding account in our system.
lastModifiedDatedatetime or null
Date and time that the funding account was last modified.
statusenum or null
Status of the funding account. The value is one of the following: - `approved` - We approved the funding account. - `rejected` - We rejected the funding account. - `pending` - We have not yet approved the funding account. - `hold` - Our Risk team have temporarily placed a hold on the funding account.
Allowed values:
metadatamap from strings to strings or null

Metadata object you can use to include custom data with your request.

Errors