Operations 3
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/methodfi:methodfi-merchants-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Methodfi Merchants API
version: '1.0'
description: 'Operations tagged Merchants across 2 of this provider''s published API definitions: methodfi-openapi-original.yml, methodfi-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://production.methodfi.com
description: Production
- url: https://sandbox.methodfi.com
description: Sandbox
- url: https://dev.methodfi.com
description: Development
tags:
- name: Merchants
description: Merchant directory
paths:
/merchants:
get:
operationId: listMerchants
summary: List all merchants
description: Returns a list of merchants from the Method merchant directory.
tags:
- Merchants
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- name: name
in: query
required: false
description: Search merchants by name.
schema:
type: string
- name: type
in: query
required: false
description: Filter merchants by account type.
schema:
$ref: '#/components/schemas/MerchantType'
responses:
'200':
description: A list of merchants.
content:
application/json:
schema:
$ref: '#/components/schemas/MerchantListResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
servers:
- url: https://production.methodfi.com
description: Production
- url: https://sandbox.methodfi.com
description: Sandbox
- url: https://dev.methodfi.com
description: Development
/merchants/{mchId}:
get:
operationId: retrieveMerchant
summary: Retrieve a merchant
description: Returns a single merchant by its identifier.
tags:
- Merchants
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- name: mchId
in: path
required: true
description: Unique identifier for the merchant.
schema:
type: string
pattern: ^mch_\w+$
responses:
'200':
description: The requested merchant.
content:
application/json:
schema:
$ref: '#/components/schemas/MerchantResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
servers:
- url: https://production.methodfi.com
description: Production
- url: https://sandbox.methodfi.com
description: Sandbox
- url: https://dev.methodfi.com
description: Development
/merchants/{mch_id}:
parameters:
- name: mch_id
in: path
required: true
schema:
type: string
get:
operationId: getMerchant
tags:
- Merchants
summary: Retrieve a merchant
responses:
'200':
description: The merchant
content:
application/json:
schema:
$ref: '#/components/schemas/MerchantResponse_2'
security:
- bearerAuth: []
servers:
- url: https://production.methodfi.com
description: Production
- url: https://sandbox.methodfi.com
description: Sandbox
- url: https://dev.methodfi.com
description: Development (simulations enabled)
components:
responses:
InternalError:
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
Unauthorized:
description: Unauthorized - missing or invalid authentication token.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
RateLimited:
description: Too many requests - rate limit exceeded.
headers:
Retry-After:
description: Number of seconds to wait before retrying.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
NotFound:
description: Not found - the requested resource does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
Forbidden:
description: Forbidden - insufficient permissions for this operation.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
BadRequest:
description: Bad request - invalid parameters or request body.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
schemas:
ErrorEnvelope:
type: object
required:
- success
- data
- message
properties:
success:
type: boolean
description: Always `false` for error responses.
data:
type: object
required:
- error
properties:
error:
$ref: '#/components/schemas/ErrorObject'
message:
type: string
MerchantListResponse:
allOf:
- $ref: '#/components/schemas/ListEnvelope'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Merchant'
Merchant:
type: object
required:
- id
- parent_name
- name
- logo
- type
- provider_ids
- is_temp
- account_number_formats
properties:
id:
type: string
description: Unique identifier for the merchant.
example: mch_aTJMbnCjw34yQ
parent_name:
type: string
description: Name of the parent merchant group.
example: Chase
name:
type: string
description: Display name of the merchant.
example: Chase - Credit Cards
logo:
type: string
description: URL of the merchant logo.
example: https://static.methodfi.com/logos/chase.png
type:
$ref: '#/components/schemas/MerchantType'
description: Type of accounts supported by this merchant.
provider_ids:
$ref: '#/components/schemas/MerchantProviderIds'
is_temp:
type: boolean
description: Whether this is a temporary merchant entry.
account_number_formats:
type: array
items:
type: string
description: Accepted account number formats.
SuccessEnvelope:
type: object
description: Standard envelope for successful responses that return a single payload.
required:
- success
- data
- message
properties:
success:
type: boolean
description: Always `true` for successful responses.
data:
description: Operation-specific response payload.
message:
type:
- string
- 'null'
example:
success: true
data: {}
message: null
ListEnvelope:
type: object
description: Standard envelope for successful responses that return a list payload.
required:
- success
- data
- message
properties:
success:
type: boolean
description: Always `true` for successful responses.
data:
description: Operation-specific list payload.
message:
type:
- string
- 'null'
example:
success: true
data: []
message: null
ErrorObject:
type: object
required:
- type
- code
- message
properties:
type:
type: string
description: Error type category.
enum:
- invalid_request
- api_error
- resource_error
code:
type: integer
description: Numeric error code. Common codes include 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 422 (unprocessable entity), 429 (rate limited), and 500 (internal error).
sub_type:
type:
- string
- 'null'
description: More specific error classification.
message:
type: string
description: Human-readable error description.
MerchantType:
type: string
enum:
- auto_loan
- bank
- bnpl
- business_loan
- city
- collection
- county
- credit_builder
- credit_card
- electric_utility
- fintech
- home_equity_loan
- home_loan
- insurance
- internet_utility
- loan
- medical
- mortgage
- personal_loan
- student_loan
- student_loans
- subscription
- telephone_utility
- television_utility
- unknown
- utility
- waste_utility
- water_utility
MerchantProviderIds:
type: object
properties:
plaid:
type: array
items:
type: string
mx:
type: array
items:
type: string
finicity:
type: array
items:
type: string
dpp:
type: array
items:
type: string
rpps:
type: array
items:
type: string
MerchantResponse:
allOf:
- $ref: '#/components/schemas/SuccessEnvelope'
- type: object
properties:
data:
$ref: '#/components/schemas/Merchant'
MerchantResponse_2:
type: object
properties:
mch_id:
type: string
name:
type: string
parent_name:
type: string
logo:
type: string
format: uri
type:
type: string
description: The liability account type this merchant services.
account_prefixes:
type: array
items:
type: string
MerchantListResponse_2:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/MerchantResponse_2'
parameters:
method_version:
name: Method-Version
in: header
required: true
description: 'API version to use for this request. This spec targets `2025-12-01`.
The SDK sets this header automatically.
'
schema:
type: string
enum:
- '2025-12-01'
default: '2025-12-01'
Page:
name: page
in: query
required: false
schema:
type: integer
default: 1
PageLimit:
name: page_limit
in: query
required: false
schema:
type: integer
default: 50
maximum: 100
securitySchemes:
OpalToken:
type: http
scheme: bearer
description: 'Opal token authentication for Opal session endpoints. Use an Opal token (`otkn_...`)
as the Bearer token. Created via POST /opal/token using a secret key.
'
SecretKey:
type: http
scheme: bearer
description: 'Secret key authentication. Use your team''s secret key (`sk_...`) as the Bearer token.
All authenticated API endpoints require this scheme unless otherwise noted.
'
bearerAuth:
type: http
scheme: bearer
description: Provide your Method API key as a Bearer token in the Authorization header. Optionally send a Method-Version header (e.g. 2026-03-30).
x-refined-from:
- methodfi-openapi-original.yml
- methodfi-openapi.yml