A merchant contains information about the merchant, business, company, or seller associated with a specific transaction. This information includes a name, logo, and website.

Note: Not every transaction will have a merchant_guid assigned to it; this field may be set to null.

List merchants

Endpoint: GET /merchants

This endpoint returns a paginated list of all the merchants in the MX system.

Parameters

For the Request

Example Request

curl -X GET /merchants \\
	-H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}" \\
	-d '{}'

Example Response

For more information about the response, see the model documentation entry on Plaid institutions.

{
  "merchants": [
    {
      "guid": "MCH-ad6d3405-ec03-721d-b0ca-eeceeebcb8b5",
      "logo_url": "<https://content.mx.com/logos/merchants/MCH-ad6d3405-ec03-721d-b0ca-eeceeebcb8b5.png>",
      "name": "1-800 Contacts",
      "website_url": "<https://www.1800contacts.com>",
      "created_at": "2018-09-17T19:13:53Z",
      "logo_updated_at": "2021-08-09T16:19:23Z",
      "updated_at": "2021-08-09T16:19:23Z"
    },
    {
      "guid": "MCH-dfef19bb-1af4-bbaa-db41-434b4b1c8f04",
      "logo_url": "<https://content.mx.com/logos/merchants/MCH-dfef19bb-1af4-bbaa-db41-434b4b1c8f04.png>",
      "name": "1-800-Flowers.com",
      "website_url": "<https://www.1800flowers.com>",
      "created_at": "2018-07-16T16:31:35Z",
      "logo_updated_at": "2021-02-19T15:58:10Z",
      "updated_at": "2021-02-19T15:58:10Z"
    },
    {
      "guid": "MCH-9559c6fb-c05f-ee9e-bb33-ce23078df1a0",
      "logo_url": "<https://content.mx.com/logos/merchants/MCH-9559c6fb-c05f-ee9e-bb33-ce23078df1a0.png>",
      "name": "24 Hour Fitness",
      "website_url": "<https://www.24hourfitness.com>",
      "created_at": "2018-04-23T20:23:59Z",
      "logo_updated_at": "2021-02-19T16:15:59Z",
      "updated_at": "2021-02-19T16:15:59Z"
    },
•••
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_entries": 11443,
    "total_pages": 1145
  }
}

Read merchant

Endpoint: GET /merchants/:merchant_guid

This endpoint returns the attributes of the specified merchant.

Parameters

For the Request