Skip to main content
POST
/
subscriptions
/
eligibility
/
payment_methods
curl --request POST \
  --url https://sandbox.cashfree.com/pg/subscriptions/eligibility/payment_methods \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "queries": {
    "subscription_id": "test-subscription-1"
  },
  "filters": {
    "payment_methods": []
  }
}
'
[
  {
    "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"
        }
      ]
    }
  }
]

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app id in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

​
x-api-version
string
default:2023-08-01
required

API version to be used. Format is in YYYY-MM-DD API version to be used

​
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

​
x-idempotency-key
string<UUID>

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.

Body

application/json

Request body to fetch subscription eligibile payment method details.

Request body to fetch subscription eligibile payment method details.

​
queries
object
required

Necessary parameters to fetch eligible payment methods.

​
filters
object

Filters to refine eligible payment method selection.

Response

Subscrition eligibility API 200 response

Subscrition eligibility API response

​
type
EligibilityMethodItem · object[]

List of eligibile payment methods for the subscription.