terminal-gateway 1.0.5 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,7 +34,7 @@ $ yarn add terminal-gateway
|
|
|
34
34
|
|
|
35
35
|
``` javascript
|
|
36
36
|
import Terminal from 'terminal-gateway'
|
|
37
|
-
|
|
37
|
+
|
|
38
38
|
const terminal = new Terminal({
|
|
39
39
|
key: '',
|
|
40
40
|
timeout: 50000,
|
|
@@ -45,12 +45,14 @@ $ yarn add terminal-gateway
|
|
|
45
45
|
|
|
46
46
|
## Sale transaction
|
|
47
47
|
__onSale():__ This method allows you to do sale transactions. user needs to call this function to get the result failed or successful. It is required four parameters:
|
|
48
|
-
| Parameter name | Data type |
|
|
49
|
-
|
|
|
48
|
+
| Parameter name | Data type | Require | Default | Description |
|
|
49
|
+
| --------- | --- | --- | --- | --- |
|
|
50
50
|
| amount | String | Yes | 0 | amount define transaction |
|
|
51
|
-
| type | String | Yes | SHOWQR | SHOWQR: sale by screen QR
|
|
51
|
+
| type | String | Yes | SHOWQR | SHOWQR: sale by screen QR code <br> EDC: sale by card |
|
|
52
52
|
| invoice | String | Yes | The invoice number must be unique. Example: INV0011620291635 |
|
|
53
|
-
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
54
56
|
``` javascript
|
|
55
57
|
terminal.onSale({amount: '0.01', type: 'SHOWQR', currency: 'USD', invoice: 'INV0011620291635'})
|
|
56
58
|
```
|
|
@@ -59,9 +61,10 @@ __onEnquiry():__ This method allows you to receive the response back with the re
|
|
|
59
61
|
|
|
60
62
|
| Parameter name | Data type | Require | Default |Description |
|
|
61
63
|
| --- | --- | --- | --- | --- |
|
|
62
|
-
| invoice | String | Yes |
|
|
64
|
+
| invoice | String | Yes | | The invoice number must be unique. example: `INV0011620291635`|
|
|
65
|
+
|
|
66
|
+
|
|
63
67
|
|
|
64
|
-
<br />
|
|
65
68
|
``` javascript
|
|
66
69
|
terminal.onEnquiry({invoice: 'INV0011620291635'})
|
|
67
70
|
```
|