-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(CustomUiSDK): add plugin for Paytm Custom UI SDK (#3546)
* added custom-uisdk index file * feat(CustomUiSDK): add plugin for Paytm Custom UI SDK * removed template generated comments and added ngx at the end to the import
- Loading branch information
Showing
1 changed file
with
306 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,306 @@ | ||
import { Injectable } from '@angular/core'; | ||
import { | ||
Plugin, | ||
Cordova, | ||
CordovaProperty, | ||
CordovaInstance, | ||
InstanceProperty, | ||
IonicNativePlugin, | ||
} from '@ionic-native/core'; | ||
|
||
/** | ||
* @name CustomUISDK | ||
* @description | ||
* This plugin is used to access Paytm's native CustomUISDK framework's apis. | ||
* | ||
* @usage | ||
* ```typescript | ||
* import { CustomUISDK } from '@ionic-native/custom-uisdk/ngx'; | ||
* | ||
* constructor(private customuisdk: CustomUISDK) { } | ||
* | ||
* ... | ||
* this.customuisdk.functionName('Hello', 123) | ||
* .then((res: any) => console.log(res)) | ||
* .catch((error: any) => console.error(error)); | ||
* ``` | ||
*/ | ||
@Plugin({ | ||
pluginName: 'cordova-paytm-customuisdk', | ||
plugin: 'cordova-paytm-customuisdk', | ||
pluginRef: 'paytm.customuisdk', | ||
repo: 'https://github.com/paytm/paytm-customuisdk-cordova', | ||
install: '', | ||
installVariables: [], | ||
platforms: ['Android, iOS'], | ||
}) | ||
@Injectable() | ||
export class CustomUISDK extends IonicNativePlugin { | ||
/** | ||
* This function show dialog to ask user permision to fetch authcode | ||
* @param clientId {string} unique id give to each merchant | ||
* @param mid {string} merchant id | ||
* @return {Promise<string>} Returns authcode | ||
*/ | ||
@Cordova() | ||
fetchAuthCode(clientId: string, mid: string): Promise<string> { | ||
return; | ||
} | ||
|
||
/** | ||
* This function check that paytm app is installed or not | ||
* @return {Promise<boolean>} Returns installed - true or not -false | ||
*/ | ||
@Cordova() | ||
isPaytmAppInstalled(): Promise<boolean> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param mid {string} merchant id | ||
* @return {Promise<boolean>} Returns if has payment methods - true or not -false | ||
*/ | ||
@Cordova() | ||
checkHasInstrument(mid: string): Promise<boolean> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param mid {string} merchant id | ||
* @param orderId {string} order id | ||
* @param txnToken {string} transaction token | ||
* @param amount {string} transaction amount | ||
* @param isStaging {boolean} staging or production | ||
* @param callbackUrl {string} callback url only required for custom url page | ||
*/ | ||
@Cordova() | ||
initPaytmSDK( | ||
mid: string, | ||
orderId: string, | ||
txnToken: string, | ||
amount: string, | ||
isStaging: boolean, | ||
callbackUrl: string | ||
) { | ||
return; | ||
} | ||
|
||
/** | ||
* @param paymentFlow {string} payment type NONE, ADDANDPAY | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
goForWalletTransaction(paymentFlow: string): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param cardNumber {string} card number | ||
* @param cardExpiry {string} card expiry | ||
* @param cardCvv {string} card cvv | ||
* @param cardType {string} card type debit or credit | ||
* @param paymentFlow {string} payment type NONE, ADDANDPAY | ||
* @param channelCode {string} bank channel code | ||
* @param issuingBankCode {string} issuing bank code | ||
* @param emiChannelId {string} emi plan id | ||
* @param authMode {string} authentication mode 'otp' 'pin' | ||
* @param saveCard {boolean} save card for next time | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
goForNewCardTransaction( | ||
cardNumber: string, | ||
cardExpiry: string, | ||
cardCvv: string, | ||
cardType: string, | ||
paymentFlow: string, | ||
channelCode: string, | ||
issuingBankCode: string, | ||
emiChannelId: string, | ||
authMode: string, | ||
saveCard: boolean | ||
): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param cardId {string} card id of saved card | ||
* @param cardCvv {string} card cvv | ||
* @param cardType {string} card type debit or credit | ||
* @param paymentFlow {string} payment type NONE, ADDANDPAY | ||
* @param channelCode {string} bank channel code | ||
* @param issuingBankCode {string} issuing bank code | ||
* @param emiChannelId {string} emi plan id | ||
* @param authMode {string} authentication mode 'otp' 'pin' | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
goForSavedCardTransaction( | ||
cardId: string, | ||
cardCvv: string, | ||
cardType: string, | ||
paymentFlow: string, | ||
channelCode: string, | ||
issuingBankCode: string, | ||
emiChannelId: string, | ||
authMode: string | ||
): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param netBankingCode {string} bank channel code | ||
* @param paymentFlow {string} payment type NONE, ADDANDPAY | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
goForNetBankingTransaction(netBankingCode: string, paymentFlow: string): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param upiCode {string} upi code | ||
* @param paymentFlow {string} payment type NONE, ADDANDPAY | ||
* @param saveVPA {boolean} save vpa for future transaction | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
goForUpiCollectTransaction(upiCode: string, paymentFlow: string, saveVPA: boolean): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @return {Promise<any>} Returns upi app list names | ||
*/ | ||
@Cordova() | ||
getUpiIntentList(): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param appName {string} upi app name | ||
* @param paymentFlow {string} payment type NONE, ADDANDPAY | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
goForUpiIntentTransaction(appName: string, paymentFlow: string): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param vpaName {string} vpa name | ||
* @param paymentFlow {string} payment type NONE, ADDANDPAY | ||
* @param bankAccountJson {{}} bank account json object | ||
* @param merchantDetailsJson {{}} merchant detail json | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
goForUpiPushTransaction( | ||
paymentFlow: string, | ||
bankAccountJson: {}, | ||
vpaName: string, | ||
merchantDetailsJson: {} | ||
): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param vpaName {string} vpa name | ||
* @param bankAccountJson {{}} bank account json object | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
fetchUpiBalance(bankAccountJson: {}, vpaName: string): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param vpaName {string} vpa name | ||
* @param bankAccountJson {{}} bank account json object | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
setUpiMpin(bankAccountJson: {}, vpaName: string): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param cardSixDigit {string} card starting six digit | ||
* @param tokenType {string} token type ACCESS or TXN_TOKEN | ||
* @param token {string} token fetch from api | ||
* @param mid {string} merchant id | ||
* @param referenceId {string} reference id | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
getBin(cardSixDigit: string, tokenType: string, token: string, mid: string, referenceId: string): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param tokenType {string} token type ACCESS or TXN_TOKEN | ||
* @param token {string} token fetch from api | ||
* @param mid {string} merchant id | ||
* @param orderId {string} order id required only if token type is TXN_TOKEN | ||
* @param referenceId {string} reference id required only if token type is ACCESS | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
fetchNBList(tokenType: string, token: string, mid: string, orderId: string, referenceId: string): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param channelCode {string} bank channel code | ||
* @param cardType {string} card type debit or credit | ||
* @return {Promise<any>} Returns object of response | ||
*/ | ||
@Cordova() | ||
fetchEmiDetails(channelCode: string, cardType: string): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @return {Promise<any>} Returns last successfully used net backing code | ||
*/ | ||
|
||
@Cordova() | ||
getLastNBSavedBank(): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @return {Promise<any>} Returns last successfully used vpa code | ||
*/ | ||
|
||
@Cordova() | ||
getLastSavedVPA(): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param clientId {string} unique id give to each merchant | ||
* @param authCode {string} fetched auth code | ||
* @return {Promise<any>} Returns last successfully used vpa code | ||
*/ | ||
@Cordova() | ||
isAuthCodeValid(clientId: string, authCode: string): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* @return {Promise<any>} Returns current environment | ||
*/ | ||
@Cordova() | ||
getEnvironment(): Promise<string> { | ||
return; | ||
} | ||
|
||
/** | ||
* @param environment {string} setting environment PRODUCTION or STAGING | ||
*/ | ||
@Cordova() | ||
setEnvironment(environment: string): void { | ||
return; | ||
} | ||
} |