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"
}
]
}
}
]{
"message": "bad URL, please check API documentation",
"code": "request_failed",
"type": "invalid_request_error"
}{
"message": "authentication Failed",
"code": "request_failed",
"type": "authentication_error"
}{
"message": "something is not found",
"code": "somethind_not_found",
"type": "invalid_request_error"
}{
"message": "something is not found",
"code": "request_invalid",
"type": "idempotency_error"
}{
"message": "Too many requests from IP. Check headers",
"code": "request_failed",
"type": "rate_limit_error"
}{
"message": "internal Server Error",
"code": "internal_error",
"type": "api_error"
}API to get all the payment method details available for subscription payments.
Use this API to check if a payment method is enabled for your account.
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"
}
]
}
}
]{
"message": "bad URL, please check API documentation",
"code": "request_failed",
"type": "invalid_request_error"
}{
"message": "authentication Failed",
"code": "request_failed",
"type": "authentication_error"
}{
"message": "something is not found",
"code": "somethind_not_found",
"type": "invalid_request_error"
}{
"message": "something is not found",
"code": "request_invalid",
"type": "idempotency_error"
}{
"message": "Too many requests from IP. Check headers",
"code": "request_failed",
"type": "rate_limit_error"
}{
"message": "internal Server Error",
"code": "internal_error",
"type": "api_error"
}Authorizations
XClientID & XClientSecretXClientID & XPartnerAPIKeyXClientID & XClientSignatureHeaderXPartnerMerchantID & XPartnerAPIKey
Client app ID. You can find your app id in the Merchant Dashboard.
Client secret key. You can find your secret in the Merchant Dashboard.
Headers
Body
application/json
Request body to fetch subscription eligibile payment method details.
