Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Partner Integration.Merchants

List merchants

List all merchants associated with the given application.

get/partner-integration/v1/merchants

Query parameters

pageSizeinteger

The maximum number of items to return.

pageTokenstring

The next_page_token value returned from a previous request, null for first request.

appIdEqstring

The id of the application associated with the merchant.

queryStringstring

Query to filter the merchants by.

Response

A successful response.

nextPageTokenstring

Token to retrieve the next page of results, or empty if there are no more results in the list.

prevPageTokenstring

Token to the previous page.

totalSizeinteger

Total number of records.

Example response

{
  "merchants": [
    {
      "appId": "125801f6-4657-436d-b317-8f0153705fb6",
      "categoryCode": "5816",
      "countryCode": "GB",
      "external_id": "12d5c553-1558-454d-8981-6c2810138abe",
      "id": "05d5c053-1558-454d-8981-6c2810138abe",
      "name": "Example Inc.",
      "organizationNumber": "123",
      "status": "VERIFIED",
      "url": "https://endpoint.example.com"
    }
  ],
  "nextPageToken": "MA=",
  "prevPageToken": "MA==",
  "totalSize": "1"
}