​
Payment Gateway Android Guide

This integration allows you to integrate with a Cashfree Android SDK in your app. You can view the integration video on Youtube.

​
Setting Up SDK

implementation 'com.cashfree.pg:api:2.1.25'

​
Step 1: Creating an Order

The first step in the Cashfree Payment Gateway integration is to create an Order. You need to do this before any payment can be processed. You can add an endpoint to your server which creates this order and is used for communication with your frontend.

Order creation must happen from your backend (as this API uses your secret key). Please do not call this directly from your mobile application.
API Request for Creating an Order

Here’s a sample request for creating an order using your desired backend language. Cashfree offers backend SDKs to simplify the integration process.

You can find the SDKs here.

import { Cashfree } from "cashfree-pg"; 

Cashfree.XClientId = {Client ID};
Cashfree.XClientSecret = {Client Secret Key};
Cashfree.XEnvironment = Cashfree.Environment.PRODUCTION;

function createOrder() {
  var request = {
    "order_amount": "1",
    "order_currency": "INR",
    "customer_details": {
      "customer_id": "node_sdk_test",
      "customer_name": "",
      "customer_email": "example@gmail.com",
      "customer_phone": "9999999999"
    },
    "order_meta": {
      "return_url": "https://test.cashfree.com/pgappsdemos/return.php?order_id=order_123"
    },
    "order_note": ""
  }

  Cashfree.PGCreateOrder("2023-08-01", request).then((response) => {
    var a = response.data;
    console.log(a)
  })
    .catch((error) => {
      console.error('Error setting up order request:', error.response.data);
    });
}

After successfully creating an order, you will receive a unique order_id and payment_session_id that you need for subsequent steps.

You can view all the complete api request and response for /orders here.

​
Step 2: Opening the Payment Page

Once the order is created, the next step is to open the payment page so the customer can make the payment. Cashfree Android SDK offer below payment flow.

To complete the payment, we can follow the following steps:

  1. Create a CFSession object.
  2. Create a CFTheme object.
  3. Create a CFWebCheckoutPayment/CFUPIIntentCheckoutPayment object.
  4. Set payment callback.
  5. Initiate the payment using the payment object created from [step 3]

We go through these step by step below.

​
Create a Session

This object contains essential information about the order, including the payment session ID (payment_session_id) and order ID (order_id) obtained from Step 1. It also specifies the environment (sandbox or production).

CFSession cfSession = new CFSession.CFSessionBuilder()
        .setEnvironment(CFSession.Environment.SANDBOX)
        .setPaymentSessionID("paymentSessionID")
        .setOrderId("orderID")
        .build();

​
Customize Theme (Optional)

You can customize the appearance of the checkout screen using CFTheme. This step is optional but can help maintain consistency with your app’s design.

​
Create Checkout Payment Object

​
Setup payment callback

The SDK exposes an interface CFCheckoutResponseCallback to receive callbacks from the SDK once the payment journey ends.

This interface consists of 2 methods:

public void onPaymentVerify(String orderID)
public void onPaymentFailure(CFErrorResponse cfErrorResponse, String orderID)
Make sure to set the callback at activity’s onCreate as this also handles the activity restart cases.
public class YourActivity extends AppCompatActivity implements CFCheckoutResponseCallback {
    ...
    @Override
    public void onPaymentVerify(String orderID) {

    }

    @Override
    public void onPaymentFailure(CFErrorResponse cfErrorResponse, String orderID) {

    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_upi_intent_checkout);
        try {
          // If you are using a fragment then you need to add this line inside onCreate() of your Fragment
            CFPaymentGatewayService.getInstance().setCheckoutCallback(this);
        } catch (CFException e) {
            e.printStackTrace();
        }
    }
    ...

}

​
Open Checkout Screen

Finally, call doPayment() to open the Cashfree checkout screen. This will present the user with the payment options and handle the payment process.

​
Step 3: Sample Code

Github Sample

​
Step 4: Confirming the Payment

After the payment is completed, you need to confirm whether the payment was successful by checking the order status. Once the payment finishes, the user will be redirected back to your activity to your implementation of the CFCheckoutResponseCallback interface.

You must always verify payment status from your backend. Before delivering the goods or services, please ensure you call check the order status from your backend. Ensure you check the order status from your server endpoint.

To verify an order you can call our /pg/orders endpoint from your backend. You can also use our SDK to achieve the same.

version := "2023-08-01"
response, httpResponse, err := cashfree.PGFetchOrder(&version, "<order_id>", nil, nil, nil)
if err != nil {
	fmt.Println(err.Error())
} else {
	fmt.Println(httpResponse.StatusCode)
	fmt.Println(response)
}

​
Testing

You should now have a working checkout button that redirects your customer to Cashfree Checkout. If your integration isn’t working:

  1. Open the Network tab in your browser’s developer tools.
  2. Click the button and check the console logs.
  3. Use console.log(session) inside your button click listener to confirm the correct error returned.

​
Error Codes

To confirm the error returned in your android application, you can view the error codes that are exposed by the SDK.

​
Other Options

Was this page helpful?

Custom Checkout Integration - iOSReact Native Integration