Payment Methods

Fetch Payment Methods

Use the

Below are the sample payloads for each payment method.

There are no specific request parameters to be passed. Instead, you must pass the fetchVirtualAccount method for your Customer Identifier to get created and the details to appear on the checkout. Know more about

Debit and Credit Card

For Card payments, method should be specified as card. Other required fields:

• card[name]
• card[number]
• card[cvv]
• card[expiry_month]
• card[expiry_year]

Sample Code

The sample code shown below allows the checkout to accept a card payment of ₹299.35.

JSONObject data = new JSONObject();
data.put("amount", 29935);
data.put("currency", "");
data.put("order_id", "order_DgZ26rHjbzLLY2");//sample order_id. Generate orders using Orders API
data.put("email", "gaurav.kumar@example.com");
data.put("contact", "+919876543210");
data.put("method", "card");
data.put("card[name]", "Gaurav Kumar");
data.put("card[number]", "4628 9499 7226 2986");
data.put("card[expiry_month]", "12");
data.put("card[expiry_year]", "30");
data.put("card[cvv]", "100");

Check the

If you want to securely store customer's card details as network tokens, know about

EMI on Debit and Credit Cards

For EMI, method should be specified as emi. Add an additional field, emi_duration, corresponding to the number of months for EMI. After a customer selects the desired plan, pass the corresponding value in the emi_duration field.

Sample Code

The sample code below allows checkout to accept a card payment of ₹3999.35:

JSONObject data = new JSONObject();
data.put("amount", 399935);
data.put("order_id", "order_DgZ26rHjbzLLY2");//sample order_id. Generate orders using Orders API
data.put("email", "gaurav.kumar@example.com");
data.put("contact", "+919876543210");
data.put("method", "emi");
data.put("emi_duration", 2); //defines the number of months for the EMI.
data.put("card[name]", "Gaurav Kumar");
data.put("card[number]", "4628 9499 7226 2986");
data.put("card[expiry_month]", "12");
data.put("card[expiry_year]", "30");
data.put("card[cvv]", "100");

Check the list of supported

Cardless EMI

Cardless EMI is a payment method that allows customers to convert their payment amount to EMIs. The customer does not require a debit or credit card. They can make payments via credits approved by the supported Cardless EMI payment provider. For Cardless EMI, method should be specified as cardless_emi and an additional field provider must specify the provider with its respective provider code.

Sample Code

The sample code below allows checkout to accept a card payment of ₹5999.35:

JSONObject payload = new JSONObject("{\"currency\":\"\"}");
payload.put("amount", 599935);
payload.put("contact", "+919876543210");
payload.put("order_id", "order_9A33XWu170gUtm");
payload.put("email", "gaurav.kumar@example.com");
payload.put("method", "cardless_emi");
payload.put("provider", "walnut369");

Check the

Netbanking

For Netbanking, method should be specified as netbanking and an additional field bank must specify the bank with its respective bank code.

Sample Code

The sample code shown below allows the checkout to perform a netbanking transaction for a payment of ₹299.35:

JSONObject data = new JSONObject();
data.put("amount", 29935);
data.put("order_id", "order_DgZ26rHjbzLLY2");//sample order_id. Generate orders using Orders API
data.put("email", "gaurav.kumar@example.com");
data.put("contact", "+919876543210");
data.put("method", "netbanking");
data.put("bank", "SBIN");

Check the

Pay Later

You can enable your customers to make payments using the Pay Later service offered by various third-party providers. For pay later, method should be specified as paylater and an additional field provider must specify the provider with its respective provider code.

Sample Code

Use the sample code given below:

JSONObject payload = new JSONObject("{\"currency\":\"\"}");
payload.put("amount",5000);
payload.put("contact","+919876543210");
payload.put("order_id","order_9A33XWu170gUtm");
payload.put("email", "gaurav.kumar@example.com");
payload.put("method", "paylater");
payload.put("provider", "lazypay");

Check the

Wallet

For Wallet payments, method should be specified as wallet.

Sample Code

The sample code shown below allows the checkout to perform a wallet transaction for a payment of ₹299.35 :

JSONObject data = new JSONObject();
data.put("amount", 29935);
data.put("order_id", "order_DgZ26rHjbzLLY2");//sample order_id. Generate orders using Orders API
data.put("email", "gaurav.kumar@example.com");
data.put("contact", "+919876543210");
data.put("method", "wallet");
data.put("wallet", "mobikwik");

Check the list

UPI

For UPI payments, method should be specified as upi. The SDK supports two flows:

1. Intent
2. Collect

Intent Flow

<queries>
    <!-- List of apps which you want to support for Intent pay -->
    <package android:name="com.google.android.apps.nbu.paisa.user" />
    <package android:name="com.phonepe.app"/>

    <!--
         Specific intents you query for,
         eg: for a custom share UI
    -->
    <intent>
        <action android:name="android.intent.action.SEND" />
    </intent>
</queries>

In Intent Flow, the SDK invokes a UPI intent, which is handled by the UPI apps installed on the Android device.

To implement this flow:

1. Fetch a list of apps on the customer's device that support UPI payments and Autopay using the sample codes given below:

   • Fetch list of UPI Supported Apps

     JavaKotlin

     copy

     Razorpay.getAppsWhichSupportUpi(this, new RzpUpiSupportedAppsCallback() {
         @Override
         public void onReceiveUpiSupportedApps(List<ApplicationDetails> list) {
             // List of upi supported app
         }
     });

   • Fetch list of UPI Autopay Supported Apps

     JavaKotlin

     copy

     Razorpay.getAppsWhichSupportAutopayIntent(this, new RzpUpiSupportedAppsCallback() {
         @Override
         public void onReceiveUpiSupportedApps(List<ApplicationDetails> applicationDetailsList) {
         }
     });

2. Override the onActivityResult() of your activity and pass the same to our SDK:

   JavaKotlin

   copy

   @Override
   protected void onActivityResult(int requestCode, int resultCode, Intent data){
   super.onActivityResult(requestCode, resultCode, data);
       if(razorpay!=null){
       razorpay.onActivityResult(requestCode,resultCode,data);
       }
   }

3. Invoke the UPI and UPI Autopay Intent with the sample codes given below. This will enable the customer to select the desired application.
   

   • Invoke UPI Intent

     JavaKotlin

     copy

     JSONObject data = new JSONObject();
     data.put("amount", 29935);
     data.put("order_id", "order_DgZ26rHjbzLLY2");//sample order_id. Generate orders using Orders API
     data.put("email", "gaurav.kumar@example.com");
     data.put("contact", "+919876543210");
     data.put("method", "upi");
     data.put("_[flow]", "intent");
     data.put("upi_app_package_name", "in.org.npci.upiapp"); //For BHIM app

   • Invoke UPI Autopay Intent (Default)

     JavaKotlin

     copy

     JSONObject data = new JSONObject("{currency: ''}");
     data.put("amount", "10000");
     data.put("contact", "+919876543210");
     data.put("email", "gaurav.kumar@example.com");
     data.put("order_id", "order_DgZ26rHjbzLLY2");// mandatory for UPI Autopay payments
     data.put("customer_id", "cust_805c8oBQdBGPwS");// mandatory for UPI Autopay payments
     data.put("recurring", "1");
     data.put("description","Credits towards consultation");
     data.put("method", "upi");
     data.put("_[flow]", "intent");
     data.put("upi_app_package_name","com.google.android.apps.nbu.paisa.user"); // pass package name that is returned in getAppsWhichSupportUpi and/or getAppsWhichSupportUpiAutopay

   • Preferred Payload for Recurring: In the sample code below, recurring is passed as preferred. It initiates a flow in SDK where, if a selected app supports Autopay payments, the payment passes via the Autopay payment route. If it does not, then it passes via the one-time payment route.

     JavaKotlin

     copy

     JSONObject data = new JSONObject("{currency: ''}");
     data.put("amount", "10000");
     data.put("contact", "+919876543210");
     data.put("email", "gaurav.kumar@example.com");
     data.put("order_id", "order_DgZ26rHjbzLLY2");// mandatory for UPI Autopay payments
     data.put("customer_id", "cust_805c8oBQdBGPwS");// mandatory for UPI Autopay payments
     data.put("recurring", "preferred");
     data.put("description","Credits towards consultation");
     data.put("method", "upi");
     data.put("_[flow]", "intent");
     data.put("upi_app_package_name","com.google.android.apps.nbu.paisa.user"); // pass package name that is returned in getAppsWhichSupportUpi and/or getAppsWhichSupportUpiAutopay

Check the complete list of

Customise Order of Apps

In the Intent Flow, you can customise the order in which UPI apps appear at the Checkout. There are two sections within the app: Preferred Apps and Other Apps.

To define the order in which apps appear under these sections of the app chooser, two lists that contain the application package names must be passed to the SDK within options.

1. Preferred apps list
2. Other apps list

PREFERRED APPS Section

This section displays the list of applications specified using the key preferred_apps_order within options. If no application exists for this key, this section is not displayed.

OTHER APPS Section

The list of applications specified using the key other_apps_order within options is displayed under this section. Any unspecified app (which supports UPI intent) appears subsequent to the list passed in the options.

Sample Code

In the sample code below, BHIM (in.org.npci.upiapp) is passed in the preferred apps list and Google Pay(com.google.android.apps.nbu.paisa.user) in other apps list. As a result, BHIM is shown in the PREFERRED APPS SECTION. Google Pay is shown at the top in the OTHER APPS SECTION followed by other apps present in the device:

JSONArray prefAppsJArray = new JSONArray();
prefAppsJArray.put("in.org.npci.upiapp");

JSONArray otherAppsJArray = new JSONArray();
otherAppsJArray.put("com.google.android.apps.nbu.paisa.user");

payload.put("method", "upi");
payload.put("_[flow]", "intent");
payload.put("preferred_apps_order", prefAppsJArray);
payload.put("other_apps_order", jArray);

Collect Flow

Customers enter their vpa or

You can now pass the vpa parameter in the upi array as shown below.

Sample Code

The sample code below sends a collect request to gaurav.kumar@exampleupi handle.

JSONObject data = new JSONObject();
data.put("amount", 29935);
data.put("order_id", "order_DgZ26rHjbzLLY2");//sample order_id. Generate orders using Orders API
data.put("email", "gaurav.kumar@example.com");
data.put("contact", "+919876543210");
data.put("method", "upi");
data.put("vpa", "gaurav.kumar@exampleupi");