Skip to main content
POST
/
eligibility
/
payment_methods
curl --request POST \
  --url https://sandbox.cashfree.com/pg/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": {
    "amount": 100
  }
}
'
[
  {
    "eligibility": true,
    "entity_type": "payment_methods",
    "entity_value": "netbanking",
    "entity_details": {
      "payment_method_details": [
        {
          "nick": "motak_kahindra_bank",
          "display": "Motak Kahindra Bank",
          "eligibility": true,
          "code": 3032
        },
        {
          "nick": "bank_of_india",
          "display": "Bank Of India",
          "eligibility": true,
          "code": 3031
        }
      ]
    }
  }
]
Run in Postman: You can also try this API in our Postman Collection.

​
Client environment headers

Cashfree requires information about the customer’s device environment to enforce NPCI rules. You must include the following headers in your Order Pay API and Get Eligible Payment Methods request:
HeaderAccepted valuesRequirementDescription
x-client-devicemobile, desktop, tabletRequiredType of device used by customer
x-client-osandroid, ios, windows, macos, linux, othersRequiredOperating system of customer’s device
x-client-rendering-typemweb, webview, nativeRequired when x-client-device is mobileRendering method used for the checkout experience
x-client-browsersafari, chrome, firefox, edge, othersRequiredBrowser used by the customer
x-client-rendering-type is required only when x-client-device is set to mobile. For desktop and tablet devices, this header is optional.

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 parameters to get eligible Payment Methods.

​
queries
PaymentMethodsQueries · object
required

Payment Method Query Object.

Example:
{ "amount": 100 }
​
filters
PaymentMethodsFilters · object

Filter for Payment Methods.

Example:
{ "payment_methods": null }

Response

Success response for getting eligible Payment Methods.

​
eligibility
boolean
Example:

true

​
entity_type
string
Example:

"payment_methods"

​
entity_value
string
Example:

"netbanking"

​
entity_details
object
Example:
{
  "payment_method_details": [
    {
      "nick": "motak_kahindra_bank",
      "display": "Motak Kahindra Bank",
      "eligibility": true,
      "code": 3032
    },
    {
      "nick": "bank_of_india",
      "display": "Bank Of India",
      "eligibility": true,
      "code": 3031
    }
  ]
}