Ionic SDK Integration (Standard)

The steps to integrate the PhonePe Payment Gateway with the Ionic platform. We provide a plugin/bridge to integrate our SDK.

The minimum supported versions

Ionic:- 4.*
Latest Ionic SDK Version: 2.0.1

We can implement with the below 2 steps:

Add the native configuration (Android/iOS)
Add the Plugin to the Ionic project

Sequence

Add the native configuration (Android/iOS)
Android – Add the native configuration in the Android Studio project
iOS – Add the native configuration in the Xcode project
Add the Plugin in your Ionic Project/App
1. Init Method
2. Start The PG transaction
3. Helper Methods (For Android and iOS)
4. Helper Methods (Only Android Specific)
  1. Get Package Signature for Android
  2. Get UPI Apps for Android
Parameters
Server Side Implementation
Ionic Sample App

Add the native configuration (Android/iOS)

Android

Add the native configuration in the Android Studio project

Add the below code to ‘repositories’ section of your project level build.gradle file

// Top-level build file where you can add configuration options common to all sub-projects/modules.

allprojects {
   repositories {
       google()
       maven {
            url  "https://phonepe.mycloudrepo.io/public/repositories/phonepe-intentsdk-android"
       }
   }
}

iOS

Add the native configuration in the Xcode project

1. In your Info.plist under the iOS Xcode project, create or append a new Array type node LSApplicationQueriesSchemes to append the following values:

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>ppemerchantsdkv1</string>
    <string>ppemerchantsdkv2</string>
    <string>ppemerchantsdkv3</string>
    <string>paytmmp</string>
    <string>gpay</string>
</array>

2. Create a URLType for your app (Deeplink), if not already present.

For example, we have used: iOSIntentIntegration. (You can create your own identifier for your app)

URLScheme should match the below conditions

Only Alphabets (lower and upper case) and numbers are allowed.
We can allow special characters only like dot and Hyphen
The name should always start with alphabets.

The schema should be correct to redirect the app otherwise it will not redirect back to the merchant app.

Add the Plugin in your Ionic Project/App

Add the dependency in your project

npm i  https://phonepe.mycloudrepo.io/public/repositories/phonepe-mobile-capacitor-sdk/releases/v2/phonepe-payment-capacitor.tgz -f

import the package in your code

import { PhonePePaymentPlugin } from 'phonepe-payment-capacitor'

Call the PhonePe methods as below

Init Method (Initialisation of SDK)

Initialize the init method before starting the transaction.


/**
* This method is used to initiate PhonePe Payment sdk.

* Provide all the information as requested by the method signature.

* Params:

* - environment: This signified the environment required for the payment sdk

* possible values: SANDBOX, PRODUCTION

* if any unknown value is provided, PRODUCTION will be considered as default.

* - merchantId: The merchant id provided by PhonePe at the time of onboarding.

* - appId:

* - It is optional, if you have received it from the PhonePe team, kindly pass it within the method. Otherwise pass it as 'null'.

* - enableLogging: If you want to enabled sdk log

* - enabled = YES

* - disable = NO

* - Return: Boolean (TRUE -> SUCCESS).

* - SUCCESS: TRUE

* - FAILURE: FALSE

* - in iOS = False 

* - in Android = Error in case of invalid arguments ex: "Invalid environment or merchantId!"

*/
    init(options: {
    environment: string,
    merchantId: string,
    appId: string | null,
    enableLogging: boolean | false
    }): Promise<Record<string, boolean>>;  
 

Example:
PhonePePaymentPlugin.init({
      environment: environment,
      merchantId: merchantId,
      appId: appId,
      enableLogging: false
    }).then(result => {        
        console.log('VS: '+ JSON.stringify(result['status']));
        setMessage(JSON.stringify(result['status']));     
    }).catch(error => {
      console.log('VS: error:'+ error.message);
    })

Start The PG transaction

/**
* This method is used to initiate PhonePe B2B PG Flow.
* Provide all the information as requested by the method signature.
* Params:
* - body : The request body for the transaction as per the developer docs, Make sure the request body is base64encoded.
* - checksum: checksum for the particular transaction as per the developer docs.
* - packageName: @Optional(Not need for iOS) For android, it is a packageName for specific app.
* - appSchema: @Optional(Not need for Android) For iOS, Your custom URL Schemes, as per the developer docs.
* Return: Will be returning a dictionary / hashMap
* {
* status: String, // string value to provide the status of the transaction
* // possible values: SUCCESS, FAILURE, INTERRUPTED
* error: String // if any error occurs
* }
*/
startTransaction(options: {
body: string,
checksum: string,
packageName: string | null,
appSchema: string | null
}):Promise<Record<string, string>>;

Example:

await PhonePePaymentPlugin.startTransaction({
body: base64,
checksum: checksum,
packageName: packageName, // Package name
appSchema: 'ionicDemoApp'
}).then(a => {
console.log('VS: '+ JSON.stringify(a));
setMessage(JSON.stringify(a));
}).catch(error => {
console.log('VS: error:'+ error.message);
setMessage("error:" + error.message);
})

Helper Methods (Only Android Specific)

Get Package Signature for Android

/**
   * This method is called to get package signature while creation of AppId in @Android only.
   * Return: String
   *  Non empty string -> app package signature
   *  NOTE :- In iOS, it will send null.
   */
  getPackageSignatureForAndroid(): Promise<Record<string, string>>;
 
 
Example:
if (Capacitor.getPlatform() === 'android') {
      PhonePePaymentPlugin.getPackageSignatureForAndroid().then(result => {
        console.log('VS: '+ JSON.stringify(result['status']));
        setMessage(JSON.stringify(result['status']));
      }).catch(error => {
        setMessage("error:" + error.message);
      })
    }
  };

Parameters

Keys	Data Type	Possible Values
environment	String	1. SANDBOX 2. PRODUCTION
merchantId	String	Add the Merchant ID provided by the Integration Team
appId	String	It is optional, if you have received it from the PhonePe team, kindly pass it within the method. Otherwise pass it as ‘null’.
enableLogs	Bool	Show the logs in the console in the SDK 1. true 2. false
body	String	base64String request body
callbackURL	String	[Only for iOS]Your App URL Scheme – To return the UI control back to the merchant app.
checksum	String	Checksum for the particular transaction.
apiEndPoint	String	The API endpoint for the PG transaction.
packageName	String	[Only for Android] The Package name of the UPI app selected by the user.

Server Side Implementation

Step 1. Save the below-assigned value on your server

String apiEndPoint = "/pg/v1/pay";

Step 2. Construct the request body and encode it in Base 64 at your server as per the platform (Android/iOS):

For PG Pay API (Standard Checkout), refer to this Link.

Sample Request

{
  "merchantId": "MERCHANTUAT",
  "merchantTransactionId": "MT7850590068188104",
  "merchantUserId": "MUID123",
  "amount": 10000,
  "redirectUrl": "https://webhook.site/redirect-url",
  "redirectMode": "REDIRECT",
  "callbackUrl": "https://webhook.site/callback-url",
  "mobileNumber": "9999999999",
  "paymentInstrument": {
    "type": "PAY_PAGE"
  }
}

Convert the JSON Payload to Base64 Encoded Payload

The above JSON request payload should be converted to the Base64 Encoded Payload and then the request should be sent in the below format.

{
  "request": "ewogICJtZXJjaGFudElkIjogIk1FUkNIQU5UVUFUIiwKICAibWVyY2hhbnRUcmFuc2FjdGlvbklkIjogIk1UNzg1MDU5MDA2ODE4ODEwNCIsCiAgIm1lcmNoYW50VXNlcklkIjogIk1VSUQxMjMiLAogICJhbW91bnQiOiAxMDAwMCwKICAicmVkaXJlY3RVcmwiOiAiaHR0cHM6Ly93ZWJob29rLnNpdGUvcmVkaXJlY3QtdXJsIiwKICAicmVkaXJlY3RNb2RlIjogIlJFRElSRUNUIiwKICAiY2FsbGJhY2tVcmwiOiAiaHR0cHM6Ly93ZWJob29rLnNpdGUvY2FsbGJhY2stdXJsIiwKICAibW9iaWxlTnVtYmVyIjogIjk5OTk5OTk5OTkiLAogICJwYXltZW50SW5zdHJ1bWVudCI6IHsKICAgICJ0eXBlIjogIlBBWV9QQUdFIgogIH0KfQ=="
}

Step 3. Checksum Calculation

Select one of the salts shared with you and note its index. Construct the X-verify at your server as follows:

String checksum = sha256(base64Body + apiEndPoint + salt) + ### + saltIndex;

Step 4. Check the payment status

Once the payment is completed, please call the Check Transaction Status API to validate the response received via the App. You can call the Check Transaction Status at regular intervals to fetch the response from the PhonePe server in case a response is not received in the application even after 10 minutes of initiating the application.

Step 5. Handling Payment Status

The payment status can be Successful, Failed, Pending or any of the codes. For Pending, you should retry until the status changes to Successful or Failed.

Ionic Sample App

Refer to the Sample App to test the Plugin and use in your Ionic platform – Link