Android Integration

This is a new integration provided by Cashfree. If you are integrating with Cashfree PG for the first time, we recommend that you use this integration.

We have revamped our Android SDK to make it easy for our merchants to integrate and customize their payment flows. Our Android SDK supports Android SDK version 19 and above and provides two types of checkout flows -

  1. Drop Checkout - Pre-built native Android UI screen to facilitate a quick integration with our payment gateway. This mode handles all the business logic and UI Components to make the payment smooth and easy to use. The SDK allows the merchant to customize the UI in terms of color coding, fonts and payment modes shown.
  2. Web Checkout - Web checkout flow is the another payment flow similar to Drop flow for collection payments using the Cashfree payment gateway's Android SDK. In this flow, SDK provides a webview based checkout implementation to facilitate a quick integration with our payment gateway. Your customers can fill in the necessary details in the web page and complete the payment. This mode also handles all the business logic and UI components to make the payment smooth and easy to use.

👍

Prerequisite

We hope you have already created an account with Cashfree Payments and have the API keys ready to start the integration. If not, click here to know how to create an account.

The integration can be completed in a few steps and should not take more than 30 minutes.

  1. Getting the SDK
  2. Create an order with Cashfree from backend (Step 2 in the image below)
  3. Initiate payment (Step 3 in the image below)
  4. Verify payment (Steps 4 & 5 in the image below) - This is a mandatory step so please don't skip this
1218

Simplified payment flow

When a customer places an order on merchant app, merchant needs to create order in Cashfree's system. In response of that request Cashfree will return payment_session_id to you. It contains all the order details and has to be sent to the SDK while initiating the payment. Then checkout page is loaded and customer chooses the payment method he wants to pay by and enters his details (like UPI ID/card number etc.) Cashfree uses these details to process the payment and notifies the mobile SDK that payment has ended. Merchant verifies the payment and order status from Cashfree's backend and the same is shown to the customer on his app.

1199

Checkout flow

You can use our sample Android app project mentioned below as a reference for this SDK integration.

You can also refer to the Change Logs of the sdk here

Access to sandbox is provided for everyone and you can use the following endpoint - https://sandbox.cashfree.com/pg

Resources

You can try out the APIs for Steps 3 and 4 by using any of the following methods

  1. From our Run in Postman

Ask a question about Integration

You can ask questions, and participate in discussions about our Payment Gateway in the Cashfree Discord channel.