processingAccounts

List processing account's funding accounts

Changed on

Use this method to return a list of funding accounts linked to a processing acccount.

To retrieve a list of funding accounts for a processing account, you need the processingAccountId. Our gateway returned the processingAccountId in the response of the Create Merchant Platform method or the Create Proccessing Account method.

Our gateway returns information about the following for each funding account in the list:

  • Account information, including the name on the account and payment methods.
  • Status, including whether we have approved or rejected the account.

For each funding account, we also return its fundingAccountId, which you can use to perform follow-on actions.

get/processing-accounts/{processingAccountId}/funding-accounts

Request

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

Path parameters

processingAccountIdstring required

Unique identifier that we assigned to the processing account.

Response

Successful request. Returns a list of funding accounts associated with the processing account.

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 listProcessingAccountFundingAccounts removed and replaced with processingAccounts_listProcessingAccountFundingAccounts