MethodFi Account Transactions API

openapi: 3.2.0
info:
  title: Method Account Transactions 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

    entities and accounts programmatically.'
  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: Account Transactions
  description: Transactions for accounts
paths:
  /accounts/{accountId}/transactions:
    get:
      operationId: listAccountTransactions
      summary: List all account transactions
      description: Returns a paginated list of transactions for the specified account. Results can be filtered by status and date range.
      tags:
      - Account Transactions
      security:
      - SecretKey: []
      parameters:
      - $ref: '#/components/parameters/method_version'
      - $ref: '#/components/parameters/AccountIdParam'
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PageLimitParam'
      - $ref: '#/components/parameters/PageCursorParam'
      - $ref: '#/components/parameters/FromDateParam'
      - $ref: '#/components/parameters/ToDateParam'
      responses:
        '200':
          description: A paginated list of account transactions.
          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/AccountTransactionListResponse'
        '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'
  /accounts/{accountId}/transactions/{accTxnId}:
    get:
      operationId: retrieveAccountTransaction
      summary: Retrieve an account transaction
      description: Retrieves an account transaction by its unique identifier.
      tags:
      - Account Transactions
      security:
      - SecretKey: []
      parameters:
      - $ref: '#/components/parameters/method_version'
      - $ref: '#/components/parameters/AccountIdParam'
      - $ref: '#/components/parameters/AccountTransactionIdParam'
      responses:
        '200':
          description: The requested account transaction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountTransactionResponse'
        '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'
components:
  headers:
    Pagination-Page-Limit:
      description: Number of items per page.
      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'
    Pagination-Page:
      description: Current page number.
      schema:
        type: integer
    Pagination-Total-Count:
      description: Total number of items across all pages.
      schema:
        type: integer
  parameters:
    AccountIdParam:
      name: accountId
      in: path
      required: true
      description: Unique identifier for the account.
      schema:
        type: string
        pattern: ^acc_\w+$
    PageLimitParam:
      name: page_limit
      in: query
      required: false
      description: Number of items per page.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
    AccountTransactionIdParam:
      name: accTxnId
      in: path
      required: true
      description: Unique identifier for the account transaction.
      schema:
        type: string
        pattern: ^acc_txn_\w+$
    PageParam:
      name: page
      in: query
      required: false
      description: Page number for pagination (1-indexed).
      schema:
        type: integer
        minimum: 1
        default: 1
    FromDateParam:
      name: from_date
      in: query
      required: false
      description: Filter results from this date (inclusive, YYYY-MM-DD format).
      schema:
        type: string
        format: date
    PageCursorParam:
      name: page_cursor
      in: query
      required: false
      description: Cursor for cursor-based pagination. Use the value from `Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.
      schema:
        type: string
    ToDateParam:
      name: to_date
      in: query
      required: false
      description: Filter results to this date (inclusive, YYYY-MM-DD format).
      schema:
        type: string
        format: date
    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'
  schemas:
    AccountTransactionResponse:
      allOf:
      - $ref: '#/components/schemas/SuccessEnvelope'
      - type: object
        properties:
          data:
            $ref: '#/components/schemas/AccountTransaction'
    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
    AccountTransaction:
      type: object
      description: A transaction for an account.
      required:
      - id
      - account_id
      - merchant
      - amount
      - auth_amount
      - currency_code
      - transaction_amount
      - transaction_auth_amount
      - transaction_currency_code
      - status
      - descriptor
      - transacted_at
      - posted_at
      - voided_at
      - original_txn_id
      - created_at
      - updated_at
      properties:
        id:
          type: string
          pattern: ^txn_\w+$
          description: Unique identifier for the transaction.
          example: txn_aTJMbnCjw34yQ
        account_id:
          type: string
          description: The ID of the account this transaction belongs to.
        merchant:
          type:
          - object
          - 'null'
          description: Merchant information for this transaction.
          properties:
            name:
              type:
              - string
              - 'null'
              description: The merchant name.
            logo:
              type:
              - string
              - 'null'
              description: URL of the merchant logo.
        amount:
          type:
          - number
          - 'null'
          description: The transaction amount in cents.
        auth_amount:
          type:
          - number
          - 'null'
          description: The authorized amount in cents.
        currency_code:
          type:
          - string
          - 'null'
          description: The ISO 4217 currency code.
        transaction_amount:
          type:
          - number
          - 'null'
          description: The transaction amount in the transaction currency.
        transaction_auth_amount:
          type:
          - number
          - 'null'
          description: The authorized amount in the transaction currency.
        transaction_currency_code:
          type:
          - string
          - 'null'
          description: The ISO 4217 currency code of the transaction currency.
        status:
          type: string
          description: The current status of the transaction.
          enum:
          - pending
          - posted
          - voided
        descriptor:
          type:
          - string
          - 'null'
          description: The transaction descriptor.
        transacted_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Timestamp when the transaction occurred.
        posted_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Timestamp when the transaction was posted.
        voided_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Timestamp when the transaction was voided.
        original_txn_id:
          type:
          - string
          - 'null'
          description: The ID of the original transaction if this is a related transaction.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the transaction record was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the transaction record was last updated.
    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
    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
    AccountTransactionListResponse:
      allOf:
      - $ref: '#/components/schemas/ListEnvelope'
      - type: object
        properties:
          data:
            type: array
            items:
              $ref: '#/components/schemas/AccountTransaction'
    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.
  responses:
    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'
    BadRequest:
      description: Bad request - invalid parameters or request body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    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'
  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.

        '