---
title: "Merchants:List"
method: GET
path: "/v2/merchants/list"
tags: ["Merchants"]
---

# Merchants:List

`GET /v2/merchants/list`

Get a list (without pagination) of all your merchants.

## Query parameters

- `status` object
  - `eq` 'ACTIVE' | 'INACTIVE' — Filter on the exact merchant status.
  - `neq` 'ACTIVE' | 'INACTIVE' — Filter out the specified merchant status.
- `payoutStatus` object
  - `eq` 'ENABLED' | 'DISABLED' — Filter on the exact merchant payout status.
  - `neq` 'ENABLED' | 'DISABLED' — Filter out the specified merchant payout status.
- `boardingStatus` object
  - `eq` 'REGISTERED' | 'ONBOARDING' | 'ACCEPTED' — Filter on the exact merchant boarding status.
  - `neq` 'REGISTERED' | 'ONBOARDING' | 'ACCEPTED' — Filter out the specified merchant boarding status.

## Response `200`

OK

- MerchantMerchantsListOutput — A collection of minimal merchant representations.
  - `merchants` MerchantMerchantListOutput[] — Collection of Merchant.MerchantListOutput objects or an empty array
    - `code` string — The merchant id of your company starting with M.
    - `name` string — The name of the merchant.
    - `status` 'ACTIVE' | 'INACTIVE' — The status of the merchant.
    - `payoutStatus` 'ENABLED' | 'DISABLED' — The payment status of the merchant.
    - `boardingStatus` 'REGISTERED' | 'ONBOARDING' | 'ACCEPTED' | 'SUSPENDED' | 'OFFBOARDED' — The boarding status of the merchant.
  - `total` integer, nullable — The total items the collection contains
  - `_links` LinkOutput[], nullable
    - `href` string, nullable — The URI to the linked resource
    - `rel` string, nullable — The name of the linked resource
    - `type` string, nullable — The (http(s)) method needed to approach the linked resource

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `404` — Resource not found
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `410` — Indicates that this resource is no longer available for use
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `429` — Rate limit reached.
- `500` — An internal error occurred.
- `503` — The server is currently unable to handle your request

---

[API](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/versions/2bc260c7bdfc/schema)