---
title: "List merchants"
method: GET
path: "/partner-integration/v1/merchants"
tags: ["Partner Integration.Merchants"]
---

# List merchants

`GET /partner-integration/v1/merchants`

List all merchants associated with the given application.

## Query parameters

- `pageSize` integer
- `pageToken` string
- `appIdEq` string
- `queryString` string

## Response `200`

A successful response.

- V1ListMerchantsResponse
  - `merchants` V1Merchant[] — List of merchants owned by the application.
    - `appId` string — The id of the application associated with the merchant. Output only.
    - `categoryCode` string, required — The merchant category code (MCC) of the merchant, as a four-digit code (ISO 18245).
    - `countryCode` string, required — The merchant's domicile, the country in which the merchant is legally registered, as a two-letter code (ISO 3166-1 alpha-2).
    - `externalId` string — The external id of the merchant.
    - `id` string — The id of the merchant. Output only.
    - `name` string, required — The name of the merchant. Can only have alphanumerics plus full stop, hyphen, forward slash or ampersand.
    - `organizationNumber` string, required — The organization/company/registration number of the merchant. The identification number given to a company when it is registered or incorporated.
    - `status` 'PENDING' | 'VERIFIED' | 'DECLINED' — Status of the merchant. - PENDING: Merchant has not yet been verified. - VERIFIED: Merchant has been successfully verified. - DECLINED: Merchant verification has failed.
    - `url` string, required — The url to the merchant's website without a path, e.g. https://example.com.
  - `nextPageToken` string — Token to retrieve the next page of results, or empty if there are no more results in the list.
  - `prevPageToken` string — Token to the previous page.
  - `totalSize` integer — Total number of records.

## Other responses

- `401` — The scopes associated with the access token is not allowed the resource.
- `403` — The application used does not belong to subject associated with the access token.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/tink/apis/tink-api.md) · [All operations](https://skmtc.net/tink/apis/tink-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tink/tink-api/revisions/23d8982b533d/schema)