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

# List the payment methods to show

> The methods the policy offers and a processor can take now, in order, each with its placement and what it needs; the others with their reason. A publishable key gets no processor gaps.



## OpenAPI

````yaml /payments-api/openapi.json post /v1/eligible-methods
openapi: 3.1.0
info:
  title: TagadaPay Payments API
  version: '2026-11-01'
servers:
  - url: https://api.tagada.io
security: []
paths:
  /v1/eligible-methods:
    post:
      tags:
        - eligibility
      summary: List the payment methods to show
      description: >-
        The methods the policy offers and a processor can take now, in order,
        each with its placement and what it needs; the others with their reason.
        A publishable key gets no processor gaps.
      operationId: eligibility.list
      parameters:
        - in: header
          name: payments-account
          required: false
          schema:
            type: string
        - in: header
          name: payments-version
          required: false
          schema:
            enum:
              - '2026-11-01'
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEligibleMethods'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EligibleMethods'
          description: Eligible methods.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: parameter_invalid, parameter_missing, amount_out_of_range
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: authentication_required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: permission_denied
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: no_active_policy
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: rate_limited
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: internal_error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: not_implemented
      security:
        - bearerAuth: []
components:
  schemas:
    ListEligibleMethods:
      additionalProperties: false
      properties:
        amount:
          description: Integer amount in the currency minor unit.
          minimum: 0
          type: integer
        country:
          pattern: ^[A-Z]{2}$
          type:
            - string
            - 'null'
        currency:
          enum:
            - AED
            - AFN
            - ALL
            - AMD
            - AOA
            - ARS
            - AUD
            - AWG
            - AZN
            - BAM
            - BBD
            - BDT
            - BHD
            - BIF
            - BMD
            - BND
            - BOB
            - BOV
            - BRL
            - BSD
            - BTN
            - BWP
            - BYN
            - BZD
            - CAD
            - CDF
            - CHE
            - CHF
            - CHW
            - CLF
            - CLP
            - CNY
            - COP
            - COU
            - CRC
            - CUP
            - CVE
            - CZK
            - DJF
            - DKK
            - DOP
            - DZD
            - EGP
            - ERN
            - ETB
            - EUR
            - FJD
            - FKP
            - GBP
            - GEL
            - GHS
            - GIP
            - GMD
            - GNF
            - GTQ
            - GYD
            - HKD
            - HNL
            - HTG
            - HUF
            - IDR
            - ILS
            - INR
            - IQD
            - IRR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KGS
            - KHR
            - KMF
            - KPW
            - KRW
            - KWD
            - KYD
            - KZT
            - LAK
            - LBP
            - LKR
            - LRD
            - LSL
            - LYD
            - MAD
            - MDL
            - MGA
            - MKD
            - MMK
            - MNT
            - MOP
            - MRU
            - MUR
            - MVR
            - MWK
            - MXN
            - MXV
            - MYR
            - MZN
            - NAD
            - NGN
            - NIO
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - PYG
            - QAR
            - RON
            - RSD
            - RUB
            - RWF
            - SAR
            - SBD
            - SCR
            - SDG
            - SEK
            - SGD
            - SHP
            - SLE
            - SOS
            - SRD
            - SSP
            - STN
            - SVC
            - SYP
            - SZL
            - THB
            - TJS
            - TMT
            - TND
            - TOP
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - UGX
            - USD
            - USN
            - UYI
            - UYU
            - UYW
            - UZS
            - VED
            - VES
            - VND
            - VUV
            - WST
            - XAD
            - XAF
            - XCD
            - XCG
            - XOF
            - XPF
            - YER
            - ZAR
            - ZMW
            - ZWG
          type: string
        customer:
          pattern: ^cus_[a-f0-9]{12}$
          type: string
        device:
          maxLength: 40
          minLength: 1
          type: string
        store:
          pattern: ^store_[a-f0-9]{12}$
          type: string
      required:
        - amount
        - currency
      type: object
    EligibleMethods:
      additionalProperties: false
      properties:
        hidden:
          items:
            additionalProperties: false
            properties:
              method:
                enum:
                  - card
                  - apple_pay
                  - google_pay
                  - link
                  - paypal
                  - klarna
                  - afterpay
                  - ideal
                type: string
                x-extensible-enum:
                  - card
                  - apple_pay
                  - google_pay
                  - link
                  - paypal
                  - klarna
                  - afterpay
                  - ideal
              processors:
                description: >-
                  Each processor of the flow with its gaps; null for a
                  publishable key.
                items:
                  additionalProperties: false
                  properties:
                    gaps:
                      items:
                        type: string
                      type: array
                    processor:
                      type: string
                  required:
                    - processor
                    - gaps
                  type: object
                type:
                  - array
                  - 'null'
              reason:
                enum:
                  - payment_method_not_eligible
                  - payment_method_not_available
                type: string
                x-extensible-enum:
                  - payment_method_not_eligible
                  - payment_method_not_available
            required:
              - method
              - reason
              - processors
            type: object
          type: array
        object:
          enum:
            - eligible_methods
          type: string
        shown:
          items:
            additionalProperties: false
            properties:
              method:
                enum:
                  - card
                  - apple_pay
                  - google_pay
                  - link
                  - paypal
                  - klarna
                  - afterpay
                  - ideal
                type: string
                x-extensible-enum:
                  - card
                  - apple_pay
                  - google_pay
                  - link
                  - paypal
                  - klarna
                  - afterpay
                  - ideal
              placement:
                enum:
                  - wallet
                  - form
                  - redirect
                  - widget
                type: string
                x-extensible-enum:
                  - wallet
                  - form
                  - redirect
                  - widget
              requires:
                additionalProperties: false
                properties:
                  redirect:
                    type: boolean
                  three_ds_likely:
                    type: boolean
                  wallet_domain:
                    type: boolean
                required:
                  - wallet_domain
                  - redirect
                  - three_ds_likely
                type: object
            required:
              - method
              - placement
              - requires
            type: object
          type: array
      required:
        - object
        - shown
        - hidden
      type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              $ref: '#/components/schemas/ErrorCode'
            details:
              additionalProperties: {}
              type: object
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            request_id:
              type: string
            type:
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - unavailable_error
              type: string
          required:
            - type
            - code
            - message
            - param
            - request_id
          type: object
      required:
        - error
      type: object
    ErrorCode:
      enum:
        - account_daily_cap_exceeded
        - account_not_enabled
        - amount_out_of_range
        - authentication_required
        - checkout_session_in_use
        - currency_not_supported
        - fx_rate_unavailable
        - idempotency_key_in_progress
        - idempotency_key_reused
        - internal_error
        - no_active_policy
        - not_implemented
        - parameter_invalid
        - parameter_missing
        - parent_payment_invalid
        - parent_payment_not_allowed
        - parent_payment_not_paid
        - payment_method_not_usable
        - payment_method_required
        - payment_method_save_disabled
        - payment_not_confirmable
        - payment_not_retryable
        - payments_api_disabled
        - permission_denied
        - rate_limited
        - resource_not_found
        - retry_exists
        - retry_limit_reached
        - store_not_on_payments_api
        - stored_credential_missing
      type: string
      x-extensible-enum:
        - account_daily_cap_exceeded
        - account_not_enabled
        - amount_out_of_range
        - authentication_required
        - checkout_session_in_use
        - currency_not_supported
        - fx_rate_unavailable
        - idempotency_key_in_progress
        - idempotency_key_reused
        - internal_error
        - no_active_policy
        - not_implemented
        - parameter_invalid
        - parameter_missing
        - parent_payment_invalid
        - parent_payment_not_allowed
        - parent_payment_not_paid
        - payment_method_not_usable
        - payment_method_required
        - payment_method_save_disabled
        - payment_not_confirmable
        - payment_not_retryable
        - payments_api_disabled
        - permission_denied
        - rate_limited
        - resource_not_found
        - retry_exists
        - retry_limit_reached
        - store_not_on_payments_api
        - stored_credential_missing
  securitySchemes:
    bearerAuth:
      description: >-
        Secret, platform or publishable API key. Platform keys require
        Payments-Account.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.