GET
/
merchants
curl "https://production.methodfi.com/merchants?name=Capital One" \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

{
  "data": [
    {
      "id": "mch_301761",
      "parent_name": "Capital One",
      "name": "Capital One Credit Card",
      "logo": "https://static.methodfi.com/mch_logos/mch_301761.png",
      "type": "credit_card",
      "provider_ids": {
        "plaid": [
          "ins_9",
          "ins_128026"
        ],
        "mx": [
          "capital_one"
        ],
        "finicity": [],
        "dpp": [
          "9366979",
          "18372457",
          "18431971",
          "18373255",
          "14444930"
        ]
      },
      "is_temp": false,
      "account_number_formats": [
        "################"
      ]
    }
  ]
}

Returns a list of Merchants that satisfy the provided filters.

​
Query Parameters

​
name
string

The name of the Merchant to filter for.

​
type
enum

The liability type supported by the Merchant. One of credit_card, auto_loan, student_loan, personal_loan or mortgage

​
creditor_name
string

The name of the creditor as seen in a credit report. Ex. JPMCB CARD pertains to a Chase Credit Card.

​
provider_id.plaid
string

The Plaid Institution ID for the Merchant to filter for.

​
provider_id.mx
string

The MX ID for the Merchant to filter for.

​
provider_id.finicity
string

The Finicity ID for the Merchant to filter for.

​
provider_id.dpp
string

The DebtPayPro ID for the Merchant to filter for.

​
page
string

The number of the page to return.

​
page_cursor
string

The ID of a resource from which a page should start or end. Mutually exclusive with page.

​
page_limit
string

The number of Merchants to return per page.

​
Returns

Returns a list of Merchants objects.

curl "https://production.methodfi.com/merchants?name=Capital One" \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

{
  "data": [
    {
      "id": "mch_301761",
      "parent_name": "Capital One",
      "name": "Capital One Credit Card",
      "logo": "https://static.methodfi.com/mch_logos/mch_301761.png",
      "type": "credit_card",
      "provider_ids": {
        "plaid": [
          "ins_9",
          "ins_128026"
        ],
        "mx": [
          "capital_one"
        ],
        "finicity": [],
        "dpp": [
          "9366979",
          "18372457",
          "18431971",
          "18373255",
          "14444930"
        ]
      },
      "is_temp": false,
      "account_number_formats": [
        "################"
      ]
    }
  ]
}
Retrieve a MerchantThe webhook endpoint