SchemaBoardingProcessing Accounts

List processing account's funding accounts

View as MarkdownOpen in Claude
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](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method or the [Create Proccessing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-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.

Authentication

AuthorizationBearer

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

Path parameters

processingAccountIdstringRequired
Unique identifier that we assigned to the processing account.

Response

Successful request. Returns a list of funding accounts associated with the processing 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.
fundingAccountIdintegerRead-only
Unique identifier that we assigned to the funding account.
createdDatedatetimeRead-only
Date and time that we received your request to create the funding account in our system.
lastModifiedDatedatetimeRead-only
Date and time that the funding account was last modified.
statusenumRead-only

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

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

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
500
Internal Server Error