Custom UI SDK Integration - Optional Methods

paytmSDK.openPaytmAppForAddMoneyToWallet(activity)

Method Params:

Note: To support PSP Apps (UPI Intent) or to invoke Paytm app for Target SDK version 30 ( Android 11) and above. Please add below query in AndroidManifest.xml.

<queries>
   <package android:name=“net.one97.paytm” />
    <intent>
       <action android:name=“android.intent.action.MAIN” />
    </intent>
</queries>

Use the attributes below in your XML to customize the consent checkbox:

Usage Example:

<net.one97.paytm.nativesdk.common.widget.PaytmConsentCheckBox
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:text="Allow <Merchant> to fetch Paytm instruments"
   app:consentButton="@drawable/customised_checkbox"
   app:consentCheckboxColorStateList="@drawable/consent_colorstatelist"
   app:consentTextAppearance="@style/ConsentTextAppearance"
   app:consentBackgroundColor="@color/gray"/>

Usage:

PaytmPaymentsUtilRepository paymentsUtilRepository =PaytmSDK.getPaymentsUtilRepository()
paymentsUtilRepository.userHasSavedInstruments(context, mid)

Method Parameters:

Response:

UpiDataRequestModel requestModel = new UpiDataRequestModel(vpa,bankAccount)

paytmSDK.fetchUpiBalance(this, upiDataRequestModel)

{   // value of data
  "statusCode": 100,
  "statusMsg": "SUCCESS",
  "totalBalance": "12345.6"
}

UpiDataRequestModel requestModel = new UpiDataRequestModel(vpa,bankAccount)

Constructor Params:

Method Parameters:

paytmSDK.setUpiPin(this, upiDataRequestModel) 

{"statusCode":100,"statusMsg":"SUCCESS"}

fun getNBList(callback: PaymentMethodDataSource.Callback<JSONObject>)

PaytmSDK.getPaymentsHelper()
   getNBList(object:PaymentMethodDataSource.Callback<JSONObject> {
        override fun onResponse(response: JSONObject?,) {
            Toast.makeText(this@BaseInstrumentActivity, getMessage(response),
            Toast.LENGTH_LONG).show()
        }
        override fun onErrorResponse(error: VolleyError?, errorInfo: JSONObject?) {
             Toast.makeText(this@BaseInstrumentActivity, 
                getMessage(errorInfo) ?: "Error fetching NB List", 
                Toast.LENGTH_LONG).show()  
        }
})

class="language-javascript">{
    "head":{
        "requestId":null,
        "responseTimestamp":"1591622928848",
        "version":"v1"
    },
    "body":{
        "extraParamsMap":null,
        "resultInfo":{
            "resultStatus":"S",
            "resultCode":"0000",
            "resultMsg":"Success"
        },
        "nbPayOption":{
            "displayName":"Net Banking",
            "isDisabled":{
                "status":"false",
                "msg":""
            },
            "payChannelOptions":[
                {
                "isDisabled":{
                    "status":"false",
                    "msg":null
                },
                "hasLowSuccess":{
                    "status":"false",
                    "msg":""
                },
                "iconUrl":"AXIS.png",
                "isHybridDisabled":false,
                "channelCode":"AXIS",
                "channelName":"Axis Bank"
                },
                {
                "isDisabled":{
                    "status":"false",
                    "msg":null
                },
                "hasLowSuccess":{
                    "status":"false",
                    "msg":""
                },
                "iconUrl":"HDFC.png",
                "isHybridDisabled":false,
                "channelCode":"HDFC",
                "channelName":"HDFC Bank"
                }
            ]
        }
    }
}

PaytmPaymentsUtilRepository paymentsUtilRepository =PaytmSDK.getPaymentsUtilRepository()
paymentsUtilRepository.getLastNBSavedBank()

Method:

This method will return a string parameter.

Note: This method will return the bank code using which successful transaction using NetBanking was done

Method Signature:

PaytmSDK.getPaymentsUtilRepository().checkIfLoggedInUserMobNoMatched(context, userMobileHash ,object :
                    CheckLoggedInUserMatchListener{
                    override fun getIfUserMatched(case: Int) {
                       }
 
                })

Method Parameters:

Generate SHA256 Hash Of User’s Mobile

private String getSHA256HashString(String userMobileNumber) throws NoSuchAlgorithmException {
MessageDigest md = MessageDigest.getInstance("SHA-256");
            md.reset();
            byte[] hashedBytes = md.digest(userMobileNumber.getBytes());
            return new String(hashedBytes);
}

PaymentsDataImpl.validateVPA(vpa, mid, tokenType, txn, orderId, object : PaymentMethodDataSource.Callback<VPAValidateResponse> {
   override fun onResponse(response: VPAValidateResponse?) {
       if (response?.isValid == true) {
           Toast.makeText(applicationContext, "VPA Validated", Toast.LENGTH_SHORT).show()
       } else {
           Toast.makeText(applicationContext, "VPA Not Validated " + response?.resultMsg, Toast.LENGTH_SHORT).show()
       }
   }

   override fun onErrorResponse(error: VolleyError?, errorInfo: VPAValidateResponse?) {
       Toast.makeText(applicationContext, "Error in API", Toast.LENGTH_SHORT).show()
   }
},upiNumber)

Method Parameters:

This will return a VPAValidateResponse object which contains isValid (boolean) and is true if it is valid vpaId.

1. To invoke the Paytm app, add the following entry into Info.plist.

   1. LSApplicationQueriesSchemes(Array) Item 0 (String)->paytm

   2. LSApplicationQueriesSchemes(Array) Item 1 (String)->paytmmp

   

   Define the app delegate method to handle Paytm response. The client will get the response in the Appdelegate Method.

   

   func application(_ app: UIApplication, open url: URL, 
   options: [UIApplicationOpenURLOptionsKey : Any] = [:]) ->Bool{
       let dict = separateDeeplinkParamsIn(url: url.absoluteString, byRemovingParams: nil)
        //get paytm params from dictionary
       return true
   }

    

2. Use the method mentioned below to invoke Paytm:

   public func openPaytm(selectedPayModel: PaytmNativeSDK.AINativeInhouseParameterModel, 
            merchantId: String, 
            orderId: String, 
            txnToken: String, 
            amount: String, 
            callbackUrl: String?, 
            delegate: PaytmNativeSDK.AIDelegate, 
            environment: PaytmNativeSDK.AIEnvironment)

   Sample Response:

   {
       "nameValuePairs": {
           "ORDERID": "PARCEL16105282330",
           "MID": "AliSub58582630351896",
           "TXNID": "20210113111212800110168877474890508",
           "TXNAMOUNT": "1.00",
           "PAYMENTMODE": "PPI",
           "CURRENCY": "INR",
           "TXNDATE": "2021-01-13 14:27:12.0",
           "STATUS": "TXN_SUCCESS",
           "RESPCODE": "01",
           "RESPMSG": "Txn Success",
           "MERC_UNQ_REF": "test4",
           "UDF_1": "test1",
           "UDF_2": "test2",
           "UDF_3": "test3",
           "ADDITIONAL_INFO": "test5",
           "GATEWAYNAME": "WALLET",
           "BANKTXNID": "151096542207",
           "BANKNAME": "WALLET"
       }
   }

func fetchBin(selectedPayModel : AINativeSavedCardParameterModel, delegate: AIDelegate)

Method Params:

self.appInvoke.fetchBin(selectedPayModel: self.selectedModel!, delegate: self)

Use the method mentioned below to save the channel code of the last used net banking instrument in the cache:

self.appInvoke.saveNetBankingMethod(channelCode: channelCode)

Use the method mentioned below to fetch the channel code of the last used net banking instrument from the cache:

self.appInvoke.getSavedNetBankingMethod()

Below are the possible values:

enum MerchantPaymentStatus:String {
    case none = "PYTM_100"
    case initiated = "PYTM_101"
    case paymentMode = "PYTM_102"
    case paymentDeduction = "PYTM_103"
    case errorInParameter = "PYTM_104"
    case error = "PYTM_105"
    case cancel = "PYTM_106"
}

Use the method mentioned below to save the VPA used by the customer in the last UPI collect transaction:

self.appInvoke.saveVPA(vpa: vpaAddress)

Use the method mentioned below to fetch and show the VPA used by the customer in the last UPI collect transaction:

self.appInvoke.getSavedVPA()

Method Signature:

fun fetchNetBankingChannels(selectedPayModel : AINativeNBParameterModel,
    delegate: AIDelegate)

Method Parameters:

final public func setBackgroundColor(_ color: UIColor)
final public func setFontFamily(_ family: String)
final public func setFontSize(_ size: CGFloat)
final public func setFont(_ font: UIFont)
final public func setTextColor(_ color: UIColor)
final public func setSelectedCheckmarkImage(_ image: UIImage?)
final public func setSelectedCheckmarkTint(_ tintColor: UIColor)
final public func setUnselectedCheckmarkImage(_ image: UIImage?)
final public func setUnselectedCheckmarkTint(_ tintColor: UIColor)
final public func applyTheme(_ theme: PaytmNativeSDK.AINativeConsentView.Theme)

consentView.applyTheme(theme)
consentView.setFontSize(12)