capacitor-paxstore-sdk
v1.0.30
Published
Communicate with Paxstore SDK, to receive data from POS treminals.
Downloads
5
Maintainers
Readme
capacitor-paxstore-sdk
Communicate with Paxstore SDK, to receive data from POS treminals.
Install
npm install capacitor-paxstore-sdk
npx cap sync
API
init(...)
checkInit()
startSale(...)
startReversal(...)
startRefund(...)
startPrintTrans(...)
startPrintTransTotal(...)
findPrinters()
setPrinter(...)
printBill(...)
- Interfaces
init(...)
init(options: InitOptions) => any
Initialize sdk.
| Param | Type | Description |
| ------------- | --------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| options
| InitOptions | : {appKey: string, appSecret: string, packageName: 'com.pax.psp_3rd_app'}` Get from offsite. |
Returns: any
Since: 1.0.0
checkInit()
checkInit() => any
Check Initialization.
Returns: any
Since: 1.0.8
startSale(...)
startSale(options: SaleOptions) => any
Start Sale API to start payment
| Param | Type |
| ------------- | --------------------------------------------------- |
| options
| SaleOptions |
Returns: any
Since: 1.0.9
startReversal(...)
startReversal(options: ReversalOptions) => any
Start Reversal API to start reversal
| Param | Type | Description |
| ------------- | ----------------------------------------------------------- | ---------------- |
| options
| ReversalOptions | : {rrn: string}` |
Returns: any
Since: 1.0.20
startRefund(...)
startRefund(options: RefundOptions) => any
Start Refund API to start reversal
| Param | Type | Description |
| ------------- | ------------------------------------------------------- | -------------------------------- |
| options
| RefundOptions | : {amount: string, rrn: string}` |
Returns: any
Since: 1.0.20
startPrintTrans(...)
startPrintTrans(options: PrintTransOptions) => any
Start Print Transaction API to start Print Transaction
| Param | Type | Description |
| ------------- | --------------------------------------------------------------- | ------------------------ |
| options
| PrintTransOptions | : {etVoucherNo: string}` |
Returns: any
Since: 1.0.20
startPrintTransTotal(...)
startPrintTransTotal(options: PrintTransTotalOptions) => any
Start Print Transaction Total API to start Print Transaction Total
| Param | Type | Description |
| ------------- | ------------------------------------------------------------------------- | ------------------------ |
| options
| PrintTransTotalOptions | : {etPrintType: string}` |
Returns: any
Since: 1.0.20
findPrinters()
findPrinters() => any
Find printers API to List all connected printers
Returns: any
Since: 1.0.25
setPrinter(...)
setPrinter(options: { address: string; }) => any
Select Printer API to select printer and init it
| Param | Type |
| ------------- | --------------------------------- |
| options
| { address: string; } |
Returns: any
Since: 1.0.25
printBill(...)
printBill(options: { value: string; }) => any
Print Bill API to Print bill
| Param | Type | Description |
| ------------- | ------------------------------- | ------------------ |
| options
| { value: string; } | : {value: string}` |
Returns: any
Since: 1.0.21
Interfaces
InitOptions
| Prop | Type |
| ----------------- | ------------------- |
| appKey
| string |
| appSecret
| string |
| packageName
| string |
SaleOptions
| Prop | Type |
| ------------ | ------------------- |
| amount
| string |
ReversalOptions
| Prop | Type |
| --------- | ------------------- |
| rrn
| string |
RefundOptions
| Prop | Type |
| ------------ | ------------------- |
| amount
| string |
| rrn
| string |
PrintTransOptions
| Prop | Type |
| ----------------- | ------------------- |
| etVoucherNo
| string |
PrintTransTotalOptions
| Prop | Type |
| ----------------- | ------------------- |
| etPrintType
| string |
Printer
| Prop | Type |
| ------------- | ------------------- |
| address
| string |
| name
| string |
| class
| string |