SchemaBoardingMerchant Platforms

List merchant platform's processing accounts

Use this method to return a paginated list of processing accounts linked to a merchant platform.

Note: If you want to view the details of a specific processing account and you have its processingAccountId, use our Retrieve Processing Account method.

Use the query parameters to filter the list of results that we return, for example, to search for only closed processing accounts.

To list the processing accounts for a merchant platform, you need its merchantPlatformId. If you don’t have the merchantPlatformId, use our List Merchant Platforms method to search for the merchant platform.

Our gateway returns the following information about eahc processing account in the list:

  • Business details, including its status, time zone, and address.
  • Owners’ details, including their contact details.
  • Funding, pricing, and processing information, including its pricing model and funding accounts.

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

Path parameters

merchantPlatformIdstringRequired
Unique identifier of the merchant platform that we sent to you when you created the merchant platform.

Headers

AuthorizationstringRequired

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

Query parameters

beforestringOptional

Return the previous page of results before the value that you specify.

You can’t send a before parameter in the same request as an after parameter.

afterstringOptional

Return the next page of results after the value that you specify.

You can’t send an after parameter in the same request as a before parameter.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.
includeClosedbooleanOptionalDefaults to false

Indicates if you want to return closed processing accounts. This includes processing accounts that have a status of terminated, cancelled, or rejected.
Note: By default, we return only open processing accounts.

Response

Successful request. Returns a list of processing accounts associated with the merchant platform.
countdouble or null

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

datalist of objects or null
Array of processingAccount objects.
hasMoreboolean or null
Indicates whether there is another page of results available.
limitdouble or null
Maximum number of results that we return for each page.

Errors