MethodFi Accounts API
Financial accounts (ACH, liability, clearing, debit card)
OpenAPI Specification
openapi: 3.1.0
info:
title: Method Account Attributes Accounts API
version: '2025-12-01'
license:
name: Proprietary
url: https://methodfi.com
description: "The Method API enables you to retrieve financial data, create payments, and manage\nentities and accounts programmatically. This specification covers the public API\nsurface for version `2025-12-01`.\n\n## Authentication\n\nMost API requests require a Bearer token in the `Authorization` header.\nUse your secret key (`sk_...`) for server-side requests and public key (`pk_...`)\nfor client-side Element requests. Public Message-Level Encryption key discovery\nendpoints are documented separately and do not require authentication.\n\n## Versioning\n\nThe API version is selected via the `Method-Version` header. This spec targets\nversion `2025-12-01`. The SDK sets this header automatically.\n\n## Response Envelope\n\nMost JSON responses are wrapped in a standard envelope:\n\n```json\n{\n \"success\": true,\n \"data\": { ... },\n \"message\": null\n}\n```\n\nThe `/.well-known/jwks.json` endpoint is an exception and returns a bare JWK set.\n\n## Pagination\n\nList endpoints return pagination metadata in response headers:\n`Pagination-Page`, `Pagination-Page-Count`, `Pagination-Page-Limit`,\n`Pagination-Total-Count`, `Pagination-Page-Cursor-Prev`, `Pagination-Page-Cursor-Next`.\n\n## Expandable Fields\n\nCertain resource fields can be expanded from IDs to full objects using the\n`expand` query parameter. Maximum nesting depth is 4 levels.\n"
contact:
name: Method Financial
url: https://methodfi.com
email: team@methodfi.com
servers:
- url: https://production.methodfi.com
description: Production
- url: https://sandbox.methodfi.com
description: Sandbox
- url: https://dev.methodfi.com
description: Development
security:
- SecretKey: []
tags:
- name: Accounts
description: Financial accounts (ACH, liability, clearing, debit card)
paths:
/accounts:
get:
operationId: listAccounts
summary: List all accounts
description: Returns a paginated list of accounts. Results can be filtered by status, type, holder, and date range.
tags:
- Accounts
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PageLimitParam'
- $ref: '#/components/parameters/PageCursorParam'
- $ref: '#/components/parameters/FromDateParam'
- $ref: '#/components/parameters/ToDateParam'
- name: status
in: query
required: false
description: Filter accounts by status.
schema:
type: string
enum:
- active
- disabled
- name: type
in: query
required: false
description: Filter accounts by type.
schema:
type: string
enum:
- ach
- liability
- clearing
- debit_card
- name: consent_status
in: query
required: false
description: Filter accounts by consent status.
schema:
type: string
enum:
- pending
- withdrawn
- approved
- name: holder_id
in: query
required: false
description: Filter accounts by the entity ID that owns them.
schema:
type: string
pattern: ^ent_\w+$
- name: holder_ids
in: query
required: false
description: Filter accounts by one or more entity IDs.
style: form
explode: true
schema:
type: array
items:
type: string
pattern: ^ent_\w+$
- name: include_pending_consent
in: query
required: false
description: Include accounts that are still pending consent.
schema:
type: boolean
- name: liability.mch_id
in: query
required: false
description: Filter liability accounts by merchant ID.
schema:
type: string
pattern: ^mch_\w+$
- name: liability.type
in: query
required: false
description: Filter liability accounts by liability type.
schema:
type: string
enum:
- credit_card
- auto_loan
- mortgage
- personal_loan
- student_loan
- student_loans
- collection
- credit_builder
- insurance
- loan
- medical
- utility
- bnpl
- fintech
- name: liability.ownership
in: query
required: false
description: Filter liability accounts by ownership type.
schema:
type: string
enum:
- primary
- authorized
- joint
- unknown
- $ref: '#/components/parameters/expand_accounts'
responses:
'200':
description: A paginated list of accounts.
headers:
Pagination-Page:
$ref: '#/components/headers/Pagination-Page'
Pagination-Page-Count:
$ref: '#/components/headers/Pagination-Page-Count'
Pagination-Page-Limit:
$ref: '#/components/headers/Pagination-Page-Limit'
Pagination-Total-Count:
$ref: '#/components/headers/Pagination-Total-Count'
Pagination-Page-Cursor-Prev:
$ref: '#/components/headers/Pagination-Page-Cursor-Prev'
Pagination-Page-Cursor-Next:
$ref: '#/components/headers/Pagination-Page-Cursor-Next'
content:
application/json:
schema:
$ref: '#/components/schemas/AccountListResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
post:
operationId: createAccount
summary: Create an account
description: Creates a new account for the specified entity. The request body must include exactly one of `ach`, `liability`, `clearing`, or `debit_card` to determine the account type.
tags:
- Accounts
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/idempotency_key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccountCreateRequest'
examples:
ach:
summary: Create an ACH account
value:
type: ach
holder_id: ent_au22b1fbFJbp8
ach:
routing: '111000025'
number: 000123456789
type: checking
metadata:
customer_reference: acct-001
liability:
summary: Create a liability account
value:
type: liability
holder_id: ent_au22b1fbFJbp8
liability:
mch_id: mch_4c1j9e4t4R8Qd
account_number: '4111111111111111'
metadata:
portfolio: cards
debit_card:
summary: Create a debit card account
value:
type: debit_card
holder_id: ent_au22b1fbFJbp8
debit_card:
number: '4111111111111111'
exp_month: '12'
exp_year: 2028
cvv: '123'
billing_zip_code: '78701'
responses:
'200':
description: The newly created account.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountResponse'
example:
success: true
data:
id: acc_b9q2XVAnNFbp3
holder_id: ent_au22b1fbFJbp8
type: ach
status: active
consent_status: approved
ach:
routing: '111000025'
number: 000123456789
type: checking
liability: null
clearing: null
debit_card: null
capabilities: []
available_capabilities:
- payments:send
- payments:receive
error: null
metadata:
customer_reference: acct-001
products: []
restricted_products: []
subscriptions: []
available_subscriptions: []
restricted_subscriptions: []
latest_verification_session: null
balance: null
payoff: null
payment_instrument: null
card_brand: null
update: null
attribute: null
sensitive: null
created_at: '2026-01-15T18:30:00.000Z'
updated_at: '2026-01-15T18:30:00.000Z'
message: null
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
/accounts/{accountId}:
get:
operationId: retrieveAccount
summary: Retrieve an account
description: Retrieves an account by its unique identifier.
tags:
- Accounts
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/AccountIdParam'
- $ref: '#/components/parameters/expand_accounts'
responses:
'200':
description: The requested account.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
put:
operationId: updateAccount
summary: Update an account
description: Updates an account's metadata or liability account number.
tags:
- Accounts
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/AccountIdParam'
- $ref: '#/components/parameters/idempotency_key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccountUpdateRequest'
examples:
metadata:
summary: Update account metadata
value:
metadata:
servicing_tier: gold
liability:
summary: Update a liability account number
value:
liability:
credit_card:
number: '5555444433331111'
responses:
'200':
description: Account updated successfully.
content:
application/json:
schema:
type: object
required:
- success
- data
- message
properties:
success:
type: boolean
example: true
data:
type: 'null'
example: null
message:
type:
- 'null'
- string
example: null
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
components:
schemas:
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.
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
UpdateResourceError:
type:
- object
- 'null'
description: Error details when an account update fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of update error.
enum:
- UPDATE_FAILED
code:
type: integer
description: Numeric error code (21XXX range).
enum:
- 21001
sub_type:
type: string
description: Specific update error classification.
enum:
- UPDATE_TEMPORARILY_UNAVAILABLE
message:
type: string
description: Human-readable error description.
example:
type: UPDATE_FAILED
code: 21001
sub_type: UPDATE_TEMPORARILY_UNAVAILABLE
message: Update is temporarily unavailable for this account.
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
AccountSensitive:
type: object
description: Sensitive data for an account.
required:
- id
- account_id
- status
- type
- fields
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the sensitive record.
pattern: ^astv_\w+$
example: astv_aTJMbnCjw34yQ
account_id:
type: string
description: The account this sensitive data belongs to.
pattern: ^acc_\w+$
status:
type: string
description: Current status of the sensitive data request.
enum:
- completed
- pending
- failed
type:
type: string
description: The type of sensitive data.
fields:
type: array
description: List of sensitive data fields retrieved.
items:
type: object
properties:
name:
type: string
description: Name of the field.
value:
type: string
description: Value of the field.
error:
$ref: '#/components/schemas/AccountSensitiveResourceError'
created_at:
type: string
format: date-time
description: Timestamp when the sensitive record was created.
updated_at:
type: string
format: date-time
description: Timestamp when the sensitive record was last updated.
PayoffResourceError:
type:
- object
- 'null'
description: Error details when a payoff sync fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of payoff error.
enum:
- PAYOFF_FAILED
code:
type: integer
description: Numeric error code (18XXX range).
enum:
- 18001
sub_type:
type: string
description: Specific payoff error classification.
enum:
- PAYOFF_TEMPORARILY_UNAVAILABLE
message:
type: string
description: Human-readable error description.
example:
type: PAYOFF_FAILED
code: 18001
sub_type: PAYOFF_TEMPORARILY_UNAVAILABLE
message: Payoff is temporarily unavailable for this account.
AccountExpandableBalance:
title: AccountExpandableBalance
description: 'The latest balance ID. This field is expandable. When expanded, returns the full AccountBalance object.
'
oneOf:
- type: string
pattern: ^bal_\w+$
- type: 'null'
- $ref: '#/components/schemas/AccountBalance'
AccountListResponse:
allOf:
- $ref: '#/components/schemas/ListEnvelope'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Account'
AccountResponse:
allOf:
- $ref: '#/components/schemas/SuccessEnvelope'
- type: object
properties:
data:
$ref: '#/components/schemas/Account'
AccountVerificationSessionResourceError:
type:
- object
- 'null'
description: Error details when an account verification session fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of verification session error.
enum:
- ACCOUNT_VERIFICATION_SESSION_FAILED
code:
type: integer
description: Numeric error code (16XXX range).
enum:
- 16001
- 16002
- 16003
- 16004
sub_type:
type: string
description: Specific verification session error classification.
enum:
- VERIFICATION_TYPE_NOT_SUPPORTED
- INVALID_DETAILS
- VERIFICATION_SESSION_ATTEMPT_LIMIT_REACHED
- MICRO_DEPOSITS_FAILED
message:
type: string
description: Human-readable error description.
example:
type: ACCOUNT_VERIFICATION_SESSION_FAILED
code: 16001
sub_type: VERIFICATION_TYPE_NOT_SUPPORTED
message: The verification type provided is not supported for the merchant.
CreateAchAccountRequest:
type: object
description: Create an ACH account.
required:
- holder_id
- ach
properties:
type:
type: string
enum:
- ach
holder_id:
type: string
description: The entity ID that will own this account.
pattern: ^ent_\w+$
ach:
type: object
description: ACH account details.
required:
- routing
- number
- type
properties:
routing:
type: string
description: The ACH routing number.
pattern: ^\d{9}$
number:
type: string
description: The ACH account number.
pattern: ^\d+$
type:
type: string
description: The type of ACH account.
enum:
- checking
- savings
metadata:
$ref: '#/components/schemas/Metadata'
AccountCreateRequest:
description: 'Request body for creating an account.
`type` is recommended and used for discrimination in generated clients, but
the API can also infer the account type from the nested object you provide.
'
oneOf:
- $ref: '#/components/schemas/CreateAchAccountRequest'
- $ref: '#/components/schemas/CreateLiabilityAccountRequest'
- $ref: '#/components/schemas/CreateClearingAccountRequest'
- $ref: '#/components/schemas/CreateDebitCardAccountRequest'
discriminator:
propertyName: type
mapping:
ach: '#/components/schemas/CreateAchAccountRequest'
liability: '#/components/schemas/CreateLiabilityAccountRequest'
clearing: '#/components/schemas/CreateClearingAccountRequest'
debit_card: '#/components/schemas/CreateDebitCardAccountRequest'
AccountExpandableSensitive:
title: AccountExpandableSensitive
description: 'The latest sensitive ID. This field is expandable. When expanded, returns the full AccountSensitive object.
'
oneOf:
- type: string
pattern: ^astv_\w+$
- type: 'null'
- $ref: '#/components/schemas/AccountSensitive'
AccountPaymentInstrument:
type: object
description: A payment instrument for an account.
required:
- id
- account_id
- status
- type
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the payment instrument.
pattern: ^pmt_inst_\w+$
example: pmt_inst_aTJMbnCjw34yQ
account_id:
type: string
description: The account this payment instrument belongs to.
pattern: ^acc_\w+$
status:
type: string
description: Current status of the payment instrument.
enum:
- pending
- in_progress
- completed
type:
type: string
description: The type of payment instrument.
enum:
- card
- network_token
- inbound_achwire_payment
chargeable:
type: boolean
description: Whether this payment instrument is currently chargeable.
card:
type:
- object
- 'null'
description: Card details. Present when type is card.
properties:
number:
type: string
description: The card number.
exp_month:
type: string
description: Card expiration month.
exp_year:
type: string
description: Card expiration year.
billing_zip_code:
type: string
description: Billing zip code.
network_token:
type:
- object
- 'null'
description: Network token details. Present when type is network_token.
properties:
token:
type: string
description: The network token value.
inbound_achwire_payment:
type:
- object
- 'null'
description: ACH/wire payment details. Present when type is inbound_achwire_payment.
properties:
account_number:
type: string
description: The account number.
routing_number:
type: string
description: The routing number.
error:
$ref: '#/components/schemas/ResourceError'
created_at:
type: string
format: date-time
description: Timestamp when the payment instrument was created.
updated_at:
type: string
format: date-time
description: Timestamp when the payment instrument was last updated.
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
AccountExpandableAttribute:
title: AccountExpandableAttribute
description: 'The latest attribute ID. This field is expandable. When expanded, returns the full AccountAttribute object.
'
oneOf:
- type: string
pattern: ^acc_attr_\w+$
- type: 'null'
- $ref: '#/components/schemas/AccountAttribute'
CreateClearingAccountRequest:
type: object
description: Create a clearing account.
required:
- holder_id
- clearing
properties:
type:
type: string
enum:
- clearing
holder_id:
type: string
description: The entity ID that will own this account.
pattern: ^ent_\w+$
clearing:
type: object
description: Clearing account details.
required:
- type
properties:
type:
type: string
description: The type of clearing account to create.
enum:
- single_use
- multi_use
metadata:
$ref: '#/components/schemas/Metadata'
AccountExpandableUpdate:
title: AccountExpandableUpdate
description: 'The latest update ID. This field is expandable. When expanded, returns the full AccountUpdate object.
'
oneOf:
- type: string
pattern: ^upd_\w+$
- type: 'null'
- $ref: '#/components/schemas/AccountUpdate'
AccountExpandableCardBrand:
title: AccountExpandableCardBrand
description: 'The latest card brand ID. This field is expandable. When expanded, returns the full AccountCardBrand object.
'
oneOf:
- type: string
pattern: ^cbrd_\w+$
- type: 'null'
- $ref: '#/components/schemas/AccountCardBrand'
Metadata:
type:
- object
- 'null'
additionalProperties: true
description: Arbitrary key-value metadata attached to the resource.
AccountDebitCard:
type:
- object
- 'null'
description: Debit card account details. Present when `type` is `debit_card`.
properties:
network:
type: string
description: The card network.
mask:
type: string
description: Last 4 digits of the card number.
issuer:
type: string
description: The card issuer.
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
AccountExpandablePaymentInstrument:
title: AccountExpandablePaymentInstrument
description: 'The latest payment instrument ID. This field is expandable. When expanded, returns the full AccountPaymentInstrument object.
'
oneOf:
- type: string
pattern: ^pmt_inst_\w+$
- type: 'null'
- $ref: '#/components/schemas/AccountPaymentInstrument'
AccountExpandablePayoff:
title: AccountExpandablePayoff
description: 'The latest payoff ID. This field is expandable. When expanded, returns the full AccountPayoff object.
'
oneOf:
- type: string
pattern: ^pyf_\w+$
- type: 'null'
- $ref: '#/components/schemas/AccountPayoff'
AccountSensitiveResourceError:
type:
- object
- 'null'
description: Error details when retrieving account sensitive data fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of sensitive data error.
enum:
- ACCOUNT_SENSITIVE_FAILED
code:
type: integer
description: Numeric error code (17XXX range).
enum:
- 17001
sub_type:
type: string
description: Specific sensitive data error classification.
enum:
- ACCOUNT_SENSITIVE_FAILED_VERIFICATION_REQUIRED
message:
type: string
description: Human-readable error description.
example:
type: ACCOUNT_SENSITIVE_FAILED
code: 17001
sub_type: ACCOUNT_SENSITIVE_FAILED_VERIFICATION_REQUIRED
message: Account sensitive failed due to missing required verification.
AccountResourceError:
type:
- object
- 'null'
description: Error details when an account is disabled.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of account error.
enum:
- ACCOUNT_DISABLED
code:
type: integer
description: Numeric error code (11XXX range).
enum:
- 11001
- 11002
- 11003
- 11004
- 11005
- 11006
sub_type:
type: string
description: Specific account error classification.
enum:
- ACCOUNT_INVALID_DETAILS
- ACCOUNT_UNAUTHORIZED_PAYMENT
- ACCOUNT_CLOSED
- ACCOUNT_CONSENT_WITHDRAWN
- ACCOUNT_DISABLED_INVALID_STATE
- ACCOUNT_DISABLED_HOLDER_ENTITY_DISABLED
message:
type: string
description: Human-readable error description.
example:
type: ACCOUNT_DISABLED
code: 11001
sub_type: ACCOUNT_INVALID_DETAILS
message: Account was disabled due to invalid information reported by the financial institution.
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:
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/methodfi/refs/heads/main/openapi/methodfi-accounts-api-openapi.yml