All-in-One SDK Integration in Flutter App

To merchants who have built their app on Flutter platform, Paytm provides a bridge to conveniently integrate All-in-One SDK. On this page, we will highlight the steps required to integrate All-in-One SDK with Flutter platform for your app. This platform helps you to build a seamless and responsive checkout experience for your application.

This integration will support the following flows:

• App Invoke Flow: In case the Paytm app is installed, it will be launched to complete the transaction and give the response back to your app.
• Redirection Flow: In case the Paytm app is not installed, All-in-One SDK will open a web-view to process transaction and give the response back to your app.

1. On your mobile app, the user adds goods/services into the shopping/order cart and proceeds to checkout. You call the Initiate Transaction API from your backend to generate transaction token.
   Within the Initiate Transaction API, you also get an option to include single or multiple payment sources for the users, thus, allowing you to make your own payment page with multiple payment sources.

2. Launch the Hybrid app bridge to invoke Paytm All-in-One SDK with the transaction token received in step 1.

3. If Paytm app is installed on user's phone, the payment will be completed on Paytm app using the user's saved credentials else transaction will be processed via web view within the All-in-One SDK(Paytm hosted redirection flow).

4. Paytm processes the transaction with the user’s bank and returns the transaction response to your app.

5. You call the Transaction Status API to verify the transaction response.

6. Notify the payment status to the user and proceed with the order/service fulfilment.

Before you begin the integration, make sure you follow the steps below:

1. Create an account on Paytm as a merchant. Click how to create an account.

   Note: Save the MID and merchant key generated in the above step.

2. Go through the checksum logic to understand how to generate and validate the checksum.

3. Get the staging android or iOS Paytm app for integration testing on the merchant staging environment.

4. Go through All-in-One SDK documentation before proceeding with integration.

5. Call the Initiate Transaction API from your backend to generate Transaction Token.

Follow the steps below to integrate All-in-One SDK in your flutter app:

Note:

In case of Okhttp Exception, make the following changes to your build.gradle (app level):

• Exclude okhttp from the app invoke SDK
  implementation('com.paytm.appinvokesdk:appinvokesdk:1.5.4'){
    exclude group: "com.squareup.okhttp3", module: 'okhttp3'
}
• If okhttp is not added in your project dependencies then add
  implementation "com.squareup.okhttp3:okhttp:4.8.0"

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

   dependencies:
      ...
     paytm_allinonesdk: ^1.1.7

2. You can install packages from the command line with Flutter:

   $ flutter pub get

3. Now in your Dart code, you can use

   import 'package:paytm_allinonesdk/paytm_allinonesdk.dart';

4. Call plugin method as below:

   var response = AllInOneSdk.startTransaction(
            mid, orderId, amount, txnToken, callbackurl, isStaging, restrictAppInvoke);
   response.then((value) {
          print(value);
          setState(() {
            result = value.toString();
          });
    }).catchError((onError) {
          if (onError is PlatformException) {
            setState(() {
              result = onError.message + " \n  " + onError.details.toString();
            });
          } else {
            setState(() {
              result = onError.toString();
            });
          }
    });
   

   Attributes	Description	Mandatory
   mid String(20)	A unique identifier which is a part of your account credentials and is provided to every merchant by Paytm. It is different on staging and production environment.	Yes
   orderid String(50)	A unique reference ID for a transaction which is generated by merchant Special characters allowed in Order ID are: "@" "-" "_" ".". Note - pass same order id in SDK which was used for initiateTransaction	Yes
   txnToken String	Transaction token received in response to Initiate Transaction API request.	Yes
   amount String	Amount in INR payable by the customer. It should contain digits up to two decimal points and the amount should not include any separator like (",").	Yes
   isStaging Boolean	Defines the staging or production server (True for staging and False for production)	Yes
   callbackurl String(255)	On completion of the transaction, Paytm Payment Gateway sends the response on this URL. This URL should be same as passed in callbackURL of Initiate Transaction API. It can be a dynamic or static response URL as mentioned below: Staging Environment: "https://securestage.paytmpayments.com/theia/paytmCallback?ORDER_ID=<order_id>" Production Environment: "https://secure.paytmpayments.com/theia/paytmCallback?ORDER_ID=<order_id>"	Yes
   restrictAppInvoke Boolean	restrictAppInvoke is to define app invoke restriction (Only Redirection flow when True else AppInovke if Paytm app is installed)	Yes

5. Callback will be received in ‘then’ method as below else error message will be received in catchError method.
   
   Sample Response for Android

   {
       "TXNAMOUNT": "1.00",
       "TXNDATE": "2020-07-21 19:00:05.0",
       "BANKTXNID": "Bank transaction Id",
       "TXNID": "Transaction Value",
       "BANKNAME": "WALLET",
       "GATEWAYNAME": "WALLET",
       "CHECKSUMHASH": "XXXXXX",
       "STATUS": "TXN_SUCCESS",
       "ORDERID": "Order Id",
       "MID": "Merchant Id",
       "PAYMENTMODE": "PPI",
       "RESPCODE": "01",
       "CURRENCY": "INR",
       "RESPMSG": "Txn Success"
   }

   
   Sample Response for iOS

   {
     txnToken: 6a310365ba0747998b651XXXXXXXX6328050877XX,
     orderId: LAL_1632805083_202XX928XXXXXX,
     response: {
       "TXNAMOUNT": "1.00",
       "TXNDATE": "2020-07-21 19:00:05.0",
       "BANKTXNID": "Bank transaction Id",
       "TXNID": "Transaction Value",
       "BANKNAME": "WALLET",
       "GATEWAYNAME": "WALLET",
       "CHECKSUMHASH": "XXXXXX",
       "STATUS": "TXN_SUCCESS",
       "ORDERID": "Order Id",
       "MID": "Merchant Id",
       "PAYMENTMODE": "PPI",
       "RESPCODE": "01",
       "CURRENCY": "INR",
       "RESPMSG": "Txn Success"
     },
     status: PYTM_103,
     mid: "Merchant Id",
     trimmedurl: paytmXXXXXXXXXX:
   }

6. Verifying Payment

   1. You should validate the transaction response via a server-side request using the Transaction Status API. This API requires checksumhash in request and response. You must verify the Order ID and Amount with your data. The status should be treated as the final status of the transaction in all cases.
   2. Paytm provides payment response on both Callback URL and Webhook URL. Please click here for more details.

7. Add the following pro-guard rules if needed:

   -keep class com.paytm.pgsdk.model.ProcessTransactionInfo { *; }
   -keep class com.paytm.pgsdk.model.Body { *; }