search

All-in-One SDK Integration for Ionic platform via Cordova Plugin

To merchants who have built their app on an Ionic platform, Paytm provides a bridge to conveniently integrate All-in-One SDK for both Android and iOS. In this page, we will highlight the steps required to integrate All-in-One SDK with Cordova plugin for your app. This bridge will help you to build a seamless and responsive checkout experience for your iOS or Android 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 result 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 transactions and give results to you.

Overview of payment processing via ionic bridge

  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 tokens.
    Within 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 a 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.

Pre-requisites

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.

Integration on Ionic for All-in-One SDK with Cordova plugin

Note:
  1. Download the paytm staging app for android and iOS and install it. Login on the staging app with credentials 7777777777 and static otp 888888.
  2. To help you with the integration, we have provided a sample merchant app integrated with this SDK. To get the sample app, please click here.

Please go through the following steps to integrate All-in-One SDK in your Ionic app:

  1. Add the plugins to your ionic project.

    • ionic cordova plugin add cordova-paytm-allinonesdk

    • ionic cordova plugin add cordova-plugin-androidx

    • ionic cordova plugin add cordova-plugin-androidx-adapter

    Note: Ignore the warning message "Plugin doesn't support this project's cordova-android version. cordova-android: 9.0.0, failed version requirement: <9.0.0", if it comes on adding cordova-plugin-androidx plugin.
  2. Add ionic-native wrapper to your application.

    Note: We are working on ionic-native wrapper for all-in-one-sdk with ionic team after that you can use below command to add that.
    npm install @ionic-native/all-in-one-sdk

    But for now use below process to add ionic wapper.
    Take checkout from below git command out of your ionic project directory (branch all-in-one-sdk).

    - git clone -b 'allInOneSDK' https://github.com/paytm/ionic-native.git
    - cd ionic-native
    - npm i
    - npm run build

    Now go to your ionic project directory and run the below command:

    - cp -r ../ionic-native/dist/@ionic-native/plugins/all-in-one-sdk ./node_modules/@ionic-native
    
    Note: Change the path of directories as per your project structure and while running any code for cordova plugin you have to run above copy(cp) code again.
  3. This step is only for the iOS platform, you can avoid this step if your application is not available for iOS. Add iOS platform to your application.

    ionic cordova platform add ios

    This will create an iOS project for your application at the following path:
    'applicationName/platforms/ios/applicationName.xcworkspace'

    1. Info: Add LSApplicationQueriesSchemes. Change the type to Array. Create a new item in it and set its value as “paytm”.

    2. Info -> URL Types: Add a new URL Type that you’ll be using as the callback from Paytm app (URL Scheme: “paytm”+”MID”). Example: paytmMid123.

  4. Add the plugin to your app's provider list.

    import { AllInOneSDK } from '@ionic-native/all-in-one-sdk/ngx'
    @NgModule({
      declarations: [...],
      entryComponents: [...],
      imports: [...],
      providers: [..., AllInOneSDK],
      bootstrap: [...]
    })
    export class AppModule {}
    
  5. In your page from where you want to invoke the All-in-One SDK, add the following code:

    import { AllInOneSDK } from '@ionic-native/all-in-one-sdk/ngx'
    constructor(private allInOneSDK : AllInOneSDK) {} 
    //Call Initiate Transaction API from your backend to generate Transaction Token.
    let paymentIntent = { mid : "<Merchant ID>",
                          orderId: "<Order ID>",
                          txnToken: "<Transaction Token generated by Initiate Transaction API from your backend>", 
                          amount: "<Amount>", 
                          isStaging: "<Environment(true/false)>", 
                          callbackUrl: "<Callback URL>", 
                          restrictAppInvoke: "<Restrict(true/false)>",
                          enableAssist: "<Restrict(true/false)>"};
    this.allInOneSDK.startTransaction(paymentIntent).then(
    resp => {
      // The response received after the transaction is completed will be an object containing "message" and "response". You can parse both and use them as required in your application
      alert(JSON.parse(resp.response));
    }).catch(error => {
      alert(error);
    })
    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://securegw-stage.paytm.in/theia/paytmCallback?ORDER_ID=<order_id>"
    • Production Environment: "https://securegw.paytm.in/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

    enableAssist

    Boolean

    enableAssist is to enable or disable otp assist (For enabling otp assist flow pass True else for disabling pass false) No
    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"
  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.