Skip to main content
POST
/
subscriptions
/
eligibility
/
payment_methods
API to get all the payment method details available for subscription payments.
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": "<string>"
  },
  "filters": {
    "payment_methods": [
      "<string>"
    ]
  }
}
'
{
  "type": [
    {
      "eligibility": true,
      "entity_type": "<string>",
      "entity_value": "<string>",
      "entity_details": {
        "account_types": [
          "<string>"
        ],
        "frequent_bank_details": [
          {
            "bank_id": "<string>",
            "bank_name": "<string>",
            "account_auth_modes": [
              "<string>"
            ]
          }
        ],
        "all_bank_details": [
          {
            "bank_id": "<string>",
            "bank_name": "<string>",
            "account_auth_modes": [
              "<string>"
            ]
          }
        ],
        "available_handles": [
          {
            "handle": "<string>",
            "application": "<string>"
          }
        ],
        "allowed_card_types": [
          "<string>"
        ]
      }
    }
  ]
}

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

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