PApayroc
merchantPlatforms

List merchant platforms

Changed on

Use this method to return a paginated 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 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.

get/merchant-platforms

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/merchant-platforms
  • Auth
    HTTP bearer

Query parameters

beforestring

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.

afterstring

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.

limitinteger

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.

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

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

hasMoreboolean

Indicates whether there is another page of results available.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 2365ff7cb3a5Revision changes
    • breaking

      added subschema #10 to the ///// response property oneOf list for the response status