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

# Search merchants

`GET /merchants`

 

## Query parameters

- `merchant_id` string
- `merchant_name` string
- `gateway_id` integer
- `card_type_id` integer
- `currency_id` integer
- `merchant_mid_id` string
- `merchant_descriptor` string
- `primary_merchant_category_id` integer
- `secondary_merchant_category_id` integer
- `merchant_active` boolean
- `with` 'merchant_currencies' | 'merchant_payment_methods' | 'merchant_card_types' | 'primary_merchant_category' | 'secondary_merchant_category'
- `limit` integer
- `offset` integer
- `sort_by` string
- `order` 'asc' | 'desc'

## Response `200`

OK

- object
  - `total` string
  - `merchants` object[]
    - `merchant_id` integer
    - `merchant_name` string
    - `gateway_id` integer
    - `currency_id` integer — Default currency
    - `merchant_mid_id` string
    - `merchant_descriptor` string
    - `merchant_phone` string
    - `merchant_url` string
    - `merchant_active` boolean
    - `merchant_processor` string, nullable
    - `merchant_mcc_code` string, nullable
    - `merchant_processing_limit` string
    - `merchant_processing_inforce` boolean
    - `merchant_daily_rebills_limit` string
    - `merchant_state` string, nullable
    - `merchant_tax` string
    - `merchant_mtd_revenue` string
    - `merchant_mtd_transactions` integer
    - `merchant_mtd_initial` integer
    - `merchant_processing_perc` string
    - `primary_merchant_category_id` integer
    - `secondary_merchant_category_id` integer
    - `merchant_notes` string, nullable
    - `date_created` string, date-time
    - `created_by` integer
    - `date_modified` string, date-time
    - `modified_by` integer
    - `merchant_currencies` object[]
      - `currency_id` integer
      - `currency_value` string
    - `merchant_payment_methods` object[]
      - `payment_method_id` integer
      - `payment_method_name` string
    - `merchant_card_types` object[]
      - `card_type_id` integer
      - `card_type_name` string
    - `primary_merchant_category` object, nullable
      - `merchant_category_id` integer
      - `merchant_category_name` string
    - `secondary_merchant_category` object, nullable
      - `merchant_category_id` integer
      - `merchant_category_name` string

## Other responses

- `401` — Unauthorized response
- `403` — Forbidden response
- `500` — Error response

---

[API](https://skmtc.net/vrio/apis/crm-configuration.md) · [All operations](https://skmtc.net/vrio/apis/crm-configuration/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vrio/crm-configuration/versions/62037010356e/schema)