List all merchants
Returns the most popular
ℹ️ Info: Only the most popular merchants are returned at once in the call to
liability
merchants that are payable using Method's API.ℹ️ Info: Only the most popular merchants are returned at once in the call to
GET /merchants
. Use the available filters/query parameters to narrow your search and find many more merchants.Parameters
name
string
Name of the merchant to find.
Optional
creditor_name
string
The name of the creditor as seen in a credit report. Ex.
JPMCB CARD
pertains to a Chase Credit Card.Optional
provider_id.plaid
string
Plaid id for the merchant to find.
Optional
provider_id.mx
string
MX id for the merchant to find.
Optional
provider_id.finicity
string
Finicity id for the merchant to find.
Optional
Returns
Returns a list of merchant objects.
- cURL
- Node.js
- Python
GET
/merchants
curl https://production.methodfi.com/merchants \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
GET
/merchants
const merchants = await method.merchants.list();
GET
/merchants
merchants = method.merchants.list()
RESPONSE
{
"data": [
{
"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"
]
}
},
{
"mch_id": "mch_21",
"parent_name": "FedLoan",
"name": "FedLoan Servicing",
"logo": "https://static.methodfi.com/mch-logos/1616215578688-fedloan.png",
"description": null,
"note": null,
"types": [
"student_loan"
],
"account_prefixes": [
"5655"
],
"provider_ids": {
"plaid": [
"ins_116527"
],
"mx": [],
"finicity": [
"100302"
]
}
},
{
"mch_id": "mch_231",
"parent_name": "Wells Fargo",
"name": "Wells Fargo - Home Mortgage",
"logo": "https://static.methodfi.com/mch-logos/1616215578688-wells-fargo.png",
"description": null,
"note": null,
"types": [
"mortgage"
],
"account_prefixes": [],
"provider_ids": {
"plaid": [],
"mx": [],
"finicity": []
}
}
]
}