SchemaBoardingMerchant Platforms

List merchant platform’s processing accounts

Use this method to retrieve a paginated list of processing accounts associated with a merchant platform.

When you created the merchant platform, we sent you its merchantPlatformId in the response. Send this merchantPlatformId as a path parameter in your endpoint.

Note: By default, we return only open processing accounts. To include closed processing accounts, send a value of true for the includeClosed query parameter.

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

Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.

afterstringOptional

Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.

limitintegerOptional<=100Defaults to 10

States the total amount of results the response is limited to.

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.

Response

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

countintegerOptional

Number of results that we returned.

datalist of objectsOptional

Array of processingAccount objects.

hasMorebooleanOptional

Indicates that further results are available.

limitintegerOptional

Maximum number of results that we return for each page.