List funding recipient's funding accounts

Browse API reference

GET/funding-recipients/{recipientId}/funding-accountslistFundRecipientFundingAccounts

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.

Parameters

Name	In	Type	Description
`recipientId`Required	path	`integer`	Unique identifier that we assigned to the funding recipient.

Responses

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

200 OK · application/json

[
  {
    "createdDate": "2024-07-02T15:30:00+00:00",
    "fundingAccountId": 123,
    "lastModifiedDate": "2024-07-02T15:30:00+00:00",
    "links": [
      {
        "href": "https://api.payroc.com/v1/funding-recipients/234",
        "method": "get",
        "rel": "parent"
      }
    ],
    "metadata": {
      "yourCustomField": "abc123"
    },
    "nameOnAccount": "Jane Doe",
    "paymentMethods": [
      {
        "type": "ach",
        "value": {
          "accountNumber": "******7890",
          "routingNumber": "*****6789"
        }
      }
    ],
    "status": "approved",
    "type": "checking",
    "use": "credit"
  },
  {
    "createdDate": "2024-07-02T15:30:00+00:00",
    "fundingAccountId": 124,
    "lastModifiedDate": "2024-07-02T15:30:00+00:00",
    "links": [
      {
        "href": "https://api.payroc.com/v1/funding-recipients/235",
        "method": "get",
        "rel": "parent"
      }
    ],
    "metadata": {
      "yourCustomField": "abc123"
    },
    "nameOnAccount": "Jane Doe",
    "paymentMethods": [
      {
        "type": "ach",
        "value": {
          "accountNumber": "******3491",
          "routingNumber": "*****8725"
        }
      }
    ],
    "status": "pending",
    "type": "checking",
    "use": "debit"
  }
]

Response schema · 16 of 18 fields

createdDatestringdate-time
Date and time that we received your request to create the funding account in our system.
fundingAccountIdinteger
Unique identifier that we assigned to the funding account.
lastModifiedDatestringdate-time
Date and time that the funding account was last modified.
linksobject[]
Array of HATEOAS links.
- hrefstringrequired
  URL of the target resource.
- methodstringrequired
  HTTP method that you need to use with the target resource.
- relstringrequired
  Indicates the relationship between the current resource and the target resource.
metadataobject
Metadata object you can use to include custom data with your request.
nameOnAccountstringrequired
Name of the account holder.
paymentMethodsobject[]required
Array of PaymentMethodAch objects.
- ACH payment methodobject
  - typestring
    Payment method that we use to send funds to the account.ach
  - valueobject
    Object that contains information about the funding account.+2 more fields at deeper levels — see the full spec
statusstring
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.approvedrejectedpendinghold
typestringrequired
Type of funding account.checkingsavingsgeneralLedger
usestringrequired
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.creditdebitcreditAndDebit

Invalid request

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected time, got '' for start_time",
      "parameter": "start_time"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

manage-funding-recipients