---
agentTools:
  projectIndex: https://developer.mxmerchant.com/llms.txt
---

# Get List of Merchants

Gets a list of all merchants the user has access to

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Checkout API",
    "version": "1.00"
  },
  "servers": [
    {
      "url": "https://sandbox.api.mxmerchant.com/checkout"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v3/merchant": {
      "get": {
        "summary": "Get List of Merchants",
        "description": "Gets a list of all merchants the user has access to",
        "operationId": "get-list-of-merchants",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "description": "How many results to return",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 9999
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Which record to start on",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n   \"records\":[\n      {\n         \"id\":418272276,\n         \"dba\":\"Golf Store TEST\",\n         \"xmid\":8739000841300002,\n         \"applicationStatus\":\"0\",\n         \"awaitingMerchantAcceptance\":false,\n         \"merchantAcceptedAgreement\":false,\n         \"hasPayRightHealthEquipment\":false,\n         \"plan\":\"Basic\",\n         \"package\":[\n            \"Basic\",\n            \"Developer\",\n            \"Retail\",\n            \"Invoice\"\n         ],\n         \"canProcessPayment\":false,\n         \"address\":{\n            \"name\":\"Location\",\n            \"address1\":\"1360 BING WAY\",\n            \"city\":\"ALPHARETTA\",\n            \"state\":\"GA\",\n            \"zip\":\"30004\",\n            \"country\":\"USA\"\n         }\n      },\n      {\n         \"id\":110070419,\n         \"dba\":\"Demo Test TSYS Merchant\",\n         \"xmid\":8739290300300001,\n         \"applicationStatus\":\"0\",\n         \"awaitingMerchantAcceptance\":false,\n         \"merchantAcceptedAgreement\":false,\n         \"hasPayRightHealthEquipment\":false,\n         \"plan\":\"Basic\",\n         \"package\":[\n            \"Basic\",\n            \"Developer\",\n            \"Retail\",\n            \"Invoice\"\n         ],\n         \"canProcessPayment\":false,\n         \"address\":{\n            \"name\":\"Location\",\n            \"address1\":\"1234 TEST ST\",\n            \"city\":\"ALPHARETTA\",\n            \"state\":\"GA\",\n            \"zip\":\"30004\",\n            \"country\":\"USA\"\n         }\n      }\n   ],\n   \"recordCount\":2\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "records": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 418272276,
                            "default": 0
                          },
                          "dba": {
                            "type": "string",
                            "example": "Golf Store TEST"
                          },
                          "xmid": {
                            "type": "integer",
                            "example": 8739000841300002,
                            "default": 0
                          },
                          "applicationStatus": {
                            "type": "string",
                            "example": "0"
                          },
                          "awaitingMerchantAcceptance": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "merchantAcceptedAgreement": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "hasPayRightHealthEquipment": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "plan": {
                            "type": "string",
                            "example": "Basic"
                          },
                          "package": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "Basic"
                            }
                          },
                          "canProcessPayment": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "address": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "example": "Location"
                              },
                              "address1": {
                                "type": "string",
                                "example": "1360 BING WAY"
                              },
                              "city": {
                                "type": "string",
                                "example": "ALPHARETTA"
                              },
                              "state": {
                                "type": "string",
                                "example": "GA"
                              },
                              "zip": {
                                "type": "string",
                                "example": "30004"
                              },
                              "country": {
                                "type": "string",
                                "example": "USA"
                              }
                            }
                          }
                        }
                      }
                    },
                    "recordCount": {
                      "type": "integer",
                      "example": 2,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true,
  "_id": "644bb860dd3d4600261d0de7:644bb860dd3d4600261d0df8"
}
```