Use this API to create a subscription in a seamless manner. This allows you to provide your own payment experience to your customers. With this, you can collect all payment details on your webpage and safely send them to Cashfree for processing. The authLink received in the response will redirect the customer to the 2FA page of the issuer/destination bank.
General Pointers
Store the subReferenceId as this is the unique id generated by Cashfree for the subscription. It will be required for subsequent operations.
It is recommended that the checkout page showcases all the subscription and payment details so that the customer can make an informed decision. For e-mandates, the NPCI guidelines state that the checkout information should include but are not limited to the following
- Mandate description
- Account type - Savings or Current
- Bank Name
- Customer Name
- Recurring payment details: This should include the following information
a. Frequency of the subscription
b. Recurring amount/Maximum amount
c. Last Payment date
d. Purpose of the Subscription
Mapping for BankId
| Bank ID | Bank Name |
|---|---|
| CITI | CITIBANK N A |
| DCBL | DCB BANK LTD |
| BDBL | BANDHAN BANK LTD |
| IDIB | INDIAN BANK |
| BARB | BANK OF BARODA |
| CBIN | CENTRAL BANK OF INDIA |
| CIUB | CITY UNION BANK LTD |
| CNRB | CANARA BANK |
| COSB | Cosmos Bank |
| DEUT | DEUTSCHE BANK AG |
| DLXB | DHANALAXMI BANK |
| ESFB | EQUITAS SMALL FINANCE BANK LTD |
| FDRL | FEDERAL BANK |
| HDFC | HDFC BANK LTD |
| IBKL | IDBI BANK LTD |
| ICIC | ICICI BANK LTD |
| IDFB | IDFC FIRST Bank |
| INDB | INDUSIND BANK |
| KARB | KARNATAKA BANK LTD |
| KKBK | KOTAK MAHINDRA BANK LTD |
| MAHB | BANK OF MAHARASHTRA |
| PUNB | PUNJAB NATIONAL BANK |
| TMBL | TAMILNAD MERCANTILE BANK LTD |
| USFB | UJJIVAN SMALL FINANCE BANK LTD |
| UTIB | AXIS BANK |
| PYTM | PAYTM PAYMENTS BANK LTD |
| RATN | RBL BANK LIMITED |
| SBIN | STATE BANK OF INDIA |
| SCBL | STANDARD CHARTERED BANK |
| YESB | YES BANK |
| SIBL | SOUTH INDIAN BANK |
| DBSS | DBS BANK INDIA LTD |
| JSFB | JANA SMALL FINANCE BANK LTD |
| HSBC | THE HONGKONG AND SHANGHAI BANKING CORPORATION LTD |
| KVBL | KARUR VYSA BANK |
| UBIN | UNION BANK OF INDIA |
| CSBK | CSB BANK LTD |
| VARA | THE VARACHHA CO OP BANK LTD |
| KVGB | KARNATAKA VIKAS GRAMEENA BANK |
| APGB | ANDHRA PRAGATHI GRAMEENA BANK |
| CNSX | THE CHEMBUR NAGARIK SAHAKARI BANK |
| SHIX | SHIVALIK SMALL FINANCE BANK LTD |
| NCBL | THE NATIONAL CO OP BANK LTD |
| KNSB | KURLA NAGARIK SAHAKARI BANK LTD |
| AUBL | AU SMALL FINANCE BANK |
| BKID | BANK OF INDIA |
| PSIB | PUNJAB AND SIND BANK |
| IOBA | INDIAN OVERSEAS BANK |
| CLBL | CAPITAL SMALL FINANCE BANK LTD |
Possible Values for Bank ID
| If emandate_authMode is NetBanking: | If emandate_authMode is debitCard: |
|---|---|
| BARB, CBIN, CIUB, CNRB, COSB, DEUT, DLXB, ESFB, FDRL, HDFC, IBKL, ICIC, IDFB, INDB, KARB, KKBK, MAHB, PUNB, PYTM, RATN, SBIN, SCBL, TMBL, USFB, UTIB, YESB, SIBL, DBSS, JSFB, HSBC, KVBL, CITI, DCBL, BDBL, IDIB, UBIN, CSBK, VARA, KVGB, APGB, AUBL, IOBA, PSIB | ANDB, AUBL, CITI, DCBL, DEUT, DLXB, ESFB, FDRL, HDFC, ICIC, IDFB, INDB, KARB, KKBK, MAHB, PUNB, PYTM, RATN, SBIN, SIBL, USFB, YESB, DBSS, TMBL, UTIB, BARB, JSFB, SCBL, UBIN, CSBK, CNSX, SHIX, NCBL, KNSB, BKID, CLBL |