Cordova framework is an open-source SDK. It is used by developers to develop solutions for different operating systems and web from a single codebase.

The Cashfree Cordova SDK allows you to integrate Cashfree Payment Gateway into your application and start collecting payments from your customers. It opens the payment page in a webview. The Cordova SDK has been designed to minimise the complexity of handling and integrating payments in your Cordova project.

The Cashfree Cordova SDK is available here. This SDK is supported for iPhone devices and not on Simulator. It supports Ionic and Phonegap project. It does not support Capacitor Ionic framework.

Integration Steps

To integrate Cashfree SDK with your Cordova application,

1. ​Create an account with Cashfree and get the API keys​

2. ​Integrate the Cashfree SDK in your application​

3. ​Generate Token (From Backend)​

4. ​Initiate Payment - Invoke a payment API from the Cashfree SDK with the token generated when the customer initiates payment for an order from your application. Cashfree SDK displays appropriate screens to the customer for the payment.

5. ​Receive and handle response - Cashfree SDK returns a response after the payment flow is complete.

6. ​Verify response - We recommend you to verify the payment response using webhooks and by checking the signature value returned in the payment response.

Step 1: Create an account with Cashfree and get the API Keys

1. Go to Cashfree website and create an account. Click here for detailed steps on how to create and activate your account.

2. Login to your Merchant Dashboard using the same credentials.

3. In the Payment Gateway section click View Dashboard > Credentials. For security purposes, you must enter your password for verification.

4. Copy the app ID and secret key. These values are required to create the order token from your server. Order tokens are used to authenticate the API calls made from Cashfree Cordova SDK.

Step 2: Integrate Cashfree Cordova SDK in your application

To integrate the SDK, follow the steps below:

Step 2a: Install the plugin

Install the plugin using the below code:

cd your-project-folder
cordova plugin add cashfree_pg_sdk_cordova

Click here for more information.

Step 2b: Add permissions (Android)

The Cashfree PG SDK requires you to add the INTERNET permission in your Android Manifest file.

<manifest ...>
 <uses-permission android:name="android.permission.INTERNET" />
<application ...>

Step 3: Generate Token (From Backend)

The cftoken is used to authenticate the payment requests made from SDK. It has to be generated for every payment attempt made for an order. Pass this token to the SDK while initiating the payment for that order. To generate a cftoken you need to use our token generation API.

Ensure that this API is called only from your backend as it uses a secret key. This API should never be called from the App.

Request Description

Production - set the URL tohttps://api.cashfree.com/api/v2/cftoken/order

Testing - set the URL to https://test.cashfree.com/api/v2/cftoken/order

You need to send orderId, orderCurrency and orderAmount as a JSON object to the API endpoint and in response, you will receive a token. See the description of the request below.

curl -XPOST -H 'Content-Type: application/json'
-H 'x-client-id: <YOUR_APP_ID>'
-H 'x-client-secret: <YOUR_SECRET_KEY>'
-d '{
 "orderId": "<ORDER_ID>",
 "orderAmount":<ORDER_AMOUNT>,
 "orderCurrency": "<ORDER_CURRENCY>"
}' '<TEST_OR_PROD_API_URL>’'

Request Example: Replace YOUR_APP_ID and YOUR_SECRET_KEY with actual values.

curl -XPOST -H 'Content-Type: application/json' -H 'x-client-id: YOUR_APP_ID' -H 'x-client-secret: YOUR_SECRET_KEY' -d '{
 "orderId": "Order0001",
 "orderAmount":1,
 "orderCurrency":"INR"
}' 'https://test.cashfree.com/api/v2/cftoken/order'

Response Example

{
"status": "OK",
"message": "Token generated",
"cftoken": "v79JCN4MzUIJiOicGbhJCLiQ1VKJiOiAXe0Jye.s79BTM0AjNwUDN1EjOiAHelJCLiIlTJJiOik3YuVmcyV3QyVGZy9mIsEjOiQnb19WbBJXZkJ3biwiIxADMwIXZkJ3TiojIklkclRmcvJye.K3NKICVS5DcEzXm2VQUO_ZagtWMIKKXzYOqPZ4x0r2P_N3-PRu2mowm-8UXoyqAgsG"
}

The "cftoken" is used to authenticate your payment request.

Step 4: Initiate Payment

To initiate payments, your application passes the order info and the cftoken to the SDK. The relevant payment screen is displayed to the customer where they can enter required information and make the payment. Cordova SDK verifies the payment after it is complete and sends a response to the application. The application handles the response appropriately.

The order details passed during the token generation and the payment initiation should match. Else, you will get an `Invalid order details` error.

Wrong appId and token will result in `Unable to authenticate merchant` error. The token generated for payment is valid for 5 minutes within which the payment has to be initiated. Else, you will get an `Invalid token` error.

Step 5: Receive and Handle Response

When you invoke the SDK function, it returns a callback as response.

cordova.exec(function(success) {  
             },  //Success callback
             function(error) {
             
             }, // Error Callback
             "PgCordovaWrapper",                      
             "startPaymentWEB",    
             [params]); 

Step 6: Verify Response

We recommend you to verify the payment response using webhooks. You can also verify the response by checking the signature in the payment response.

Sample Application

Click here to view the sample application.

Web Checkout

Web Checkout is the standard flow for Cashfree Cordova SDK. In this flow, the SDK loads a webview which will render the payment page. The customer can fill the required payment details here and complete the payment. The Web Checkout can be used in two ways:-

1. Web Checkout with Cashfree UI: Customer selects the payment mode and enters the payment details within the Cashfree's web payment page to complete the payment

2. Seamless Web Checkout: Customer selects the payment mode and enters payment details in your application. These details are then passed on to the Cashfree SDK. Webview is launched only for scenarios like the two-factor authentication.

Web checkout supports payment through Google pay, Amazon pay, PhonePe and UPI payment modes.

Web Checkout Using Cashfree UI

Web checkout uses webview to process payment hence the name. For both Web Checkout and Seamless Web Checkout you need to invoke the startPaymentWEB() method. However, there are a few extra parameters you need to pass for seamless integration method.

startPaymentWEB

cordova.exec(function(success) {
 }, //Success callback function
 function(error) {
 }, //Error callback function
 "PgCordovaWrapper",
 "startPaymentWEB",
 [params]); 

Initiates the payment in a webview. The customer will be taken to the payment page on the Cashfree server where they have the option to pay through any payment option that is activated on their account. Once the payment is done the webview will close and the response will be delivered in the responseData as a callback as JsonString.

Parameters:

• params: A map of all the relevant parameters described in the Request Params section below.

• Success and error callback to receive a response.

Seamless Web Checkout

When you have a requirement for a customised payment flow, you can use the seamless integration. You can implement the payment page as per your requirement and then use our SDK to authorise the payment. Once the payment details are collected the OTP or the two-factor authentication page will open in a webview. After the payment is confirmed the webview closes and you will receive a response.

We recommend that you do Web Checkout using Cashfree UI integration unless you are certain that you require a customised payment flow.

The following sections describe the additional parameters for each of the payment methods:

Credit/Debit Card

Add the following parameters to the params map before invoking startPaymentWEB() method to initiate a seamless card transaction.

params.put( "paymentOption", “card”);
params.put( "card_number", “4434260000000008”); //Replace Card number
params.put( "card_expiryMonth", “05”); // Card Expiry Month in MM
params.put( "card_expiryYear", “2021”); // Card Expiry Year in YYYY
params.put( "card_holder", “John Doe”); // Card Holder name
params.put( "card_cvv", “123”); // Card CVV

Net Banking

Add the following parameters to the params map before invoking startPaymentWEB() method to initiate a seamless net banking transaction. All valid bank codes are available here.

params.put( "paymentOption", “nb”);
params.put( "PARAM_BANK_CODE", “3333”); // Put correct bank code here

Wallet

Add the following parameters to the params map before invoking startPaymentWEB() method to initiate a seamless wallet transaction. All valid wallet codes are available here.

params.put( "paymentOption", “wallet”);
params.put( "PARAM_BANK_CODE", “4001”); // Put correct wallet code here

UPI

Add the following parameters to the params map before invoking startPaymentWEB() method to initiate a seamless UPI transaction.

params.put( "paymentOption", “upi”);
params.put( "PARAM_BANK_CODE", “[email protected]”); // Put correct upi vpa here

Paypal

Add the following parameters to the params map before invoking startPaymentWEB() method to initiate a seamless Paypal transaction.

params.put(PARAM_PAYMENT_OPTION, "paypal");

Sample Code

cordova.exec(function(success) {
 }, //Success callback function
 function(error) {
 }, //Error callback function
 "PgCordovaWrapper",
 "startPaymentWEB",
 [params] );

Verify Response

It is recommended to verify the payment response from the SDK using one of the following methods.

Webhook Notifications

We send a notification from Cashfree backend to your backend whenever a payment is successful for an order. This is useful for users in cases when the internet connection is not stable after payment. This will allow you to reconcile all the successful orders at your end. The notification will be sent to notifyUrl which is specified during order creation. The parameters sent in the notification are described here.

To specify notifyUrl, add it with other parameters (orderId, orderAmount etc.) as shown below:

params.put( "notifyUrl", “https://example.com/path/to/notify/url/”);

Notifications are usually instant but rarely can take a minute to hit your server. Make sure that your url supports https. Notifications are sent only in the case of successful payments. Sometimes you may receive the same notification two or more times. It is recommended to ensure that your implementation of the webhook is idempotent. Ensure that you verify the signature in the webhook response.

Verify Signature

Verify the signature value in the payment response to check the authenticity of the transaction response. In every response, we add a digital signature to establish the authenticity of the message. We require you to verify the received signature at your end. This will verify if the response has tampered. This verification has to be done on your server as it involves secretKey which should not be exposed on the client-side.

<?php  
 $orderId = $_POST["orderId"];
 $orderAmount = $_POST["orderAmount"];
 $referenceId = $_POST["referenceId"];
 $txStatus = $_POST["txStatus"];
 $paymentMode = $_POST["paymentMode"];
 $txMsg = $_POST["txMsg"];
 $txTime = $_POST["txTime"];
 $signature = $_POST["signature"];
 $data = $orderId.$orderAmount.$referenceId.$txStatus.$paymentMode.$txMsg.$txTime;
 $hash_hmac = hash_hmac('sha256', $data, $secretkey, true) ;
 $computedSignature = base64_encode($hash_hmac);
 if ($signature == $computedSignature) {
    // Proceed
  } else {
   // Reject this call
 }
 ?>

import hashlib
import hmac
import base64
​
@app.route('/notify_url/', methods=["POST"])
def notify_url_process():
​
 postData = {
  "orderId" : request.form['orderId'], 
  "orderAmount" : request.form['orderAmount'], 
  "referenceId" : request.form['referenceId'], 
  "txStatus" : request.form['txStatus'], 
  "paymentMode" : request.form['paymentMode'], 
  "txMsg" : request.form['txMsg'], 
  "txTime" : request.form['txTime'], 
 }
​
 signatureData = postData["orderId"] + postData["orderAmount"] + postData["referenceId"] + postData["txStatus"] + postData["paymentMode"] + postData["txMsg"] + postData["txTime"]
​
 message = bytes(signatureData).encode('utf-8')
 #get secret key from your config
 secret = bytes(secretKey).encode('utf-8')
 signature = base64.b64encode(hmac.new(secret, 
   message,digestmod=hashlib.sha256).digest())

LinkedHashMap<String, String> postData = new LinkedHashMap<String, String>();
​
postData.put("orderId", ORDERID);
postData.put("orderAmount", ORDERAMOUNT);
postData.put("referenceId", REFERENCE_ID);
postData.put("txStatus", TXN_STATUS);
postData.put("paymentMode", PAYMENT_MODE);
postData.put("txMsg", TX_MSG);
postData.put("txTime", TX_TIME);
​
String data = "";
Set<String> keys = postData.keySet();
​
for (String key : keys) {
    data = data + postData.get(key);
}
String secretKey = "" // Get secret key from config;
Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secret_key_spec = new
SecretKeySpec(secretKey.getBytes(),"HmacSHA256");
sha256_HMAC.init(secret_key_spec);
​
String signature = Base64.getEncoder().encodeToString(sha256_HMAC.doFinal(data.getBytes()));

using System;
using System.Security.Cryptography;
using System.Collections.Generic;
namespace Rextester {
  public class Program {
    private string CreateToken(string message, string secret){
      secret = secret ?? "";
      var encoding = new System.Text.ASCIIEncoding();
      byte[] keyByte = encoding.GetBytes(secret);
      byte[] messageBytes = encoding.GetBytes(message);
​
      using (var hmacsha256 = new HMACSHA256(keyByte))
      {
        byte[] hashmessage = hmacsha256.ComputeHash(messageBytes);
        return Convert.ToBase64String(hashmessage);
      }
    }
​
    public static void Main(string[] args) {
​
      string secret = "<your_secret_key>";
      string data = "";
​
      data = data + "FEX101";
      data = data + "10.00";
      data = data + "19992";
      data = data + "SUCCESS";
      data = data + "pg";
      data = data + "payment done";
      data = data + "2018-02-02 17:29:12";
​
      Program n = new Program();
      string signature = n.CreateToken(data, secret);
      Console.WriteLine(signature);
    }
  }
}

Request and Response Parameters

Request Parameters

Response parameters

These parameters are sent as extras to response callback. They contain the details of the transaction.

Checklist

Checklist to Go Live

• Ensure you are triggering https://api.cashfree.com/api/v2/cftoken/orderendpoint for generating token.

• Pass the Production appId/secretKey in the x-client-id and x-client-secret of the token request API. Obtain these appId/secretKey here in the Production section.

• When calling startPaymentWEB() ensure that the stage parameter is PROD.

• When calling startPaymentWEB() ensure the params map is sent to your appId. Ensure it is the correct production appId.

Checklist to Test the Integration

• Ensure you trigger https://test.cashfree.com/api/v2/cftoken/orderendpoint to generate the Token.

• Pass the Test appId/secretKey in the x-client-id and x-client-secret of the token request API. Get the appId/secretKey here in the Sandbox section.

• When calling startPaymentWEB() ensure that the stage parameter is TEST.

• When calling startPaymentWEB() ensure the params map is sent to your appId. Ensure it is the correct test appId.