GET /companies/{companyId}/merchants

Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.

To make this request, your API credential must have the following roles:

Servers

Path parameters

Name Type Required Description
companyId String Yes

The unique identifier of the company account.

Query parameters

Name Type Required Description
pageNumber Integer No

The number of the page to fetch.

pageSize Integer No

The number of items to have on a page, maximum 100. The default is 10 items on a page.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.