@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.
Files changed (249) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/LICENSE +201 -0
  3. package/README.md +303 -0
  4. package/_shims/MultipartBody.d.ts +9 -0
  5. package/_shims/MultipartBody.d.ts.map +1 -0
  6. package/_shims/MultipartBody.js +16 -0
  7. package/_shims/MultipartBody.js.map +1 -0
  8. package/_shims/MultipartBody.mjs +12 -0
  9. package/_shims/MultipartBody.mjs.map +1 -0
  10. package/_shims/README.md +46 -0
  11. package/_shims/auto/runtime-bun.d.ts +5 -0
  12. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  13. package/_shims/auto/runtime-bun.js +21 -0
  14. package/_shims/auto/runtime-bun.js.map +1 -0
  15. package/_shims/auto/runtime-bun.mjs +2 -0
  16. package/_shims/auto/runtime-bun.mjs.map +1 -0
  17. package/_shims/auto/runtime-node.d.ts +5 -0
  18. package/_shims/auto/runtime-node.d.ts.map +1 -0
  19. package/_shims/auto/runtime-node.js +21 -0
  20. package/_shims/auto/runtime-node.js.map +1 -0
  21. package/_shims/auto/runtime-node.mjs +2 -0
  22. package/_shims/auto/runtime-node.mjs.map +1 -0
  23. package/_shims/auto/runtime.d.ts +5 -0
  24. package/_shims/auto/runtime.d.ts.map +1 -0
  25. package/_shims/auto/runtime.js +21 -0
  26. package/_shims/auto/runtime.js.map +1 -0
  27. package/_shims/auto/runtime.mjs +2 -0
  28. package/_shims/auto/runtime.mjs.map +1 -0
  29. package/_shims/auto/types-node.d.ts +5 -0
  30. package/_shims/auto/types-node.d.ts.map +1 -0
  31. package/_shims/auto/types-node.js +21 -0
  32. package/_shims/auto/types-node.js.map +1 -0
  33. package/_shims/auto/types-node.mjs +2 -0
  34. package/_shims/auto/types-node.mjs.map +1 -0
  35. package/_shims/auto/types.d.ts +101 -0
  36. package/_shims/auto/types.js +3 -0
  37. package/_shims/auto/types.mjs +3 -0
  38. package/_shims/bun-runtime.d.ts +6 -0
  39. package/_shims/bun-runtime.d.ts.map +1 -0
  40. package/_shims/bun-runtime.js +14 -0
  41. package/_shims/bun-runtime.js.map +1 -0
  42. package/_shims/bun-runtime.mjs +10 -0
  43. package/_shims/bun-runtime.mjs.map +1 -0
  44. package/_shims/index.d.ts +81 -0
  45. package/_shims/index.js +13 -0
  46. package/_shims/index.mjs +7 -0
  47. package/_shims/manual-types.d.ts +12 -0
  48. package/_shims/manual-types.js +3 -0
  49. package/_shims/manual-types.mjs +3 -0
  50. package/_shims/node-runtime.d.ts +3 -0
  51. package/_shims/node-runtime.d.ts.map +1 -0
  52. package/_shims/node-runtime.js +89 -0
  53. package/_shims/node-runtime.js.map +1 -0
  54. package/_shims/node-runtime.mjs +56 -0
  55. package/_shims/node-runtime.mjs.map +1 -0
  56. package/_shims/node-types.d.ts +42 -0
  57. package/_shims/node-types.js +3 -0
  58. package/_shims/node-types.mjs +3 -0
  59. package/_shims/registry.d.ts +37 -0
  60. package/_shims/registry.d.ts.map +1 -0
  61. package/_shims/registry.js +41 -0
  62. package/_shims/registry.js.map +1 -0
  63. package/_shims/registry.mjs +37 -0
  64. package/_shims/registry.mjs.map +1 -0
  65. package/_shims/web-runtime.d.ts +5 -0
  66. package/_shims/web-runtime.d.ts.map +1 -0
  67. package/_shims/web-runtime.js +78 -0
  68. package/_shims/web-runtime.js.map +1 -0
  69. package/_shims/web-runtime.mjs +71 -0
  70. package/_shims/web-runtime.mjs.map +1 -0
  71. package/_shims/web-types.d.ts +83 -0
  72. package/_shims/web-types.js +3 -0
  73. package/_shims/web-types.mjs +3 -0
  74. package/core.d.ts +241 -0
  75. package/core.d.ts.map +1 -0
  76. package/core.js +908 -0
  77. package/core.js.map +1 -0
  78. package/core.mjs +876 -0
  79. package/core.mjs.map +1 -0
  80. package/error.d.ts +47 -0
  81. package/error.d.ts.map +1 -0
  82. package/error.js +113 -0
  83. package/error.js.map +1 -0
  84. package/error.mjs +97 -0
  85. package/error.mjs.map +1 -0
  86. package/index.d.mts +157 -0
  87. package/index.d.ts +157 -0
  88. package/index.d.ts.map +1 -0
  89. package/index.js +164 -0
  90. package/index.js.map +1 -0
  91. package/index.mjs +121 -0
  92. package/index.mjs.map +1 -0
  93. package/package.json +103 -0
  94. package/resource.d.ts +6 -0
  95. package/resource.d.ts.map +1 -0
  96. package/resource.js +11 -0
  97. package/resource.js.map +1 -0
  98. package/resource.mjs +7 -0
  99. package/resource.mjs.map +1 -0
  100. package/resources/balance.d.ts +34 -0
  101. package/resources/balance.d.ts.map +1 -0
  102. package/resources/balance.js +16 -0
  103. package/resources/balance.js.map +1 -0
  104. package/resources/balance.mjs +12 -0
  105. package/resources/balance.mjs.map +1 -0
  106. package/resources/banks.d.ts +223 -0
  107. package/resources/banks.d.ts.map +1 -0
  108. package/resources/banks.js +30 -0
  109. package/resources/banks.js.map +1 -0
  110. package/resources/banks.mjs +26 -0
  111. package/resources/banks.mjs.map +1 -0
  112. package/resources/capabilities.d.ts +28 -0
  113. package/resources/capabilities.d.ts.map +1 -0
  114. package/resources/capabilities.js +16 -0
  115. package/resources/capabilities.js.map +1 -0
  116. package/resources/capabilities.mjs +12 -0
  117. package/resources/capabilities.mjs.map +1 -0
  118. package/resources/charges.d.ts +86 -0
  119. package/resources/charges.d.ts.map +1 -0
  120. package/resources/charges.js +15 -0
  121. package/resources/charges.js.map +1 -0
  122. package/resources/charges.mjs +11 -0
  123. package/resources/charges.mjs.map +1 -0
  124. package/resources/checkoutsession.d.ts +2370 -0
  125. package/resources/checkoutsession.d.ts.map +1 -0
  126. package/resources/checkoutsession.js +30 -0
  127. package/resources/checkoutsession.js.map +1 -0
  128. package/resources/checkoutsession.mjs +26 -0
  129. package/resources/checkoutsession.mjs.map +1 -0
  130. package/resources/customers.d.ts +37 -0
  131. package/resources/customers.d.ts.map +1 -0
  132. package/resources/customers.js +21 -0
  133. package/resources/customers.js.map +1 -0
  134. package/resources/customers.mjs +17 -0
  135. package/resources/customers.mjs.map +1 -0
  136. package/resources/index.d.ts +13 -0
  137. package/resources/index.d.ts.map +1 -0
  138. package/resources/index.js +29 -0
  139. package/resources/index.js.map +1 -0
  140. package/resources/index.mjs +14 -0
  141. package/resources/index.mjs.map +1 -0
  142. package/resources/mandates.d.ts +91 -0
  143. package/resources/mandates.d.ts.map +1 -0
  144. package/resources/mandates.js +27 -0
  145. package/resources/mandates.js.map +1 -0
  146. package/resources/mandates.mjs +23 -0
  147. package/resources/mandates.mjs.map +1 -0
  148. package/resources/orders.d.ts +1255 -0
  149. package/resources/orders.d.ts.map +1 -0
  150. package/resources/orders.js +23 -0
  151. package/resources/orders.js.map +1 -0
  152. package/resources/orders.mjs +19 -0
  153. package/resources/orders.mjs.map +1 -0
  154. package/resources/payouts.d.ts +224 -0
  155. package/resources/payouts.d.ts.map +1 -0
  156. package/resources/payouts.js +28 -0
  157. package/resources/payouts.js.map +1 -0
  158. package/resources/payouts.mjs +24 -0
  159. package/resources/payouts.mjs.map +1 -0
  160. package/resources/refunds.d.ts +138 -0
  161. package/resources/refunds.d.ts.map +1 -0
  162. package/resources/refunds.js +28 -0
  163. package/resources/refunds.js.map +1 -0
  164. package/resources/refunds.mjs +24 -0
  165. package/resources/refunds.mjs.map +1 -0
  166. package/resources/reports.d.ts +120 -0
  167. package/resources/reports.d.ts.map +1 -0
  168. package/resources/reports.js +31 -0
  169. package/resources/reports.js.map +1 -0
  170. package/resources/reports.mjs +27 -0
  171. package/resources/reports.mjs.map +1 -0
  172. package/resources/subaccounts.d.ts +49 -0
  173. package/resources/subaccounts.d.ts.map +1 -0
  174. package/resources/subaccounts.js +22 -0
  175. package/resources/subaccounts.js.map +1 -0
  176. package/resources/subaccounts.mjs +18 -0
  177. package/resources/subaccounts.mjs.map +1 -0
  178. package/shims/node.d.ts +30 -0
  179. package/shims/node.d.ts.map +1 -0
  180. package/shims/node.js +31 -0
  181. package/shims/node.js.map +1 -0
  182. package/shims/node.mjs +5 -0
  183. package/shims/node.mjs.map +1 -0
  184. package/shims/web.d.ts +26 -0
  185. package/shims/web.d.ts.map +1 -0
  186. package/shims/web.js +31 -0
  187. package/shims/web.js.map +1 -0
  188. package/shims/web.mjs +5 -0
  189. package/shims/web.mjs.map +1 -0
  190. package/src/_shims/MultipartBody.ts +9 -0
  191. package/src/_shims/README.md +46 -0
  192. package/src/_shims/auto/runtime-bun.ts +4 -0
  193. package/src/_shims/auto/runtime-node.ts +4 -0
  194. package/src/_shims/auto/runtime.ts +4 -0
  195. package/src/_shims/auto/types-node.ts +4 -0
  196. package/src/_shims/auto/types.d.ts +101 -0
  197. package/src/_shims/auto/types.js +3 -0
  198. package/src/_shims/auto/types.mjs +3 -0
  199. package/src/_shims/bun-runtime.ts +14 -0
  200. package/src/_shims/index.d.ts +81 -0
  201. package/src/_shims/index.js +13 -0
  202. package/src/_shims/index.mjs +7 -0
  203. package/src/_shims/manual-types.d.ts +12 -0
  204. package/src/_shims/manual-types.js +3 -0
  205. package/src/_shims/manual-types.mjs +3 -0
  206. package/src/_shims/node-runtime.ts +81 -0
  207. package/src/_shims/node-types.d.ts +42 -0
  208. package/src/_shims/node-types.js +3 -0
  209. package/src/_shims/node-types.mjs +3 -0
  210. package/src/_shims/registry.ts +67 -0
  211. package/src/_shims/web-runtime.ts +103 -0
  212. package/src/_shims/web-types.d.ts +83 -0
  213. package/src/_shims/web-types.js +3 -0
  214. package/src/_shims/web-types.mjs +3 -0
  215. package/src/core.ts +1200 -0
  216. package/src/error.ts +130 -0
  217. package/src/index.ts +393 -0
  218. package/src/lib/.keep +4 -0
  219. package/src/resource.ts +11 -0
  220. package/src/resources/balance.ts +49 -0
  221. package/src/resources/banks.ts +1536 -0
  222. package/src/resources/capabilities.ts +291 -0
  223. package/src/resources/charges.ts +108 -0
  224. package/src/resources/checkoutsession.ts +9254 -0
  225. package/src/resources/customers.ts +60 -0
  226. package/src/resources/index.ts +75 -0
  227. package/src/resources/mandates.ts +135 -0
  228. package/src/resources/orders.ts +3195 -0
  229. package/src/resources/payouts.ts +297 -0
  230. package/src/resources/refunds.ts +184 -0
  231. package/src/resources/reports.ts +172 -0
  232. package/src/resources/subaccounts.ts +73 -0
  233. package/src/shims/node.ts +50 -0
  234. package/src/shims/web.ts +50 -0
  235. package/src/tsconfig.json +11 -0
  236. package/src/uploads.ts +255 -0
  237. package/src/version.ts +1 -0
  238. package/uploads.d.ts +75 -0
  239. package/uploads.d.ts.map +1 -0
  240. package/uploads.js +171 -0
  241. package/uploads.js.map +1 -0
  242. package/uploads.mjs +158 -0
  243. package/uploads.mjs.map +1 -0
  244. package/version.d.ts +2 -0
  245. package/version.d.ts.map +1 -0
  246. package/version.js +5 -0
  247. package/version.js.map +1 -0
  248. package/version.mjs +2 -0
  249. package/version.mjs.map +1 -0
@@ -0,0 +1,3195 @@
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 Orders extends APIResource {
7
+ /**
8
+ * Retrieve details of an order. You can retrieve the order by passing either the
9
+ * internal Ivy order id or the `referenceId` you specified when creating a
10
+ * Checkout Session to the `id` field.
11
+ */
12
+ retrieve(body: OrderRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<OrderRetrieveResponse> {
13
+ return this._client.post('/api/service/order/details', { body, ...options });
14
+ }
15
+
16
+ /**
17
+ * Update certain fields of the specified order.
18
+ */
19
+ update(body: OrderUpdateParams, options?: Core.RequestOptions): Core.APIPromise<OrderUpdateResponse> {
20
+ return this._client.post('/api/service/order/update', { body, ...options });
21
+ }
22
+ }
23
+
24
+ export interface OrderRetrieveResponse {
25
+ /**
26
+ * The Ivy unique identifier for the order.
27
+ */
28
+ id: string;
29
+
30
+ /**
31
+ * @deprecated The unique identifier for the merchantApp which initiated the order
32
+ * / payment attempt.
33
+ */
34
+ appId: string;
35
+
36
+ /**
37
+ * The Ivy fee for the payment.
38
+ */
39
+ applicationFeeAmount: number;
40
+
41
+ createdAt: string;
42
+
43
+ instantPaymentScheme: boolean;
44
+
45
+ /**
46
+ * @deprecated Deprecated in favor of `appId`.
47
+ */
48
+ merchantAppId: string;
49
+
50
+ /**
51
+ * The unique identifier for the merchant which initiated the order / payment
52
+ * attempt.
53
+ */
54
+ merchantId: string;
55
+
56
+ /**
57
+ * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
58
+ * represents EUR 10.23. Any amount of decimal places can be provided on
59
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
60
+ * as this is the format accepted by most banks.
61
+ */
62
+ price: OrderRetrieveResponse.Price;
63
+
64
+ /**
65
+ * An internal reference id which will be stored with the checkout & corresponding
66
+ * order. Needs to be unique per shop per order and can be up to 200 characters.
67
+ */
68
+ referenceId: string;
69
+
70
+ /**
71
+ * The name of the merchant which initiated the order.
72
+ */
73
+ shopName: string;
74
+
75
+ /**
76
+ * The order status. This status symbolises the state of the user's payment
77
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
78
+ * information.
79
+ */
80
+ status:
81
+ | 'failed'
82
+ | 'canceled'
83
+ | 'processing'
84
+ | 'in_handshake'
85
+ | 'waiting_for_payment'
86
+ | 'paid'
87
+ | 'in_refund'
88
+ | 'refunded'
89
+ | 'refund_failed'
90
+ | 'partially_refunded'
91
+ | 'in_dispute'
92
+ | 'disputed'
93
+ | 'refused';
94
+
95
+ updatedAt: string;
96
+
97
+ /**
98
+ * The bank statement reference of the payment for the order. This is the reference
99
+ * that will be visible on the bank statement.
100
+ */
101
+ bankStatementReference?: string;
102
+
103
+ /**
104
+ * The billing address of the user. Required when handshake=true.
105
+ */
106
+ billingAddress?: OrderRetrieveResponse.BillingAddress;
107
+
108
+ /**
109
+ * The merchant category code or
110
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
111
+ */
112
+ category?: string;
113
+
114
+ /**
115
+ * @deprecated
116
+ */
117
+ climateActionMode?: OrderRetrieveResponse.ClimateActionMode;
118
+
119
+ /**
120
+ * @deprecated
121
+ */
122
+ co2Grams?: number;
123
+
124
+ /**
125
+ * The unique identifier of the customer who placed the order.
126
+ */
127
+ customerId?: string;
128
+
129
+ /**
130
+ * The customer facing id. This id is displayed to the user during the checkout and
131
+ * in the merchant dashboard.
132
+ */
133
+ displayId?: string;
134
+
135
+ /**
136
+ * False by default. If set to true, customers skip email input and jump directly
137
+ * to their bank login. For express Checkout Sessions this is always false.
138
+ */
139
+ guest?: boolean;
140
+
141
+ /**
142
+ * Only valid for sustainable incentive mode. The social / sustainable projects
143
+ * available to the user during Checkout.
144
+ */
145
+ impactOffsetProjects?: Array<string>;
146
+
147
+ /**
148
+ * The incentive mode of the checkout session. For any use-case apart from
149
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
150
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
151
+ * session will contain sustainable incentives for users.
152
+ */
153
+ incentiveMode?: 'white_label' | 'sustainable';
154
+
155
+ /**
156
+ * The line items of the Checkout.
157
+ */
158
+ lineItems?: Array<OrderRetrieveResponse.LineItem>;
159
+
160
+ mandate?: OrderRetrieveResponse.Mandate;
161
+
162
+ /**
163
+ * The destination bank account where the money will be sent to.
164
+ */
165
+ merchantFinancialAddress?: OrderRetrieveResponse.MerchantFinancialAddress;
166
+
167
+ /**
168
+ * Any data which will be stored and returned for this checkout session and
169
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
170
+ * more info.
171
+ */
172
+ metadata?: Record<string, unknown>;
173
+
174
+ /**
175
+ * Only valid for sustainable incentive mode. The social / sustainability project
176
+ * chosen by the user during Checkout.
177
+ */
178
+ offsetProject?: string;
179
+
180
+ /**
181
+ * The source bank account where the money is send from.
182
+ */
183
+ payerFinancialAddress?: OrderRetrieveResponse.PayerFinancialAddress;
184
+
185
+ paymentMethodType?: 'sepa_debit' | 'customer_balance';
186
+
187
+ /**
188
+ * The payment mode of the order. Can be either 'settlement' or 'direct'.
189
+ */
190
+ paymentMode?: 'settlement' | 'direct';
191
+
192
+ /**
193
+ * @deprecated Deprecated in favor of `status`. Do not use this field to trigger
194
+ * actions in your system.
195
+ */
196
+ paymentStatus?:
197
+ | 'failed'
198
+ | 'canceled'
199
+ | 'processing'
200
+ | 'requires_action'
201
+ | 'succeeded'
202
+ | 'in_refund'
203
+ | 'refunded'
204
+ | 'refund_failed'
205
+ | 'partially_refunded'
206
+ | 'not_settled'
207
+ | 'disputed';
208
+
209
+ /**
210
+ * The total amount in the currency of all successful refunds for this order
211
+ */
212
+ refundAmount?: number;
213
+
214
+ /**
215
+ * The list of refunds connected to this order.
216
+ */
217
+ refunds?: Array<OrderRetrieveResponse.Refund>;
218
+
219
+ /**
220
+ * The shipping address of the user. This is only collected in express Checkouts.
221
+ */
222
+ shippingAddress?: OrderRetrieveResponse.ShippingAddress;
223
+
224
+ /**
225
+ * The selected shipping method by the user. Can either be selected during an
226
+ * express Checkout Session or passed during Checkout Session creation.
227
+ */
228
+ shippingMethod?: OrderRetrieveResponse.ShippingMethod;
229
+
230
+ /**
231
+ * The logo of the shop provided as a URL.
232
+ */
233
+ shopLogo?: string;
234
+
235
+ /**
236
+ * The shopper object. Contains information collected from the user during the
237
+ * Checkout.
238
+ */
239
+ shopper?: OrderRetrieveResponse.Shopper;
240
+
241
+ /**
242
+ * @deprecated Deprecated in favor of `shopper.email`. The email of the user if
243
+ * collected in the Checkout.
244
+ */
245
+ shopperEmail?: string;
246
+
247
+ statusClassification?: OrderRetrieveResponse.StatusClassification;
248
+
249
+ /**
250
+ * List of status history items for the order, used for logging every update on
251
+ * status.
252
+ */
253
+ statusHistoryList?: Array<OrderRetrieveResponse.StatusHistoryList>;
254
+
255
+ /**
256
+ * The subaccount id of the order.
257
+ */
258
+ subaccountId?: string;
259
+
260
+ /**
261
+ * The legal name of the subaccount
262
+ */
263
+ subaccountLegalName?: string;
264
+
265
+ /**
266
+ * @deprecated
267
+ */
268
+ trees?: number;
269
+ }
270
+
271
+ export namespace OrderRetrieveResponse {
272
+ /**
273
+ * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
274
+ * represents EUR 10.23. Any amount of decimal places can be provided on
275
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
276
+ * as this is the format accepted by most banks.
277
+ */
278
+ export interface Price {
279
+ currency: 'EUR' | 'GBP' | 'PLN';
280
+
281
+ /**
282
+ * The total amount to be paid.
283
+ */
284
+ total: number;
285
+
286
+ /**
287
+ * The shipping amount.
288
+ */
289
+ shipping?: number;
290
+
291
+ /**
292
+ * The subtotal amount, i.e. the total amount without VAT and shipping.
293
+ */
294
+ subTotal?: number;
295
+
296
+ /**
297
+ * The total net amount, i.e. the total amount without VAT. This value is rounded
298
+ * to 2 decimal places for the actual transfer.
299
+ */
300
+ totalNet?: number;
301
+
302
+ /**
303
+ * The VAT amount.
304
+ */
305
+ vat?: number;
306
+ }
307
+
308
+ /**
309
+ * The billing address of the user. Required when handshake=true.
310
+ */
311
+ export interface BillingAddress {
312
+ city: string;
313
+
314
+ /**
315
+ * The country code in
316
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
317
+ */
318
+ country:
319
+ | 'AF'
320
+ | 'AL'
321
+ | 'DZ'
322
+ | 'AS'
323
+ | 'AD'
324
+ | 'AO'
325
+ | 'AI'
326
+ | 'AQ'
327
+ | 'AG'
328
+ | 'AR'
329
+ | 'AM'
330
+ | 'AW'
331
+ | 'AU'
332
+ | 'AT'
333
+ | 'AZ'
334
+ | 'BS'
335
+ | 'BH'
336
+ | 'BD'
337
+ | 'BB'
338
+ | 'BY'
339
+ | 'BE'
340
+ | 'BZ'
341
+ | 'BJ'
342
+ | 'BM'
343
+ | 'BT'
344
+ | 'BO'
345
+ | 'BA'
346
+ | 'BW'
347
+ | 'BV'
348
+ | 'BR'
349
+ | 'IO'
350
+ | 'BN'
351
+ | 'BG'
352
+ | 'BF'
353
+ | 'BI'
354
+ | 'KH'
355
+ | 'CM'
356
+ | 'CA'
357
+ | 'CV'
358
+ | 'KY'
359
+ | 'CF'
360
+ | 'TD'
361
+ | 'CL'
362
+ | 'CN'
363
+ | 'CX'
364
+ | 'CC'
365
+ | 'CO'
366
+ | 'KM'
367
+ | 'CG'
368
+ | 'CD'
369
+ | 'CK'
370
+ | 'CR'
371
+ | 'CI'
372
+ | 'HR'
373
+ | 'CU'
374
+ | 'CY'
375
+ | 'CZ'
376
+ | 'DK'
377
+ | 'DJ'
378
+ | 'DM'
379
+ | 'DO'
380
+ | 'EC'
381
+ | 'EG'
382
+ | 'SV'
383
+ | 'GQ'
384
+ | 'ER'
385
+ | 'EE'
386
+ | 'ET'
387
+ | 'FK'
388
+ | 'FO'
389
+ | 'FJ'
390
+ | 'FI'
391
+ | 'FR'
392
+ | 'GF'
393
+ | 'PF'
394
+ | 'TF'
395
+ | 'GA'
396
+ | 'GM'
397
+ | 'GE'
398
+ | 'DE'
399
+ | 'GH'
400
+ | 'GI'
401
+ | 'GR'
402
+ | 'GL'
403
+ | 'GD'
404
+ | 'GP'
405
+ | 'GU'
406
+ | 'GT'
407
+ | 'GN'
408
+ | 'GW'
409
+ | 'GY'
410
+ | 'HT'
411
+ | 'HM'
412
+ | 'VA'
413
+ | 'HN'
414
+ | 'HK'
415
+ | 'HU'
416
+ | 'IS'
417
+ | 'IN'
418
+ | 'ID'
419
+ | 'IR'
420
+ | 'IQ'
421
+ | 'IE'
422
+ | 'IL'
423
+ | 'IT'
424
+ | 'JM'
425
+ | 'JP'
426
+ | 'JO'
427
+ | 'KZ'
428
+ | 'KE'
429
+ | 'KI'
430
+ | 'KP'
431
+ | 'KR'
432
+ | 'KW'
433
+ | 'KG'
434
+ | 'LA'
435
+ | 'LV'
436
+ | 'LB'
437
+ | 'LS'
438
+ | 'LR'
439
+ | 'LY'
440
+ | 'LI'
441
+ | 'LT'
442
+ | 'LU'
443
+ | 'MO'
444
+ | 'MG'
445
+ | 'MW'
446
+ | 'MY'
447
+ | 'MV'
448
+ | 'ML'
449
+ | 'MT'
450
+ | 'MH'
451
+ | 'MQ'
452
+ | 'MR'
453
+ | 'MU'
454
+ | 'YT'
455
+ | 'MX'
456
+ | 'FM'
457
+ | 'MD'
458
+ | 'MC'
459
+ | 'MN'
460
+ | 'MS'
461
+ | 'MA'
462
+ | 'MZ'
463
+ | 'MM'
464
+ | 'NA'
465
+ | 'NR'
466
+ | 'NP'
467
+ | 'NL'
468
+ | 'NC'
469
+ | 'NZ'
470
+ | 'NI'
471
+ | 'NE'
472
+ | 'NG'
473
+ | 'NU'
474
+ | 'NF'
475
+ | 'MP'
476
+ | 'MK'
477
+ | 'NO'
478
+ | 'OM'
479
+ | 'PK'
480
+ | 'PW'
481
+ | 'PS'
482
+ | 'PA'
483
+ | 'PG'
484
+ | 'PY'
485
+ | 'PE'
486
+ | 'PH'
487
+ | 'PN'
488
+ | 'PL'
489
+ | 'PT'
490
+ | 'PR'
491
+ | 'QA'
492
+ | 'RE'
493
+ | 'RO'
494
+ | 'RU'
495
+ | 'RW'
496
+ | 'SH'
497
+ | 'KN'
498
+ | 'LC'
499
+ | 'PM'
500
+ | 'VC'
501
+ | 'WS'
502
+ | 'SM'
503
+ | 'ST'
504
+ | 'SA'
505
+ | 'SN'
506
+ | 'SC'
507
+ | 'SL'
508
+ | 'SG'
509
+ | 'SK'
510
+ | 'SI'
511
+ | 'SB'
512
+ | 'SO'
513
+ | 'ZA'
514
+ | 'GS'
515
+ | 'ES'
516
+ | 'LK'
517
+ | 'SD'
518
+ | 'SR'
519
+ | 'SJ'
520
+ | 'SZ'
521
+ | 'SE'
522
+ | 'CH'
523
+ | 'SY'
524
+ | 'TW'
525
+ | 'TJ'
526
+ | 'TZ'
527
+ | 'TH'
528
+ | 'TL'
529
+ | 'TG'
530
+ | 'TK'
531
+ | 'TO'
532
+ | 'TT'
533
+ | 'TN'
534
+ | 'TR'
535
+ | 'TM'
536
+ | 'TC'
537
+ | 'TV'
538
+ | 'UG'
539
+ | 'UA'
540
+ | 'AE'
541
+ | 'GB'
542
+ | 'US'
543
+ | 'UM'
544
+ | 'UY'
545
+ | 'UZ'
546
+ | 'VU'
547
+ | 'VE'
548
+ | 'VN'
549
+ | 'VG'
550
+ | 'VI'
551
+ | 'WF'
552
+ | 'EH'
553
+ | 'YE'
554
+ | 'ZM'
555
+ | 'ZW'
556
+ | 'AX'
557
+ | 'BQ'
558
+ | 'CW'
559
+ | 'GG'
560
+ | 'IM'
561
+ | 'JE'
562
+ | 'ME'
563
+ | 'BL'
564
+ | 'MF'
565
+ | 'RS'
566
+ | 'SX'
567
+ | 'SS'
568
+ | 'XK';
569
+
570
+ line1: string;
571
+
572
+ zipCode: string;
573
+
574
+ firstName?: string;
575
+
576
+ lastName?: string;
577
+
578
+ line2?: string;
579
+
580
+ region?: string;
581
+ }
582
+
583
+ /**
584
+ * @deprecated
585
+ */
586
+ export interface ClimateActionMode {
587
+ amount: number;
588
+
589
+ type: 'transaction' | 'amount';
590
+ }
591
+
592
+ export interface LineItem {
593
+ /**
594
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
595
+ * decimals, i.e. 10.23 represents EUR 10.23.
596
+ */
597
+ amount: number;
598
+
599
+ /**
600
+ * The name of the line item.
601
+ */
602
+ name: string;
603
+
604
+ /**
605
+ * The quantity of the line item.
606
+ */
607
+ quantity: number;
608
+
609
+ /**
610
+ * The net amount of a single item.
611
+ */
612
+ singleNet: number;
613
+
614
+ /**
615
+ * The VAT amount of a single item.
616
+ */
617
+ singleVat: number;
618
+
619
+ /**
620
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
621
+ * the line item.
622
+ */
623
+ category?: string;
624
+
625
+ /**
626
+ * The
627
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
628
+ * of the line item.
629
+ */
630
+ EAN?: string;
631
+
632
+ /**
633
+ * The image of the line item as a URL.
634
+ */
635
+ image?: string;
636
+
637
+ /**
638
+ * The internal unique identifier of the line item.
639
+ */
640
+ referenceId?: string;
641
+ }
642
+
643
+ export interface Mandate {
644
+ /**
645
+ * The name of the account holder who signs the mandate.
646
+ */
647
+ accountHolderName?: string;
648
+
649
+ /**
650
+ * Additional information to display to the user during the mandate setup. This
651
+ * information is not used to setup any recurrence on the mandate. It is only
652
+ * displayed to the user during checkout.
653
+ */
654
+ additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
655
+
656
+ /**
657
+ * Mandate creditor data
658
+ */
659
+ creditor?: Mandate.Creditor;
660
+
661
+ /**
662
+ * The reference of the mandate going to be setup
663
+ */
664
+ reference?: string;
665
+
666
+ /**
667
+ * The mandate referenceId. Set this to match incoming `mandate_setup_started`,
668
+ * `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
669
+ * mandate setup request.
670
+ */
671
+ referenceId?: string;
672
+
673
+ /**
674
+ * If true, a ready to use mandate will be set up after the payment flow.
675
+ */
676
+ setup?: boolean;
677
+
678
+ /**
679
+ * The email of the user who signs the mandate.
680
+ */
681
+ userNotificationEmail?: string;
682
+ }
683
+
684
+ export namespace Mandate {
685
+ /**
686
+ * Additional information to display to the user during the mandate setup. This
687
+ * information is not used to setup any recurrence on the mandate. It is only
688
+ * displayed to the user during checkout.
689
+ */
690
+ export interface AdditionalDisplayInformation {
691
+ /**
692
+ * The intended cadence of charges used for displaying purpose only. On demand
693
+ * would be used for unscheduled charges.
694
+ */
695
+ cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
696
+
697
+ price?: AdditionalDisplayInformation.Price;
698
+ }
699
+
700
+ export namespace AdditionalDisplayInformation {
701
+ export interface Price {
702
+ /**
703
+ * The amount displayed to the user as decimal e.g. 10.23 would be displayed as
704
+ * 10.23 EUR.
705
+ */
706
+ amount?: number;
707
+
708
+ currency?: 'EUR' | 'GBP' | 'PLN';
709
+ }
710
+ }
711
+
712
+ /**
713
+ * Mandate creditor data
714
+ */
715
+ export interface Creditor {
716
+ id?: string;
717
+
718
+ name?: string;
719
+ }
720
+ }
721
+
722
+ /**
723
+ * The destination bank account where the money will be sent to.
724
+ */
725
+ export interface MerchantFinancialAddress {
726
+ bankCode?: MerchantFinancialAddress.BankCode;
727
+
728
+ bban?: MerchantFinancialAddress.Bban;
729
+
730
+ iban?: MerchantFinancialAddress.Iban;
731
+
732
+ /**
733
+ * The payment reference for the order. This is the reference that will be visible
734
+ * on the bank statement.
735
+ */
736
+ paymentReference?: string;
737
+
738
+ sortCode?: MerchantFinancialAddress.SortCode;
739
+
740
+ /**
741
+ * The type of the financial address. The actual destination is determined by this
742
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
743
+ * validation will fail if you set e.g. type="iban", but then not fill any values
744
+ * in the "iban" object.
745
+ *
746
+ * - iban: The IBAN of the account
747
+ * - sort_code: The sort code of the account
748
+ * - bank_code: The bank code of the account
749
+ * - bban: The BBAN of the account
750
+ */
751
+ type?: string;
752
+ }
753
+
754
+ export namespace MerchantFinancialAddress {
755
+ export interface BankCode {
756
+ /**
757
+ * The name of the account holder.
758
+ */
759
+ accountHolderName: string;
760
+
761
+ accountNumber: string;
762
+
763
+ code: string;
764
+ }
765
+
766
+ export interface Bban {
767
+ /**
768
+ * The name of the account holder.
769
+ */
770
+ accountHolderName: string;
771
+
772
+ bban: string;
773
+
774
+ bic?: string;
775
+ }
776
+
777
+ export interface Iban {
778
+ /**
779
+ * The name of the account holder.
780
+ */
781
+ accountHolderName: string;
782
+
783
+ iban: string;
784
+
785
+ bic?: string;
786
+ }
787
+
788
+ export interface SortCode {
789
+ /**
790
+ * The name of the account holder.
791
+ */
792
+ accountHolderName: string;
793
+
794
+ accountNumber: string;
795
+
796
+ sortCode: string;
797
+ }
798
+ }
799
+
800
+ /**
801
+ * The source bank account where the money is send from.
802
+ */
803
+ export interface PayerFinancialAddress {
804
+ /**
805
+ * The type of the financial address. The actual destination is determined by this
806
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
807
+ * validation will fail if you set e.g. type="iban", but then not fill any values
808
+ * in the "iban" object.
809
+ *
810
+ * - iban: The IBAN of the account
811
+ * - sort_code: The sort code of the account
812
+ * - bank_code: The bank code of the account
813
+ * - bban: The BBAN of the account
814
+ */
815
+ type: string;
816
+
817
+ bankCode?: PayerFinancialAddress.BankCode;
818
+
819
+ bban?: PayerFinancialAddress.Bban;
820
+
821
+ iban?: PayerFinancialAddress.Iban;
822
+
823
+ sortCode?: PayerFinancialAddress.SortCode;
824
+ }
825
+
826
+ export namespace PayerFinancialAddress {
827
+ export interface BankCode {
828
+ accountNumber: string;
829
+
830
+ code: string;
831
+
832
+ /**
833
+ * The name of the account holder.
834
+ */
835
+ accountHolderName?: string;
836
+ }
837
+
838
+ export interface Bban {
839
+ bban: string;
840
+
841
+ /**
842
+ * The name of the account holder.
843
+ */
844
+ accountHolderName?: string;
845
+
846
+ bic?: string;
847
+ }
848
+
849
+ export interface Iban {
850
+ iban: string;
851
+
852
+ /**
853
+ * The name of the account holder.
854
+ */
855
+ accountHolderName?: string;
856
+
857
+ bic?: string;
858
+ }
859
+
860
+ export interface SortCode {
861
+ accountNumber: string;
862
+
863
+ sortCode: string;
864
+
865
+ /**
866
+ * The name of the account holder.
867
+ */
868
+ accountHolderName?: string;
869
+ }
870
+ }
871
+
872
+ /**
873
+ * A Refund object. This corresponds to one Refund request.
874
+ */
875
+ export interface Refund {
876
+ id: string;
877
+
878
+ amount: number;
879
+
880
+ createdAt: string;
881
+
882
+ referenceId: string;
883
+
884
+ /**
885
+ * The status of the refund. Always use the status of the order as your source of
886
+ * truth to trigger actions in your dashboard.
887
+ */
888
+ status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
889
+
890
+ updatedAt: string;
891
+
892
+ description?: string;
893
+ }
894
+
895
+ /**
896
+ * The shipping address of the user. This is only collected in express Checkouts.
897
+ */
898
+ export interface ShippingAddress {
899
+ city: string;
900
+
901
+ /**
902
+ * The country code in
903
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
904
+ */
905
+ country:
906
+ | 'AF'
907
+ | 'AL'
908
+ | 'DZ'
909
+ | 'AS'
910
+ | 'AD'
911
+ | 'AO'
912
+ | 'AI'
913
+ | 'AQ'
914
+ | 'AG'
915
+ | 'AR'
916
+ | 'AM'
917
+ | 'AW'
918
+ | 'AU'
919
+ | 'AT'
920
+ | 'AZ'
921
+ | 'BS'
922
+ | 'BH'
923
+ | 'BD'
924
+ | 'BB'
925
+ | 'BY'
926
+ | 'BE'
927
+ | 'BZ'
928
+ | 'BJ'
929
+ | 'BM'
930
+ | 'BT'
931
+ | 'BO'
932
+ | 'BA'
933
+ | 'BW'
934
+ | 'BV'
935
+ | 'BR'
936
+ | 'IO'
937
+ | 'BN'
938
+ | 'BG'
939
+ | 'BF'
940
+ | 'BI'
941
+ | 'KH'
942
+ | 'CM'
943
+ | 'CA'
944
+ | 'CV'
945
+ | 'KY'
946
+ | 'CF'
947
+ | 'TD'
948
+ | 'CL'
949
+ | 'CN'
950
+ | 'CX'
951
+ | 'CC'
952
+ | 'CO'
953
+ | 'KM'
954
+ | 'CG'
955
+ | 'CD'
956
+ | 'CK'
957
+ | 'CR'
958
+ | 'CI'
959
+ | 'HR'
960
+ | 'CU'
961
+ | 'CY'
962
+ | 'CZ'
963
+ | 'DK'
964
+ | 'DJ'
965
+ | 'DM'
966
+ | 'DO'
967
+ | 'EC'
968
+ | 'EG'
969
+ | 'SV'
970
+ | 'GQ'
971
+ | 'ER'
972
+ | 'EE'
973
+ | 'ET'
974
+ | 'FK'
975
+ | 'FO'
976
+ | 'FJ'
977
+ | 'FI'
978
+ | 'FR'
979
+ | 'GF'
980
+ | 'PF'
981
+ | 'TF'
982
+ | 'GA'
983
+ | 'GM'
984
+ | 'GE'
985
+ | 'DE'
986
+ | 'GH'
987
+ | 'GI'
988
+ | 'GR'
989
+ | 'GL'
990
+ | 'GD'
991
+ | 'GP'
992
+ | 'GU'
993
+ | 'GT'
994
+ | 'GN'
995
+ | 'GW'
996
+ | 'GY'
997
+ | 'HT'
998
+ | 'HM'
999
+ | 'VA'
1000
+ | 'HN'
1001
+ | 'HK'
1002
+ | 'HU'
1003
+ | 'IS'
1004
+ | 'IN'
1005
+ | 'ID'
1006
+ | 'IR'
1007
+ | 'IQ'
1008
+ | 'IE'
1009
+ | 'IL'
1010
+ | 'IT'
1011
+ | 'JM'
1012
+ | 'JP'
1013
+ | 'JO'
1014
+ | 'KZ'
1015
+ | 'KE'
1016
+ | 'KI'
1017
+ | 'KP'
1018
+ | 'KR'
1019
+ | 'KW'
1020
+ | 'KG'
1021
+ | 'LA'
1022
+ | 'LV'
1023
+ | 'LB'
1024
+ | 'LS'
1025
+ | 'LR'
1026
+ | 'LY'
1027
+ | 'LI'
1028
+ | 'LT'
1029
+ | 'LU'
1030
+ | 'MO'
1031
+ | 'MG'
1032
+ | 'MW'
1033
+ | 'MY'
1034
+ | 'MV'
1035
+ | 'ML'
1036
+ | 'MT'
1037
+ | 'MH'
1038
+ | 'MQ'
1039
+ | 'MR'
1040
+ | 'MU'
1041
+ | 'YT'
1042
+ | 'MX'
1043
+ | 'FM'
1044
+ | 'MD'
1045
+ | 'MC'
1046
+ | 'MN'
1047
+ | 'MS'
1048
+ | 'MA'
1049
+ | 'MZ'
1050
+ | 'MM'
1051
+ | 'NA'
1052
+ | 'NR'
1053
+ | 'NP'
1054
+ | 'NL'
1055
+ | 'NC'
1056
+ | 'NZ'
1057
+ | 'NI'
1058
+ | 'NE'
1059
+ | 'NG'
1060
+ | 'NU'
1061
+ | 'NF'
1062
+ | 'MP'
1063
+ | 'MK'
1064
+ | 'NO'
1065
+ | 'OM'
1066
+ | 'PK'
1067
+ | 'PW'
1068
+ | 'PS'
1069
+ | 'PA'
1070
+ | 'PG'
1071
+ | 'PY'
1072
+ | 'PE'
1073
+ | 'PH'
1074
+ | 'PN'
1075
+ | 'PL'
1076
+ | 'PT'
1077
+ | 'PR'
1078
+ | 'QA'
1079
+ | 'RE'
1080
+ | 'RO'
1081
+ | 'RU'
1082
+ | 'RW'
1083
+ | 'SH'
1084
+ | 'KN'
1085
+ | 'LC'
1086
+ | 'PM'
1087
+ | 'VC'
1088
+ | 'WS'
1089
+ | 'SM'
1090
+ | 'ST'
1091
+ | 'SA'
1092
+ | 'SN'
1093
+ | 'SC'
1094
+ | 'SL'
1095
+ | 'SG'
1096
+ | 'SK'
1097
+ | 'SI'
1098
+ | 'SB'
1099
+ | 'SO'
1100
+ | 'ZA'
1101
+ | 'GS'
1102
+ | 'ES'
1103
+ | 'LK'
1104
+ | 'SD'
1105
+ | 'SR'
1106
+ | 'SJ'
1107
+ | 'SZ'
1108
+ | 'SE'
1109
+ | 'CH'
1110
+ | 'SY'
1111
+ | 'TW'
1112
+ | 'TJ'
1113
+ | 'TZ'
1114
+ | 'TH'
1115
+ | 'TL'
1116
+ | 'TG'
1117
+ | 'TK'
1118
+ | 'TO'
1119
+ | 'TT'
1120
+ | 'TN'
1121
+ | 'TR'
1122
+ | 'TM'
1123
+ | 'TC'
1124
+ | 'TV'
1125
+ | 'UG'
1126
+ | 'UA'
1127
+ | 'AE'
1128
+ | 'GB'
1129
+ | 'US'
1130
+ | 'UM'
1131
+ | 'UY'
1132
+ | 'UZ'
1133
+ | 'VU'
1134
+ | 'VE'
1135
+ | 'VN'
1136
+ | 'VG'
1137
+ | 'VI'
1138
+ | 'WF'
1139
+ | 'EH'
1140
+ | 'YE'
1141
+ | 'ZM'
1142
+ | 'ZW'
1143
+ | 'AX'
1144
+ | 'BQ'
1145
+ | 'CW'
1146
+ | 'GG'
1147
+ | 'IM'
1148
+ | 'JE'
1149
+ | 'ME'
1150
+ | 'BL'
1151
+ | 'MF'
1152
+ | 'RS'
1153
+ | 'SX'
1154
+ | 'SS'
1155
+ | 'XK';
1156
+
1157
+ line1: string;
1158
+
1159
+ zipCode: string;
1160
+
1161
+ firstName?: string;
1162
+
1163
+ lastName?: string;
1164
+
1165
+ line2?: string;
1166
+
1167
+ region?: string;
1168
+ }
1169
+
1170
+ /**
1171
+ * The selected shipping method by the user. Can either be selected during an
1172
+ * express Checkout Session or passed during Checkout Session creation.
1173
+ */
1174
+ export interface ShippingMethod {
1175
+ /**
1176
+ * The customer-facing name of the shipping method.
1177
+ */
1178
+ name: string;
1179
+
1180
+ /**
1181
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
1182
+ */
1183
+ price: number;
1184
+
1185
+ /**
1186
+ * The unique identifier of the shipping method within Ivy.
1187
+ */
1188
+ id?: string;
1189
+
1190
+ /**
1191
+ * The list of countries where the shipping method is available.
1192
+ */
1193
+ countries?: Array<
1194
+ | 'AF'
1195
+ | 'AL'
1196
+ | 'DZ'
1197
+ | 'AS'
1198
+ | 'AD'
1199
+ | 'AO'
1200
+ | 'AI'
1201
+ | 'AQ'
1202
+ | 'AG'
1203
+ | 'AR'
1204
+ | 'AM'
1205
+ | 'AW'
1206
+ | 'AU'
1207
+ | 'AT'
1208
+ | 'AZ'
1209
+ | 'BS'
1210
+ | 'BH'
1211
+ | 'BD'
1212
+ | 'BB'
1213
+ | 'BY'
1214
+ | 'BE'
1215
+ | 'BZ'
1216
+ | 'BJ'
1217
+ | 'BM'
1218
+ | 'BT'
1219
+ | 'BO'
1220
+ | 'BA'
1221
+ | 'BW'
1222
+ | 'BV'
1223
+ | 'BR'
1224
+ | 'IO'
1225
+ | 'BN'
1226
+ | 'BG'
1227
+ | 'BF'
1228
+ | 'BI'
1229
+ | 'KH'
1230
+ | 'CM'
1231
+ | 'CA'
1232
+ | 'CV'
1233
+ | 'KY'
1234
+ | 'CF'
1235
+ | 'TD'
1236
+ | 'CL'
1237
+ | 'CN'
1238
+ | 'CX'
1239
+ | 'CC'
1240
+ | 'CO'
1241
+ | 'KM'
1242
+ | 'CG'
1243
+ | 'CD'
1244
+ | 'CK'
1245
+ | 'CR'
1246
+ | 'CI'
1247
+ | 'HR'
1248
+ | 'CU'
1249
+ | 'CY'
1250
+ | 'CZ'
1251
+ | 'DK'
1252
+ | 'DJ'
1253
+ | 'DM'
1254
+ | 'DO'
1255
+ | 'EC'
1256
+ | 'EG'
1257
+ | 'SV'
1258
+ | 'GQ'
1259
+ | 'ER'
1260
+ | 'EE'
1261
+ | 'ET'
1262
+ | 'FK'
1263
+ | 'FO'
1264
+ | 'FJ'
1265
+ | 'FI'
1266
+ | 'FR'
1267
+ | 'GF'
1268
+ | 'PF'
1269
+ | 'TF'
1270
+ | 'GA'
1271
+ | 'GM'
1272
+ | 'GE'
1273
+ | 'DE'
1274
+ | 'GH'
1275
+ | 'GI'
1276
+ | 'GR'
1277
+ | 'GL'
1278
+ | 'GD'
1279
+ | 'GP'
1280
+ | 'GU'
1281
+ | 'GT'
1282
+ | 'GN'
1283
+ | 'GW'
1284
+ | 'GY'
1285
+ | 'HT'
1286
+ | 'HM'
1287
+ | 'VA'
1288
+ | 'HN'
1289
+ | 'HK'
1290
+ | 'HU'
1291
+ | 'IS'
1292
+ | 'IN'
1293
+ | 'ID'
1294
+ | 'IR'
1295
+ | 'IQ'
1296
+ | 'IE'
1297
+ | 'IL'
1298
+ | 'IT'
1299
+ | 'JM'
1300
+ | 'JP'
1301
+ | 'JO'
1302
+ | 'KZ'
1303
+ | 'KE'
1304
+ | 'KI'
1305
+ | 'KP'
1306
+ | 'KR'
1307
+ | 'KW'
1308
+ | 'KG'
1309
+ | 'LA'
1310
+ | 'LV'
1311
+ | 'LB'
1312
+ | 'LS'
1313
+ | 'LR'
1314
+ | 'LY'
1315
+ | 'LI'
1316
+ | 'LT'
1317
+ | 'LU'
1318
+ | 'MO'
1319
+ | 'MG'
1320
+ | 'MW'
1321
+ | 'MY'
1322
+ | 'MV'
1323
+ | 'ML'
1324
+ | 'MT'
1325
+ | 'MH'
1326
+ | 'MQ'
1327
+ | 'MR'
1328
+ | 'MU'
1329
+ | 'YT'
1330
+ | 'MX'
1331
+ | 'FM'
1332
+ | 'MD'
1333
+ | 'MC'
1334
+ | 'MN'
1335
+ | 'MS'
1336
+ | 'MA'
1337
+ | 'MZ'
1338
+ | 'MM'
1339
+ | 'NA'
1340
+ | 'NR'
1341
+ | 'NP'
1342
+ | 'NL'
1343
+ | 'NC'
1344
+ | 'NZ'
1345
+ | 'NI'
1346
+ | 'NE'
1347
+ | 'NG'
1348
+ | 'NU'
1349
+ | 'NF'
1350
+ | 'MP'
1351
+ | 'MK'
1352
+ | 'NO'
1353
+ | 'OM'
1354
+ | 'PK'
1355
+ | 'PW'
1356
+ | 'PS'
1357
+ | 'PA'
1358
+ | 'PG'
1359
+ | 'PY'
1360
+ | 'PE'
1361
+ | 'PH'
1362
+ | 'PN'
1363
+ | 'PL'
1364
+ | 'PT'
1365
+ | 'PR'
1366
+ | 'QA'
1367
+ | 'RE'
1368
+ | 'RO'
1369
+ | 'RU'
1370
+ | 'RW'
1371
+ | 'SH'
1372
+ | 'KN'
1373
+ | 'LC'
1374
+ | 'PM'
1375
+ | 'VC'
1376
+ | 'WS'
1377
+ | 'SM'
1378
+ | 'ST'
1379
+ | 'SA'
1380
+ | 'SN'
1381
+ | 'SC'
1382
+ | 'SL'
1383
+ | 'SG'
1384
+ | 'SK'
1385
+ | 'SI'
1386
+ | 'SB'
1387
+ | 'SO'
1388
+ | 'ZA'
1389
+ | 'GS'
1390
+ | 'ES'
1391
+ | 'LK'
1392
+ | 'SD'
1393
+ | 'SR'
1394
+ | 'SJ'
1395
+ | 'SZ'
1396
+ | 'SE'
1397
+ | 'CH'
1398
+ | 'SY'
1399
+ | 'TW'
1400
+ | 'TJ'
1401
+ | 'TZ'
1402
+ | 'TH'
1403
+ | 'TL'
1404
+ | 'TG'
1405
+ | 'TK'
1406
+ | 'TO'
1407
+ | 'TT'
1408
+ | 'TN'
1409
+ | 'TR'
1410
+ | 'TM'
1411
+ | 'TC'
1412
+ | 'TV'
1413
+ | 'UG'
1414
+ | 'UA'
1415
+ | 'AE'
1416
+ | 'GB'
1417
+ | 'US'
1418
+ | 'UM'
1419
+ | 'UY'
1420
+ | 'UZ'
1421
+ | 'VU'
1422
+ | 'VE'
1423
+ | 'VN'
1424
+ | 'VG'
1425
+ | 'VI'
1426
+ | 'WF'
1427
+ | 'EH'
1428
+ | 'YE'
1429
+ | 'ZM'
1430
+ | 'ZW'
1431
+ | 'AX'
1432
+ | 'BQ'
1433
+ | 'CW'
1434
+ | 'GG'
1435
+ | 'IM'
1436
+ | 'JE'
1437
+ | 'ME'
1438
+ | 'BL'
1439
+ | 'MF'
1440
+ | 'RS'
1441
+ | 'SX'
1442
+ | 'SS'
1443
+ | 'XK'
1444
+ >;
1445
+
1446
+ /**
1447
+ * The delivery estimate of the shipping method.
1448
+ */
1449
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
1450
+
1451
+ /**
1452
+ * The unique identifier within your system of the shipping method.
1453
+ */
1454
+ reference?: string;
1455
+
1456
+ /**
1457
+ * @deprecated Deprecated in favor of deliveryEstimate
1458
+ */
1459
+ timeFrame?: string;
1460
+ }
1461
+
1462
+ export namespace ShippingMethod {
1463
+ /**
1464
+ * The delivery estimate of the shipping method.
1465
+ */
1466
+ export interface DeliveryEstimate {
1467
+ /**
1468
+ * The maximum delivery time.
1469
+ */
1470
+ maximum?: DeliveryEstimate.Maximum;
1471
+
1472
+ /**
1473
+ * The minimum delivery time.
1474
+ */
1475
+ minimum?: DeliveryEstimate.Minimum;
1476
+ }
1477
+
1478
+ export namespace DeliveryEstimate {
1479
+ /**
1480
+ * The maximum delivery time.
1481
+ */
1482
+ export interface Maximum {
1483
+ /**
1484
+ * The unit of the time duration.
1485
+ */
1486
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1487
+
1488
+ /**
1489
+ * The value of the time duration.
1490
+ */
1491
+ value: number;
1492
+ }
1493
+
1494
+ /**
1495
+ * The minimum delivery time.
1496
+ */
1497
+ export interface Minimum {
1498
+ /**
1499
+ * The unit of the time duration.
1500
+ */
1501
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1502
+
1503
+ /**
1504
+ * The value of the time duration.
1505
+ */
1506
+ value: number;
1507
+ }
1508
+ }
1509
+ }
1510
+
1511
+ /**
1512
+ * The shopper object. Contains information collected from the user during the
1513
+ * Checkout.
1514
+ */
1515
+ export interface Shopper {
1516
+ email?: string;
1517
+
1518
+ phoneNumber?: string;
1519
+ }
1520
+
1521
+ export interface StatusClassification {
1522
+ /**
1523
+ * Populated with the primary payment initiation failure classsification if
1524
+ * available.
1525
+ */
1526
+ primary?: string;
1527
+
1528
+ /**
1529
+ * Populated with the secondary payment initiation failure classsification if
1530
+ * available.
1531
+ */
1532
+ secondary?: string;
1533
+ }
1534
+
1535
+ export interface StatusHistoryList {
1536
+ /**
1537
+ * The order status. This status symbolises the state of the user's payment
1538
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
1539
+ * information.
1540
+ */
1541
+ currentStatus:
1542
+ | 'failed'
1543
+ | 'canceled'
1544
+ | 'processing'
1545
+ | 'in_handshake'
1546
+ | 'waiting_for_payment'
1547
+ | 'paid'
1548
+ | 'in_refund'
1549
+ | 'refunded'
1550
+ | 'refund_failed'
1551
+ | 'partially_refunded'
1552
+ | 'in_dispute'
1553
+ | 'disputed'
1554
+ | 'refused';
1555
+
1556
+ reason: string;
1557
+
1558
+ updatedAt: string;
1559
+
1560
+ /**
1561
+ * The order status. This status symbolises the state of the user's payment
1562
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
1563
+ * information.
1564
+ */
1565
+ previousStatus?:
1566
+ | 'failed'
1567
+ | 'canceled'
1568
+ | 'processing'
1569
+ | 'in_handshake'
1570
+ | 'waiting_for_payment'
1571
+ | 'paid'
1572
+ | 'in_refund'
1573
+ | 'refunded'
1574
+ | 'refund_failed'
1575
+ | 'partially_refunded'
1576
+ | 'in_dispute'
1577
+ | 'disputed'
1578
+ | 'refused'
1579
+ | null;
1580
+ }
1581
+ }
1582
+
1583
+ export interface OrderUpdateResponse {
1584
+ /**
1585
+ * The Ivy unique identifier for the order.
1586
+ */
1587
+ id: string;
1588
+
1589
+ /**
1590
+ * @deprecated The unique identifier for the merchantApp which initiated the order
1591
+ * / payment attempt.
1592
+ */
1593
+ appId: string;
1594
+
1595
+ /**
1596
+ * The Ivy fee for the payment.
1597
+ */
1598
+ applicationFeeAmount: number;
1599
+
1600
+ createdAt: string;
1601
+
1602
+ instantPaymentScheme: boolean;
1603
+
1604
+ /**
1605
+ * @deprecated Deprecated in favor of `appId`.
1606
+ */
1607
+ merchantAppId: string;
1608
+
1609
+ /**
1610
+ * The unique identifier for the merchant which initiated the order / payment
1611
+ * attempt.
1612
+ */
1613
+ merchantId: string;
1614
+
1615
+ /**
1616
+ * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
1617
+ * represents EUR 10.23. Any amount of decimal places can be provided on
1618
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
1619
+ * as this is the format accepted by most banks.
1620
+ */
1621
+ price: OrderUpdateResponse.Price;
1622
+
1623
+ /**
1624
+ * An internal reference id which will be stored with the checkout & corresponding
1625
+ * order. Needs to be unique per shop per order and can be up to 200 characters.
1626
+ */
1627
+ referenceId: string;
1628
+
1629
+ /**
1630
+ * The name of the merchant which initiated the order.
1631
+ */
1632
+ shopName: string;
1633
+
1634
+ /**
1635
+ * The order status. This status symbolises the state of the user's payment
1636
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
1637
+ * information.
1638
+ */
1639
+ status:
1640
+ | 'failed'
1641
+ | 'canceled'
1642
+ | 'processing'
1643
+ | 'in_handshake'
1644
+ | 'waiting_for_payment'
1645
+ | 'paid'
1646
+ | 'in_refund'
1647
+ | 'refunded'
1648
+ | 'refund_failed'
1649
+ | 'partially_refunded'
1650
+ | 'in_dispute'
1651
+ | 'disputed'
1652
+ | 'refused';
1653
+
1654
+ updatedAt: string;
1655
+
1656
+ /**
1657
+ * The bank statement reference of the payment for the order. This is the reference
1658
+ * that will be visible on the bank statement.
1659
+ */
1660
+ bankStatementReference?: string;
1661
+
1662
+ /**
1663
+ * The billing address of the user. Required when handshake=true.
1664
+ */
1665
+ billingAddress?: OrderUpdateResponse.BillingAddress;
1666
+
1667
+ /**
1668
+ * The merchant category code or
1669
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
1670
+ */
1671
+ category?: string;
1672
+
1673
+ /**
1674
+ * @deprecated
1675
+ */
1676
+ climateActionMode?: OrderUpdateResponse.ClimateActionMode;
1677
+
1678
+ /**
1679
+ * @deprecated
1680
+ */
1681
+ co2Grams?: number;
1682
+
1683
+ /**
1684
+ * The unique identifier of the customer who placed the order.
1685
+ */
1686
+ customerId?: string;
1687
+
1688
+ /**
1689
+ * The customer facing id. This id is displayed to the user during the checkout and
1690
+ * in the merchant dashboard.
1691
+ */
1692
+ displayId?: string;
1693
+
1694
+ /**
1695
+ * False by default. If set to true, customers skip email input and jump directly
1696
+ * to their bank login. For express Checkout Sessions this is always false.
1697
+ */
1698
+ guest?: boolean;
1699
+
1700
+ /**
1701
+ * Only valid for sustainable incentive mode. The social / sustainable projects
1702
+ * available to the user during Checkout.
1703
+ */
1704
+ impactOffsetProjects?: Array<string>;
1705
+
1706
+ /**
1707
+ * The incentive mode of the checkout session. For any use-case apart from
1708
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
1709
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
1710
+ * session will contain sustainable incentives for users.
1711
+ */
1712
+ incentiveMode?: 'white_label' | 'sustainable';
1713
+
1714
+ /**
1715
+ * The line items of the Checkout.
1716
+ */
1717
+ lineItems?: Array<OrderUpdateResponse.LineItem>;
1718
+
1719
+ mandate?: OrderUpdateResponse.Mandate;
1720
+
1721
+ /**
1722
+ * The destination bank account where the money will be sent to.
1723
+ */
1724
+ merchantFinancialAddress?: OrderUpdateResponse.MerchantFinancialAddress;
1725
+
1726
+ /**
1727
+ * Any data which will be stored and returned for this checkout session and
1728
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
1729
+ * more info.
1730
+ */
1731
+ metadata?: Record<string, unknown>;
1732
+
1733
+ /**
1734
+ * Only valid for sustainable incentive mode. The social / sustainability project
1735
+ * chosen by the user during Checkout.
1736
+ */
1737
+ offsetProject?: string;
1738
+
1739
+ /**
1740
+ * The source bank account where the money is send from.
1741
+ */
1742
+ payerFinancialAddress?: OrderUpdateResponse.PayerFinancialAddress;
1743
+
1744
+ paymentMethodType?: 'sepa_debit' | 'customer_balance';
1745
+
1746
+ /**
1747
+ * The payment mode of the order. Can be either 'settlement' or 'direct'.
1748
+ */
1749
+ paymentMode?: 'settlement' | 'direct';
1750
+
1751
+ /**
1752
+ * @deprecated Deprecated in favor of `status`. Do not use this field to trigger
1753
+ * actions in your system.
1754
+ */
1755
+ paymentStatus?:
1756
+ | 'failed'
1757
+ | 'canceled'
1758
+ | 'processing'
1759
+ | 'requires_action'
1760
+ | 'succeeded'
1761
+ | 'in_refund'
1762
+ | 'refunded'
1763
+ | 'refund_failed'
1764
+ | 'partially_refunded'
1765
+ | 'not_settled'
1766
+ | 'disputed';
1767
+
1768
+ /**
1769
+ * The total amount in the currency of all successful refunds for this order
1770
+ */
1771
+ refundAmount?: number;
1772
+
1773
+ /**
1774
+ * The list of refunds connected to this order.
1775
+ */
1776
+ refunds?: Array<OrderUpdateResponse.Refund>;
1777
+
1778
+ /**
1779
+ * The shipping address of the user. This is only collected in express Checkouts.
1780
+ */
1781
+ shippingAddress?: OrderUpdateResponse.ShippingAddress;
1782
+
1783
+ /**
1784
+ * The selected shipping method by the user. Can either be selected during an
1785
+ * express Checkout Session or passed during Checkout Session creation.
1786
+ */
1787
+ shippingMethod?: OrderUpdateResponse.ShippingMethod;
1788
+
1789
+ /**
1790
+ * The logo of the shop provided as a URL.
1791
+ */
1792
+ shopLogo?: string;
1793
+
1794
+ /**
1795
+ * The shopper object. Contains information collected from the user during the
1796
+ * Checkout.
1797
+ */
1798
+ shopper?: OrderUpdateResponse.Shopper;
1799
+
1800
+ /**
1801
+ * @deprecated Deprecated in favor of `shopper.email`. The email of the user if
1802
+ * collected in the Checkout.
1803
+ */
1804
+ shopperEmail?: string;
1805
+
1806
+ statusClassification?: OrderUpdateResponse.StatusClassification;
1807
+
1808
+ /**
1809
+ * List of status history items for the order, used for logging every update on
1810
+ * status.
1811
+ */
1812
+ statusHistoryList?: Array<OrderUpdateResponse.StatusHistoryList>;
1813
+
1814
+ /**
1815
+ * The subaccount id of the order.
1816
+ */
1817
+ subaccountId?: string;
1818
+
1819
+ /**
1820
+ * The legal name of the subaccount
1821
+ */
1822
+ subaccountLegalName?: string;
1823
+
1824
+ /**
1825
+ * @deprecated
1826
+ */
1827
+ trees?: number;
1828
+ }
1829
+
1830
+ export namespace OrderUpdateResponse {
1831
+ /**
1832
+ * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
1833
+ * represents EUR 10.23. Any amount of decimal places can be provided on
1834
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
1835
+ * as this is the format accepted by most banks.
1836
+ */
1837
+ export interface Price {
1838
+ currency: 'EUR' | 'GBP' | 'PLN';
1839
+
1840
+ /**
1841
+ * The total amount to be paid.
1842
+ */
1843
+ total: number;
1844
+
1845
+ /**
1846
+ * The shipping amount.
1847
+ */
1848
+ shipping?: number;
1849
+
1850
+ /**
1851
+ * The subtotal amount, i.e. the total amount without VAT and shipping.
1852
+ */
1853
+ subTotal?: number;
1854
+
1855
+ /**
1856
+ * The total net amount, i.e. the total amount without VAT. This value is rounded
1857
+ * to 2 decimal places for the actual transfer.
1858
+ */
1859
+ totalNet?: number;
1860
+
1861
+ /**
1862
+ * The VAT amount.
1863
+ */
1864
+ vat?: number;
1865
+ }
1866
+
1867
+ /**
1868
+ * The billing address of the user. Required when handshake=true.
1869
+ */
1870
+ export interface BillingAddress {
1871
+ city: string;
1872
+
1873
+ /**
1874
+ * The country code in
1875
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
1876
+ */
1877
+ country:
1878
+ | 'AF'
1879
+ | 'AL'
1880
+ | 'DZ'
1881
+ | 'AS'
1882
+ | 'AD'
1883
+ | 'AO'
1884
+ | 'AI'
1885
+ | 'AQ'
1886
+ | 'AG'
1887
+ | 'AR'
1888
+ | 'AM'
1889
+ | 'AW'
1890
+ | 'AU'
1891
+ | 'AT'
1892
+ | 'AZ'
1893
+ | 'BS'
1894
+ | 'BH'
1895
+ | 'BD'
1896
+ | 'BB'
1897
+ | 'BY'
1898
+ | 'BE'
1899
+ | 'BZ'
1900
+ | 'BJ'
1901
+ | 'BM'
1902
+ | 'BT'
1903
+ | 'BO'
1904
+ | 'BA'
1905
+ | 'BW'
1906
+ | 'BV'
1907
+ | 'BR'
1908
+ | 'IO'
1909
+ | 'BN'
1910
+ | 'BG'
1911
+ | 'BF'
1912
+ | 'BI'
1913
+ | 'KH'
1914
+ | 'CM'
1915
+ | 'CA'
1916
+ | 'CV'
1917
+ | 'KY'
1918
+ | 'CF'
1919
+ | 'TD'
1920
+ | 'CL'
1921
+ | 'CN'
1922
+ | 'CX'
1923
+ | 'CC'
1924
+ | 'CO'
1925
+ | 'KM'
1926
+ | 'CG'
1927
+ | 'CD'
1928
+ | 'CK'
1929
+ | 'CR'
1930
+ | 'CI'
1931
+ | 'HR'
1932
+ | 'CU'
1933
+ | 'CY'
1934
+ | 'CZ'
1935
+ | 'DK'
1936
+ | 'DJ'
1937
+ | 'DM'
1938
+ | 'DO'
1939
+ | 'EC'
1940
+ | 'EG'
1941
+ | 'SV'
1942
+ | 'GQ'
1943
+ | 'ER'
1944
+ | 'EE'
1945
+ | 'ET'
1946
+ | 'FK'
1947
+ | 'FO'
1948
+ | 'FJ'
1949
+ | 'FI'
1950
+ | 'FR'
1951
+ | 'GF'
1952
+ | 'PF'
1953
+ | 'TF'
1954
+ | 'GA'
1955
+ | 'GM'
1956
+ | 'GE'
1957
+ | 'DE'
1958
+ | 'GH'
1959
+ | 'GI'
1960
+ | 'GR'
1961
+ | 'GL'
1962
+ | 'GD'
1963
+ | 'GP'
1964
+ | 'GU'
1965
+ | 'GT'
1966
+ | 'GN'
1967
+ | 'GW'
1968
+ | 'GY'
1969
+ | 'HT'
1970
+ | 'HM'
1971
+ | 'VA'
1972
+ | 'HN'
1973
+ | 'HK'
1974
+ | 'HU'
1975
+ | 'IS'
1976
+ | 'IN'
1977
+ | 'ID'
1978
+ | 'IR'
1979
+ | 'IQ'
1980
+ | 'IE'
1981
+ | 'IL'
1982
+ | 'IT'
1983
+ | 'JM'
1984
+ | 'JP'
1985
+ | 'JO'
1986
+ | 'KZ'
1987
+ | 'KE'
1988
+ | 'KI'
1989
+ | 'KP'
1990
+ | 'KR'
1991
+ | 'KW'
1992
+ | 'KG'
1993
+ | 'LA'
1994
+ | 'LV'
1995
+ | 'LB'
1996
+ | 'LS'
1997
+ | 'LR'
1998
+ | 'LY'
1999
+ | 'LI'
2000
+ | 'LT'
2001
+ | 'LU'
2002
+ | 'MO'
2003
+ | 'MG'
2004
+ | 'MW'
2005
+ | 'MY'
2006
+ | 'MV'
2007
+ | 'ML'
2008
+ | 'MT'
2009
+ | 'MH'
2010
+ | 'MQ'
2011
+ | 'MR'
2012
+ | 'MU'
2013
+ | 'YT'
2014
+ | 'MX'
2015
+ | 'FM'
2016
+ | 'MD'
2017
+ | 'MC'
2018
+ | 'MN'
2019
+ | 'MS'
2020
+ | 'MA'
2021
+ | 'MZ'
2022
+ | 'MM'
2023
+ | 'NA'
2024
+ | 'NR'
2025
+ | 'NP'
2026
+ | 'NL'
2027
+ | 'NC'
2028
+ | 'NZ'
2029
+ | 'NI'
2030
+ | 'NE'
2031
+ | 'NG'
2032
+ | 'NU'
2033
+ | 'NF'
2034
+ | 'MP'
2035
+ | 'MK'
2036
+ | 'NO'
2037
+ | 'OM'
2038
+ | 'PK'
2039
+ | 'PW'
2040
+ | 'PS'
2041
+ | 'PA'
2042
+ | 'PG'
2043
+ | 'PY'
2044
+ | 'PE'
2045
+ | 'PH'
2046
+ | 'PN'
2047
+ | 'PL'
2048
+ | 'PT'
2049
+ | 'PR'
2050
+ | 'QA'
2051
+ | 'RE'
2052
+ | 'RO'
2053
+ | 'RU'
2054
+ | 'RW'
2055
+ | 'SH'
2056
+ | 'KN'
2057
+ | 'LC'
2058
+ | 'PM'
2059
+ | 'VC'
2060
+ | 'WS'
2061
+ | 'SM'
2062
+ | 'ST'
2063
+ | 'SA'
2064
+ | 'SN'
2065
+ | 'SC'
2066
+ | 'SL'
2067
+ | 'SG'
2068
+ | 'SK'
2069
+ | 'SI'
2070
+ | 'SB'
2071
+ | 'SO'
2072
+ | 'ZA'
2073
+ | 'GS'
2074
+ | 'ES'
2075
+ | 'LK'
2076
+ | 'SD'
2077
+ | 'SR'
2078
+ | 'SJ'
2079
+ | 'SZ'
2080
+ | 'SE'
2081
+ | 'CH'
2082
+ | 'SY'
2083
+ | 'TW'
2084
+ | 'TJ'
2085
+ | 'TZ'
2086
+ | 'TH'
2087
+ | 'TL'
2088
+ | 'TG'
2089
+ | 'TK'
2090
+ | 'TO'
2091
+ | 'TT'
2092
+ | 'TN'
2093
+ | 'TR'
2094
+ | 'TM'
2095
+ | 'TC'
2096
+ | 'TV'
2097
+ | 'UG'
2098
+ | 'UA'
2099
+ | 'AE'
2100
+ | 'GB'
2101
+ | 'US'
2102
+ | 'UM'
2103
+ | 'UY'
2104
+ | 'UZ'
2105
+ | 'VU'
2106
+ | 'VE'
2107
+ | 'VN'
2108
+ | 'VG'
2109
+ | 'VI'
2110
+ | 'WF'
2111
+ | 'EH'
2112
+ | 'YE'
2113
+ | 'ZM'
2114
+ | 'ZW'
2115
+ | 'AX'
2116
+ | 'BQ'
2117
+ | 'CW'
2118
+ | 'GG'
2119
+ | 'IM'
2120
+ | 'JE'
2121
+ | 'ME'
2122
+ | 'BL'
2123
+ | 'MF'
2124
+ | 'RS'
2125
+ | 'SX'
2126
+ | 'SS'
2127
+ | 'XK';
2128
+
2129
+ line1: string;
2130
+
2131
+ zipCode: string;
2132
+
2133
+ firstName?: string;
2134
+
2135
+ lastName?: string;
2136
+
2137
+ line2?: string;
2138
+
2139
+ region?: string;
2140
+ }
2141
+
2142
+ /**
2143
+ * @deprecated
2144
+ */
2145
+ export interface ClimateActionMode {
2146
+ amount: number;
2147
+
2148
+ type: 'transaction' | 'amount';
2149
+ }
2150
+
2151
+ export interface LineItem {
2152
+ /**
2153
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
2154
+ * decimals, i.e. 10.23 represents EUR 10.23.
2155
+ */
2156
+ amount: number;
2157
+
2158
+ /**
2159
+ * The name of the line item.
2160
+ */
2161
+ name: string;
2162
+
2163
+ /**
2164
+ * The quantity of the line item.
2165
+ */
2166
+ quantity: number;
2167
+
2168
+ /**
2169
+ * The net amount of a single item.
2170
+ */
2171
+ singleNet: number;
2172
+
2173
+ /**
2174
+ * The VAT amount of a single item.
2175
+ */
2176
+ singleVat: number;
2177
+
2178
+ /**
2179
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
2180
+ * the line item.
2181
+ */
2182
+ category?: string;
2183
+
2184
+ /**
2185
+ * The
2186
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
2187
+ * of the line item.
2188
+ */
2189
+ EAN?: string;
2190
+
2191
+ /**
2192
+ * The image of the line item as a URL.
2193
+ */
2194
+ image?: string;
2195
+
2196
+ /**
2197
+ * The internal unique identifier of the line item.
2198
+ */
2199
+ referenceId?: string;
2200
+ }
2201
+
2202
+ export interface Mandate {
2203
+ /**
2204
+ * The name of the account holder who signs the mandate.
2205
+ */
2206
+ accountHolderName?: string;
2207
+
2208
+ /**
2209
+ * Additional information to display to the user during the mandate setup. This
2210
+ * information is not used to setup any recurrence on the mandate. It is only
2211
+ * displayed to the user during checkout.
2212
+ */
2213
+ additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
2214
+
2215
+ /**
2216
+ * Mandate creditor data
2217
+ */
2218
+ creditor?: Mandate.Creditor;
2219
+
2220
+ /**
2221
+ * The reference of the mandate going to be setup
2222
+ */
2223
+ reference?: string;
2224
+
2225
+ /**
2226
+ * The mandate referenceId. Set this to match incoming `mandate_setup_started`,
2227
+ * `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
2228
+ * mandate setup request.
2229
+ */
2230
+ referenceId?: string;
2231
+
2232
+ /**
2233
+ * If true, a ready to use mandate will be set up after the payment flow.
2234
+ */
2235
+ setup?: boolean;
2236
+
2237
+ /**
2238
+ * The email of the user who signs the mandate.
2239
+ */
2240
+ userNotificationEmail?: string;
2241
+ }
2242
+
2243
+ export namespace Mandate {
2244
+ /**
2245
+ * Additional information to display to the user during the mandate setup. This
2246
+ * information is not used to setup any recurrence on the mandate. It is only
2247
+ * displayed to the user during checkout.
2248
+ */
2249
+ export interface AdditionalDisplayInformation {
2250
+ /**
2251
+ * The intended cadence of charges used for displaying purpose only. On demand
2252
+ * would be used for unscheduled charges.
2253
+ */
2254
+ cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
2255
+
2256
+ price?: AdditionalDisplayInformation.Price;
2257
+ }
2258
+
2259
+ export namespace AdditionalDisplayInformation {
2260
+ export interface Price {
2261
+ /**
2262
+ * The amount displayed to the user as decimal e.g. 10.23 would be displayed as
2263
+ * 10.23 EUR.
2264
+ */
2265
+ amount?: number;
2266
+
2267
+ currency?: 'EUR' | 'GBP' | 'PLN';
2268
+ }
2269
+ }
2270
+
2271
+ /**
2272
+ * Mandate creditor data
2273
+ */
2274
+ export interface Creditor {
2275
+ id?: string;
2276
+
2277
+ name?: string;
2278
+ }
2279
+ }
2280
+
2281
+ /**
2282
+ * The destination bank account where the money will be sent to.
2283
+ */
2284
+ export interface MerchantFinancialAddress {
2285
+ bankCode?: MerchantFinancialAddress.BankCode;
2286
+
2287
+ bban?: MerchantFinancialAddress.Bban;
2288
+
2289
+ iban?: MerchantFinancialAddress.Iban;
2290
+
2291
+ /**
2292
+ * The payment reference for the order. This is the reference that will be visible
2293
+ * on the bank statement.
2294
+ */
2295
+ paymentReference?: string;
2296
+
2297
+ sortCode?: MerchantFinancialAddress.SortCode;
2298
+
2299
+ /**
2300
+ * The type of the financial address. The actual destination is determined by this
2301
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
2302
+ * validation will fail if you set e.g. type="iban", but then not fill any values
2303
+ * in the "iban" object.
2304
+ *
2305
+ * - iban: The IBAN of the account
2306
+ * - sort_code: The sort code of the account
2307
+ * - bank_code: The bank code of the account
2308
+ * - bban: The BBAN of the account
2309
+ */
2310
+ type?: string;
2311
+ }
2312
+
2313
+ export namespace MerchantFinancialAddress {
2314
+ export interface BankCode {
2315
+ /**
2316
+ * The name of the account holder.
2317
+ */
2318
+ accountHolderName: string;
2319
+
2320
+ accountNumber: string;
2321
+
2322
+ code: string;
2323
+ }
2324
+
2325
+ export interface Bban {
2326
+ /**
2327
+ * The name of the account holder.
2328
+ */
2329
+ accountHolderName: string;
2330
+
2331
+ bban: string;
2332
+
2333
+ bic?: string;
2334
+ }
2335
+
2336
+ export interface Iban {
2337
+ /**
2338
+ * The name of the account holder.
2339
+ */
2340
+ accountHolderName: string;
2341
+
2342
+ iban: string;
2343
+
2344
+ bic?: string;
2345
+ }
2346
+
2347
+ export interface SortCode {
2348
+ /**
2349
+ * The name of the account holder.
2350
+ */
2351
+ accountHolderName: string;
2352
+
2353
+ accountNumber: string;
2354
+
2355
+ sortCode: string;
2356
+ }
2357
+ }
2358
+
2359
+ /**
2360
+ * The source bank account where the money is send from.
2361
+ */
2362
+ export interface PayerFinancialAddress {
2363
+ /**
2364
+ * The type of the financial address. The actual destination is determined by this
2365
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
2366
+ * validation will fail if you set e.g. type="iban", but then not fill any values
2367
+ * in the "iban" object.
2368
+ *
2369
+ * - iban: The IBAN of the account
2370
+ * - sort_code: The sort code of the account
2371
+ * - bank_code: The bank code of the account
2372
+ * - bban: The BBAN of the account
2373
+ */
2374
+ type: string;
2375
+
2376
+ bankCode?: PayerFinancialAddress.BankCode;
2377
+
2378
+ bban?: PayerFinancialAddress.Bban;
2379
+
2380
+ iban?: PayerFinancialAddress.Iban;
2381
+
2382
+ sortCode?: PayerFinancialAddress.SortCode;
2383
+ }
2384
+
2385
+ export namespace PayerFinancialAddress {
2386
+ export interface BankCode {
2387
+ accountNumber: string;
2388
+
2389
+ code: string;
2390
+
2391
+ /**
2392
+ * The name of the account holder.
2393
+ */
2394
+ accountHolderName?: string;
2395
+ }
2396
+
2397
+ export interface Bban {
2398
+ bban: string;
2399
+
2400
+ /**
2401
+ * The name of the account holder.
2402
+ */
2403
+ accountHolderName?: string;
2404
+
2405
+ bic?: string;
2406
+ }
2407
+
2408
+ export interface Iban {
2409
+ iban: string;
2410
+
2411
+ /**
2412
+ * The name of the account holder.
2413
+ */
2414
+ accountHolderName?: string;
2415
+
2416
+ bic?: string;
2417
+ }
2418
+
2419
+ export interface SortCode {
2420
+ accountNumber: string;
2421
+
2422
+ sortCode: string;
2423
+
2424
+ /**
2425
+ * The name of the account holder.
2426
+ */
2427
+ accountHolderName?: string;
2428
+ }
2429
+ }
2430
+
2431
+ /**
2432
+ * A Refund object. This corresponds to one Refund request.
2433
+ */
2434
+ export interface Refund {
2435
+ id: string;
2436
+
2437
+ amount: number;
2438
+
2439
+ createdAt: string;
2440
+
2441
+ referenceId: string;
2442
+
2443
+ /**
2444
+ * The status of the refund. Always use the status of the order as your source of
2445
+ * truth to trigger actions in your dashboard.
2446
+ */
2447
+ status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
2448
+
2449
+ updatedAt: string;
2450
+
2451
+ description?: string;
2452
+ }
2453
+
2454
+ /**
2455
+ * The shipping address of the user. This is only collected in express Checkouts.
2456
+ */
2457
+ export interface ShippingAddress {
2458
+ city: string;
2459
+
2460
+ /**
2461
+ * The country code in
2462
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
2463
+ */
2464
+ country:
2465
+ | 'AF'
2466
+ | 'AL'
2467
+ | 'DZ'
2468
+ | 'AS'
2469
+ | 'AD'
2470
+ | 'AO'
2471
+ | 'AI'
2472
+ | 'AQ'
2473
+ | 'AG'
2474
+ | 'AR'
2475
+ | 'AM'
2476
+ | 'AW'
2477
+ | 'AU'
2478
+ | 'AT'
2479
+ | 'AZ'
2480
+ | 'BS'
2481
+ | 'BH'
2482
+ | 'BD'
2483
+ | 'BB'
2484
+ | 'BY'
2485
+ | 'BE'
2486
+ | 'BZ'
2487
+ | 'BJ'
2488
+ | 'BM'
2489
+ | 'BT'
2490
+ | 'BO'
2491
+ | 'BA'
2492
+ | 'BW'
2493
+ | 'BV'
2494
+ | 'BR'
2495
+ | 'IO'
2496
+ | 'BN'
2497
+ | 'BG'
2498
+ | 'BF'
2499
+ | 'BI'
2500
+ | 'KH'
2501
+ | 'CM'
2502
+ | 'CA'
2503
+ | 'CV'
2504
+ | 'KY'
2505
+ | 'CF'
2506
+ | 'TD'
2507
+ | 'CL'
2508
+ | 'CN'
2509
+ | 'CX'
2510
+ | 'CC'
2511
+ | 'CO'
2512
+ | 'KM'
2513
+ | 'CG'
2514
+ | 'CD'
2515
+ | 'CK'
2516
+ | 'CR'
2517
+ | 'CI'
2518
+ | 'HR'
2519
+ | 'CU'
2520
+ | 'CY'
2521
+ | 'CZ'
2522
+ | 'DK'
2523
+ | 'DJ'
2524
+ | 'DM'
2525
+ | 'DO'
2526
+ | 'EC'
2527
+ | 'EG'
2528
+ | 'SV'
2529
+ | 'GQ'
2530
+ | 'ER'
2531
+ | 'EE'
2532
+ | 'ET'
2533
+ | 'FK'
2534
+ | 'FO'
2535
+ | 'FJ'
2536
+ | 'FI'
2537
+ | 'FR'
2538
+ | 'GF'
2539
+ | 'PF'
2540
+ | 'TF'
2541
+ | 'GA'
2542
+ | 'GM'
2543
+ | 'GE'
2544
+ | 'DE'
2545
+ | 'GH'
2546
+ | 'GI'
2547
+ | 'GR'
2548
+ | 'GL'
2549
+ | 'GD'
2550
+ | 'GP'
2551
+ | 'GU'
2552
+ | 'GT'
2553
+ | 'GN'
2554
+ | 'GW'
2555
+ | 'GY'
2556
+ | 'HT'
2557
+ | 'HM'
2558
+ | 'VA'
2559
+ | 'HN'
2560
+ | 'HK'
2561
+ | 'HU'
2562
+ | 'IS'
2563
+ | 'IN'
2564
+ | 'ID'
2565
+ | 'IR'
2566
+ | 'IQ'
2567
+ | 'IE'
2568
+ | 'IL'
2569
+ | 'IT'
2570
+ | 'JM'
2571
+ | 'JP'
2572
+ | 'JO'
2573
+ | 'KZ'
2574
+ | 'KE'
2575
+ | 'KI'
2576
+ | 'KP'
2577
+ | 'KR'
2578
+ | 'KW'
2579
+ | 'KG'
2580
+ | 'LA'
2581
+ | 'LV'
2582
+ | 'LB'
2583
+ | 'LS'
2584
+ | 'LR'
2585
+ | 'LY'
2586
+ | 'LI'
2587
+ | 'LT'
2588
+ | 'LU'
2589
+ | 'MO'
2590
+ | 'MG'
2591
+ | 'MW'
2592
+ | 'MY'
2593
+ | 'MV'
2594
+ | 'ML'
2595
+ | 'MT'
2596
+ | 'MH'
2597
+ | 'MQ'
2598
+ | 'MR'
2599
+ | 'MU'
2600
+ | 'YT'
2601
+ | 'MX'
2602
+ | 'FM'
2603
+ | 'MD'
2604
+ | 'MC'
2605
+ | 'MN'
2606
+ | 'MS'
2607
+ | 'MA'
2608
+ | 'MZ'
2609
+ | 'MM'
2610
+ | 'NA'
2611
+ | 'NR'
2612
+ | 'NP'
2613
+ | 'NL'
2614
+ | 'NC'
2615
+ | 'NZ'
2616
+ | 'NI'
2617
+ | 'NE'
2618
+ | 'NG'
2619
+ | 'NU'
2620
+ | 'NF'
2621
+ | 'MP'
2622
+ | 'MK'
2623
+ | 'NO'
2624
+ | 'OM'
2625
+ | 'PK'
2626
+ | 'PW'
2627
+ | 'PS'
2628
+ | 'PA'
2629
+ | 'PG'
2630
+ | 'PY'
2631
+ | 'PE'
2632
+ | 'PH'
2633
+ | 'PN'
2634
+ | 'PL'
2635
+ | 'PT'
2636
+ | 'PR'
2637
+ | 'QA'
2638
+ | 'RE'
2639
+ | 'RO'
2640
+ | 'RU'
2641
+ | 'RW'
2642
+ | 'SH'
2643
+ | 'KN'
2644
+ | 'LC'
2645
+ | 'PM'
2646
+ | 'VC'
2647
+ | 'WS'
2648
+ | 'SM'
2649
+ | 'ST'
2650
+ | 'SA'
2651
+ | 'SN'
2652
+ | 'SC'
2653
+ | 'SL'
2654
+ | 'SG'
2655
+ | 'SK'
2656
+ | 'SI'
2657
+ | 'SB'
2658
+ | 'SO'
2659
+ | 'ZA'
2660
+ | 'GS'
2661
+ | 'ES'
2662
+ | 'LK'
2663
+ | 'SD'
2664
+ | 'SR'
2665
+ | 'SJ'
2666
+ | 'SZ'
2667
+ | 'SE'
2668
+ | 'CH'
2669
+ | 'SY'
2670
+ | 'TW'
2671
+ | 'TJ'
2672
+ | 'TZ'
2673
+ | 'TH'
2674
+ | 'TL'
2675
+ | 'TG'
2676
+ | 'TK'
2677
+ | 'TO'
2678
+ | 'TT'
2679
+ | 'TN'
2680
+ | 'TR'
2681
+ | 'TM'
2682
+ | 'TC'
2683
+ | 'TV'
2684
+ | 'UG'
2685
+ | 'UA'
2686
+ | 'AE'
2687
+ | 'GB'
2688
+ | 'US'
2689
+ | 'UM'
2690
+ | 'UY'
2691
+ | 'UZ'
2692
+ | 'VU'
2693
+ | 'VE'
2694
+ | 'VN'
2695
+ | 'VG'
2696
+ | 'VI'
2697
+ | 'WF'
2698
+ | 'EH'
2699
+ | 'YE'
2700
+ | 'ZM'
2701
+ | 'ZW'
2702
+ | 'AX'
2703
+ | 'BQ'
2704
+ | 'CW'
2705
+ | 'GG'
2706
+ | 'IM'
2707
+ | 'JE'
2708
+ | 'ME'
2709
+ | 'BL'
2710
+ | 'MF'
2711
+ | 'RS'
2712
+ | 'SX'
2713
+ | 'SS'
2714
+ | 'XK';
2715
+
2716
+ line1: string;
2717
+
2718
+ zipCode: string;
2719
+
2720
+ firstName?: string;
2721
+
2722
+ lastName?: string;
2723
+
2724
+ line2?: string;
2725
+
2726
+ region?: string;
2727
+ }
2728
+
2729
+ /**
2730
+ * The selected shipping method by the user. Can either be selected during an
2731
+ * express Checkout Session or passed during Checkout Session creation.
2732
+ */
2733
+ export interface ShippingMethod {
2734
+ /**
2735
+ * The customer-facing name of the shipping method.
2736
+ */
2737
+ name: string;
2738
+
2739
+ /**
2740
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
2741
+ */
2742
+ price: number;
2743
+
2744
+ /**
2745
+ * The unique identifier of the shipping method within Ivy.
2746
+ */
2747
+ id?: string;
2748
+
2749
+ /**
2750
+ * The list of countries where the shipping method is available.
2751
+ */
2752
+ countries?: Array<
2753
+ | 'AF'
2754
+ | 'AL'
2755
+ | 'DZ'
2756
+ | 'AS'
2757
+ | 'AD'
2758
+ | 'AO'
2759
+ | 'AI'
2760
+ | 'AQ'
2761
+ | 'AG'
2762
+ | 'AR'
2763
+ | 'AM'
2764
+ | 'AW'
2765
+ | 'AU'
2766
+ | 'AT'
2767
+ | 'AZ'
2768
+ | 'BS'
2769
+ | 'BH'
2770
+ | 'BD'
2771
+ | 'BB'
2772
+ | 'BY'
2773
+ | 'BE'
2774
+ | 'BZ'
2775
+ | 'BJ'
2776
+ | 'BM'
2777
+ | 'BT'
2778
+ | 'BO'
2779
+ | 'BA'
2780
+ | 'BW'
2781
+ | 'BV'
2782
+ | 'BR'
2783
+ | 'IO'
2784
+ | 'BN'
2785
+ | 'BG'
2786
+ | 'BF'
2787
+ | 'BI'
2788
+ | 'KH'
2789
+ | 'CM'
2790
+ | 'CA'
2791
+ | 'CV'
2792
+ | 'KY'
2793
+ | 'CF'
2794
+ | 'TD'
2795
+ | 'CL'
2796
+ | 'CN'
2797
+ | 'CX'
2798
+ | 'CC'
2799
+ | 'CO'
2800
+ | 'KM'
2801
+ | 'CG'
2802
+ | 'CD'
2803
+ | 'CK'
2804
+ | 'CR'
2805
+ | 'CI'
2806
+ | 'HR'
2807
+ | 'CU'
2808
+ | 'CY'
2809
+ | 'CZ'
2810
+ | 'DK'
2811
+ | 'DJ'
2812
+ | 'DM'
2813
+ | 'DO'
2814
+ | 'EC'
2815
+ | 'EG'
2816
+ | 'SV'
2817
+ | 'GQ'
2818
+ | 'ER'
2819
+ | 'EE'
2820
+ | 'ET'
2821
+ | 'FK'
2822
+ | 'FO'
2823
+ | 'FJ'
2824
+ | 'FI'
2825
+ | 'FR'
2826
+ | 'GF'
2827
+ | 'PF'
2828
+ | 'TF'
2829
+ | 'GA'
2830
+ | 'GM'
2831
+ | 'GE'
2832
+ | 'DE'
2833
+ | 'GH'
2834
+ | 'GI'
2835
+ | 'GR'
2836
+ | 'GL'
2837
+ | 'GD'
2838
+ | 'GP'
2839
+ | 'GU'
2840
+ | 'GT'
2841
+ | 'GN'
2842
+ | 'GW'
2843
+ | 'GY'
2844
+ | 'HT'
2845
+ | 'HM'
2846
+ | 'VA'
2847
+ | 'HN'
2848
+ | 'HK'
2849
+ | 'HU'
2850
+ | 'IS'
2851
+ | 'IN'
2852
+ | 'ID'
2853
+ | 'IR'
2854
+ | 'IQ'
2855
+ | 'IE'
2856
+ | 'IL'
2857
+ | 'IT'
2858
+ | 'JM'
2859
+ | 'JP'
2860
+ | 'JO'
2861
+ | 'KZ'
2862
+ | 'KE'
2863
+ | 'KI'
2864
+ | 'KP'
2865
+ | 'KR'
2866
+ | 'KW'
2867
+ | 'KG'
2868
+ | 'LA'
2869
+ | 'LV'
2870
+ | 'LB'
2871
+ | 'LS'
2872
+ | 'LR'
2873
+ | 'LY'
2874
+ | 'LI'
2875
+ | 'LT'
2876
+ | 'LU'
2877
+ | 'MO'
2878
+ | 'MG'
2879
+ | 'MW'
2880
+ | 'MY'
2881
+ | 'MV'
2882
+ | 'ML'
2883
+ | 'MT'
2884
+ | 'MH'
2885
+ | 'MQ'
2886
+ | 'MR'
2887
+ | 'MU'
2888
+ | 'YT'
2889
+ | 'MX'
2890
+ | 'FM'
2891
+ | 'MD'
2892
+ | 'MC'
2893
+ | 'MN'
2894
+ | 'MS'
2895
+ | 'MA'
2896
+ | 'MZ'
2897
+ | 'MM'
2898
+ | 'NA'
2899
+ | 'NR'
2900
+ | 'NP'
2901
+ | 'NL'
2902
+ | 'NC'
2903
+ | 'NZ'
2904
+ | 'NI'
2905
+ | 'NE'
2906
+ | 'NG'
2907
+ | 'NU'
2908
+ | 'NF'
2909
+ | 'MP'
2910
+ | 'MK'
2911
+ | 'NO'
2912
+ | 'OM'
2913
+ | 'PK'
2914
+ | 'PW'
2915
+ | 'PS'
2916
+ | 'PA'
2917
+ | 'PG'
2918
+ | 'PY'
2919
+ | 'PE'
2920
+ | 'PH'
2921
+ | 'PN'
2922
+ | 'PL'
2923
+ | 'PT'
2924
+ | 'PR'
2925
+ | 'QA'
2926
+ | 'RE'
2927
+ | 'RO'
2928
+ | 'RU'
2929
+ | 'RW'
2930
+ | 'SH'
2931
+ | 'KN'
2932
+ | 'LC'
2933
+ | 'PM'
2934
+ | 'VC'
2935
+ | 'WS'
2936
+ | 'SM'
2937
+ | 'ST'
2938
+ | 'SA'
2939
+ | 'SN'
2940
+ | 'SC'
2941
+ | 'SL'
2942
+ | 'SG'
2943
+ | 'SK'
2944
+ | 'SI'
2945
+ | 'SB'
2946
+ | 'SO'
2947
+ | 'ZA'
2948
+ | 'GS'
2949
+ | 'ES'
2950
+ | 'LK'
2951
+ | 'SD'
2952
+ | 'SR'
2953
+ | 'SJ'
2954
+ | 'SZ'
2955
+ | 'SE'
2956
+ | 'CH'
2957
+ | 'SY'
2958
+ | 'TW'
2959
+ | 'TJ'
2960
+ | 'TZ'
2961
+ | 'TH'
2962
+ | 'TL'
2963
+ | 'TG'
2964
+ | 'TK'
2965
+ | 'TO'
2966
+ | 'TT'
2967
+ | 'TN'
2968
+ | 'TR'
2969
+ | 'TM'
2970
+ | 'TC'
2971
+ | 'TV'
2972
+ | 'UG'
2973
+ | 'UA'
2974
+ | 'AE'
2975
+ | 'GB'
2976
+ | 'US'
2977
+ | 'UM'
2978
+ | 'UY'
2979
+ | 'UZ'
2980
+ | 'VU'
2981
+ | 'VE'
2982
+ | 'VN'
2983
+ | 'VG'
2984
+ | 'VI'
2985
+ | 'WF'
2986
+ | 'EH'
2987
+ | 'YE'
2988
+ | 'ZM'
2989
+ | 'ZW'
2990
+ | 'AX'
2991
+ | 'BQ'
2992
+ | 'CW'
2993
+ | 'GG'
2994
+ | 'IM'
2995
+ | 'JE'
2996
+ | 'ME'
2997
+ | 'BL'
2998
+ | 'MF'
2999
+ | 'RS'
3000
+ | 'SX'
3001
+ | 'SS'
3002
+ | 'XK'
3003
+ >;
3004
+
3005
+ /**
3006
+ * The delivery estimate of the shipping method.
3007
+ */
3008
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
3009
+
3010
+ /**
3011
+ * The unique identifier within your system of the shipping method.
3012
+ */
3013
+ reference?: string;
3014
+
3015
+ /**
3016
+ * @deprecated Deprecated in favor of deliveryEstimate
3017
+ */
3018
+ timeFrame?: string;
3019
+ }
3020
+
3021
+ export namespace ShippingMethod {
3022
+ /**
3023
+ * The delivery estimate of the shipping method.
3024
+ */
3025
+ export interface DeliveryEstimate {
3026
+ /**
3027
+ * The maximum delivery time.
3028
+ */
3029
+ maximum?: DeliveryEstimate.Maximum;
3030
+
3031
+ /**
3032
+ * The minimum delivery time.
3033
+ */
3034
+ minimum?: DeliveryEstimate.Minimum;
3035
+ }
3036
+
3037
+ export namespace DeliveryEstimate {
3038
+ /**
3039
+ * The maximum delivery time.
3040
+ */
3041
+ export interface Maximum {
3042
+ /**
3043
+ * The unit of the time duration.
3044
+ */
3045
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
3046
+
3047
+ /**
3048
+ * The value of the time duration.
3049
+ */
3050
+ value: number;
3051
+ }
3052
+
3053
+ /**
3054
+ * The minimum delivery time.
3055
+ */
3056
+ export interface Minimum {
3057
+ /**
3058
+ * The unit of the time duration.
3059
+ */
3060
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
3061
+
3062
+ /**
3063
+ * The value of the time duration.
3064
+ */
3065
+ value: number;
3066
+ }
3067
+ }
3068
+ }
3069
+
3070
+ /**
3071
+ * The shopper object. Contains information collected from the user during the
3072
+ * Checkout.
3073
+ */
3074
+ export interface Shopper {
3075
+ email?: string;
3076
+
3077
+ phoneNumber?: string;
3078
+ }
3079
+
3080
+ export interface StatusClassification {
3081
+ /**
3082
+ * Populated with the primary payment initiation failure classsification if
3083
+ * available.
3084
+ */
3085
+ primary?: string;
3086
+
3087
+ /**
3088
+ * Populated with the secondary payment initiation failure classsification if
3089
+ * available.
3090
+ */
3091
+ secondary?: string;
3092
+ }
3093
+
3094
+ export interface StatusHistoryList {
3095
+ /**
3096
+ * The order status. This status symbolises the state of the user's payment
3097
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
3098
+ * information.
3099
+ */
3100
+ currentStatus:
3101
+ | 'failed'
3102
+ | 'canceled'
3103
+ | 'processing'
3104
+ | 'in_handshake'
3105
+ | 'waiting_for_payment'
3106
+ | 'paid'
3107
+ | 'in_refund'
3108
+ | 'refunded'
3109
+ | 'refund_failed'
3110
+ | 'partially_refunded'
3111
+ | 'in_dispute'
3112
+ | 'disputed'
3113
+ | 'refused';
3114
+
3115
+ reason: string;
3116
+
3117
+ updatedAt: string;
3118
+
3119
+ /**
3120
+ * The order status. This status symbolises the state of the user's payment
3121
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
3122
+ * information.
3123
+ */
3124
+ previousStatus?:
3125
+ | 'failed'
3126
+ | 'canceled'
3127
+ | 'processing'
3128
+ | 'in_handshake'
3129
+ | 'waiting_for_payment'
3130
+ | 'paid'
3131
+ | 'in_refund'
3132
+ | 'refunded'
3133
+ | 'refund_failed'
3134
+ | 'partially_refunded'
3135
+ | 'in_dispute'
3136
+ | 'disputed'
3137
+ | 'refused'
3138
+ | null;
3139
+ }
3140
+ }
3141
+
3142
+ export interface OrderRetrieveParams {
3143
+ id: string;
3144
+ }
3145
+
3146
+ export interface OrderUpdateParams {
3147
+ id: string;
3148
+
3149
+ /**
3150
+ * The customer-facing id of the order. This id will also be shown next to the
3151
+ * orders in the Ivy Dashboard.
3152
+ */
3153
+ displayId?: string;
3154
+
3155
+ /**
3156
+ * An internal reference id which will be stored with the checkout & corresponding
3157
+ * order. Needs to be unique per shop per order and can be up to 200 characters. We
3158
+ * recommend to use your internal order id here.
3159
+ */
3160
+ referenceId?: string;
3161
+
3162
+ /**
3163
+ * The customer-facing name of the shop.
3164
+ */
3165
+ shopName?: string;
3166
+
3167
+ /**
3168
+ * The order status. This status symbolises the state of the user's payment
3169
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
3170
+ * information.
3171
+ */
3172
+ status?:
3173
+ | 'failed'
3174
+ | 'canceled'
3175
+ | 'processing'
3176
+ | 'in_handshake'
3177
+ | 'waiting_for_payment'
3178
+ | 'paid'
3179
+ | 'in_refund'
3180
+ | 'refunded'
3181
+ | 'refund_failed'
3182
+ | 'partially_refunded'
3183
+ | 'in_dispute'
3184
+ | 'disputed'
3185
+ | 'refused';
3186
+ }
3187
+
3188
+ export declare namespace Orders {
3189
+ export {
3190
+ type OrderRetrieveResponse as OrderRetrieveResponse,
3191
+ type OrderUpdateResponse as OrderUpdateResponse,
3192
+ type OrderRetrieveParams as OrderRetrieveParams,
3193
+ type OrderUpdateParams as OrderUpdateParams,
3194
+ };
3195
+ }