@getivy/node-sdk 0.1.0-alpha.2
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/CHANGELOG.md +24 -0
- package/LICENSE +201 -0
- package/README.md +303 -0
- package/_shims/MultipartBody.d.ts +9 -0
- package/_shims/MultipartBody.d.ts.map +1 -0
- package/_shims/MultipartBody.js +16 -0
- package/_shims/MultipartBody.js.map +1 -0
- package/_shims/MultipartBody.mjs +12 -0
- package/_shims/MultipartBody.mjs.map +1 -0
- package/_shims/README.md +46 -0
- package/_shims/auto/runtime-bun.d.ts +5 -0
- package/_shims/auto/runtime-bun.d.ts.map +1 -0
- package/_shims/auto/runtime-bun.js +21 -0
- package/_shims/auto/runtime-bun.js.map +1 -0
- package/_shims/auto/runtime-bun.mjs +2 -0
- package/_shims/auto/runtime-bun.mjs.map +1 -0
- package/_shims/auto/runtime-node.d.ts +5 -0
- package/_shims/auto/runtime-node.d.ts.map +1 -0
- package/_shims/auto/runtime-node.js +21 -0
- package/_shims/auto/runtime-node.js.map +1 -0
- package/_shims/auto/runtime-node.mjs +2 -0
- package/_shims/auto/runtime-node.mjs.map +1 -0
- package/_shims/auto/runtime.d.ts +5 -0
- package/_shims/auto/runtime.d.ts.map +1 -0
- package/_shims/auto/runtime.js +21 -0
- package/_shims/auto/runtime.js.map +1 -0
- package/_shims/auto/runtime.mjs +2 -0
- package/_shims/auto/runtime.mjs.map +1 -0
- package/_shims/auto/types-node.d.ts +5 -0
- package/_shims/auto/types-node.d.ts.map +1 -0
- package/_shims/auto/types-node.js +21 -0
- package/_shims/auto/types-node.js.map +1 -0
- package/_shims/auto/types-node.mjs +2 -0
- package/_shims/auto/types-node.mjs.map +1 -0
- package/_shims/auto/types.d.ts +101 -0
- package/_shims/auto/types.js +3 -0
- package/_shims/auto/types.mjs +3 -0
- package/_shims/bun-runtime.d.ts +6 -0
- package/_shims/bun-runtime.d.ts.map +1 -0
- package/_shims/bun-runtime.js +14 -0
- package/_shims/bun-runtime.js.map +1 -0
- package/_shims/bun-runtime.mjs +10 -0
- package/_shims/bun-runtime.mjs.map +1 -0
- package/_shims/index.d.ts +81 -0
- package/_shims/index.js +13 -0
- package/_shims/index.mjs +7 -0
- package/_shims/manual-types.d.ts +12 -0
- package/_shims/manual-types.js +3 -0
- package/_shims/manual-types.mjs +3 -0
- package/_shims/node-runtime.d.ts +3 -0
- package/_shims/node-runtime.d.ts.map +1 -0
- package/_shims/node-runtime.js +89 -0
- package/_shims/node-runtime.js.map +1 -0
- package/_shims/node-runtime.mjs +56 -0
- package/_shims/node-runtime.mjs.map +1 -0
- package/_shims/node-types.d.ts +42 -0
- package/_shims/node-types.js +3 -0
- package/_shims/node-types.mjs +3 -0
- package/_shims/registry.d.ts +37 -0
- package/_shims/registry.d.ts.map +1 -0
- package/_shims/registry.js +41 -0
- package/_shims/registry.js.map +1 -0
- package/_shims/registry.mjs +37 -0
- package/_shims/registry.mjs.map +1 -0
- package/_shims/web-runtime.d.ts +5 -0
- package/_shims/web-runtime.d.ts.map +1 -0
- package/_shims/web-runtime.js +78 -0
- package/_shims/web-runtime.js.map +1 -0
- package/_shims/web-runtime.mjs +71 -0
- package/_shims/web-runtime.mjs.map +1 -0
- package/_shims/web-types.d.ts +83 -0
- package/_shims/web-types.js +3 -0
- package/_shims/web-types.mjs +3 -0
- package/core.d.ts +241 -0
- package/core.d.ts.map +1 -0
- package/core.js +908 -0
- package/core.js.map +1 -0
- package/core.mjs +876 -0
- package/core.mjs.map +1 -0
- package/error.d.ts +47 -0
- package/error.d.ts.map +1 -0
- package/error.js +113 -0
- package/error.js.map +1 -0
- package/error.mjs +97 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +157 -0
- package/index.d.ts +157 -0
- package/index.d.ts.map +1 -0
- package/index.js +164 -0
- package/index.js.map +1 -0
- package/index.mjs +121 -0
- package/index.mjs.map +1 -0
- package/package.json +103 -0
- package/resource.d.ts +6 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +11 -0
- package/resource.js.map +1 -0
- package/resource.mjs +7 -0
- package/resource.mjs.map +1 -0
- package/resources/balance.d.ts +34 -0
- package/resources/balance.d.ts.map +1 -0
- package/resources/balance.js +16 -0
- package/resources/balance.js.map +1 -0
- package/resources/balance.mjs +12 -0
- package/resources/balance.mjs.map +1 -0
- package/resources/banks.d.ts +223 -0
- package/resources/banks.d.ts.map +1 -0
- package/resources/banks.js +30 -0
- package/resources/banks.js.map +1 -0
- package/resources/banks.mjs +26 -0
- package/resources/banks.mjs.map +1 -0
- package/resources/capabilities.d.ts +28 -0
- package/resources/capabilities.d.ts.map +1 -0
- package/resources/capabilities.js +16 -0
- package/resources/capabilities.js.map +1 -0
- package/resources/capabilities.mjs +12 -0
- package/resources/capabilities.mjs.map +1 -0
- package/resources/charges.d.ts +86 -0
- package/resources/charges.d.ts.map +1 -0
- package/resources/charges.js +15 -0
- package/resources/charges.js.map +1 -0
- package/resources/charges.mjs +11 -0
- package/resources/charges.mjs.map +1 -0
- package/resources/checkoutsession.d.ts +2370 -0
- package/resources/checkoutsession.d.ts.map +1 -0
- package/resources/checkoutsession.js +30 -0
- package/resources/checkoutsession.js.map +1 -0
- package/resources/checkoutsession.mjs +26 -0
- package/resources/checkoutsession.mjs.map +1 -0
- package/resources/customers.d.ts +37 -0
- package/resources/customers.d.ts.map +1 -0
- package/resources/customers.js +21 -0
- package/resources/customers.js.map +1 -0
- package/resources/customers.mjs +17 -0
- package/resources/customers.mjs.map +1 -0
- package/resources/index.d.ts +13 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +29 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +14 -0
- package/resources/index.mjs.map +1 -0
- package/resources/mandates.d.ts +91 -0
- package/resources/mandates.d.ts.map +1 -0
- package/resources/mandates.js +27 -0
- package/resources/mandates.js.map +1 -0
- package/resources/mandates.mjs +23 -0
- package/resources/mandates.mjs.map +1 -0
- package/resources/orders.d.ts +1255 -0
- package/resources/orders.d.ts.map +1 -0
- package/resources/orders.js +23 -0
- package/resources/orders.js.map +1 -0
- package/resources/orders.mjs +19 -0
- package/resources/orders.mjs.map +1 -0
- package/resources/payouts.d.ts +224 -0
- package/resources/payouts.d.ts.map +1 -0
- package/resources/payouts.js +28 -0
- package/resources/payouts.js.map +1 -0
- package/resources/payouts.mjs +24 -0
- package/resources/payouts.mjs.map +1 -0
- package/resources/refunds.d.ts +138 -0
- package/resources/refunds.d.ts.map +1 -0
- package/resources/refunds.js +28 -0
- package/resources/refunds.js.map +1 -0
- package/resources/refunds.mjs +24 -0
- package/resources/refunds.mjs.map +1 -0
- package/resources/reports.d.ts +120 -0
- package/resources/reports.d.ts.map +1 -0
- package/resources/reports.js +31 -0
- package/resources/reports.js.map +1 -0
- package/resources/reports.mjs +27 -0
- package/resources/reports.mjs.map +1 -0
- package/resources/subaccounts.d.ts +49 -0
- package/resources/subaccounts.d.ts.map +1 -0
- package/resources/subaccounts.js +22 -0
- package/resources/subaccounts.js.map +1 -0
- package/resources/subaccounts.mjs +18 -0
- package/resources/subaccounts.mjs.map +1 -0
- package/shims/node.d.ts +30 -0
- package/shims/node.d.ts.map +1 -0
- package/shims/node.js +31 -0
- package/shims/node.js.map +1 -0
- package/shims/node.mjs +5 -0
- package/shims/node.mjs.map +1 -0
- package/shims/web.d.ts +26 -0
- package/shims/web.d.ts.map +1 -0
- package/shims/web.js +31 -0
- package/shims/web.js.map +1 -0
- package/shims/web.mjs +5 -0
- package/shims/web.mjs.map +1 -0
- package/src/_shims/MultipartBody.ts +9 -0
- package/src/_shims/README.md +46 -0
- package/src/_shims/auto/runtime-bun.ts +4 -0
- package/src/_shims/auto/runtime-node.ts +4 -0
- package/src/_shims/auto/runtime.ts +4 -0
- package/src/_shims/auto/types-node.ts +4 -0
- package/src/_shims/auto/types.d.ts +101 -0
- package/src/_shims/auto/types.js +3 -0
- package/src/_shims/auto/types.mjs +3 -0
- package/src/_shims/bun-runtime.ts +14 -0
- package/src/_shims/index.d.ts +81 -0
- package/src/_shims/index.js +13 -0
- package/src/_shims/index.mjs +7 -0
- package/src/_shims/manual-types.d.ts +12 -0
- package/src/_shims/manual-types.js +3 -0
- package/src/_shims/manual-types.mjs +3 -0
- package/src/_shims/node-runtime.ts +81 -0
- package/src/_shims/node-types.d.ts +42 -0
- package/src/_shims/node-types.js +3 -0
- package/src/_shims/node-types.mjs +3 -0
- package/src/_shims/registry.ts +67 -0
- package/src/_shims/web-runtime.ts +103 -0
- package/src/_shims/web-types.d.ts +83 -0
- package/src/_shims/web-types.js +3 -0
- package/src/_shims/web-types.mjs +3 -0
- package/src/core.ts +1200 -0
- package/src/error.ts +130 -0
- package/src/index.ts +393 -0
- package/src/lib/.keep +4 -0
- package/src/resource.ts +11 -0
- package/src/resources/balance.ts +49 -0
- package/src/resources/banks.ts +1536 -0
- package/src/resources/capabilities.ts +291 -0
- package/src/resources/charges.ts +108 -0
- package/src/resources/checkoutsession.ts +9254 -0
- package/src/resources/customers.ts +60 -0
- package/src/resources/index.ts +75 -0
- package/src/resources/mandates.ts +135 -0
- package/src/resources/orders.ts +3195 -0
- package/src/resources/payouts.ts +297 -0
- package/src/resources/refunds.ts +184 -0
- package/src/resources/reports.ts +172 -0
- package/src/resources/subaccounts.ts +73 -0
- package/src/shims/node.ts +50 -0
- package/src/shims/web.ts +50 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +255 -0
- package/src/version.ts +1 -0
- package/uploads.d.ts +75 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +171 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +158 -0
- package/uploads.mjs.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../resource';
|
|
4
|
+
import * as Core from '../core';
|
|
5
|
+
|
|
6
|
+
export class Capabilities extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieve the capabilities of your Ivy account. The capabilities are broken down
|
|
9
|
+
* by market and by product.
|
|
10
|
+
*/
|
|
11
|
+
retrieve(
|
|
12
|
+
body: CapabilityRetrieveParams,
|
|
13
|
+
options?: Core.RequestOptions,
|
|
14
|
+
): Core.APIPromise<CapabilityRetrieveResponse> {
|
|
15
|
+
return this._client.post('/api/service/merchant/capabilities/details', { body, ...options });
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export interface CapabilityRetrieveResponse {
|
|
20
|
+
/**
|
|
21
|
+
* Either `'pis'` or `'ais'` or both. The capabilities of the merchant set in the
|
|
22
|
+
* merchant dashboard for the specific market. If no capabilities are set, the
|
|
23
|
+
* response will be an empty array. Check if `'pis'` is present in the array for
|
|
24
|
+
* payments capabilities.
|
|
25
|
+
*/
|
|
26
|
+
capabilities: Array<'pis' | 'ais'>;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
export interface CapabilityRetrieveParams {
|
|
30
|
+
/**
|
|
31
|
+
* The market for which you want to retrieve the capabilities.
|
|
32
|
+
*/
|
|
33
|
+
market:
|
|
34
|
+
| 'AF'
|
|
35
|
+
| 'AL'
|
|
36
|
+
| 'DZ'
|
|
37
|
+
| 'AS'
|
|
38
|
+
| 'AD'
|
|
39
|
+
| 'AO'
|
|
40
|
+
| 'AI'
|
|
41
|
+
| 'AQ'
|
|
42
|
+
| 'AG'
|
|
43
|
+
| 'AR'
|
|
44
|
+
| 'AM'
|
|
45
|
+
| 'AW'
|
|
46
|
+
| 'AU'
|
|
47
|
+
| 'AT'
|
|
48
|
+
| 'AZ'
|
|
49
|
+
| 'BS'
|
|
50
|
+
| 'BH'
|
|
51
|
+
| 'BD'
|
|
52
|
+
| 'BB'
|
|
53
|
+
| 'BY'
|
|
54
|
+
| 'BE'
|
|
55
|
+
| 'BZ'
|
|
56
|
+
| 'BJ'
|
|
57
|
+
| 'BM'
|
|
58
|
+
| 'BT'
|
|
59
|
+
| 'BO'
|
|
60
|
+
| 'BA'
|
|
61
|
+
| 'BW'
|
|
62
|
+
| 'BV'
|
|
63
|
+
| 'BR'
|
|
64
|
+
| 'IO'
|
|
65
|
+
| 'BN'
|
|
66
|
+
| 'BG'
|
|
67
|
+
| 'BF'
|
|
68
|
+
| 'BI'
|
|
69
|
+
| 'KH'
|
|
70
|
+
| 'CM'
|
|
71
|
+
| 'CA'
|
|
72
|
+
| 'CV'
|
|
73
|
+
| 'KY'
|
|
74
|
+
| 'CF'
|
|
75
|
+
| 'TD'
|
|
76
|
+
| 'CL'
|
|
77
|
+
| 'CN'
|
|
78
|
+
| 'CX'
|
|
79
|
+
| 'CC'
|
|
80
|
+
| 'CO'
|
|
81
|
+
| 'KM'
|
|
82
|
+
| 'CG'
|
|
83
|
+
| 'CD'
|
|
84
|
+
| 'CK'
|
|
85
|
+
| 'CR'
|
|
86
|
+
| 'CI'
|
|
87
|
+
| 'HR'
|
|
88
|
+
| 'CU'
|
|
89
|
+
| 'CY'
|
|
90
|
+
| 'CZ'
|
|
91
|
+
| 'DK'
|
|
92
|
+
| 'DJ'
|
|
93
|
+
| 'DM'
|
|
94
|
+
| 'DO'
|
|
95
|
+
| 'EC'
|
|
96
|
+
| 'EG'
|
|
97
|
+
| 'SV'
|
|
98
|
+
| 'GQ'
|
|
99
|
+
| 'ER'
|
|
100
|
+
| 'EE'
|
|
101
|
+
| 'ET'
|
|
102
|
+
| 'FK'
|
|
103
|
+
| 'FO'
|
|
104
|
+
| 'FJ'
|
|
105
|
+
| 'FI'
|
|
106
|
+
| 'FR'
|
|
107
|
+
| 'GF'
|
|
108
|
+
| 'PF'
|
|
109
|
+
| 'TF'
|
|
110
|
+
| 'GA'
|
|
111
|
+
| 'GM'
|
|
112
|
+
| 'GE'
|
|
113
|
+
| 'DE'
|
|
114
|
+
| 'GH'
|
|
115
|
+
| 'GI'
|
|
116
|
+
| 'GR'
|
|
117
|
+
| 'GL'
|
|
118
|
+
| 'GD'
|
|
119
|
+
| 'GP'
|
|
120
|
+
| 'GU'
|
|
121
|
+
| 'GT'
|
|
122
|
+
| 'GN'
|
|
123
|
+
| 'GW'
|
|
124
|
+
| 'GY'
|
|
125
|
+
| 'HT'
|
|
126
|
+
| 'HM'
|
|
127
|
+
| 'VA'
|
|
128
|
+
| 'HN'
|
|
129
|
+
| 'HK'
|
|
130
|
+
| 'HU'
|
|
131
|
+
| 'IS'
|
|
132
|
+
| 'IN'
|
|
133
|
+
| 'ID'
|
|
134
|
+
| 'IR'
|
|
135
|
+
| 'IQ'
|
|
136
|
+
| 'IE'
|
|
137
|
+
| 'IL'
|
|
138
|
+
| 'IT'
|
|
139
|
+
| 'JM'
|
|
140
|
+
| 'JP'
|
|
141
|
+
| 'JO'
|
|
142
|
+
| 'KZ'
|
|
143
|
+
| 'KE'
|
|
144
|
+
| 'KI'
|
|
145
|
+
| 'KP'
|
|
146
|
+
| 'KR'
|
|
147
|
+
| 'KW'
|
|
148
|
+
| 'KG'
|
|
149
|
+
| 'LA'
|
|
150
|
+
| 'LV'
|
|
151
|
+
| 'LB'
|
|
152
|
+
| 'LS'
|
|
153
|
+
| 'LR'
|
|
154
|
+
| 'LY'
|
|
155
|
+
| 'LI'
|
|
156
|
+
| 'LT'
|
|
157
|
+
| 'LU'
|
|
158
|
+
| 'MO'
|
|
159
|
+
| 'MG'
|
|
160
|
+
| 'MW'
|
|
161
|
+
| 'MY'
|
|
162
|
+
| 'MV'
|
|
163
|
+
| 'ML'
|
|
164
|
+
| 'MT'
|
|
165
|
+
| 'MH'
|
|
166
|
+
| 'MQ'
|
|
167
|
+
| 'MR'
|
|
168
|
+
| 'MU'
|
|
169
|
+
| 'YT'
|
|
170
|
+
| 'MX'
|
|
171
|
+
| 'FM'
|
|
172
|
+
| 'MD'
|
|
173
|
+
| 'MC'
|
|
174
|
+
| 'MN'
|
|
175
|
+
| 'MS'
|
|
176
|
+
| 'MA'
|
|
177
|
+
| 'MZ'
|
|
178
|
+
| 'MM'
|
|
179
|
+
| 'NA'
|
|
180
|
+
| 'NR'
|
|
181
|
+
| 'NP'
|
|
182
|
+
| 'NL'
|
|
183
|
+
| 'NC'
|
|
184
|
+
| 'NZ'
|
|
185
|
+
| 'NI'
|
|
186
|
+
| 'NE'
|
|
187
|
+
| 'NG'
|
|
188
|
+
| 'NU'
|
|
189
|
+
| 'NF'
|
|
190
|
+
| 'MP'
|
|
191
|
+
| 'MK'
|
|
192
|
+
| 'NO'
|
|
193
|
+
| 'OM'
|
|
194
|
+
| 'PK'
|
|
195
|
+
| 'PW'
|
|
196
|
+
| 'PS'
|
|
197
|
+
| 'PA'
|
|
198
|
+
| 'PG'
|
|
199
|
+
| 'PY'
|
|
200
|
+
| 'PE'
|
|
201
|
+
| 'PH'
|
|
202
|
+
| 'PN'
|
|
203
|
+
| 'PL'
|
|
204
|
+
| 'PT'
|
|
205
|
+
| 'PR'
|
|
206
|
+
| 'QA'
|
|
207
|
+
| 'RE'
|
|
208
|
+
| 'RO'
|
|
209
|
+
| 'RU'
|
|
210
|
+
| 'RW'
|
|
211
|
+
| 'SH'
|
|
212
|
+
| 'KN'
|
|
213
|
+
| 'LC'
|
|
214
|
+
| 'PM'
|
|
215
|
+
| 'VC'
|
|
216
|
+
| 'WS'
|
|
217
|
+
| 'SM'
|
|
218
|
+
| 'ST'
|
|
219
|
+
| 'SA'
|
|
220
|
+
| 'SN'
|
|
221
|
+
| 'SC'
|
|
222
|
+
| 'SL'
|
|
223
|
+
| 'SG'
|
|
224
|
+
| 'SK'
|
|
225
|
+
| 'SI'
|
|
226
|
+
| 'SB'
|
|
227
|
+
| 'SO'
|
|
228
|
+
| 'ZA'
|
|
229
|
+
| 'GS'
|
|
230
|
+
| 'ES'
|
|
231
|
+
| 'LK'
|
|
232
|
+
| 'SD'
|
|
233
|
+
| 'SR'
|
|
234
|
+
| 'SJ'
|
|
235
|
+
| 'SZ'
|
|
236
|
+
| 'SE'
|
|
237
|
+
| 'CH'
|
|
238
|
+
| 'SY'
|
|
239
|
+
| 'TW'
|
|
240
|
+
| 'TJ'
|
|
241
|
+
| 'TZ'
|
|
242
|
+
| 'TH'
|
|
243
|
+
| 'TL'
|
|
244
|
+
| 'TG'
|
|
245
|
+
| 'TK'
|
|
246
|
+
| 'TO'
|
|
247
|
+
| 'TT'
|
|
248
|
+
| 'TN'
|
|
249
|
+
| 'TR'
|
|
250
|
+
| 'TM'
|
|
251
|
+
| 'TC'
|
|
252
|
+
| 'TV'
|
|
253
|
+
| 'UG'
|
|
254
|
+
| 'UA'
|
|
255
|
+
| 'AE'
|
|
256
|
+
| 'GB'
|
|
257
|
+
| 'US'
|
|
258
|
+
| 'UM'
|
|
259
|
+
| 'UY'
|
|
260
|
+
| 'UZ'
|
|
261
|
+
| 'VU'
|
|
262
|
+
| 'VE'
|
|
263
|
+
| 'VN'
|
|
264
|
+
| 'VG'
|
|
265
|
+
| 'VI'
|
|
266
|
+
| 'WF'
|
|
267
|
+
| 'EH'
|
|
268
|
+
| 'YE'
|
|
269
|
+
| 'ZM'
|
|
270
|
+
| 'ZW'
|
|
271
|
+
| 'AX'
|
|
272
|
+
| 'BQ'
|
|
273
|
+
| 'CW'
|
|
274
|
+
| 'GG'
|
|
275
|
+
| 'IM'
|
|
276
|
+
| 'JE'
|
|
277
|
+
| 'ME'
|
|
278
|
+
| 'BL'
|
|
279
|
+
| 'MF'
|
|
280
|
+
| 'RS'
|
|
281
|
+
| 'SX'
|
|
282
|
+
| 'SS'
|
|
283
|
+
| 'XK';
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
export declare namespace Capabilities {
|
|
287
|
+
export {
|
|
288
|
+
type CapabilityRetrieveResponse as CapabilityRetrieveResponse,
|
|
289
|
+
type CapabilityRetrieveParams as CapabilityRetrieveParams,
|
|
290
|
+
};
|
|
291
|
+
}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../resource';
|
|
4
|
+
import * as Core from '../core';
|
|
5
|
+
|
|
6
|
+
export class Charges extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Creates a Direct Debit Charge with a valid mandate.
|
|
9
|
+
*/
|
|
10
|
+
create(body: ChargeCreateParams, options?: Core.RequestOptions): Core.APIPromise<Charge> {
|
|
11
|
+
return this._client.post('/api/service/charge/create', { body, ...options });
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export interface Charge {
|
|
16
|
+
id: string;
|
|
17
|
+
|
|
18
|
+
mandateId: string;
|
|
19
|
+
|
|
20
|
+
orderId?: string;
|
|
21
|
+
|
|
22
|
+
subaccountId?: string;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export interface ChargeCreateParams {
|
|
26
|
+
/**
|
|
27
|
+
* A unique key to ensure the charge is not processed twice.
|
|
28
|
+
*/
|
|
29
|
+
idempotencyKey: string;
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* A valid mandate id of the customer's bank account. This can be retrieved from
|
|
33
|
+
* the `mandate_setup_succeeded` event.
|
|
34
|
+
*/
|
|
35
|
+
mandateId: string;
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* The price to be charged.
|
|
39
|
+
*/
|
|
40
|
+
price: ChargeCreateParams.Price;
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* An internal reference id which will be stored with the charge & corresponding
|
|
44
|
+
* order. Needs to be unique per merchant per order and can be up to 200
|
|
45
|
+
* characters. We recommend to use your internal order id here.
|
|
46
|
+
*/
|
|
47
|
+
referenceId: string;
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Additional data to be stored with the charge.
|
|
51
|
+
*/
|
|
52
|
+
metadata?: ChargeCreateParams.Metadata;
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* The subaccount id to be used for the charge.
|
|
56
|
+
*/
|
|
57
|
+
subaccountId?: string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export namespace ChargeCreateParams {
|
|
61
|
+
/**
|
|
62
|
+
* The price to be charged.
|
|
63
|
+
*/
|
|
64
|
+
export interface Price {
|
|
65
|
+
currency: 'EUR' | 'GBP' | 'PLN';
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* The total amount to be paid.
|
|
69
|
+
*/
|
|
70
|
+
total: number;
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* The shipping amount.
|
|
74
|
+
*/
|
|
75
|
+
shipping?: number;
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* The subtotal amount, i.e. the total amount without VAT and shipping.
|
|
79
|
+
*/
|
|
80
|
+
subTotal?: number;
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* The total net amount, i.e. the total amount without VAT. This value is rounded
|
|
84
|
+
* to 2 decimal places for the actual transfer.
|
|
85
|
+
*/
|
|
86
|
+
totalNet?: number;
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* The VAT amount.
|
|
90
|
+
*/
|
|
91
|
+
vat?: number;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Additional data to be stored with the charge.
|
|
96
|
+
*/
|
|
97
|
+
export interface Metadata {
|
|
98
|
+
/**
|
|
99
|
+
* A token to verify incoming webhooks. Used in the shopware plugin. Limited to 200
|
|
100
|
+
* characters.
|
|
101
|
+
*/
|
|
102
|
+
verificationToken?: string;
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
export declare namespace Charges {
|
|
107
|
+
export { type Charge as Charge, type ChargeCreateParams as ChargeCreateParams };
|
|
108
|
+
}
|