Skip to main content

The merchant object

Merchants are financial institutions that accept payments for a liability. This includes student loan servicers, credit cards, mortgages, etc. Method's API covers the majority of merchants in the US.
ℹ️ Info: Merchants / Financial institutions with multiple verticals have a unique mch_id for each vertical (e.g. Chase - Credit Cards & Chase - Auto Loans )

Attributes

mch_id

string
Unique identifier for the merchant. Required for retrieving a merchant token.

parent_name

string
A presentable name for the parent organization. Useful for a merchant with multiple verticals.

name

string
A presentable name of the merchant.

description

string,null
A detailed name provided by the merchant.

note

string,null
Additional details provided by the merchant.

types

enum[]
The type of liability this merchant handles. This field is important for merchants with multiple verticals. (e.g. Chase - Credit Cards & Chase - Auto Loans).
Possible enum values

auto_loan

business_loan

home_loan

loan

personal_loan

student_loan

home_equity_loan

mortgage

electric_utility

internet_utility

telephone_utility

television_utility

water_utility

waste_utility

utility

credit_card

insurance

medical

bank

account_prefixes

string[]
Prefixes of valid account numbers for this merchant.

provider_ids

object
Related IDs for this merchant in third-party aggregators.

provider_ids.plaid

string[]
A list of Plaid institution ids for this merchant.

provider_ids.mx

string[]
A list of MX institution ids for this merchant.

provider_ids.finicity

string[]
A list of Finicity institution ids for this merchant.
{
  "mch_id": "mch_1",
  "parent_name": "Chase",
  "name": "Chase - Credit Cards",
  "logo": "https://static.methodfi.com/mch-logos/1616215578688-chase.png",
  "description": "Chase Mastercard & Visa",
  "note": "For Credit Card Accounts Only",
  "types": [
    "credit_card"
  ],
  "account_prefixes": [
    "403116",
    "438857"
  ],
  "provider_ids": {
    "plaid": [
      "ins_3"
    ],
    "mx": [
      "chase"
    ],
    "finicity": [
      "5"
    ]
  }
}