Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/methodfi-payments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Methodfi Payments API
version: '1.0'
description: 'Operations tagged Payments 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: Payments
description: ACH and clearing payments
paths:
/payments:
get:
operationId: listPayments
summary: List all payments
description: Returns a paginated list of payments. Results can be filtered by status, type, accounts, holders, reversal, and date range.
tags:
- Payments
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 payments by status.
schema:
type: string
enum:
- pending
- processing
- sent
- posted
- settled
- failed
- reversed
- canceled
- cashed
- name: source
in: query
required: false
description: Filter payments by source account ID.
schema:
type: string
pattern: ^acc_\w+$
- name: destination
in: query
required: false
description: Filter payments by destination account ID.
schema:
type: string
pattern: ^acc_\w+$
- name: type
in: query
required: false
description: Filter payments by payment type.
schema:
type: string
enum:
- standard
- clearing
- name: reversal_id
in: query
required: false
description: Filter payments by reversal ID.
schema:
type: string
pattern: ^rvs_\w+$
- name: acc_id
in: query
required: false
description: Filter payments by either the source or destination account ID.
schema:
type: string
pattern: ^acc_\w+$
- name: destination_holder_id
in: query
required: false
description: Filter payments by destination entity ID.
schema:
type: string
pattern: ^ent_\w+$
- name: source_holder_id
in: query
required: false
description: Filter payments by source entity ID.
schema:
type: string
pattern: ^ent_\w+$
- name: holder_id
in: query
required: false
description: Filter payments by either the source or destination entity ID.
schema:
type: string
pattern: ^ent_\w+$
- $ref: '#/components/parameters/expand_payments'
responses:
'200':
description: A paginated list of payments.
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/PaymentListResponse'
'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: createPayment
summary: Create a payment
description: Creates a new payment to transfer funds from a source account to a destination account.
tags:
- Payments
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/idempotency_key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentCreateRequest'
examples:
standard:
summary: Create a standard payment
value:
source: acc_b9q2XVAnNFbp3
destination: acc_Y8u3qL9mNa1Bz
amount: 5000
description: Monthly card payment
metadata:
invoice_id: inv_1001
clearing:
summary: Create a clearing payment with a fee
value:
source: acc_b9q2XVAnNFbp3
destination: acc_Y8u3qL9mNa1Bz
amount: 25000
description: Settlement transfer
fee:
type: total
amount: 250
responses:
'200':
description: The newly created payment.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse'
example:
success: true
data:
id: pmt_rPrDPEwyCVUcm
reversal_id: null
source_trace_id: null
destination_trace_id: null
source: acc_b9q2XVAnNFbp3
destination: acc_Y8u3qL9mNa1Bz
amount: 5000
description: Monthly card payment
status: pending
fund_status: transmitting
estimated_completion_date: '2026-01-19'
source_settlement_date: null
destination_settlement_date: null
source_status: null
destination_status: null
destination_payment_method: null
fee: null
type: standard
error: null
metadata:
invoice_id: inv_1001
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'
servers:
- url: https://production.methodfi.com
description: Production
- url: https://sandbox.methodfi.com
description: Sandbox
- url: https://dev.methodfi.com
description: Development
/payments/{paymentId}:
get:
operationId: retrievePayment
summary: Retrieve a payment
description: Retrieves a payment by its unique identifier.
tags:
- Payments
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/PaymentIdParam'
- $ref: '#/components/parameters/expand_payments'
responses:
'200':
description: The requested payment.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse'
'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'
delete:
operationId: deletePayment
summary: Delete a payment
description: Cancels a pending payment. Only payments with a `pending` status can be canceled.
tags:
- Payments
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/PaymentIdParam'
- $ref: '#/components/parameters/idempotency_key'
responses:
'200':
description: The canceled payment.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse'
'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'
servers:
- url: https://production.methodfi.com
description: Production
- url: https://sandbox.methodfi.com
description: Sandbox
- url: https://dev.methodfi.com
description: Development
/payments/{pmt_id}:
parameters:
- $ref: '#/components/parameters/PaymentId'
get:
operationId: getPayment
tags:
- Payments
summary: Retrieve a payment
responses:
'200':
description: The payment
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse_2'
security:
- bearerAuth: []
delete:
operationId: deletePayment
tags:
- Payments
summary: Delete a pending payment
responses:
'200':
description: The deleted payment
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse_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)
/payments/{pmt_id}/reversals:
parameters:
- $ref: '#/components/parameters/PaymentId'
post:
operationId: createPaymentReversal
tags:
- Payments
summary: Create a payment reversal
description: Balances funds for an unsuccessful payment.
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Reversal
content:
application/json:
schema:
type: object
security:
- bearerAuth: []
get:
operationId: listPaymentReversals
tags:
- Payments
summary: List payment reversals
responses:
'200':
description: Reversals
content:
application/json:
schema:
type: object
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:
headers:
Pagination-Total-Count:
description: Total number of items across all pages.
schema:
type: integer
Pagination-Page-Limit:
description: Number of items per page.
schema:
type: integer
Pagination-Page:
description: Current page number.
schema:
type: integer
Pagination-Page-Count:
description: Total number of pages.
schema:
type: integer
Pagination-Page-Cursor-Next:
description: Cursor for the next page, if available.
schema:
type:
- string
- 'null'
Pagination-Page-Cursor-Prev:
description: Cursor for the previous page, if available.
schema:
type:
- string
- 'null'
schemas:
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.
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
ResourceError:
type:
- object
- 'null'
required:
- type
- code
- message
properties:
type:
type: string
code:
type: integer
sub_type:
type:
- string
- 'null'
message:
type: string
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
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'
AccountAttribute:
type: object
description: An attribute record for an account containing financial data attributes.
required:
- id
- account_id
- status
- attributes
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the account attribute.
pattern: ^acc_attr_\w+$
example: acc_attr_eTJMbnCjw34yQ
account_id:
type: string
description: The account this attribute belongs to.
pattern: ^acc_\w+$
status:
type: string
description: Current status of the attribute request.
enum:
- completed
- pending
- failed
attributes:
type: object
description: Financial data attributes for the account.
additionalProperties: true
error:
$ref: '#/components/schemas/ResourceError'
created_at:
type: string
format: date-time
description: Timestamp when the attribute was created.
updated_at:
type: string
format: date-time
description: Timestamp when the attribute was last updated.
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
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'
AccountClearing:
type:
- object
- 'null'
description: Clearing account details. Present when `type` is `clearing`.
properties:
type:
type: string
description: The type of clearing account.
enum:
- single_use
- multi_use
routing:
type: string
description: The clearing routing number.
number:
type: string
description: The clearing account number.
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.
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.
AccountLiability:
type:
- object
- 'null'
description: Liability account details. Present when `type` is `liability`.
required:
- mch_id
- mask
- ownership
- fingerprint
- type
- sub_type
- name
properties:
mch_id:
title: AccountLiabilityExpandableMerchant
description: The merchant ID associated with this liability.
oneOf:
- type: string
pattern: ^mch_\w+$
- $ref: '#/components/schemas/Merchant'
mask:
type:
- string
- 'null'
description: Last 4 digits of the account number.
example: '4321'
ownership:
type:
- string
- 'null'
description: Ownership type of the account.
enum:
- primary
- authorized
- joint
- unknown
- null
fingerprint:
type:
- string
- 'null'
description: Unique fingerprint for de-duplication.
type:
type: string
description: The type of liability.
enum:
- credit_card
- auto_loan
- mortgage
- personal_loan
- student_loan
- student_loans
- collection
- credit_builder
- insurance
- loan
- medical
- utility
- bnpl
- fintech
sub_type:
type:
- string
- 'null'
description: More specific classification of the liability type.
name:
type:
- string
- 'null'
description: Display name of the liability account.
AccountCardBrand:
type: object
description: Card brand information for an account.
required:
- id
- account_id
- status
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the card brand.
pattern: ^cbrd_\w+$
example: cbrd_aTJMbnCjw34yQ
account_id:
type: string
description: The account this card brand belongs to.
pattern: ^acc_\w+$
brands:
type:
- array
- 'null'
description: Array of card brand entries for this account.
items:
type: object
properties:
id:
type: string
description: Unique identifier for the brand entry.
card_product_id:
type:
- string
- 'null'
description: Associated card product ID.
description:
type: string
description: Description of the brand.
name:
type: string
description: Name of the brand.
issuer:
type: string
description: The card issuer.
network:
type: string
description: The card network.
network_tier:
type: string
description: The tier of the card network.
type:
type:
- string
- 'null'
description: The brand type.
url:
type: string
description: URL for the brand image.
source:
type:
- string
- 'null'
description: Source of the card brand data.
enum:
- network
- method
- null
shared:
type: boolean
description: Whether this card brand record is shared.
network:
type:
- string
- 'null'
description: The card network. Deprecated in favor of brands[].network.
enum:
- visa
- mastercard
- amex
- discover
- null
issuer:
type:
- string
- 'null'
description: The card issuer. Deprecated in favor of brands[].issuer.
last4:
type:
- string
- 'null'
description: Last 4 digits of the card number. Deprecated in favor of brands[].
status:
type: string
description: Current status of the card brand request.
enum:
- completed
- pending
- failed
error:
$ref: '#/components/schemas/ResourceError'
created_at:
type: string
format: date-time
description: Timestamp when the card brand was created.
updated_at:
type: string
format: date-time
description: Timestamp when the card brand was last updated.
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.
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'
PaymentCreateRequest:
type: object
description: Request body for creating a payment.
required:
- source
- destination
- amount
- description
properties:
source:
type: string
description: The source account ID.
pattern: ^acc_\w+$
destination:
type: string
description: The destination account ID.
pattern: ^acc_\w+$
amount:
type: integer
description: Payment amount in cents.
minimum: 1
example: 5000
description:
type: string
description: Human-readable description for the payment.
reversal_account:
type: string
description: Account ID to use for the reversal leg of the payment, if applicable.
pattern: ^acc_\w+$
metadata:
$ref: '#/components/schemas/Metadata'
dry_run:
type: boolean
description: Validate the payment request without moving funds.
fee:
type: object
description: Optional fee configuration for the payment.
properties:
type:
type: string
description: The fee type.
enum:
- total
amount:
type: integer
description: Fee amount in cents.
minimum: 0
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.
PaymentListResponse:
allOf:
- $ref: '#/components/schemas/ListEnvelope'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Payment'
BalanceResourceError:
type:
- object
- 'null'
description: Error details when a balance sync fails.
required:
- type
- code
- sub_type
- message
properties:
type:
type: string
description: The category of balance error.
enum:
- BALANCE_FAILED
code:
type: integer
description: Numeric error code (20XXX range).
enum:
- 20001
sub_type:
type: string
description: Specific balance error classification.
enum:
- BALANCE_TEMPORARILY_UNAVAILABLE
message:
type: string
description: Human-readable error description.
example:
type: BALANCE_FAILED
code: 20001
sub_type: BALANCE_TEMPORARILY_UNAVAILABLE
message: Balance is temporarily unavailable for this account.
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.
# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/methodfi/refs/heads/main/openapi/methodfi-payments-api-openapi.yml