cashfree_pg 0.0.2+7

  • Readme
  • Changelog
  • Installing
  • 72

Cashfree PG Flutter SDK pub package #

Integration Steps #

Step 1: Add Dependency #

Open the pubspec.yaml file located inside the app folder, and add cashfree_pg: under dependencies.

  cashfree_pg: 0.0.2+7

Step 2: Add permissions (Android) #

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

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

Step 3: Add plist value (iOS) #

Opt-in to the embedded views preview by adding a boolean property to the app's Info.plist file with the key io.flutter.embedded_views_preview and the value YES. This is required by the flutter_webview plugin.

    <key>io.flutter.embedded_views_preview</key>
    <true/>

Step 4: Generate Token (From Backend) #

You will need to generate a token from your backend and pass it to app while initiating payments. For generating token you need to use our token generation API. Please take care that this API is called only from your as it uses secretKey. Thus this API should never be called from App.

<br/>

Request Description #

You need to send orderId, orderCurrency and orderAmount as a JSON object to the API endpoint and in response a token will received. Please see the description of 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": "INR"
}' 'https://test.cashfree.com/api/v2/cftoken/order'

<br/>

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'

<br/>

Response Example #

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

The "cftoken" is the token that is used authenticate your payment request that will be covered in the next step. <br/>

Step 5: Initiate Payment #

  • App passes the order info and the token to the SDK
  • Customer is shown the payment screen where he completes the payment
  • Once the payment is complete SDK verifies the payment
  • App receives the response from SDK and handles it appropriately

NOTE #

  • The order details passed during the token generation and the payment initiation should match. Otherwise you'll get a"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 mins within which the payment has to be initiated. Otherwise you'll get a "Invalid token" error.

Payment modes #

Web Checkout Integration #

How to integrate #

For both the modes (normal and seamless) you need to invoke the doPayment() method. However, there are a few extra parameters you need to pass incase of seamless mode.

doPayment #

Future<dynamic> doPayment(BuildContext context, Map<String, String> inputs, String mode)

Initiates the payment in a webview. The customer will be taken to the payment page on cashfree server where they will have the option of paying 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 callback.

Parameters:

  • context BuildContext object of the widget.

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

  • token The token generated from Step 4.

  • stage Value should be either "TEST" or "PROD" for testing server or production server respectively.

doPayment - with Custom AppBar Theme #


Future<dynamic> doPaymentWithTheme(BuildContext context, Map<String, String> inputs, Color color1, Color color2, String mode)

Initiate the payment in a webview. The customer will be taken to the payment page on cashfree server where they will have the option of paying 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 callback.

Parameters:

  • context BuildContext object of the widget.

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

  • token The token generated from Step 4.

  • stage Value should be either "TEST" or "PROD" for testing server or production server respectively.

  • color1 Toolbar background color

  • color2 Toolbar text and back arrow color

Sample Code #


CashfreePGSDK().doPayment(context, inputs, "TEST").then((val){
        print("SDK Result : ${(val)}");
        // DO something with the result
});


CashfreePGSDK().doPaymentWithTheme(context, inputs, Colors.white, Colors.black,  "TEST").then((val){
        print("SDK Result : ${(val)}");
        // DO something with the result
});

<br/>

Request Parameters #

ParameterRequiredDescription
appIdYesYour app id
orderIdYesOrder/Invoice Id
orderAmountYesBill amount of the order
orderNoteNoA help text to make customers know more about the order
orderCurrencyYesCurrency code of the order. Default is INR.
customerNameNoName of the customer
customerPhoneYesPhone number of customer
customerEmailYesEmail id of the customer
tokenDataYesToken generated from step 4
notifyUrlNoNotification URL for server-server communication. Useful when user’s connection drops after completing payment.
paymentModesNoAllowed payment modes for this order. Available values: cc, dc, nb, paypal, upi, wallet. Leave it blank if you want to display all modes

Response parameters #

These parameters are sent as extras to the onActivityResult(). They contain the details of the transaction.

ParameterDescription
orderIdOrder id for which transaction has been processed. Ex: GZ-212
orderAmountAmount of the order. Ex: 256.00
paymentModePayment mode of the transaction.
referenceIdCashfree generated unique transaction Id. Ex: 140388038803
txStatusPayment status for that order. Values can be : SUCCESS, FLAGGED, PENDING, FAILED, CANCELLED.
paymentModePayment mode used by customer to make the payment. Ex: DEBIT_CARD, MobiKwik, etc
txMsgMessage related to the transaction. Will have the reason, if payment failed
txTimeTime of the transaction
typeFixed value : CashFreeResponse. To identify the response is from cashfree SDK.
signatureResponse signature, more here.

NOTE #

  • There can be scenarios where the SDK is not able to verify the payment within a short period of time. The status of such orders will be PENDING.
  • If the WebView is closing as soon as it opens then most probably something is wrong with the input passed to the SDK. Please check your inputs and if you still need further help reach out to us at techsupport@cashfree.com.

[0.0.2+7] - 22.06.2020. #

Bug fixes.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  cashfree_pg: ^0.0.2+7

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:cashfree_pg/cashfree_pg.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
51
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
72
Learn more about scoring.

We analyzed this package on Jul 7, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.13
  • Flutter: 1.17.5

Analysis suggestions

Package does not support Flutter platform linux

Because of import path [package:cashfree_pg/cashfree_pg.dart, package:webview_flutter/webview_flutter.dart] that declares support for platforms: android, ios

Package does not support Flutter platform macos

Because of import path [package:cashfree_pg/cashfree_pg.dart, package:webview_flutter/webview_flutter.dart] that declares support for platforms: android, ios

Package does not support Flutter platform web

Because of import path [package:cashfree_pg/cashfree_pg.dart, package:webview_flutter/webview_flutter.dart] that declares support for platforms: android, ios

Package does not support Flutter platform windows

Because of import path [package:cashfree_pg/cashfree_pg.dart, package:webview_flutter/webview_flutter.dart] that declares support for platforms: android, ios

Package not compatible with SDK dart

because of import path [cashfree_pg] that is in a package requiring null.

Health suggestions

Format lib/cashfree_pg.dart.

Run flutter format to format lib/cashfree_pg.dart.

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and cashfree_pg.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.7.0 <3.0.0
flutter 0.0.0
webview_flutter ^0.3.22+1 0.3.22+1
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8 1.2.1
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8
Dev dependencies
flutter_test