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

# Get All the Payment Method Details Available for Subscription Payments

> Use this API to check if a payment method is enabled for your account.



## OpenAPI

````yaml /openapi/payments/v2025-01-01.yaml post /subscriptions/eligibility/payment_methods
openapi: 3.0.0
info:
  version: '2025-01-01'
  title: Cashfree Payment Gateway APIs
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    email: developers@cashfree.com
    name: API Support
    url: https://discord.com/invite/QdZkNSxXsB
  description: >-
    Cashfree's Payment Gateway APIs provide developers with a streamlined
    pathway to integrate advanced payment processing capabilities into their
    applications, platforms and websites.
servers:
  - url: https://sandbox.cashfree.com/pg
    description: Sandbox server.
  - url: https://api.cashfree.com/pg
    description: Production server.
security: []
tags:
  - name: Orders
    description: Collection of APIs to handle orders.
  - name: Payments
    description: Collection of APIs to handle payments.
  - name: Refunds
    description: Collection of APIs to handle refunds.
  - name: Settlements
    description: Collection of APIs to handle settlements.
  - name: Payment Links
    description: Collection of APIs to handle payment links.
  - name: Token Vault
    description: >-
      Collection of APIs to use Cashfree's token Vault. This helps you save
      cards and tokenize them in a PCI complaint manner. We support creation of
      network tokens which can be used across acquiring banks.
  - name: softPOS
    description: Collection of APIs to manage softPOS' agent and order.
  - name: Offers
    description: Collection of APIs to handle offers.
  - name: Eligibility
    description: >-
      Collection of APIs to check eligibile entities - payment methods, offer,
      affordibility.
  - name: Settlement Reconciliation
    description: Collection of APIs to handle settlements.
  - name: PG Reconciliation
    description: Collection of APIs to handle reconciliation.
  - name: Customers
    description: Collection of APIs to handle customers.
  - name: Easy-Split
    description: Collection of APIs to handle Easy-Split.
  - name: Simulation
    description: Collection of APIs to handle simulation.
  - name: Disputes
    description: Collection of APIs to handle disputes.
  - name: Utilities
    description: Collection of APIs for utility requirement.
  - name: Downtimes
    description: Collection of APIs for managing downtimes.
externalDocs:
  url: https://api.cashfree.com/pg
  description: This url will have the information of all the APIs.
paths:
  /subscriptions/eligibility/payment_methods:
    post:
      tags:
        - Subscription
      summary: Get All the Payment Method Details Available for Subscription Payments
      description: Use this API to check if a payment method is enabled for your account.
      operationId: SubscriptionEligibility
      parameters:
        - $ref: '#/components/parameters/apiVersionHeader'
        - $ref: '#/components/parameters/xRequestIDHeader'
        - $ref: '#/components/parameters/xIdempotencyKeyHeader'
      requestBody:
        $ref: '#/components/requestBodies/SubscriptionEligibilityRequest'
      responses:
        '200':
          $ref: '#/components/responses/SubscriptionEligibility200Response'
        '400':
          $ref: '#/components/responses/Response400'
        '401':
          $ref: '#/components/responses/Response401'
        '404':
          $ref: '#/components/responses/Response404'
        '422':
          $ref: '#/components/responses/Response422'
        '429':
          $ref: '#/components/responses/Response429'
        '500':
          $ref: '#/components/responses/Response500'
      deprecated: false
      security:
        - XClientID: []
          XClientSecret: []
        - XClientID: []
          XPartnerAPIKey: []
        - XClientID: []
          XClientSignatureHeader: []
        - XPartnerMerchantID: []
          XPartnerAPIKey: []
components:
  parameters:
    apiVersionHeader:
      in: header
      name: x-api-version
      required: true
      description: API version to be used. Format is in YYYY-MM-DD.
      schema:
        type: string
        description: API version to be used.
        default: '2025-01-01'
      example: '2025-01-01'
      x-ignore: true
    xRequestIDHeader:
      in: header
      name: x-request-id
      description: >-
        Request ID for the API call. Can be used to resolve tech issues.
        Communicate this in your tech related queries to Cashfree.
      required: false
      schema:
        type: string
      example: 4dfb9780-46fe-11ee-be56-0242ac120002
    xIdempotencyKeyHeader:
      in: header
      name: x-idempotency-key
      required: false
      description: >
        An idempotency key is a unique identifier you include with your API
        call.

        If the request fails or times out, you can safely retry it using the
        same key to avoid duplicate actions.
      schema:
        type: string
        format: UUID
      example: 47bf8872-46fe-11ee-be56-0242ac120002
  requestBodies:
    SubscriptionEligibilityRequest:
      description: >-
        Request parameters to check if a payment method is enabled for your
        account.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionEligibilityRequest'
          examples:
            no filters:
              value:
                queries:
                  subscription_id: test-subscription-1
                filters:
                  payment_methods: []
            upi and enach filter:
              value:
                queries:
                  subscription_id: test-subscription-1
                filters:
                  payment_methods:
                    - upi
                    - enach
  responses:
    SubscriptionEligibility200Response:
      description: >-
        Success response for checking if a payment method is enabled for your
        account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionEligibilityResponse'
          examples:
            all payment methods response:
              value:
                - eligibility: true
                  entity_type: payment_methods
                  entity_value: enach
                  entity_details:
                    account_types:
                      - SAVINGS
                      - CURRENT
                    frequent_bank_details:
                      - bank_id: SBIN
                        bank_name: STATE BANK OF INDIA
                        account_auth_modes:
                          - DEBIT_CARD
                          - NET_BANKING
                      - bank_id: BARB
                        bank_name: BANK OF BARODA
                        account_auth_modes:
                          - DEBIT_CARD
                          - NET_BANKING
                      - bank_id: ICIC
                        bank_name: ICICI BANK LTD
                        account_auth_modes:
                          - DEBIT_CARD
                          - NET_BANKING
                          - AADHAAR
                      - bank_id: HDFC
                        bank_name: HDFC BANK LTD
                        account_auth_modes:
                          - DEBIT_CARD
                          - NET_BANKING
                          - AADHAAR
                    all_bank_details:
                      - bank_id: SBIN
                        bank_name: STATE BANK OF INDIA
                        account_auth_modes:
                          - DEBIT_CARD
                          - NET_BANKING
                      - bank_id: BARB
                        bank_name: BANK OF BARODA
                        account_auth_modes:
                          - DEBIT_CARD
                          - NET_BANKING
                      - bank_id: ICIC
                        bank_name: ICICI BANK LTD
                        account_auth_modes:
                          - DEBIT_CARD
                          - NET_BANKING
                          - AADHAAR
                      - bank_id: HDFC
                        bank_name: HDFC BANK LTD
                        account_auth_modes:
                          - DEBIT_CARD
                          - NET_BANKING
                          - AADHAAR
                      - bank_id: UTKS
                        bank_name: UTKARSH SMALL FINANCE BANK LTD
                        account_auth_modes:
                          - DEBIT_CARD
                      - bank_id: YESB
                        bank_name: YES BANK
                        account_auth_modes:
                          - DEBIT_CARD
                          - NET_BANKING
                          - AADHAAR
                - eligibility: true
                  entity_type: payment_methods
                  entity_value: upi
                  entity_details:
                    available_handles:
                      - handle: okaxis
                        application: Google Pay
                      - handle: ybl
                        application: PhonePe
                - eligibility: true
                  entity_type: payment_methods
                  entity_value: card
                  entity_details:
                    allowed_card_types:
                      - CREDIT_CARD
                      - DEBIT_CARD
                - eligibility: true
                  entity_type: payment_methods
                  entity_value: pnach
                  entity_details:
                    account_types:
                      - SAVINGS
                      - CURRENT
                    all_bank_details:
                      - bank_id: SRIX
                        bank_name: SRI SATYA SAI NAGRIK SAHAKARI BANK MYDT, BHOPAL
                      - bank_id: ISUX
                        bank_name: THE ISLAMPUR URBAN CO OPERATIVE BANK LIMITED
                      - bank_id: ZCBL
                        bank_name: THE ZOROASTRIAN CO OP BANK LTD
    Response400:
      description: Bad request error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
      headers:
        x-api-version:
          $ref: '#/components/headers/x-api-version'
        x-ratelimit-limit:
          $ref: '#/components/headers/x-ratelimit-limit'
        x-ratelimit-remaining:
          $ref: '#/components/headers/x-ratelimit-remaining'
        x-ratelimit-retry:
          $ref: '#/components/headers/x-ratelimit-retry'
        x-ratelimit-type:
          $ref: '#/components/headers/x-ratelimit-type'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
        x-idempotency-key:
          $ref: '#/components/headers/x-idempotency-key'
        x-idempotency-replayed:
          $ref: '#/components/headers/x-idempotency-replayed'
    Response401:
      description: Authentication Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthenticationError'
      headers:
        x-api-version:
          $ref: '#/components/headers/x-api-version'
        x-ratelimit-limit:
          $ref: '#/components/headers/x-ratelimit-limit'
        x-ratelimit-remaining:
          $ref: '#/components/headers/x-ratelimit-remaining'
        x-ratelimit-retry:
          $ref: '#/components/headers/x-ratelimit-retry'
        x-ratelimit-type:
          $ref: '#/components/headers/x-ratelimit-type'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
        x-idempotency-key:
          $ref: '#/components/headers/x-idempotency-key'
        x-idempotency-replayed:
          $ref: '#/components/headers/x-idempotency-replayed'
    Response404:
      description: Resource Not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError404'
      headers:
        x-api-version:
          $ref: '#/components/headers/x-api-version'
        x-ratelimit-limit:
          $ref: '#/components/headers/x-ratelimit-limit'
        x-ratelimit-remaining:
          $ref: '#/components/headers/x-ratelimit-remaining'
        x-ratelimit-retry:
          $ref: '#/components/headers/x-ratelimit-retry'
        x-ratelimit-type:
          $ref: '#/components/headers/x-ratelimit-type'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
        x-idempotency-key:
          $ref: '#/components/headers/x-idempotency-key'
        x-idempotency-replayed:
          $ref: '#/components/headers/x-idempotency-replayed'
    Response422:
      description: Idempotency error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IdempotencyError'
      headers:
        x-api-version:
          $ref: '#/components/headers/x-api-version'
        x-ratelimit-limit:
          $ref: '#/components/headers/x-ratelimit-limit'
        x-ratelimit-remaining:
          $ref: '#/components/headers/x-ratelimit-remaining'
        x-ratelimit-retry:
          $ref: '#/components/headers/x-ratelimit-retry'
        x-ratelimit-type:
          $ref: '#/components/headers/x-ratelimit-type'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
        x-idempotency-key:
          $ref: '#/components/headers/x-idempotency-key'
        x-idempotency-replayed:
          $ref: '#/components/headers/x-idempotency-replayed'
    Response429:
      description: Rate Limit Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitError'
      headers:
        x-api-version:
          $ref: '#/components/headers/x-api-version'
        x-ratelimit-limit:
          $ref: '#/components/headers/x-ratelimit-limit'
        x-ratelimit-remaining:
          $ref: '#/components/headers/x-ratelimit-remaining'
        x-ratelimit-retry:
          $ref: '#/components/headers/x-ratelimit-retry'
        x-ratelimit-type:
          $ref: '#/components/headers/x-ratelimit-type'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
        x-idempotency-key:
          $ref: '#/components/headers/x-idempotency-key'
        x-idempotency-replayed:
          $ref: '#/components/headers/x-idempotency-replayed'
    Response500:
      description: API related Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        x-api-version:
          $ref: '#/components/headers/x-api-version'
        x-ratelimit-limit:
          $ref: '#/components/headers/x-ratelimit-limit'
        x-ratelimit-remaining:
          $ref: '#/components/headers/x-ratelimit-remaining'
        x-ratelimit-retry:
          $ref: '#/components/headers/x-ratelimit-retry'
        x-ratelimit-type:
          $ref: '#/components/headers/x-ratelimit-type'
        x-request-id:
          $ref: '#/components/headers/x-request-id'
        x-idempotency-key:
          $ref: '#/components/headers/x-idempotency-key'
        x-idempotency-replayed:
          $ref: '#/components/headers/x-idempotency-replayed'
  schemas:
    SubscriptionEligibilityRequest:
      title: SubscriptionEligibilityRequest
      properties:
        queries:
          type: object
          description: Necessary parameters to fetch eligible payment methods.
          properties:
            subscription_id:
              type: string
              description: A unique ID passed by merchant for identifying the subscription.
          required:
            - subscription_id
        filters:
          type: object
          description: Filters to refine eligible payment method selection.
          properties:
            payment_methods:
              type: array
              description: Possbile values in array - enach, pnach, upi, card.
              items:
                type: string
      required:
        - queries
    SubscriptionEligibilityResponse:
      title: SubscriptionEligibilityResponse
      description: Subscrition eligibility API response.
      properties:
        type:
          type: array
          description: List of eligibile payment methods for the subscription.
          items:
            $ref: '#/components/schemas/EligibilityMethodItem'
    BadRequestError:
      title: BadRequestError
      description: Invalid request received from client.
      example:
        message: bad URL, please check API documentation
        help: >-
          Check latest errors and resolution from Merchant Dashboard API logs:
          https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9
        code: request_failed
        type: invalid_request_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        help:
          type: string
        type:
          type: string
          enum:
            - invalid_request_error
    AuthenticationError:
      title: AuthenticationError
      description: Error if api keys are wrong.
      example:
        message: authentication Failed
        code: request_failed
        type: authentication_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        type:
          type: string
          description: authentication_error.
    ApiError404:
      title: ApiError404
      description: Error when resource requested is not found.
      example:
        message: something is not found
        help: >-
          Check latest errors and resolution from Merchant Dashboard API logs:
          https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9
        code: something_not_found
        type: invalid_request_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        help:
          type: string
        type:
          type: string
          enum:
            - invalid_request_error
          description: invalid_request_error.
    IdempotencyError:
      title: IdempotencyError
      description: >-
        Error when idempotency fails. Different request body with the same
        idempotent key.
      example:
        message: something is not found
        help: >-
          Check latest errors and resolution from Merchant Dashboard API logs:
          https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9
        code: request_invalid
        type: idempotency_error
      type: object
      properties:
        message:
          type: string
        help:
          type: string
        code:
          type: string
        type:
          type: string
          enum:
            - idempotency_error
          description: idempotency_error.
    RateLimitError:
      title: RateLimitError
      description: Error when rate limit is breached for your api.
      example:
        message: Too many requests from IP. Check headers
        code: request_failed
        type: rate_limit_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        type:
          type: string
          enum:
            - rate_limit_error
          description: rate_limit_error.
    ApiError:
      title: ApiError
      description: Error at Cashfree's server.
      example:
        message: internal Server Error
        help: >-
          Check latest errors and resolution from Merchant Dashboard API logs:
          https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9
        code: internal_error
        type: api_error
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        help:
          type: string
        type:
          type: string
          enum:
            - api_error
          description: api_error.
    EligibilityMethodItem:
      title: EligibilityMethodItem
      description: Eligibile payment method object.
      properties:
        eligibility:
          type: boolean
          description: Indicates whether the payment method is eligible.
        entity_type:
          type: string
          description: Type of entity (e.g., "payment_methods").
        entity_value:
          type: string
          description: Payment method (e.g., enach, pnach, upi, card).
        entity_details:
          type: object
          properties:
            account_types:
              type: array
              items:
                type: string
              description: >-
                List of account types associated with the payment method. (e.g.
                SAVINGS or CURRENT).
            frequent_bank_details:
              type: array
              description: List of the most frequently used banks.
              items:
                $ref: '#/components/schemas/SubscriptionBankDetails'
            all_bank_details:
              type: array
              description: Details about all banks associated with the payment method.
              items:
                $ref: '#/components/schemas/SubscriptionBankDetails'
            available_handles:
              type: array
              description: List of supported VPA handles.
              items:
                type: object
                properties:
                  handle:
                    type: string
                    description: VPA handle.
                  application:
                    type: string
                    description: Application or service related to the VPA handle.
            allowed_card_types:
              type: array
              description: List of allowed card types. (e.g. DEBIT_CARD, CREDIT_CARD).
              items:
                type: string
                description: List of allowed card types associated with the payment method.
    SubscriptionBankDetails:
      type: object
      description: Bank details object.
      properties:
        bank_id:
          type: string
          description: ID of the bank.
        bank_name:
          type: string
          description: Name of the bank.
        account_auth_modes:
          type: array
          items:
            type: string
          description: >-
            List of account authentication modes supported by the bank. (e.g.
            DEBIT_CARD, NET_BANKING, AADHAAR).
  headers:
    x-api-version:
      schema:
        type: string
        format: YYYY-MM-DD
        enum:
          - '2025-01-01'
      description: >-
        This header has the version of the API. The current version is
        `2025-01-01`.
    x-ratelimit-limit:
      schema:
        type: integer
      example: 200
      description: Ratelimit set for your account for this API per minute.
    x-ratelimit-remaining:
      schema:
        type: integer
      example: 2
      description: >-
        Rate limit remaning for your account for this API in the next minute.
        Uses sliding window.
    x-ratelimit-retry:
      schema:
        type: integer
      example: 4
      description: |
        Contains number of seconds to wait if rate limit is breached
        - Is 0 if withing the limit
        - Is between 1 and 59 if breached
    x-ratelimit-type:
      schema:
        type: string
        enum:
          - app_id
          - ip
      example: ip
      description: >
        either ip or app_id

        - `ip` if making a call from the browser. True for api where you don't
        need `x-client-id` and `x-client-secret`

        - `app_id` for authenticated api calls i.e using `x-client-id` and
        `x-client-secret`
    x-request-id:
      schema:
        type: string
      example: some-req-id
      description: >-
        Request id for your api call. Is blank or null if no `x-request-id` is
        sent during the request.
    x-idempotency-key:
      schema:
        type: string
      example: some-idem-id
      description: >-
        An idempotency key is a unique identifier you include with your API
        call. If the request fails or times out, you can safely retry it using
        the same key to avoid duplicate actions.
    x-idempotency-replayed:
      schema:
        type: string
        format: boolean
      example: 'true'
      description: |-
        In conjunction with `x-idempotency-key` this means
        - `true` if the response was replayed
        - `false` if the response has not been replayed.
  securitySchemes:
    XClientID:
      type: apiKey
      in: header
      name: x-client-id
      description: >-
        Client app ID. You can find your app id in the [Merchant
        Dashboard](https://merchant.cashfree.com/auth/login/pg/developers/api-keys?env=prod).
    XClientSecret:
      type: apiKey
      in: header
      name: x-client-secret
      description: >-
        Client secret key. You can find your secret key in the [Merchant
        Dashboard](https://merchant.cashfree.com/auth/login/pg/developers/api-keys?env=prod).
    XPartnerAPIKey:
      type: apiKey
      in: header
      name: x-partner-apikey
      description: >-
        If you are partner and you are making an api call on behalf of a
        merchant.
    XClientSignatureHeader:
      type: apiKey
      in: header
      name: x-client-signature
      description: >-
        Use this if you do not want to pass the secret key and instead want to
        use signature.
    XPartnerMerchantID:
      type: apiKey
      in: header
      name: x-partner-merchantid
      description: >-
        If you are partner use this to specify the merchant ID if you don't have
        the merchant client app ID.

````