---
title: "List sub_merchants"
method: GET
path: "/sub_merchants"
tags: ["sub_merchants"]
---

# List sub_merchants

`GET /sub_merchants`

Retrieve an ordered and paginated list of all Sub-merchants in an organization. This call should be authenticated with an environment key from the organization and an Organization Access Secret.

## Query parameters

- `since_token` string
- `count` string
- `order` string

## Response `200`

successful

- ListSubMerchantsResponse
  - `sub_merchants` SubMerchantProperties[]
    - `token` string — The token identifying the sub_merchant at Spreedly
    - `name` string — The human readable name of the sub_merchant
    - `environment_key` string — The environment that the sub_merchant is associated with
    - `organization_key` string — The organization that the sub_merchant belongs to
    - `merchant_url` string — The merchant’s website url.
    - `ein` string — The employer identification number associated with the merchant
    - `merchant_email` string — The email address associated with the merchant
    - `merchant_defined_uid` string — A string value that can be set on the sub_merchant to help identify the sub_merchant in systems external to spreedly.
    - `merchant_data` object — An array of objects to store more information about the merchant
      - `card_network` string — The merchant data fields can be different depending on the card network. So, this field is to identify the network associated with the other fields in a merchant_data object.
      - `acquirer_merchant_id` string — The MID is a unique code that ensures the funds make it from the cardholder’s bank account to your bank account when a transaction is processed. It is passed with other transaction information and is used to help with transaction reconciliation. You receive a MID when you open a merchant account with an acquiring bank. A merchant can have multiple MIDs based on the different sales channels they have.
      - `mcc` string — The MCC is a 4-digit code that classifies the type of goods or services that the business sells. Depending on its various lines of business, a merchant could have multiple MCCs. It is mandatory and usually used during the ACS risk analysis (not to be displayed anywhere). Certain MCCs are deemed riskier than others by the issuer, and thus tend to require a stronger challenge during the authentication.
      - `acquirer_bin` string — The Acquirer Bank Identification Number (BIN) is the first four to six digits of a card number that is used to identify the bank account associated with a card network. The BIN is used to submit authorization requests and ensure that payments are routed to the correct institution.
      - `business_id` string — The merchant’s business, company, or service identifier specific to the card-network
      - `merchant_data_id` string — Spreedly generated id for each merchant_data element
    - `address` object — The address associated with the merchant
      - `address1` string — The first line of the merchant’s address
      - `address2` string — The second line of the merchant’s address
      - `city` string — The city of the merchant’s address
      - `state` string — The state of the merchant’s address
      - `zip` string — The zip code of the merchant’s address
      - `country` string — The Country Code in [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_numeric#Current_codes) numeric format of the merchant’s address
    - `metadata` object — metadata key-value pairs (limit 25). Keys are limited to 50 characters. Values are limited to 500 characters and cannot contain compounding data types
    - `created_at` string — The datetime that the sub_merchant was first created
    - `updated_at` string — The datetime that the sub_merchant was last updated

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.dev/spreedly/apis/spreedly-api-v1.md) · [All operations](https://skmtc.dev/spreedly/apis/spreedly-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/spreedly/spreedly-api-v1/revisions/72ba4e23e65c/schema)