---
title: "Merchants:Browse"
method: GET
path: "/merchants"
tags: ["Merchants"]
---

# Merchants:Browse

`GET /merchants`

Get a list of all merchants

## Response `200`

Ok.

- object
  - `total` integer
  - `merchants` Merchant[]
    - `code` string — The merchant id of your company starting with M.
    - `name` string — The name of your merchant.
    - `publicName` string — The public name of your merchant.
    - `boardingStatus` 'REGISTERED' | 'ONBOARDING' | 'ACCEPTED' | 'SUSPENDED' | 'OFFBOARDED' — The status of the boarding process for this merchant.
    - `status` string — Merchant state
    - `payoutStatus` 'ENABLED' | 'DISABLED' — Merchant payout state
    - `coc` string — Your Chamber of commerce registration number. This format differs per country.
    - `vat` string — Value added tax identification number (VAT identification number).
    - `companyTypeId` string — ID of the company type. The available company types can be retrieved with the Core Data API Companytypes (https://developer.pay.nl/reference/get_companytypes)
    - `countryCode` string — The country code consisting of 2 uppercase letters
    - `contractLanguage` string — The language code supplied needs to be a locale in i18n format. The available languages can be retrieved with the Core Data API Languages (https://developer.pay.nl/reference/get_languages) where the contractLanguageAvailable flag is set to 'True'
    - `contractPackage` string
    - `contractPackageCode` string, nullable — The authorisation group code of the contract package linked to the merchant. Returns null when the merchant has no linked authorisation group.
    - `currentProfileCode` string, nullable — The active company profile code of the merchant.
    - `contactPhone` string, phone — The primary contact phone number of the merchant.
    - `contactEmail` string, email — The primary contact email address of the merchant.
    - `establishmentLegalRegistrationNumber` string — The legal registration number of the establishment/location of the merchant. If omitted and the country code is FR, this defaults to the CoC number.
    - `accountManager` string — The email address of the active account manager.
    - `website` string, uri — The website.
    - `categories` Category[]
      - `code` string — The category (code) identifier
      - `name` string — The category name.
      - `description` string — The category's description.
      - `sequence` integer — The sequence of the category.
      - `available` boolean — The category's availability.
      - `initialMCC` integer, nullable — The initial MCC of the category.
      - `initialRiskCategory` string — The initial risk category of the category.
      - `translations` Translations — unresolved $ref
      - `paymentMethods` object[]
        - `id` integer — The payment profile identifier.
        - `name` string — The name of the payment profile.
      - `createdAt` CreatedAt — unresolved $ref
      - `modifiedAt` ModifiedAt — unresolved $ref
      - `deletedAt` DeletedAt — unresolved $ref
    - `integrations` object[]
      - `code` string — The plugin identifier.
      - `name` string
    - `clearingAccounts` object[]
      - `code` string, required
      - `status` 'APPROVED' | 'DENIED' | 'NOT_CHECKED', required
      - `method` 'iban', required
      - `iban` BankAccount, required
        - `iban` string, required — The International Bank Account Number (IBAN).
        - `bic` string, required — Business Identifier Codes (BIC/SWIFT).
        - `owner` string, required — The owner of the bank account.
    - `postalAddress` Location
      - `code` Code, required — unresolved $ref
      - `streetName` StreetName, required — unresolved $ref
      - `streetNumber` StreetNumber — unresolved $ref
      - `zipCode` ZipCode, required — unresolved $ref
      - `city` City, required — unresolved $ref
      - `countryCode` CountryCode, required — unresolved $ref
    - `visitAddress` Location
      - `code` Code, required — unresolved $ref
      - `streetName` StreetName, required — unresolved $ref
      - `streetNumber` StreetNumber — unresolved $ref
      - `zipCode` ZipCode, required — unresolved $ref
      - `city` City, required — unresolved $ref
      - `countryCode` CountryCode, required — unresolved $ref
    - `contactMethods` ContactMethod[]
      - `code` string — The contact method ID of your company starting with CM.
      - `type` 'email' | 'email_support' | 'phone' | 'phone_helpdesk' | 'phone_off_hours' | 'url' | 'email_msnskype' — The type of contact method.
      - `value` string — The value of the contact method.
      - `description` string — The description of the contact method.
      - `public` boolean — Is the contact method public accessible
      - `notifications` boolean — Does the contact method needs to receive notifications
    - `authenticationTokens` object[]
      - `authenticationTokens` string
    - `trademarks` Trademark[]
      - `code` string — An identifier for this trademark
      - `type` string
      - `name` string, required — A registered trademark name.
      - `status` string — Status of the trademark.
      - `createdAt` CreatedAt — unresolved $ref
      - `createdBy` CreatedBy — unresolved $ref
      - `modifiedAt` ModifiedAt — unresolved $ref
      - `modifiedBy` ModifiedBy — unresolved $ref
      - `deletedAt` DeletedAt — unresolved $ref
      - `deletedBy` DeletedBy — unresolved $ref
    - `licenses` Person[]
      - `code` string
      - `secret` string
      - `name` string
      - `accountCode` string
      - `gender` string — The subject's gender. Choose either M for male or F for female.
      - `firstName` string, nullable — The forename (also known as a given name, Christian name or a first name).
      - `lastName` string — The surname (also known as a family name or a last name).
      - `email` string, email — An email address.
      - `language` 'NL' | 'EN' | 'DE' | 'FR' | 'IT' | 'ES' — The language code consisting of 2 uppercase letters. Can be one of the following: EN, NL, DE, FR, ES, IT. You can find all available languages here: https://paynl.readme.io/reference/languages
      - `phone` string — The subject's phone number. Optionally prepended with a + and country code
      - `visitAddress` Address
        - `code` string
        - `firstName` FirstName — unresolved $ref
        - `lastName` LastName — unresolved $ref
        - `streetName` string — The name of the street
        - `streetNumber` string — The street number
        - `streetNumberExtension` string — A house number extension is required to deal with appartments or other addresses sharing the same front door
        - `zipCode` string — A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country.
        - `city` string — The name of a city
        - `regionCode` string — Region code (iso-3166-2)
        - `countryCode` string — The country code consisting of 2 uppercase letters
      - `complianceData` ComplianceDataPerson
        - `pep` boolean — Indicate if the person is a Politically Exposed Person (PEP).
        - `pepDescription` string — Describe in your own words why this person is a PEP.
        - `dateOfBirth` string, date-time — Date of birth of the person.
        - `nationality` string — Nationality of the person.
        - `idDocumentNumber` string — The id document number of the person
        - `ubo` Ubo — unresolved $ref
        - `uboPercentage` UboPercentage — unresolved $ref
        - `authorizedToSign` AuthorizedToSign — unresolved $ref
        - `relationshipDescription` RelationshipDescription — unresolved $ref
    - `services` object[]
      - `code` string
      - `secret` string
      - `name` string
      - `status` string
      - `category` object
        - `code` Code — unresolved $ref
        - `name` Name — unresolved $ref
      - `integration` object
        - `code` string — The plugin identifier.
        - `name` string
      - `website` string — The website URL.
      - `urls` WebsiteUrl[]
        - `code` string — The code of the website URL.
        - `website` string — The website URL.
    - `partner` Partner[]
      - `code` string
      - `name` string
      - `type` string
      - `accessToMerchant` boolean
    - `createdAt` CreatedAt — unresolved $ref
    - `createdBy` CreatedBy — unresolved $ref
    - `acceptedAt` string, date-time, nullable
    - `suspendedAt` string, date-time, nullable
    - `suspendedBy` string, nullable — SUSPENDED_BY_DESCRIPTION
    - `modifiedAt` ModifiedAt — unresolved $ref
    - `modifiedBy` ModifiedBy — unresolved $ref
    - `deletedAt` DeletedAt — unresolved $ref
    - `deletedBy` DeletedBy — unresolved $ref
    - `reviewedAt` string, date-time, nullable
    - `nextReviewDate` string, date-time

## Other responses

- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `429` — Rate limit reached.
- `500` — An internal error occurred

---

[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/revisions/2bc260c7bdfc/schema)