Cashfree Payments Developer Documentation

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>"
        ]
      }
    }
  ]
}

POST

subscriptions

eligibility

payment_methods

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:2025-01-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.

queries

object

required

Necessary parameters to fetch eligible payment methods.

Show child attributes

queries.subscription_id

string

required

A unique ID passed by merchant for identifying the subscription

filters

object

Filters to refine eligible payment method selection.

Show child attributes

filters.payment_methods

string[]

Possbile values in array - enach, pnach, upi, card.

Response

Subscrition eligibility API 200 response

Subscrition eligibility API response

type

EligibilityMethodItem · object[]

List of eligibile payment methods for the subscription.

Show child attributes

type.eligibility

boolean

Indicates whether the payment method is eligible.

type.entity_type

string

Type of entity (e.g., "payment_methods").

type.entity_value

string

Payment method (e.g., enach, pnach, upi, card).

type.entity_details

object

Show child attributes

type.entity_details.account_types

string[]

List of account types associated with the payment method. (e.g. SAVINGS or CURRENT)

type.entity_details.frequent_bank_details

object[]

List of the most frequently used banks.

Show child attributes

type.entity_details.frequent_bank_details.bank_id

string

ID of the bank.

type.entity_details.frequent_bank_details.bank_name

string

Name of the bank.

type.entity_details.frequent_bank_details.account_auth_modes

string[]

List of account authentication modes supported by the bank. (e.g. DEBIT_CARD, NET_BANKING, AADHAAR)

type.entity_details.all_bank_details

object[]

Details about all banks associated with the payment method.

Show child attributes

type.entity_details.all_bank_details.bank_id

string

ID of the bank.

type.entity_details.all_bank_details.bank_name

string

Name of the bank.

type.entity_details.all_bank_details.account_auth_modes

string[]

List of account authentication modes supported by the bank. (e.g. DEBIT_CARD, NET_BANKING, AADHAAR)

type.entity_details.available_handles

object[]

List of supported VPA handles.

Show child attributes

type.entity_details.available_handles.handle

string

VPA handle

type.entity_details.available_handles.application

string

Application or service related to the VPA handle.

type.entity_details.allowed_card_types

string[]

List of allowed card types. (e.g. DEBIT_CARD, CREDIT_CARD)

List of allowed card types associated with the payment method.

Upload file for Physical Nach Authorisation Generate Transaction Return Summary

⌘I

Payments API

v2025-01-01

Other Versions

Get All the Payment Method Details Available for Subscription Payments

Authorizations

Headers

Body

Response