> ## 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.

# Generate payout method schemas

> Returns available payout method types and their field schemas (required fields, types, validation)
for the given country. Use this to build dynamic create forms for payout methods.




## OpenAPI

````yaml https://api.withacclaim.com/openapi.yaml get /payout_method_schemas
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:
  /payout_method_schemas:
    get:
      tags:
        - Payout Methods
      summary: Generate payout method schemas
      description: >
        Returns available payout method types and their field schemas (required
        fields, types, validation)

        for the given country. Use this to build dynamic create forms for payout
        methods.
      parameters:
        - name: country
          in: query
          required: true
          schema:
            type: string
            minLength: 2
            maxLength: 2
          description: ISO 3166-1 alpha-2 country code (e.g. US)
        - name: entity_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - Individual
              - Company
            default: Individual
          description: Entity type of payee
      responses:
        '200':
          description: List of payout method schemas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutMethodSchemaListResponse'
        '400':
          description: Missing or invalid query parameters (e.g. country required).
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    PayoutMethodSchemaListResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/PayoutMethodSchema'
    PayoutMethodSchema:
      type: object
      properties:
        payout_method_type:
          type: string
          example: UnitedStatesAch
          description: Schema key; use when creating a payout method
        description:
          type: string
          description: Human-readable description of the payout method
        currency:
          type: string
          nullable: true
          description: ISO 4217 currency code
        country:
          type: string
          nullable: true
          description: Supported country code or JSON array of codes
        fields:
          type: array
          items:
            $ref: '#/components/schemas/PayoutMethodSchemaField'
    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
    PayoutMethodSchemaField:
      type: object
      properties:
        name:
          type: string
          description: Field name; use as key when creating a payout method
        label:
          type: string
        type:
          type: string
          example: text
          description: Field type (text, select, hidden, etc.)
        required:
          type: boolean
        placeholder:
          type: string
          nullable: true
        maxLength:
          type: integer
          nullable: true
        minLength:
          type: integer
          nullable: true
        pattern:
          type: string
          nullable: true
          description: Regex for client-side validation
        options:
          type: array
          nullable: true
          description: For select/radio; array of { value, label }
        helpText:
          type: string
          nullable: true
        entityTypeConstraint:
          type: string
          nullable: true
          description: Individual or Company when field is entity-specific
  responses:
    ErrorResponse:
      description: Error payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````