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

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

​
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

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 get eligible payment methods for an account and order

eligibilty request to find eligible payment method

​
queries
object
required

Payment Method Query Object

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

Filter for Payment Methods

Example:
{ "payment_methods": null }

Response

200
application/json
OK
​
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
    }
  ]
}

Was this page helpful?