> ## Documentation Index
> Fetch the complete documentation index at: https://docs.montereyfinancial.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List payment methods

> Paginated list of stored payment methods belonging to borrowers visible to the calling API key. Filter to one borrower with `party_id`. Only display-safe metadata is returned — never full card or account numbers.



## OpenAPI

````yaml /api-reference/external_api.openapi.json get /payment-methods
openapi: 3.1.0
info:
  title: Monterey External Reporting API
  description: >-
    Org-scoped, API-key-authenticated reporting endpoints for Monterey Financial
    clients.
  version: 0.1.0
servers:
  - url: https://api.montereyfinancial.app
    description: Production
security:
  - BearerApiKey: []
paths:
  /payment-methods:
    get:
      tags:
        - Payment Methods
      summary: List payment methods
      description: >-
        Paginated list of stored payment methods belonging to borrowers visible
        to the calling API key. Filter to one borrower with `party_id`. Only
        display-safe metadata is returned — never full card or account numbers.
      operationId: list_payment_methods_payment_methods_get
      parameters:
        - name: party_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Party Id
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Opaque pagination cursor from a previous response's
              `page.next_cursor`. Omit on the first page.
            title: Cursor
          description: >-
            Opaque pagination cursor from a previous response's
            `page.next_cursor`. Omit on the first page.
        - name: limit
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 1000
                minimum: 1
              - type: 'null'
            description: >-
              Page size for cursor pagination. Default 100, minimum 1, maximum
              1000. Requests above the maximum return 422 — narrow your page
              size and use the returned `next_cursor` to walk additional pages.
            title: Limit
          description: >-
            Page size for cursor pagination. Default 100, minimum 1, maximum
            1000. Requests above the maximum return 422 — narrow your page size
            and use the returned `next_cursor` to walk additional pages.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_PaymentMethodRow_'
        '401':
          description: Missing or invalid API key.
        '404':
          description: Resource not in scope or does not exist.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerApiKey: []
components:
  schemas:
    Page_PaymentMethodRow_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PaymentMethodRow'
          type: array
          title: Items
        page:
          $ref: '#/components/schemas/PageMeta'
      type: object
      required:
        - items
        - page
      title: Page[PaymentMethodRow]
      description: 'A page of results: `items` plus a `page` pagination envelope.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      description: >-
        Parameter-validation error (HTTP 422). `detail` lists each violated
        constraint with its location, message, and type.
    PaymentMethodRow:
      properties:
        id:
          type: string
          title: Id
        party_id:
          type: string
          title: Party Id
          description: The person (borrower) this payment method belongs to.
        instrument_type:
          type: string
          title: Instrument Type
          description: 'Kind of instrument. One of: card, bank_account, wallet.'
        holder_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Holder Name
          description: Name of the card or account holder.
        nickname:
          anyOf:
            - type: string
            - type: 'null'
          title: Nickname
          description: Borrower-chosen label for this payment method.
        is_active:
          type: boolean
          title: Is Active
          description: >-
            False once the payment method has been removed. Inactive methods
            cannot be attached to autopay or payments.
        last_four:
          type: string
          title: Last Four
          description: Last four digits of the card or account number.
        card_brand:
          anyOf:
            - type: string
            - type: 'null'
          title: Card Brand
          description: Card network (e.g. visa, mastercard). Cards only.
        card_exp_month:
          anyOf:
            - type: integer
            - type: 'null'
          title: Card Exp Month
          description: Card expiration month (1-12). Cards only.
        card_exp_year:
          anyOf:
            - type: integer
            - type: 'null'
          title: Card Exp Year
          description: Card expiration year (four digits). Cards only.
        bank_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Name
          description: Bank name. Bank accounts only.
        bank_account_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Account Type
          description: Bank account type (e.g. checking, savings). Bank accounts only.
        wallet_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Wallet Type
          description: Wallet provider (e.g. apple_pay, google_pay). Wallets only.
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - party_id
        - instrument_type
        - is_active
        - last_four
        - created_at
        - updated_at
      title: PaymentMethodRow
      description: |-
        A stored payment instrument (card, bank account, or wallet)
        belonging to a borrower. Carries display-safe metadata only —
        never full card or account numbers.
    PageMeta:
      properties:
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Opaque token to pass as ?cursor= to fetch the next page.
        has_more:
          type: boolean
          title: Has More
          description: True if more rows exist past this page.
        limit:
          type: integer
          title: Limit
          description: Echo of the resolved page size.
      type: object
      required:
        - has_more
        - limit
      title: PageMeta
      description: >-
        Pagination envelope on list responses. `next_cursor` is non-null when
        more rows exist — pass it back as `cursor` to continue.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      description: >-
        A single parameter-validation failure: `loc` is the path to the
        offending input, `msg` is human-readable, and `type` is the rule that
        failed.
  securitySchemes:
    BearerApiKey:
      type: http
      description: Static API key issued via the client portal. Treat it like a password.
      scheme: bearer
      bearerFormat: ApiKey

````