https://github.com/grayhat12/gray-upi
upi plugin for capacitorjs
https://github.com/grayhat12/gray-upi
android capacitor-android capacitor-plugin capacitorjs transaction upi-payment upi-plugin
Last synced: 20 days ago
JSON representation
upi plugin for capacitorjs
- Host: GitHub
- URL: https://github.com/grayhat12/gray-upi
- Owner: GrayHat12
- License: mit
- Created: 2020-10-08T01:56:28.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-10-08T11:48:55.000Z (over 4 years ago)
- Last Synced: 2025-01-06T04:36:51.528Z (about 2 months ago)
- Topics: android, capacitor-android, capacitor-plugin, capacitorjs, transaction, upi-payment, upi-plugin
- Language: Java
- Homepage: https://www.npmjs.com/package/capacitor-gray-upi
- Size: 202 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# capacitor-gray-upi
## Description
UPI Payments Plugin that uses EasyUpiPayment library.
This Plugin implements the [EasyUpiPayment](https://eupipay-docs.netlify.app/) library to initiate UPI payment and handle events.
## Supported platforms
- Android
## Android setup
- `npm i capacitor-gray-upi`
- `ionic build`
- `npx cap copy`
- `npx cap sync`
- `npx cap open android`
- `[extra step]` in android case we need to tell Capacitor to initialise the plugin:
> on your `MainActivity.java` file add `import com.grayhat.upi.GrayUPI;` and then inside the init callback `add(GrayUPI.class);`
Now you should be set to go. Try to run your client using `npx cap open android`.
> Tip: every time you change a native code you may need to clean up the cache (Build > Clean Project | Build > Rebuild Project) and then run the app again.
## Example
```js
import { Plugins } from '@capacitor/core';
import 'capacitor-gray-upi';
const { GrayUPI } = Plugins;
// ...code
//function to start payment (handle errors yourself)
startPayment = async () => {
GrayUPI.addListener('onTransactionCompleted', (res: any) => {
alert(JSON.stringify(res));
});
GrayUPI.addListener('onTransactionCancelled', (res: any) => {
alert(JSON.stringify(res));
});
GrayUPI.initialise({
transID: "**********",
transRefID: "**********",
amount: '1.00',
description: 'Test Payment',
vpa: '1234567890@service',
name: 'Sample Name',
})
.then(() => {
GrayUPI.startPayment();
})
.catch((err: any) => {
alert(JSON.stringify(err));
});
};
```
### `initialise(transaction:Transaction)`
This initialises the UPI Plugin and prepares it for `startPayment()` call.
Returns `Promise`
#### `Transaction`
```js
interface Transaction {
vpa: string;
name: string;
transID: string;
transRefID: string;
description: string;
amount: string; // decimal format
}
```
### `startPayment()`
This starts the payment intent on Android where the user chooses an App for UPI Payment and proceeds.
Returns `Promise`
### Event : `'onTransactionCompleted'`
listener : `(transaction:TransactionDetails) => void`
Transaction Completed with `"SUBMITTED"|"SUCCESS"|"FAILURE"` status
* `SUBMITTED` : Transaction is in PENDING state. Money might get deducted from user’s account but not yet deposited in payee’s account.
* `SUCCESS` : Transaction is successful.
* `FAILURE` : Transaction is failed.
#### `TransactionDetails`
```js
interface TransactionDetails {
transID : string;
responseCode : string;
approvalRefNo : string;
transactionStatus : "SUBMITTED"|"SUCCESS"|"FAILURE";
transactionRefId : string;
amount : string;
}
```
### Event : `'onTransactionCancelled'`
listener : `() => void`
User cancelled transaction or transaction failed
## Testing
Manually tested against the following platforms:
- Android device 10.0 (API Level 29)