Payment Method Eligibility

Configure Cashfree payment method eligibility rules to control which methods appear at checkout based on order amount, customer, and transaction context.

The Payment Method Eligibility feature allows you to specify which payment methods are available to customers during a transaction, letting you restrict customer payment options to a selected subset from all the available payment methods.

Supported payment methods

Payment method eligibility is widely used for the cards payment method, supporting a range of card types:

• Credit cards
• Debit cards
• Prepaid cards
• Credit card EMI
• Debit card EMI

Configuring eligibility

Payment eligibility is defined at the order level using the payment_methods_filters parameter in the Create Order API request. This allows for fine-tuned control over which payment methods are available for each transaction.

Sample configuration

The following example demonstrates how to configure payment eligibility using the payment_methods_filters parameter.
You can customise this filter by choosing specific payment methods and applying relevant restrictions.

Sample code

{
  "payment_methods_filters": {
    "methods": {
      "action": "ALLOW",
      "values": [
        "credit_card",
        "debit_card",
        "prepaid_card",
        "credit_card_emi",
        "debit_card_emi"
      ]
    },
    "filters": {
      "card_schemes": {
        "action": "ALLOW",
        "values": ["VISA"]
      },
      "card_suffix": {
        "action": "ALLOW",
        "values": ["1936"]
      },
      "card_issuing_bank": {
        "action": "ALLOW",
        "values": ["AXIS"]
      },
      "card_bins": {
        "action": "ALLOW",
        "values": ["451457"]
      },
      "card_emi_schemes": {
        "action": "ALLOW",
        "values": ["VISA", "MASTERCARD"]
      },
      "card_emi_suffix": {
        "action": "ALLOW",
        "values": ["1936"]
      },
      "card_emi_issuing_bank": {
        "action": "ALLOW",
        "values": ["AXIS"]
      },
      "card_emi_tenure": {
        "action": "ALLOW",
        "values": [3]
      },
      "card_emi_bins": {
        "action": "ALLOW",
        "values": ["451457"]
      }
    }
  }
}

Configuration guidelines

Follow these guidelines to ensure proper use and configuration of the Payment Method Eligibility feature:

• Action field: Always use ALLOW for the action field.

• Card schemes: Values must be in uppercase. For example, VISAor RUPAY.

• Issuing bank: Refer to Cashfree’s list of valid issuing banks.

• Card BINs: Only valid BINs should be used in the card_bins and card_emi_bins filters.

• Card suffix: The last four digits of the card number must be specified for restrictions.

• EMI filters: These should only be used if credit_card_emi or debit_card_emi is included in methods.

• Filter order: Filters can be defined in any order within the filters object.

• Default behaviour: If payment_methods_filters is not defined, all payment methods are supported without restrictions.

• EMI tenure range: The range for card_emi_tenure is from 3 to 36 months.

Supported card networks and issuing banks

The following card networks are supported:

View supported card networks

Sr. no.	Card network
1	RUPAY
2	VISA
3	DINERS
4	MASTERCARD
5	AMEX

The following banks, listed in the table below, can be used to define the card_issuing_bank filter within the payment_methods_filters parameter of the Create Order API.

View supported issuing banks

Sr. no.	Bank name
1	State Bank of India
2	HDFC Bank
3	ICICI Bank
4	Axis Bank
5	Kotak Mahindra Bank
6	RBL Bank
7	Union Bank of India
8	Bank of Baroda
9	IndusInd Bank
10	Punjab National Bank
11	Canara Bank
12	IDFC First Bank
13	Yes Bank
14	IDBI Bank
15	Federal Bank
16	Citibank
17	Citibank N.A.
18	Bank of India
19	American Express
20	Standard Chartered Bank
21	AU Small Finance Bank
22	HSBC Bank
23	Indian Overseas Bank
24	Indian Bank
25	Central Bank of India
26	UCO Bank
27	Jammu & Kashmir Bank
28	India Post Payments Bank
29	South Indian Bank
30	Paytm Payments Bank
31	DBS Bank
32	SBI Cards and Payment Services Limited
33	Karur Vysya Bank
34	Airtel Payments Bank
35	Karnataka Bank
36	City Union Bank
37	NPCI
38	Punjab & Sind Bank
39	Bandhan Bank
40	Saraswat Co-operative Bank
41	Tamilnad Mercantile Bank
42	BOB Financial Solutions Limited (BFSL)
43	CSB Bank (Catholic Syrian Bank)
44	SBM Bank India
45	Ujjivan Bank
46	Abhyudaya Co-operative Bank
47	Equitas Small Finance Bank
48	Fino Payments Bank
49	TDCB
50	State Bank of Mauritius
51	Cosmos Co-operative Bank
52	Bank of Maharashtra
53	Thane Janata Sahakari Bank
54	Diners Club International
55	Bassein Catholic Co-operative Bank
56	DCB Bank
57	Shamrao Vithal Co-operative Bank
58	Fincare Small Finance Bank
59	Bobcard Limited
60	Dhanlaxmi Bank
61	JP Morgan Chase Bank N.A.
62	Bharat Co-operative Bank Mumbai
63	Parsik Janata Sahakari Bank
64	Utkarsh Small Finance Bank
65	ESAF Small Finance Bank
66	NSDL Payments Bank
67	Tamil Nadu State Co-operative Bank
68	Jana Small Finance Bank
69	NKGSB Co-operative Bank
70	Apna Sahakari Bank
71	Kalyan Janata Sahakari Bank
72	SVC Co-operative Bank
73	MUBL (Mehsana Urban Co-operative Bank Ltd.)
74	West Bengal State Co-operative Bank
75	Gujarat State Co-operative Bank
76	Dombivili Nagari Sahakari Bank
77	NDCI
78	Janata Sahakari Bank
79	Greater Bombay Co-operative Bank
80	Kalupur Commercial Co-operative Bank
81	Commonwealth Bank of Australia
82	Citizencredit Co-operative Bank
83	Capital One, National Association
84	Bank of Nova Scotia
85	Tangerine Bank
86	Rajkot Nagarik Sahakari Bank
87	Revolut Ltd

Related topics

• Create Order API
• Get Eligible Payment Methods API
• Configuring Payment Options