List merchant platforms

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of merchant platforms that are linked to your ISV account. **Note**: If you want to view the details of a specific merchant platform and you have its merchantPlatformId, use our [Retrieve Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/retrieve) method. Our gateway returns the following information about each merchant platform in the list: - Legal information, including its legal name and address. - Contact information, including the email address for the business. - Processing account information, including the processingAccountId and status of each processing account that's linked to the merchant platform. For each merchant platform, we also return its merchantPlatformId and its linked processingAccountIds, which you can use to perform follow-on actions.

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 the before parameter in the same request as the after parameter.

afterstringOptional

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

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

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

Response

Successful request. Returns a list of merchant platforms associated with the ISV's account.
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 merchantPlatform 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