choco-one-click-payment 1.0.2 → 1.0.4
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 +27 -15
- package/index.d.ts +35 -0
- package/index.esm.js +1 -1
- package/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,10 +17,10 @@ import ChocoOneClickWidget from 'choco-one-click-payment';
|
|
|
17
17
|
|
|
18
18
|
const widget = new ChocoOneClickWidget({
|
|
19
19
|
trackId: 'your-track-id',
|
|
20
|
-
clientId: '
|
|
21
|
-
terminalId:
|
|
22
|
-
merchantOrderId: '
|
|
23
|
-
amount:
|
|
20
|
+
clientId: '123456',
|
|
21
|
+
terminalId: 1234,
|
|
22
|
+
merchantOrderId: '123456',
|
|
23
|
+
amount: 500,
|
|
24
24
|
environment: 'stage',
|
|
25
25
|
onSuccess: (data) => console.log('Success', data),
|
|
26
26
|
onError: (error) => console.error('Error', error),
|
|
@@ -36,17 +36,29 @@ CommonJS:
|
|
|
36
36
|
const ChocoOneClickWidget = require('choco-one-click-widget');
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
## API
|
|
40
|
-
|
|
41
|
-
- `
|
|
42
|
-
- `trackId` - track_id
|
|
43
|
-
- `terminalId` - ID терминала
|
|
44
|
-
- `merchantOrderId` - ID заказа
|
|
45
|
-
- `amount` - Сумма в
|
|
46
|
-
- `currency` -
|
|
47
|
-
- `environment` - production или stage
|
|
48
|
-
- `backlink` - URL для возврата
|
|
49
|
-
- `locale` - ru, en, kk (по умолчанию ru)
|
|
39
|
+
## API (Параметры)
|
|
40
|
+
|
|
41
|
+
- `client_id` - client_id веб-оплаты (обязательно)
|
|
42
|
+
- `trackId` - track_id (обязательно)
|
|
43
|
+
- `terminalId` - ID терминала (обязательно)
|
|
44
|
+
- `merchantOrderId` - ID заказа (обязательно)
|
|
45
|
+
- `amount` - Сумма в тенге (обязательно)
|
|
46
|
+
- `currency` - валюта (по умолчанию KZT) (обязательно)
|
|
47
|
+
- `environment` - production или stage (обязательно)
|
|
48
|
+
- `backlink` - URL для возврата (опционально)
|
|
49
|
+
- `locale` - ru, en, kk (по умолчанию ru, опционально)
|
|
50
|
+
- `preorderId` - preorder_id заказа (опционально)
|
|
51
|
+
- `disabled` - блокирует UI (опционально)
|
|
52
|
+
- `loading` - загрузка и блокировка UI (опционально)
|
|
53
|
+
- `color` - цвет background-а элементов (по умолчанию #2F2F2F, опционально)
|
|
54
|
+
- `onlyKaspiAvailable` - отключает все способы оплат и оставляет только Kaspi (опционально)
|
|
55
|
+
- `disableKaspi` - отключает оплату по kaspi (опционально)
|
|
56
|
+
|
|
57
|
+
## Методы
|
|
58
|
+
|
|
59
|
+
- `onSuccess` - вызывается после успешной оплаты (опционально)
|
|
60
|
+
- `onError` - вызывается в случае ошибки оплаты, резолвит текст ошибки (опционально)
|
|
61
|
+
- `onCancel` - вызывается при timeout (опционально)
|
|
50
62
|
|
|
51
63
|
## Сборка пакета (для разработчиков)
|
|
52
64
|
|
package/index.d.ts
CHANGED
|
@@ -3,6 +3,11 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
export interface ChocoOneClickConfig {
|
|
6
|
+
/**
|
|
7
|
+
* PreorderId для авторизации. При init() по нему получается access token.
|
|
8
|
+
* @required
|
|
9
|
+
*/
|
|
10
|
+
preorderId: number;
|
|
6
11
|
/**
|
|
7
12
|
* TrackId для авторизации. При init() по нему получается access token.
|
|
8
13
|
* @required
|
|
@@ -77,6 +82,36 @@ export interface ChocoOneClickConfig {
|
|
|
77
82
|
* Callback вызываемый при отмене оплаты пользователем
|
|
78
83
|
*/
|
|
79
84
|
onCancel?: () => void;
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Отключает интерактивные действия виджета (оплата и выбор метода)
|
|
88
|
+
* @default false
|
|
89
|
+
*/
|
|
90
|
+
disabled?: boolean;
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Показывает состояние загрузки и блокирует интеракции виджета
|
|
94
|
+
* @default false
|
|
95
|
+
*/
|
|
96
|
+
loading?: boolean;
|
|
97
|
+
|
|
98
|
+
/**
|
|
99
|
+
* Акцентный цвет (фон кнопки оплаты и включенного тумблера баланса)
|
|
100
|
+
* @default "#2F2F2F"
|
|
101
|
+
*/
|
|
102
|
+
color?: string;
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Когда true — доступна только оплата Kaspi, остальные способы не отображаются
|
|
106
|
+
* @default false
|
|
107
|
+
*/
|
|
108
|
+
onlyKaspiAvailable?: boolean;
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Отключает оплату через Kaspi; остальные способы работают как обычно
|
|
112
|
+
* @default false
|
|
113
|
+
*/
|
|
114
|
+
disableKaspi?: boolean;
|
|
80
115
|
}
|
|
81
116
|
|
|
82
117
|
export interface PaymentSuccessEvent {
|