MethodFi Events API

openapi: 3.2.0
info:
  title: Method Events 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: Events
  description: Webhook event log
paths:
  /events:
    get:
      operationId: listEvents
      summary: List all events
      description: Returns a paginated list of webhook event records.
      tags:
      - Events
      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: type
        in: query
        required: false
        description: Filter events by event type.
        schema:
          type: string
      responses:
        '200':
          description: A list of events.
          headers:
            Pagination-Page:
              description: Current page number.
              schema:
                type: integer
            Pagination-Page-Count:
              description: Total number of pages.
              schema:
                type: integer
            Pagination-Page-Limit:
              description: Number of items per page.
              schema:
                type: integer
            Pagination-Total-Count:
              description: Total number of items across all pages.
              schema:
                type: integer
            Pagination-Page-Cursor-Prev:
              description: Cursor for the previous page, if available.
              schema:
                type:
                - string
                - 'null'
            Pagination-Page-Cursor-Next:
              description: Cursor for the next page, if available.
              schema:
                type:
                - string
                - 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventListResponse'
              example:
                success: true
                data:
                - id: evt_HnEJMFWS8rJbh
                  type: payment.create
                  resource_id: pmt_rPrDPEwyCVUcm
                  resource_type: payment
                  related_ids:
                  - acc_b9q2XVAnNFbp3
                  - acc_Y8u3qL9mNa1Bz
                  data:
                    id: pmt_rPrDPEwyCVUcm
                    status: pending
                    amount: 5000
                  diff: {}
                  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'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /events/{evtId}:
    get:
      operationId: retrieveEvent
      summary: Retrieve an event
      description: Returns a single event by its identifier.
      tags:
      - Events
      security:
      - SecretKey: []
      parameters:
      - $ref: '#/components/parameters/method_version'
      - $ref: '#/components/parameters/EventIdParam'
      responses:
        '200':
          description: The requested event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResponse'
              example:
                success: true
                data:
                  id: evt_HnEJMFWS8rJbh
                  type: payment.create
                  resource_id: pmt_rPrDPEwyCVUcm
                  resource_type: payment
                  related_ids:
                  - acc_b9q2XVAnNFbp3
                  - acc_Y8u3qL9mNa1Bz
                  data:
                    id: pmt_rPrDPEwyCVUcm
                    status: pending
                    amount: 5000
                  diff: {}
                  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'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    PageLimitParam:
      name: page_limit
      in: query
      required: false
      description: Number of items per page.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
    EventIdParam:
      name: evtId
      in: path
      required: true
      description: Unique identifier for the event.
      schema:
        type: string
        pattern: ^evt_\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:
    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
    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
    Event:
      type: object
      required:
      - id
      - type
      - resource_id
      - resource_type
      - related_ids
      - data
      - diff
      - created_at
      - updated_at
      properties:
        id:
          type: string
          description: Unique identifier for the event.
          example: evt_HnEJMFWS8rJbh
        type:
          description: The webhook event type.
          example: payment.create
          $ref: '#/components/schemas/WebhookType'
        resource_id:
          type: string
          description: Identifier of the resource that triggered the event.
          example: pmt_rPrDPEwyCVUFm
        resource_type:
          type: string
          description: Type of the resource that triggered the event.
          example: payment
        related_ids:
          type: array
          items:
            type: string
          description: Identifiers of related resources.
        data:
          description: Current state of the resource at the time of the event.
          $ref: '#/components/schemas/JsonObject'
        diff:
          description: Changes from the previous state of the resource.
          $ref: '#/components/schemas/JsonObject'
        created_at:
          type: string
          format: date-time
          description: Timestamp when the event was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the event was last updated.
    EventResponse:
      allOf:
      - $ref: '#/components/schemas/SuccessEnvelope'
      - type: object
        properties:
          data:
            $ref: '#/components/schemas/Event'
      example:
        success: true
        data:
          id: evt_HnEJMFWS8rJbh
          type: payment.create
          resource_id: pmt_rPrDPEwyCVUcm
          resource_type: payment
          related_ids:
          - acc_b9q2XVAnNFbp3
          - acc_Y8u3qL9mNa1Bz
          data:
            id: pmt_rPrDPEwyCVUcm
            status: pending
            amount: 5000
          diff: {}
          created_at: '2026-01-15T18:30:00.000Z'
          updated_at: '2026-01-15T18:30:00.000Z'
        message: null
    EventListResponse:
      allOf:
      - $ref: '#/components/schemas/ListEnvelope'
      - type: object
        properties:
          data:
            type: array
            items:
              $ref: '#/components/schemas/Event'
    JsonObject:
      type: object
      description: Arbitrary JSON object.
      additionalProperties: true
    WebhookType:
      type: string
      description: The event type this webhook subscribes to.
      enum:
      - payment.create
      - payment.update
      - account.create
      - account.update
      - account.opened
      - account.closed
      - account.balance_increased
      - account.balance_decreased
      - account.credit_limit_increased
      - account.credit_limit_decreased
      - account.number.update
      - entity.create
      - entity.update
      - entity.new_accounts_pending_consent
      - account_verification.create
      - account_verification.update
      - entity_verification_session.create
      - entity_verification_session.update
      - payment_reversal.create
      - payment_reversal.update
      - connection.create
      - connection.update
      - connect.create
      - connect.available
      - connect.update
      - manual_connect.create
      - manual_connect.update
      - report.create
      - report.update
      - product.create
      - product.update
      - subscription.create
      - subscription.update
      - credit_score.create
      - credit_score.update
      - credit_score.available
      - credit_score.increased
      - credit_score.decreased
      - payoff.create
      - payoff.update
      - balance.create
      - balance.update
      - identity.create
      - identity.update
      - account_verification_session.create
      - account_verification_session.update
      - card_brand.create
      - card_brand.available
      - card_brand.update
      - payment_instrument.create
      - payment_instrument.update
      - sensitive.create
      - sensitive.update
      - update.create
      - update.update
      - attribute.create
      - attribute.update
      - entity_attribute.create
      - entity_attribute.update
      - account_attribute.create
      - account_attribute.update
      - transaction.create
      - transaction.update
      - entity_vehicle.create
      - entity_vehicle.update
      - method_jwk.create
      - method_jwk.update
      - attribute.credit_health_credit_card_usage.increased
      - attribute.credit_health_credit_card_usage.decreased
      - attribute.credit_health_derogatory_marks.increased
      - attribute.credit_health_derogatory_marks.decreased
      - attribute.credit_health_hard_inquiries.increased
      - attribute.credit_health_hard_inquiries.decreased
      - attribute.credit_health_total_accounts.increased
      - attribute.credit_health_total_accounts.decreased
      - attribute.credit_health_credit_age.increased
      - attribute.credit_health_credit_age.decreased
      - attribute.credit_health_payment_history.increased
      - attribute.credit_health_payment_history.decreased
      - attribute.credit_health_open_accounts.increased
      - attribute.credit_health_open_accounts.decreased
      - entity_attribute.credit_health_open_accounts_value.decreased
      - entity_attribute.credit_health_open_accounts_value.increased
      - entity_attribute.credit_health_total_accounts_value.decreased
      - entity_attribute.credit_health_total_accounts_value.increased
      - entity_attribute.credit_health_credit_card_usage_value.decreased
      - entity_attribute.credit_health_credit_card_usage_value.increased
      - entity_attribute.credit_health_soft_inquiries_value.decreased
      - entity_attribute.credit_health_soft_inquiries_value.increased
      - entity_attribute.credit_health_hard_inquiries_value.decreased
      - entity_attribute.credit_health_hard_inquiries_value.increased
    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'
    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'
    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.

        '