SchemaFundingFunding Accounts

Retrieve funding account

Use this method to retrieve information about a funding account. To retrieve a funding account, you need its fundingAccountId. Our gateway returned the fundingAccountId when you created the funding account. **Note:** If you don't have the fundingAccountId, use our [List Funding Accounts](https://docs.payroc.com/api/schema/funding/funding-accounts/list) method to search for the account. Our gateway returns the following information about the funding account: - Name of the account holder and ACH details for the account. - Status of the account. - Whether we send funds to the account, withdraw funds from the account, or both.

Authentication

AuthorizationBearer

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

Path Parameters

fundingAccountIdintegerRequired
Unique identifier of the funding account.

Response

Successful request. Returns the requested funding account.
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