How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MethodFi Payments API

ACH and clearing payments

MethodFi Payments API is one of 44 APIs that MethodFi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 4 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://production.methodfi.com, https://sandbox.methodfi.com, https://dev.methodfi.com.

8 operations 4 paths 43 schemas 2 DELETE4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://production.methodfi.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

MethodFi Payments API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpalToken). It accepts HTTP bearer tokens (SecretKey). It accepts HTTP bearer tokens (bearerAuth).

  • OpalToken — 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 — 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 — Provide your Method API key as a Bearer token in the Authorization header. Optionally send a Method-Version header (e.g. 2026-03-30).

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 8

ACH and clearing payments

GET
/payments
List all payments
listPayments 16 params → 200400401404429500
POST
/payments
Create a payment
createPayment 2 params body → 200400401404422429500
GET
/payments/{paymentId}
Retrieve a payment
retrievePayment 3 params → 200400401404429500
DELETE
/payments/{paymentId}
Delete a payment
deletePayment 3 params → 200400401404422429500
GET
/payments/{pmt_id}
Retrieve a payment
getPayment 1 param → 200
DELETE
/payments/{pmt_id}
Delete a pending payment
deletePayment 1 param → 200
POST
/payments/{pmt_id}/reversals
Create a payment reversal
createPaymentReversal 1 param body → 200
GET
/payments/{pmt_id}/reversals
List payment reversals
listPaymentReversals 1 param → 200

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are Account (26 properties), Payment (24 properties), AccountUpdate (17 properties), AccountVerificationSession (17 properties). Each schema is shown below with its type and property counts.

AccountDebitCard
objectnull
Debit card account details. Present when type is debitcard.
3 properties
ErrorEnvelope
object
3 properties 3 required
ResourceError
objectnull
4 properties 3 required
ListEnvelope
object
Standard envelope for successful responses that return a list payload.
3 properties 3 required
AccountExpandableUpdate
The latest update ID. This field is expandable. When expanded, returns the full AccountUpdate object.
AccountAttribute
object
An attribute record for an account containing financial data attributes.
7 properties 6 required
MerchantType
string
AccountExpandableCardBrand
The latest card brand ID. This field is expandable. When expanded, returns the full AccountCardBrand object.
AccountClearing
objectnull
Clearing account details. Present when type is clearing.
3 properties
AccountPaymentInstrument
object
A payment instrument for an account.
11 properties 6 required
AccountSensitive
object
Sensitive data for an account.
8 properties 7 required
AccountLiability
objectnull
Liability account details. Present when type is liability.
7 properties 7 required
AccountCardBrand
object
Card brand information for an account.
12 properties 5 required
AccountSensitiveResourceError
objectnull
Error details when retrieving account sensitive data fails.
4 properties 4 required
AccountExpandableSensitive
The latest sensitive ID. This field is expandable. When expanded, returns the full AccountSensitive object.
PaymentCreateRequest
object
Request body for creating a payment.
8 properties 4 required
AccountVerificationSessionResourceError
objectnull
Error details when an account verification session fails.
4 properties 4 required
PaymentListResponse
BalanceResourceError
objectnull
Error details when a balance sync fails.
4 properties 4 required
Merchant
object
8 properties 8 required
AccountUpdate
object
An update record for an account.
17 properties 6 required
AccountVerificationSession
object
A verification session for an account.
17 properties 6 required
AccountExpandableAttribute
The latest attribute ID. This field is expandable. When expanded, returns the full AccountAttribute object.
AccountExpandablePaymentInstrument
The latest payment instrument ID. This field is expandable. When expanded, returns the full AccountPaymentInstrument object.
AccountExpandableBalance
The latest balance ID. This field is expandable. When expanded, returns the full AccountBalance object.
Account
object
An Account represents a financial account (ACH, liability, clearing, or debit card) associated with an Entity. The type field indicates which nested details ob…
26 properties 9 required
AccountACH
objectnull
ACH account details. Present when type is ach.
3 properties
PaymentResourceError
objectnull
Error details when a payment fails or is canceled.
4 properties 4 required
AccountExpandablePayoff
The latest payoff ID. This field is expandable. When expanded, returns the full AccountPayoff object.
SuccessEnvelope
object
Standard envelope for successful responses that return a single payload.
3 properties 3 required
Metadata
objectnull
Arbitrary key-value metadata attached to the resource.
PayoffResourceError
objectnull
Error details when a payoff sync fails.
4 properties 4 required
AccountBalance
object
A balance record for an account.
7 properties 6 required
PaymentResponse
MerchantProviderIds
object
5 properties
AccountResourceError
objectnull
Error details when an account is disabled.
4 properties 4 required
UpdateResourceError
objectnull
Error details when an account update fails.
4 properties 4 required
Payment
object
A Payment represents a transfer of funds between two accounts.
24 properties 8 required
AccountPayoff
object
A payoff record for an account.
9 properties 8 required
ErrorObject
object
4 properties 3 required
PaymentResponse_2
object
9 properties
PaymentListResponse_2
object
1 property
PaymentCreateRequest_2
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

methodfi-payments-api-openapi.yml Raw ↑

Other APIs MethodFi publishes across the network.

MethodFi Account Attributes API
MethodFi Account Balances API
MethodFi Account Card Brands API
MethodFi Account Consent API
MethodFi Account Payment Instruments API
MethodFi Account Payoffs API
MethodFi Account Products API
MethodFi Account Sensitive API
MethodFi Account Subscriptions API
MethodFi Account Transactions API
MethodFi Account Updates API
MethodFi Account Verification Sessions API
Where this information came from

This is an independent, third-party profile of MethodFi Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.