@getivy/node-sdk 0.1.0-alpha.10

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