Original Checkout | Customized Checkout
|Use Cases
Razorpay allows you to configure the payment methods depending on your use case.- Highlighting certain payment instruments on the Checkout. For example Google Pay could be displayed outside the UPI block as a separate payment method. HDFC Netbanking could come out of the Netbanking container as a separate payment method. Similarly, OlaMoney can be pulled out of the wallet block.
- Restricting the kind of network, issuer, BIN and card type, different properties of the card, to accept payments. For example, you can choose to accept payments only from HDFC Visa Debit cards on the Checkout.
- Removing a certain payment method or instrument. For example, OlaMoney can be removed as a payment method from wallets. The entire Netbanking block or a certain bank in Netbanking can be removed from the Checkout.
- Reordering of payment methods on the Checkout. You can choose to have UPI as the first section instead of Cards on the Checkout. Within the UPI block, you can again order the PSPs, according to your need.
- Grouping of payment instruments. For example, you can choose to group Netbanking and UPI payment methods of a bank as a block that will be labelled as Pay via Bank on the Checkout.
Examples
Highlight Instruments of a Certain Bank | Regroup Payment Methods | Remove UPI
| |Configuring Payment Methods
Depending on how you want to control the payment methods on the Checkout, there are different ways in which the configuration can be passed to the Checkout:-
Pass the configuration in the
optionsparameter of the Checkout code at the run time. This is useful when you want to modify the order of the payment methods for a particular set of payments while rendering the Checkout. See the sample code for details. - Create a global setting of the payments as a Configuration ID and pass these values while creating the Order. This is useful when you want to fix the order of the payment methods on all the Checkout renderences.
Note:
Contact our Support Team for more details about the Configuration ID.
Understanding the Configuration
Let us understand the building blocks that are required to build a configuration of your choice:Payment Methods
Before deciding the payment methods or payment instruments that you want to configure on the Checkout, refer to the payment methods supported by Razorpay.Payment Instruments
A payment instrument is a combination of the payment method and its associated properties. For example, a payment instrument can be an AXIS Debit card, where card is the payment method and the issuer (AXIS bank) is the associated instrument. An instrument is a JSON object with a key namedmethod. Each method and its associated properties are described in the sections below:
Card
Payment instruments for themethod: card are listed below:
name | type | description | values | examples
issuers | array | List of issuers that are allowed | Any bank code | issuers: [“HDFC”, “ICIC”]
networks | array | List networks that are allowed | Any card network | networks: ["Visa", "MasterCard"]
types | array | List of card types that are allowed | Any card type | types: ["credit"]
JavaScript
Netbanking
Payment instruments for themethod: netbanking are listed below:
name | type | description | values | examples
banks | array“ | List of all banks that are allowed | Any bank code |banks: ["HDFC", "ICIC"]
Wallet
Payment instruments for themethod: wallet are listed below:
name | type | description | values | examples
wallets | string | Wallets to be allowed | Any wallet code |wallets: ["olamoney"]
UPI
Payment instruments for themethod: upi are listed below:
name | type | description | values | examples
flows | string | Flows to show | Any supported UPI flow | flows: [ "qr"]
apps | string | Apps to show, for intent | Any supported UPI apps | apps: ["google_pay", "phonepe"]
Cardless EMI
Payment instruments for themethod: cardless_emi are listed below:
name | type | description | values | examples
providers | string | Providers to be allowed | Any Cardless EMI provider |providers: ["zestmoney"]
PayLater
For the method:paylater, the payment instruments are listed below:
name | type | description | values | examples
providers | string | Providers to be allowed | Any paylater provider |providers: ["hdfc"]
Apps
For the methodapp, the payment instrument is listed below:
name | type | description | values | examples
providers | string | Providers to be allowed | Any app provider |providers: ["cred"]
JavaScript
Blocks
A block is a collection of one or more payment instruments. Each block has aname and code associated as shown below:
JavaScript
highlighted is the code associated with myPayments. Multiple blocks can be added to the config at the same time.
Sequence
You can specify thesequence, that is the order, in which the payment methods should be displayed on the Checkout.
A sequence is an array of strings, where each string is the name of the payment method or a block.
In a sequence, you can include any block using the block.${code} format. The block with code highlighted should be represented as block.highlighted as shown below:
JavaScript
highlighted first followed by the payment methods upi and netbanking in that particular order.
ImportantEvery block defined has to be present in the sequence. If you do not wish to reorder the methods and want to place your block, the sequence should contain
block.highlighted with just one item in it.Preferences
Using thepreferences object, you can enhance the configuration of the Checkout. By setting this value, you can decide whether the default list of payment methods should be displayed or not.
Possible values are:
true
: Checkout will display the sequence of the payment methods configured by you alongside the default order of payment methods available in the Checkout.
false
: Checkout will only show the sequence of the payment methods configured by you.
Hide Payment Instruments
You can also hide or remove certain instruments from the Checkout. This is anarray containing the method key used to hide either the payment method and/or the payment instrument associated with that payment method. For example, you can hide the methods, card and HDFC netbanking on the Checkout.
JavaScript
NoteHiding any instrument using
hide does not affect the similar instrument defined in blocks. So, if you want to hide HDFC bank from netbanking and have defined the same instrument in one of your blocks, HDFC bank will still be displayed in that block.Building the Configuration
This section contains details about thedisplay configuration and the restrictions configuration.
Display Configuration
Using thedisplay config, you can put together all the modules, that is, blocks, sequence, preferences, hide instruments as shown below:
The display config can be passed in the Checkout options or in the Orders API request using the checkout_config_id parameter.
Restrictions Configuration
Using thedisplay config, you can reorder, highlight or hide instruments and methods, and display the modules on the Checkout, whereas using the restrictions config you can accept payments using only certain instruments.
For example, if you want to accept payments only from specific cards such as Rupay or Diners Card/only HDFC or Axis Bank Cards/Cards of a particular BIN.
To restrict the payments, it is recommended to use restrictions config.
Feature RequestThis is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account.to get this feature activated on your account.The Learn more about Orders API.
restrictions config must be sent in Orders API request as shown below:Curl
Sample Code
Let us assume you want to list all the payment methods offered byHDFC bank, allow card payments for ICICI bank only and hide upi payment method from the Checkout. You can do so using the code given below:Checkout Code
Reference
All the supported payment methods and instruments are listed below:Supported Cards
Any card issued by the following banks:Bank Name | Code
AU Small Finance Bank | AUBL
Aditya Birla Idea Payments Bank | ABPB
Airtel Payments Bank | AIRP
Allahabad Bank | ALLA
Andhra Bank | ANDB
Andhra Bank Corporate Banking | ANDB_C
Axis Bank | UTIB
Bandhan Bank | BDBL
Bank of Bahrein and Kuwait | BBKM
Bank of Baroda Retail Banking | BARB_R
Bank of India | BKID
Bank of Maharashtra | MAHB
Bassein Catholic Co-operative Bank | BACB
Canara Bank | CNRB
Catholic Syrian Bank | CSBK
Central Bank of India | CBIN
City Union Bank | CIUB
Corporation Bank | CORP
Cosmos Co-operative Bank | COSB
DCB Bank | DCBL
Dena Bank | BKDN
Deutsche Bank | DEUT
Development Bank of Singapore | DBSS
Dhanlaxmi Bank | DLXB
Dhanlaxmi Bank Corporate Banking | DLXB_C
ESAF Small Finance Bank | ESAF
Equitas Small Finance Bank | ESFB
Federal Bank | FDRL
HDFC Bank | HDFC
ICICI Bank | ICIC
IDBI | IBKL
IDBI Corporate Banking | IBKL_C
IDFC FIRST Bank | IDFB
Indian Bank | IDIB
Indian Overseas Bank | IOBA
Indusind Bank | INDB
Jammu and Kashmir Bank | JAKA
Janata Sahakari Bank (Pune) | JSBP
Kalupur Commercial Co-operative Bank | KCCB
Kalyan Janata Sahakari Bank | KJSB
Karnataka Bank | KARB
Karur Vysya Bank | KVBL
Kotak Mahindra Bank | KKBK
Lakshmi Vilas Bank Corporate Banking | LAVB_C
Lakshmi Vilas Bank Retail Banking | LAVB_R
Mehsana Urban Co-operative Bank | MSNU
NKGSB Co-operative Bank | NKGS
North East Small Finance Bank | NESF
PNB (Erstwhile-Oriental Bank of Commerce) | ORBC
PNB (Erstwhile-United Bank of India) | UTBI
Punjab & Sind Bank | PSIB
Punjab National Bank Retail Banking | PUNB_R
RBL Bank | RATN
RBL Bank Corporate Banking | RATN_C
Saraswat Co-operative Bank | SRCB
Shamrao Vithal Bank Corporate Banking | SVCB_C
Shamrao Vithal Co-operative Bank | SVCB
South Indian Bank | SIBL
Standard Chartered Bank | SCBL
State Bank of Bikaner and Jaipur | SBBJ
State Bank of Hyderabad | SBHY
State Bank of India | SBIN
State Bank of Mysore | SBMY
State Bank of Patiala | STBP
State Bank of Travancore | SBTR
Suryoday Small Finance Bank | SURY
Syndicate Bank | SYNB
Tamilnadu Mercantile Bank | TMBL
Tamilnadu State Apex Co-operative Bank | TNSC
Thane Bharat Sahakari Bank | TBSB
Thane Janata Sahakari Bank | TJSB
UCO Bank | UCBA
Union Bank of India | UBIN
Varachha Co-operative Bank | VARA
Vijaya Bank | VIJB
Yes Bank | YESB
Yes Bank Corporate Banking | YESB_C
Zoroastrian Co-operative Bank | ZCBL
Supported Card Types
creditfor credit cardsdebitfor debit cards
Supported Card Networks
Card Network Name | Code
American Express | American Express
Diners Club | Diners Club
Maestro | Maestro
MasterCard | MasterCard
RuPay | RuPay
Visa | Visa
Bajaj Finserv | Bajaj Finserv
Supported Banks
Bank Name | Code
AU Small Finance Bank | AUBL
Aditya Birla Idea Payments Bank | ABPB
Airtel Payments Bank | AIRP
Allahabad Bank | ALLA
Andhra Bank | ANDB
Andhra Bank Corporate Banking | ANDB_C
Axis Bank | UTIB
Bandhan Bank | BDBL
Bank of Bahrain and Kuwait | BBKM
Bank of Baroda Retail Banking | BARB_R
Bank of India | BKID
Bank of Maharashtra | MAHB
Bassein Catholic Co-operative Bank | BACB
Canara Bank | CNRB
Catholic Syrian Bank | CSBK
Central Bank of India | CBIN
City Union Bank | CIUB
Corporation Bank | CORP
Cosmos Co-operative Bank | COSB
DCB Bank | DCBL
Dena Bank | BKDN
Deutsche Bank | DEUT
Development Bank of Singapore | DBSS
Dhanlaxmi Bank | DLXB
Dhanlaxmi Bank Corporate Banking | DLXB_C
ESAF Small Finance Bank | ESAF
Equitas Small Finance Bank | ESFB
Federal Bank | FDRL
HDFC Bank | HDFC
ICICI Bank | ICIC
IDBI | IBKL
IDBI Corporate Banking | IBKL_C
IDFC FIRST Bank | IDFB
Indian Bank | IDIB
Indian Overseas Bank | IOBA
Indusind Bank | INDB
Jammu and Kashmir Bank | JAKA
Janata Sahakari Bank (Pune) | JSBP
Kalupur Commercial Co-operative Bank | KCCB
Kalyan Janata Sahakari Bank | KJSB
Karnataka Bank | KARB
Karur Vysya Bank | KVBL
Kotak Mahindra Bank | KKBK
Lakshmi Vilas Bank Corporate Banking | LAVB_C
Lakshmi Vilas Bank Retail Banking | LAVB_R
Mehsana Urban Co-operative Bank | MSNU
NKGSB Co-operative Bank | NKGS
North East Small Finance Bank | NESF
PNB (Erstwhile-Oriental Bank of Commerce) | ORBC
PNB (Erstwhile-United Bank of India) | UTBI
Punjab & Sind Bank | PSIB
Punjab National Bank Retail Banking | PUNB_R
RBL Bank | RATN
RBL Bank Corporate Banking | RATN_C
Saraswat Co-operative Bank | SRCB
Shamrao Vithal Bank Corporate Banking | SVCB_C
Shamrao Vithal Co-operative Bank | SVCB
South Indian Bank | SIBL
Standard Chartered Bank | SCBL
State Bank of Bikaner and Jaipur | SBBJ
State Bank of Hyderabad | SBHY
State Bank of India | SBIN
State Bank of Mysore | SBMY
State Bank of Patiala | STBP
State Bank of Travancore | SBTR
Suryoday Small Finance Bank | SURY
Syndicate Bank | SYNB
Tamilnadu Mercantile Bank | TMBL
Tamilnadu State Apex Co-operative Bank | TNSC
Thane Bharat Sahakari Bank | TBSB
Thane Janata Sahakari Bank | TJSB
UCO Bank | UCBA
Union Bank of India | UBIN
Varachha Co-operative Bank | VARA
Vijaya Bank | VIJB
Yes Bank | YESB
Yes Bank Corporate Banking | YESB_C
Zoroastrian Co-operative Bank | ZCBL
Supported Wallets
Wallet provider | Wallet Code
PhonePe | phonepe
Mobikwik | mobikwik
PayZapp | payzapp
Ola Money | olamoney
Airtel Money | airtelmoney
Amazon Pay | amazonpay
JioMoney | jiomoney
PayPal | paypal
Supported UPI Apps
App Name | Package Name
Google Pay | com.google.android.apps.nbu.paisa.user
BHIM | in.org.npci.upiapp
BHIM UCO | com.lcode.ucoupi
BHIM IOB | com.euronet.iobupi
BHIM CSB | com.lcode.csbupi
PhonePe | com.phonepe.app
Paytm | net.one97.paytm
ICICI iMobile | com.csam.icici.bank.imobile
ICICI Pocket | com.icicibank.pockets
SBI | com.sbi.upi
Axis Pay | com.upi.axispay
Axis | com.axis.mobile
Samsung Pay | com.samsung.android.spay
HDFC Bank | com.snapwork.hdfc
PayZapp | com.hdfcbank.payzapp
Bank of Baroda | com.bankofbaroda.upi
Freecharge | com.freecharge.android
KVB | com.mycompany.kvb
JK UPI | com.fss.jnkpsp
IDFC | com.fss.idfcpsp
IDFC First | com.idfcfirstbank.optimus
Yes Bank | com.YesBank
YesBank Iris | in.irisbyyes.app
Microsoft Kaizala | com.microsoft.mobile.polymer
Lotza | com.upi.federalbank.org.lotza
Fed Mobile | com.fedmobile
IndusInd Pay | com.mgs.induspsp
IndusInd Mobile | com.fss.indus
Indus Indie | com.indusind.indie
Wizely | ai.wizely.android
Amazon | in.amazon.mShop.android.shopping
RBL MoBank | com.rblbank.mobank
CRED | com.dreamplug.androidapp
Finserve | in.bajajfinservmarkets.app
Fampay | com.fampay.in
Mobikwik | com.mobikwik_new
PNB Bank | com.mgs.pnbupi
PNB One | com.Version1
Digibank | com.dbs.in.digitalbank
Jupiter | money.jupiter
Navi | com.naviapp
Slice | indwin.c3.shareapp
Tata Neu | com.tatadigital.tcp
Groww | com.nextbillion.groww
Shriram One | com.shriram.one
Fave | com.pinelabs.fave
Ultracash | com.ultracash.payment.customer
Timepay | com.npst.timepay.society
Goibibo | com.goibibo
Kotak | com.msf.kbank.mobile
Kotak811 | com.kotak811mobilebankingapp.instantsavingsupiscanandpayrecharge
DakPay | com.fss.ippbpsp
India Post | com.iexceed.appzillon.ippbMB
Canara | com.canarabank.mobility
MyJio | com.jio.myjio
IndOASIS | com.IndianBank.IndOASIS
Tvam | com.atyati.tvamapp
PopClub | com.popclub.android
Vyom | com.infrasoft.uboi
Super Money | money.super.payments
Omnicard | com.eroute.omnicard
AU0101 | com.ausmallfinancebank.amb
Cent Mobile | com.infrasofttech.CentralBank
Kiwi | in.gokiwi.kiwitpap
Digi Khata | com.paypointz.wallet
Moneyview | com.whizdm.moneyview.loans
Supported UPI flows
Given below are the supported UPI flows:collectfor flow via VPAintentfor flow via UPI apps
Handy TipsThe supported UPI apps for intent on android mobile web are Google Pay and PhonePe.
qrfor flow via UPI QR
Supported PayLater Providers
Provider name | Provider Code
LazyPay | lazypay
PayPal | paypal
Handy Tips
- PayPal now supports the Pay Later feature. You should enable both PayPal and the Pay Later options under Account & Settings → Pay Later (under Payment methods) on the Dashboard to enable the Pay Later feature.
Supported Cardless EMI Providers
Banks | Provider Code
ICICI Bank | icic
IDFC Bank | idfb
HDFC Bank | hdfc
Kotak Bank| kkbk
axio | walnut369
Fibe | earlysalary
ZestMoney | zestmoney
Supported Apps
App | Code
CRED Pay |cred