fundingRecipients

List funding recipient's funding accounts

Changed on

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 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 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.

get/funding-recipients/{recipientId}/funding-accounts

Request

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

Path parameters

recipientIdinteger required

Unique identifier that we assigned to the funding recipient.

Response

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

fundingAccountIdinteger

Unique identifier that we assigned to the funding account.

createdDatestring date-time

Date and time that we received your request to create the funding account in our system.

lastModifiedDatestring date-time

Date and time that the funding account was last modified.

status'approved' | 'rejected' | 'pending' | 'hold'

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.
type'checking' | 'savings' | 'generalLedger' required

Type of funding account.

use'credit' | 'debit' | 'creditAndDebit' required

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.

nameOnAccountstring required

Name of the account holder.

metadataobject

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

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 listAccounts removed and replaced with fundingRecipients_listAccounts