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

# List payers



## OpenAPI

````yaml https://api.withacclaim.com/openapi.yaml get /payers
openapi: 3.1.0
info:
  title: Acclaim API
  version: 1.0.0
  description: >
    Payments infrastructure built for the insurance industry. This specification
    describes

    the core resources and operations for treasury accounts, payouts, funding,
    and more.


    Authentication uses a secret API key passed as a Bearer token. The API is
    JSON-only

    and available via HTTPS only.
servers:
  - url: https://api.withacclaim.com/v1
security:
  - bearerAuth: []
tags:
  - name: Treasury / Treasury Accounts
    description: Manage treasury accounts and balances.
  - name: Payees
    description: Manage recipients of payouts.
  - name: Payout Methods
    description: Manage payout methods (e.g. bank accounts) for a payee.
  - name: Payouts
    description: Create and track individual payouts.
  - name: Payout Batches
    description: Create and track groups of payouts.
  - name: Treasury / Funding
    description: Move funds between settlement accounts and treasury accounts.
  - name: Payment Requests
    description: Create and manage payment requests for collecting payments.
  - name: Setup Requests
    description: Create and manage setup requests for securely storing payment methods.
  - name: Refunds
    description: Create and manage refunds for payments.
  - name: Payers
    description: Create and manage payers for payment collection.
  - name: Payment Methods
    description: Manage payment methods (e.g. cards, bank accounts) for a payer.
paths:
  /payers:
    get:
      tags:
        - Payers
      summary: List payers
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - in: query
          name: cursor
          schema:
            type: string
      responses:
        '200':
          description: A list of payers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPayersResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    ListPayersResponse:
      allOf:
        - $ref: '#/components/schemas/CursorPage'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Payer'
    CursorPage:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
        next_cursor:
          type: string
          nullable: true
        has_more:
          type: boolean
    Payer:
      type: object
      properties:
        id:
          type: string
          example: pyr_AbC123XyZ
        identifier:
          type: string
          example: PAYER-2025-001
        name:
          type: string
          example: John Doe
          description: Full name for individual or business name
        given_name:
          type: string
          nullable: true
          example: John
        family_name:
          type: string
          nullable: true
          example: Doe
        middle_name:
          type: string
          nullable: true
        company_name:
          type: string
          nullable: true
          example: Acme Corp
        email:
          type: string
          format: email
          nullable: true
          example: john.doe@example.com
        phone:
          type: string
          nullable: true
          description: E.164 formatted phone number
          example: '+15551234567'
        tax_id:
          type: string
          nullable: true
          example: 12-3456789
          description: Tax identification number
        address:
          allOf:
            - $ref: '#/components/schemas/Address'
          nullable: true
        metadata:
          type: object
          nullable: true
          description: Optional metadata as key-value pairs
          additionalProperties: true
          example:
            custom_field: value
            source: api
        created_at:
          type: string
          format: date-time
          example: '2025-10-08T18:20:31Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-10-08T18:25:00Z'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
              example: 'Missing required field: amount'
            details:
              type: object
              additionalProperties: true
            request_id:
              type: string
              example: req_7lYt4o2x
    Address:
      type: object
      required:
        - country
      properties:
        country:
          type: string
          description: ISO 3166-1 alpha-2 country code
          example: US
          minLength: 2
          maxLength: 2
        address1:
          type: string
          nullable: true
          example: 123 Main St
          maxLength: 255
        address2:
          type: string
          nullable: true
          example: Suite 100
          maxLength: 255
        city:
          type: string
          nullable: true
          example: New York
          maxLength: 255
        state:
          type: string
          nullable: true
          example: NY
          maxLength: 255
        postal_code:
          type: string
          nullable: true
          example: '10001'
          maxLength: 255
  responses:
    ErrorResponse:
      description: Error payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````