@getivy/node-sdk 0.1.0-alpha.2 → 0.1.0-alpha.20

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 (87) hide show
  1. package/CHANGELOG.md +209 -0
  2. package/LICENSE +1 -1
  3. package/README.md +18 -18
  4. package/_shims/index.d.ts +2 -0
  5. package/_shims/index.js +5 -1
  6. package/_shims/index.mjs +5 -1
  7. package/core.d.ts +12 -1
  8. package/core.d.ts.map +1 -1
  9. package/core.js +29 -20
  10. package/core.js.map +1 -1
  11. package/core.mjs +31 -22
  12. package/core.mjs.map +1 -1
  13. package/error.d.ts +2 -2
  14. package/error.d.ts.map +1 -1
  15. package/error.js +4 -4
  16. package/error.js.map +1 -1
  17. package/error.mjs +2 -2
  18. package/error.mjs.map +1 -1
  19. package/index.d.mts +15 -12
  20. package/index.d.ts +15 -12
  21. package/index.d.ts.map +1 -1
  22. package/index.js +45 -42
  23. package/index.js.map +1 -1
  24. package/index.mjs +43 -40
  25. package/index.mjs.map +1 -1
  26. package/package.json +3 -3
  27. package/resource.d.ts +3 -3
  28. package/resource.d.ts.map +1 -1
  29. package/resource.js.map +1 -1
  30. package/resource.mjs.map +1 -1
  31. package/resources/banks.d.ts +12 -0
  32. package/resources/banks.d.ts.map +1 -1
  33. package/resources/charges.d.ts +0 -13
  34. package/resources/charges.d.ts.map +1 -1
  35. package/resources/checkoutsession.d.ts +444 -1305
  36. package/resources/checkoutsession.d.ts.map +1 -1
  37. package/resources/customers.d.ts +41 -4
  38. package/resources/customers.d.ts.map +1 -1
  39. package/resources/index.d.ts +2 -1
  40. package/resources/index.d.ts.map +1 -1
  41. package/resources/index.js +3 -1
  42. package/resources/index.js.map +1 -1
  43. package/resources/index.mjs +2 -1
  44. package/resources/index.mjs.map +1 -1
  45. package/resources/orders.d.ts +89 -659
  46. package/resources/orders.d.ts.map +1 -1
  47. package/resources/orders.js +0 -6
  48. package/resources/orders.js.map +1 -1
  49. package/resources/orders.mjs +0 -6
  50. package/resources/orders.mjs.map +1 -1
  51. package/resources/refunds.d.ts +1 -1
  52. package/resources/refunds.d.ts.map +1 -1
  53. package/resources/webhooksubscription.d.ts +155 -0
  54. package/resources/webhooksubscription.d.ts.map +1 -0
  55. package/resources/webhooksubscription.js +42 -0
  56. package/resources/webhooksubscription.js.map +1 -0
  57. package/resources/webhooksubscription.mjs +38 -0
  58. package/resources/webhooksubscription.mjs.map +1 -0
  59. package/resources.d.ts +2 -0
  60. package/resources.d.ts.map +1 -0
  61. package/resources.js +18 -0
  62. package/resources.js.map +1 -0
  63. package/resources.mjs +2 -0
  64. package/resources.mjs.map +1 -0
  65. package/src/_shims/index.d.ts +2 -0
  66. package/src/_shims/index.js +5 -1
  67. package/src/_shims/index.mjs +5 -1
  68. package/src/core.ts +49 -22
  69. package/src/error.ts +2 -2
  70. package/src/index.ts +57 -36
  71. package/src/resource.ts +3 -3
  72. package/src/resources/banks.ts +15 -0
  73. package/src/resources/charges.ts +0 -13
  74. package/src/resources/checkoutsession.ts +2103 -4416
  75. package/src/resources/customers.ts +46 -4
  76. package/src/resources/index.ts +14 -7
  77. package/src/resources/orders.ts +107 -1635
  78. package/src/resources/refunds.ts +0 -1
  79. package/src/resources/webhooksubscription.ts +353 -0
  80. package/src/resources.ts +1 -0
  81. package/src/version.ts +1 -1
  82. package/version.d.ts +1 -1
  83. package/version.d.ts.map +1 -1
  84. package/version.js +1 -1
  85. package/version.js.map +1 -1
  86. package/version.mjs +1 -1
  87. package/version.mjs.map +1 -1
@@ -22,23 +22,22 @@ export interface CheckoutsessionCreateResponse {
22
22
  * The unique identifier of the Checkout within Ivy.
23
23
  */
24
24
  id: string;
25
- appId: string;
26
25
  /**
27
26
  * The markets where the user of the Checkout can select banks from.
28
27
  */
29
28
  availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
30
29
  createdAt: string;
31
30
  /**
32
- * The Epoch time in seconds at which the Checkout Session will expire. It can be
33
- * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
34
- * default, this value is 1 hour from creation.
31
+ * The customer facing id. This id is displayed to the user during the checkout and
32
+ * in the merchant dashboard.
35
33
  */
36
- expiresAt: number;
37
- merchant: CheckoutsessionCreateResponse.Merchant;
34
+ displayId: string;
38
35
  /**
39
- * @deprecated Use merchant.appId instead
36
+ * Required if not set in the dashboard. Users will be redirected here after an
37
+ * unsuccessful Payment attempt.
40
38
  */
41
- merchantAppId: string;
39
+ errorCallbackUrl: string;
40
+ merchant: CheckoutsessionCreateResponse.Merchant;
42
41
  /**
43
42
  * - `settlement`: The payment is initially settled into a virtual account. The
44
43
  * funds are then disbursed in batches to the merchant. Refunds are instantly
@@ -48,19 +47,28 @@ export interface CheckoutsessionCreateResponse {
48
47
  */
49
48
  paymentMode: 'settlement' | 'direct';
50
49
  /**
51
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
50
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
52
51
  * represents EUR 10.23. Any amount of decimal places can be provided on
53
52
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
54
53
  * as this is the format accepted by most banks.
55
54
  */
56
55
  price: CheckoutsessionCreateResponse.Price;
56
+ redirectUrl: string;
57
57
  /**
58
- * Only applicable for express Checkout Sessions. The given fields will be required
59
- * input within the Ivy express Checkout.
58
+ * An internal reference id which will be stored with the checkout & corresponding
59
+ * order. Needs to be unique per shop per order and can be up to 200 characters. We
60
+ * recommend to use your internal order id here.
60
61
  */
61
- required: CheckoutsessionCreateResponse.Required;
62
+ referenceId: string;
62
63
  status: 'open' | 'closed' | 'expired';
64
+ /**
65
+ * Required if not set in the dashboard. Users will be redirected here after a
66
+ * successful Payment attempt.
67
+ */
68
+ successCallbackUrl: string;
69
+ updatedAt: string;
63
70
  abortReason?: string;
71
+ appId?: string;
64
72
  /**
65
73
  * The billing address of the customer. Required when handshake=true.
66
74
  */
@@ -87,15 +95,11 @@ export interface CheckoutsessionCreateResponse {
87
95
  */
88
96
  disableBankSelection?: boolean;
89
97
  /**
90
- * The customer facing id. This id is displayed to the user during the checkout and
91
- * in the merchant dashboard.
92
- */
93
- displayId?: string;
94
- /**
95
- * Required if not set in the dashboard. Users will be redirected here after an
96
- * unsuccessful Payment attempt.
98
+ * The Epoch time in seconds at which the Checkout Session will expire. It can be
99
+ * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
100
+ * default, this value is 1 hour from creation.
97
101
  */
98
- errorCallbackUrl?: string;
102
+ expiresAt?: number;
99
103
  /**
100
104
  * False by default. If set to true, the Checkout is displayed in express mode.
101
105
  */
@@ -132,6 +136,10 @@ export interface CheckoutsessionCreateResponse {
132
136
  * relevant if `prefill.bankId` is provided.
133
137
  */
134
138
  market?: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
139
+ /**
140
+ * @deprecated Use merchant.appId instead
141
+ */
142
+ merchantAppId?: string;
135
143
  /**
136
144
  * Any data which will be stored and returned for this checkout session and
137
145
  * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
@@ -139,12 +147,13 @@ export interface CheckoutsessionCreateResponse {
139
147
  */
140
148
  metadata?: Record<string, unknown>;
141
149
  offsetProject?: string;
150
+ paymentSchemeSelection?: string;
142
151
  /**
143
152
  * The shop-plugin version.
144
153
  */
145
154
  plugin?: string;
146
155
  /**
147
- * Use this to prefill data of the user in the Checkout.
156
+ * Prefill known data to skip steps in the checkout.
148
157
  */
149
158
  prefill?: CheckoutsessionCreateResponse.Prefill;
150
159
  /**
@@ -152,13 +161,11 @@ export interface CheckoutsessionCreateResponse {
152
161
  * this URL.
153
162
  */
154
163
  quoteCallbackUrl?: string;
155
- redirectUrl?: string;
156
164
  /**
157
- * An internal reference id which will be stored with the checkout & corresponding
158
- * order. Needs to be unique per shop per order and can be up to 200 characters. We
159
- * recommend to use your internal order id here.
165
+ * Only applicable for express Checkout Sessions. The given fields will be required
166
+ * input within the Ivy express Checkout.
160
167
  */
161
- referenceId?: string;
168
+ required?: CheckoutsessionCreateResponse.Required;
162
169
  selectedShippingMethodId?: string;
163
170
  shippingAddress?: CheckoutsessionCreateResponse.ShippingAddress;
164
171
  shippingMethods?: Array<CheckoutsessionCreateResponse.ShippingMethod>;
@@ -167,12 +174,7 @@ export interface CheckoutsessionCreateResponse {
167
174
  */
168
175
  shopLogo?: string;
169
176
  shopName?: string;
170
- /**
171
- * Required if not set in the dashboard. Users will be redirected here after a
172
- * successful Payment attempt.
173
- */
174
- successCallbackUrl?: string;
175
- updatedAt?: string;
177
+ subaccountId?: string;
176
178
  }
177
179
  export declare namespace CheckoutsessionCreateResponse {
178
180
  interface Merchant {
@@ -198,7 +200,7 @@ export declare namespace CheckoutsessionCreateResponse {
198
200
  }
199
201
  }
200
202
  /**
201
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
203
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
202
204
  * represents EUR 10.23. Any amount of decimal places can be provided on
203
205
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
204
206
  * as this is the format accepted by most banks.
@@ -209,35 +211,11 @@ export declare namespace CheckoutsessionCreateResponse {
209
211
  * The total amount to be paid.
210
212
  */
211
213
  total: number;
212
- /**
213
- * The shipping amount.
214
- */
215
214
  shipping?: number;
216
- /**
217
- * The subtotal amount, i.e. the total amount without VAT and shipping.
218
- */
219
215
  subTotal?: number;
220
- /**
221
- * The total net amount, i.e. the total amount without VAT. This value is rounded
222
- * to 2 decimal places for the actual transfer.
223
- */
224
216
  totalNet?: number;
225
- /**
226
- * The VAT amount.
227
- */
228
217
  vat?: number;
229
218
  }
230
- /**
231
- * Only applicable for express Checkout Sessions. The given fields will be required
232
- * input within the Ivy express Checkout.
233
- */
234
- interface Required {
235
- /**
236
- * If set to true, the phone number will be required input within the Ivy express
237
- * Checkout.
238
- */
239
- phone: boolean;
240
- }
241
219
  /**
242
220
  * The billing address of the customer. Required when handshake=true.
243
221
  */
@@ -313,85 +291,25 @@ export declare namespace CheckoutsessionCreateResponse {
313
291
  userNotificationEmail?: string;
314
292
  }
315
293
  /**
316
- * Use this to prefill data of the user in the Checkout.
294
+ * Prefill known data to skip steps in the checkout.
317
295
  */
318
296
  interface Prefill {
319
297
  /**
320
- * The id of the bank to preselect in the Checkout. Users will skip the bank
321
- * selection if given. Required for financial address prefill.
298
+ * The known bank id. Customers will skip the bank selection and go directly to the
299
+ * bank's login. Required for financial address prefill.
322
300
  */
323
301
  bankId?: string;
324
- email?: string;
325
- /**
326
- * The financial address prefill is used to preselect the payer account that will
327
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
328
- * for UK GBP payments. For other markets and currencies use your discretion. The
329
- * validation logic is based on the "type" field. For example, if "type" is set to
330
- * "iban", the "iban" object must be filled out.
331
- */
332
- payerFinancialAddress?: Prefill.PayerFinancialAddress;
333
- phone?: string;
334
302
  }
335
- namespace Prefill {
303
+ /**
304
+ * Only applicable for express Checkout Sessions. The given fields will be required
305
+ * input within the Ivy express Checkout.
306
+ */
307
+ interface Required {
336
308
  /**
337
- * The financial address prefill is used to preselect the payer account that will
338
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
339
- * for UK GBP payments. For other markets and currencies use your discretion. The
340
- * validation logic is based on the "type" field. For example, if "type" is set to
341
- * "iban", the "iban" object must be filled out.
309
+ * If set to true, the phone number will be required input within the Ivy express
310
+ * Checkout.
342
311
  */
343
- interface PayerFinancialAddress {
344
- /**
345
- * The type of the financial address. The actual destination is determined by this
346
- * field which can be either "iban", "sortCode", "bankCode", or "bban". The
347
- * validation will fail if you set e.g. type="iban", but then not fill any values
348
- * in the "iban" object.
349
- *
350
- * - iban: The IBAN of the account
351
- * - sort_code: The sort code of the account
352
- * - bank_code: The bank code of the account
353
- * - bban: The BBAN of the account
354
- */
355
- type: string;
356
- bankCode?: PayerFinancialAddress.BankCode;
357
- bban?: PayerFinancialAddress.Bban;
358
- iban?: PayerFinancialAddress.Iban;
359
- sortCode?: PayerFinancialAddress.SortCode;
360
- }
361
- namespace PayerFinancialAddress {
362
- interface BankCode {
363
- accountNumber: string;
364
- code: string;
365
- /**
366
- * The name of the account holder.
367
- */
368
- accountHolderName?: string;
369
- }
370
- interface Bban {
371
- bban: string;
372
- /**
373
- * The name of the account holder.
374
- */
375
- accountHolderName?: string;
376
- bic?: string;
377
- }
378
- interface Iban {
379
- iban: string;
380
- /**
381
- * The name of the account holder.
382
- */
383
- accountHolderName?: string;
384
- bic?: string;
385
- }
386
- interface SortCode {
387
- accountNumber: string;
388
- sortCode: string;
389
- /**
390
- * The name of the account holder.
391
- */
392
- accountHolderName?: string;
393
- }
394
- }
312
+ phone: boolean;
395
313
  }
396
314
  interface ShippingAddress {
397
315
  city: string;
@@ -484,856 +402,387 @@ export declare namespace CheckoutsessionCreateResponse {
484
402
  }
485
403
  }
486
404
  }
487
- export type CheckoutsessionRetrieveResponse = CheckoutsessionRetrieveResponse.PublicCheckoutSession | CheckoutsessionRetrieveResponse.CheckoutSession;
405
+ export interface CheckoutsessionRetrieveResponse {
406
+ /**
407
+ * The unique identifier of the Checkout within Ivy.
408
+ */
409
+ id: string;
410
+ /**
411
+ * The markets where the user of the Checkout can select banks from.
412
+ */
413
+ availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
414
+ createdAt: string;
415
+ /**
416
+ * The customer facing id. This id is displayed to the user during the checkout and
417
+ * in the merchant dashboard.
418
+ */
419
+ displayId: string;
420
+ /**
421
+ * Required if not set in the dashboard. Users will be redirected here after an
422
+ * unsuccessful Payment attempt.
423
+ */
424
+ errorCallbackUrl: string;
425
+ merchant: CheckoutsessionRetrieveResponse.Merchant;
426
+ /**
427
+ * - `settlement`: The payment is initially settled into a virtual account. The
428
+ * funds are then disbursed in batches to the merchant. Refunds are instantly
429
+ * processed from the virtual account.
430
+ * - `direct`: The payment will be settled to the specified `settlementDestination`
431
+ * account. `settlementDestination` is required if `paymentMode` is `direct`.
432
+ */
433
+ paymentMode: 'settlement' | 'direct';
434
+ /**
435
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
436
+ * represents EUR 10.23. Any amount of decimal places can be provided on
437
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
438
+ * as this is the format accepted by most banks.
439
+ */
440
+ price: CheckoutsessionRetrieveResponse.Price;
441
+ redirectUrl: string;
442
+ /**
443
+ * An internal reference id which will be stored with the checkout & corresponding
444
+ * order. Needs to be unique per shop per order and can be up to 200 characters. We
445
+ * recommend to use your internal order id here.
446
+ */
447
+ referenceId: string;
448
+ status: 'open' | 'closed' | 'expired';
449
+ /**
450
+ * Required if not set in the dashboard. Users will be redirected here after a
451
+ * successful Payment attempt.
452
+ */
453
+ successCallbackUrl: string;
454
+ updatedAt: string;
455
+ abortReason?: string;
456
+ appId?: string;
457
+ /**
458
+ * The billing address of the customer. Required when handshake=true.
459
+ */
460
+ billingAddress?: CheckoutsessionRetrieveResponse.BillingAddress;
461
+ /**
462
+ * The merchant category code or
463
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
464
+ */
465
+ category?: string;
466
+ /**
467
+ * Only applicable for express Checkouts. Complete Callback requests will be sent
468
+ * to this URL.
469
+ */
470
+ completeCallbackUrl?: string;
471
+ /**
472
+ * The Epoch time in seconds at which the Checkout Session was created. By default,
473
+ * time of Checkout creation at Ivy.
474
+ */
475
+ created?: number;
476
+ customer?: CheckoutsessionRetrieveResponse.Customer;
477
+ /**
478
+ * False by default. If set to true, customers cannot modify the pre-selected bank
479
+ * from `prefill.bankId`.
480
+ */
481
+ disableBankSelection?: boolean;
482
+ /**
483
+ * The Epoch time in seconds at which the Checkout Session will expire. It can be
484
+ * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
485
+ * default, this value is 1 hour from creation.
486
+ */
487
+ expiresAt?: number;
488
+ /**
489
+ * False by default. If set to true, the Checkout is displayed in express mode.
490
+ */
491
+ express?: boolean;
492
+ /**
493
+ * False by default. If set to true, customers skip email input and jump directly
494
+ * to their bank login. For express Checkout Sessions this is always false.
495
+ */
496
+ guest?: boolean;
497
+ /**
498
+ * If true, the order must be confirmed through the merchant with an additional
499
+ * complete callback endpoint. Always true for express sessions.
500
+ */
501
+ handshake?: boolean;
502
+ impactOffsetProjects?: Array<string>;
503
+ /**
504
+ * The incentive mode of the checkout session. For any use-case apart from
505
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
506
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
507
+ * session will contain sustainable incentives for users.
508
+ */
509
+ incentiveMode?: 'white_label' | 'sustainable';
510
+ lineItems?: Array<CheckoutsessionRetrieveResponse.LineItem>;
511
+ /**
512
+ * The locale of the Checkout. If provided, the Checkout will be displayed in the
513
+ * given language. Users can change the language in the Checkout. If not provided,
514
+ * the language of the Checkout is determined by the browser's language.
515
+ */
516
+ locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
517
+ mandate?: CheckoutsessionRetrieveResponse.Mandate;
518
+ /**
519
+ * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
520
+ * located. If provided, the Checkout will display the market's banks first. Not
521
+ * relevant if `prefill.bankId` is provided.
522
+ */
523
+ market?: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
524
+ /**
525
+ * @deprecated Use merchant.appId instead
526
+ */
527
+ merchantAppId?: string;
528
+ /**
529
+ * Any data which will be stored and returned for this checkout session and
530
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
531
+ * more info.
532
+ */
533
+ metadata?: Record<string, unknown>;
534
+ offsetProject?: string;
535
+ paymentSchemeSelection?: string;
536
+ /**
537
+ * The shop-plugin version.
538
+ */
539
+ plugin?: string;
540
+ /**
541
+ * Prefill known data to skip steps in the checkout.
542
+ */
543
+ prefill?: CheckoutsessionRetrieveResponse.Prefill;
544
+ /**
545
+ * Only applicable for express Checkouts. Quote Callback requests will be sent to
546
+ * this URL.
547
+ */
548
+ quoteCallbackUrl?: string;
549
+ /**
550
+ * Only applicable for express Checkout Sessions. The given fields will be required
551
+ * input within the Ivy express Checkout.
552
+ */
553
+ required?: CheckoutsessionRetrieveResponse.Required;
554
+ selectedShippingMethodId?: string;
555
+ shippingAddress?: CheckoutsessionRetrieveResponse.ShippingAddress;
556
+ shippingMethods?: Array<CheckoutsessionRetrieveResponse.ShippingMethod>;
557
+ /**
558
+ * The logo of the shop provided as a URL.
559
+ */
560
+ shopLogo?: string;
561
+ shopName?: string;
562
+ subaccountId?: string;
563
+ }
488
564
  export declare namespace CheckoutsessionRetrieveResponse {
489
- interface PublicCheckoutSession {
490
- /**
491
- * The unique identifier of the Checkout within Ivy.
492
- */
565
+ interface Merchant {
493
566
  id: string;
494
567
  appId: string;
495
- /**
496
- * The markets where the user of the Checkout can select banks from.
497
- */
498
- availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
499
- /**
500
- * The Epoch time in seconds at which the Checkout Session will expire. It can be
501
- * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
502
- * default, this value is 1 hour from creation.
503
- */
504
- expiresAt: number;
505
- merchant: PublicCheckoutSession.Merchant;
506
- /**
507
- * @deprecated Use merchant.appId instead
508
- */
509
- merchantAppId: string;
510
- /**
511
- * - `settlement`: The payment is initially settled into a virtual account. The
512
- * funds are then disbursed in batches to the merchant. Refunds are instantly
513
- * processed from the virtual account.
514
- * - `direct`: The payment will be settled to the specified `settlementDestination`
515
- * account. `settlementDestination` is required if `paymentMode` is `direct`.
516
- */
517
- paymentMode: 'settlement' | 'direct';
518
- /**
519
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
520
- * represents EUR 10.23. Any amount of decimal places can be provided on
521
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
522
- * as this is the format accepted by most banks.
523
- */
524
- price: PublicCheckoutSession.Price;
525
- /**
526
- * Only applicable for express Checkout Sessions. The given fields will be required
527
- * input within the Ivy express Checkout.
528
- */
529
- required: PublicCheckoutSession.Required;
530
- status: 'open' | 'closed' | 'expired';
531
- /**
532
- * The Epoch time in seconds at which the Checkout Session was created. By default,
533
- * time of Checkout creation at Ivy.
534
- */
535
- created?: number;
536
- customer?: PublicCheckoutSession.Customer;
537
- /**
538
- * False by default. If set to true, customers cannot modify the pre-selected bank
539
- * from `prefill.bankId`.
540
- */
541
- disableBankSelection?: boolean;
542
- /**
543
- * False by default. If set to true, the Checkout is displayed in express mode.
544
- */
545
- express?: boolean;
546
- /**
547
- * False by default. If set to true, customers skip email input and jump directly
548
- * to their bank login. For express Checkout Sessions this is always false.
549
- */
550
- guest?: boolean;
551
- /**
552
- * If true, the order must be confirmed through the merchant with an additional
553
- * complete callback endpoint. Always true for express sessions.
554
- */
555
- handshake?: boolean;
556
- impactOffsetProjects?: Array<string>;
557
- /**
558
- * The incentive mode of the checkout session. For any use-case apart from
559
- * e-commerce, please use `white_label` as the value. If set to `white_label`, the
560
- * checkout session will be white labeled. If set to `sustainable`, the checkout
561
- * session will contain sustainable incentives for users.
562
- */
563
- incentiveMode?: 'white_label' | 'sustainable';
564
- lineItems?: Array<PublicCheckoutSession.LineItem>;
565
- /**
566
- * The locale of the Checkout. If provided, the Checkout will be displayed in the
567
- * given language. Users can change the language in the Checkout. If not provided,
568
- * the language of the Checkout is determined by the browser's language.
569
- */
570
- locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
571
- mandate?: PublicCheckoutSession.Mandate;
572
- /**
573
- * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
574
- * located. Provided when creating the Checkout.
575
- */
576
- market?: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
577
- offsetProject?: string;
578
- /**
579
- * The shop-plugin version.
580
- */
581
- plugin?: string;
582
- /**
583
- * Use this to prefill data of the user in the Checkout.
584
- */
585
- prefill?: PublicCheckoutSession.Prefill;
586
- selectedShippingMethodId?: string;
587
- shippingMethods?: Array<PublicCheckoutSession.ShippingMethod>;
588
- /**
589
- * The logo of the shop provided as a URL.
590
- */
591
- shopLogo?: string;
592
- shopName?: string;
568
+ legalName: string;
569
+ address?: Merchant.Address;
593
570
  }
594
- namespace PublicCheckoutSession {
595
- interface Merchant {
596
- id: string;
597
- appId: string;
598
- legalName: string;
599
- address?: Merchant.Address;
600
- }
601
- namespace Merchant {
602
- interface Address {
603
- city: string;
604
- /**
605
- * The country code in
606
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
607
- */
608
- country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
609
- line1: string;
610
- zipCode: string;
611
- firstName?: string;
612
- lastName?: string;
613
- line2?: string;
614
- region?: string;
615
- }
616
- }
617
- /**
618
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
619
- * represents EUR 10.23. Any amount of decimal places can be provided on
620
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
621
- * as this is the format accepted by most banks.
622
- */
623
- interface Price {
624
- currency: 'EUR' | 'GBP' | 'PLN';
625
- /**
626
- * The total amount to be paid.
627
- */
628
- total: number;
629
- /**
630
- * The shipping amount.
631
- */
632
- shipping?: number;
633
- /**
634
- * The subtotal amount, i.e. the total amount without VAT and shipping.
635
- */
636
- subTotal?: number;
637
- /**
638
- * The total net amount, i.e. the total amount without VAT. This value is rounded
639
- * to 2 decimal places for the actual transfer.
640
- */
641
- totalNet?: number;
642
- /**
643
- * The VAT amount.
644
- */
645
- vat?: number;
646
- }
647
- /**
648
- * Only applicable for express Checkout Sessions. The given fields will be required
649
- * input within the Ivy express Checkout.
650
- */
651
- interface Required {
652
- /**
653
- * If set to true, the phone number will be required input within the Ivy express
654
- * Checkout.
655
- */
656
- phone: boolean;
657
- }
658
- interface Customer {
659
- id: string;
660
- }
661
- /**
662
- * The line items of the Checkout.
663
- */
664
- interface LineItem {
665
- /**
666
- * The total amount of all line items, i.e. single amount \* quantity. Given in
667
- * decimals, i.e. 10.23 represents EUR 10.23.
668
- */
669
- amount: number;
670
- /**
671
- * The name of the line item.
672
- */
673
- name: string;
674
- /**
675
- * The quantity of the line item.
676
- */
677
- quantity: number;
678
- /**
679
- * The net amount of a single item.
680
- */
681
- singleNet: number;
682
- /**
683
- * The VAT amount of a single item.
684
- */
685
- singleVat: number;
686
- /**
687
- * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
688
- * the line item.
689
- */
690
- category?: string;
691
- /**
692
- * The
693
- * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
694
- * of the line item.
695
- */
696
- EAN?: string;
697
- /**
698
- * The image of the line item as a URL.
699
- */
700
- image?: string;
701
- /**
702
- * The internal unique identifier of the line item.
703
- */
704
- referenceId?: string;
705
- }
706
- interface Mandate {
707
- setup: boolean;
708
- /**
709
- * The name of the account holder who signs the mandate
710
- */
711
- accountHolderName?: string;
712
- referenceId?: string;
713
- userNotificationEmail?: string;
714
- }
715
- /**
716
- * Use this to prefill data of the user in the Checkout.
717
- */
718
- interface Prefill {
719
- /**
720
- * The id of the bank to preselect in the Checkout. Users will skip the bank
721
- * selection if given. Required for financial address prefill.
722
- */
723
- bankId?: string;
724
- email?: string;
725
- /**
726
- * The financial address prefill is used to preselect the payer account that will
727
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
728
- * for UK GBP payments. For other markets and currencies use your discretion. The
729
- * validation logic is based on the "type" field. For example, if "type" is set to
730
- * "iban", the "iban" object must be filled out.
731
- */
732
- payerFinancialAddress?: Prefill.PayerFinancialAddress;
733
- phone?: string;
734
- }
735
- namespace Prefill {
571
+ namespace Merchant {
572
+ interface Address {
573
+ city: string;
736
574
  /**
737
- * The financial address prefill is used to preselect the payer account that will
738
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
739
- * for UK GBP payments. For other markets and currencies use your discretion. The
740
- * validation logic is based on the "type" field. For example, if "type" is set to
741
- * "iban", the "iban" object must be filled out.
575
+ * The country code in
576
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
742
577
  */
743
- interface PayerFinancialAddress {
744
- /**
745
- * The type of the financial address. The actual destination is determined by this
746
- * field which can be either "iban", "sortCode", "bankCode", or "bban". The
747
- * validation will fail if you set e.g. type="iban", but then not fill any values
748
- * in the "iban" object.
749
- *
750
- * - iban: The IBAN of the account
751
- * - sort_code: The sort code of the account
752
- * - bank_code: The bank code of the account
753
- * - bban: The BBAN of the account
754
- */
755
- type: string;
756
- bankCode?: PayerFinancialAddress.BankCode;
757
- bban?: PayerFinancialAddress.Bban;
758
- iban?: PayerFinancialAddress.Iban;
759
- sortCode?: PayerFinancialAddress.SortCode;
760
- }
761
- namespace PayerFinancialAddress {
762
- interface BankCode {
763
- accountNumber: string;
764
- code: string;
765
- /**
766
- * The name of the account holder.
767
- */
768
- accountHolderName?: string;
769
- }
770
- interface Bban {
771
- bban: string;
772
- /**
773
- * The name of the account holder.
774
- */
775
- accountHolderName?: string;
776
- bic?: string;
777
- }
778
- interface Iban {
779
- iban: string;
780
- /**
781
- * The name of the account holder.
782
- */
783
- accountHolderName?: string;
784
- bic?: string;
785
- }
786
- interface SortCode {
787
- accountNumber: string;
788
- sortCode: string;
789
- /**
790
- * The name of the account holder.
791
- */
792
- accountHolderName?: string;
793
- }
794
- }
578
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
579
+ line1: string;
580
+ zipCode: string;
581
+ firstName?: string;
582
+ lastName?: string;
583
+ line2?: string;
584
+ region?: string;
795
585
  }
586
+ }
587
+ /**
588
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
589
+ * represents EUR 10.23. Any amount of decimal places can be provided on
590
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
591
+ * as this is the format accepted by most banks.
592
+ */
593
+ interface Price {
594
+ currency: 'EUR' | 'GBP' | 'PLN';
796
595
  /**
797
- * The shipping methods of the Checkout.
596
+ * The total amount to be paid.
798
597
  */
799
- interface ShippingMethod {
800
- /**
801
- * The customer-facing name of the shipping method.
802
- */
803
- name: string;
804
- /**
805
- * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
806
- */
807
- price: number;
808
- /**
809
- * The unique identifier of the shipping method within Ivy.
810
- */
811
- id?: string;
812
- /**
813
- * The list of countries where the shipping method is available.
814
- */
815
- countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
816
- /**
817
- * The delivery estimate of the shipping method.
818
- */
819
- deliveryEstimate?: ShippingMethod.DeliveryEstimate;
820
- /**
821
- * The unique identifier within your system of the shipping method.
822
- */
823
- reference?: string;
824
- /**
825
- * @deprecated Deprecated in favor of deliveryEstimate
826
- */
827
- timeFrame?: string;
828
- }
829
- namespace ShippingMethod {
830
- /**
831
- * The delivery estimate of the shipping method.
832
- */
833
- interface DeliveryEstimate {
834
- /**
835
- * The maximum delivery time.
836
- */
837
- maximum?: DeliveryEstimate.Maximum;
838
- /**
839
- * The minimum delivery time.
840
- */
841
- minimum?: DeliveryEstimate.Minimum;
842
- }
843
- namespace DeliveryEstimate {
844
- /**
845
- * The maximum delivery time.
846
- */
847
- interface Maximum {
848
- /**
849
- * The unit of the time duration.
850
- */
851
- unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
852
- /**
853
- * The value of the time duration.
854
- */
855
- value: number;
856
- }
857
- /**
858
- * The minimum delivery time.
859
- */
860
- interface Minimum {
861
- /**
862
- * The unit of the time duration.
863
- */
864
- unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
865
- /**
866
- * The value of the time duration.
867
- */
868
- value: number;
869
- }
870
- }
871
- }
598
+ total: number;
599
+ shipping?: number;
600
+ subTotal?: number;
601
+ totalNet?: number;
602
+ vat?: number;
872
603
  }
873
- interface CheckoutSession {
604
+ /**
605
+ * The billing address of the customer. Required when handshake=true.
606
+ */
607
+ interface BillingAddress {
608
+ city: string;
874
609
  /**
875
- * The unique identifier of the Checkout within Ivy.
610
+ * The country code in
611
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
876
612
  */
613
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
614
+ line1: string;
615
+ zipCode: string;
616
+ firstName?: string;
617
+ lastName?: string;
618
+ line2?: string;
619
+ region?: string;
620
+ }
621
+ interface Customer {
877
622
  id: string;
878
- appId: string;
879
- /**
880
- * The markets where the user of the Checkout can select banks from.
881
- */
882
- availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
883
- createdAt: string;
884
- /**
885
- * The Epoch time in seconds at which the Checkout Session will expire. It can be
886
- * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
887
- * default, this value is 1 hour from creation.
888
- */
889
- expiresAt: number;
890
- merchant: CheckoutSession.Merchant;
623
+ }
624
+ /**
625
+ * The line items of the Checkout.
626
+ */
627
+ interface LineItem {
891
628
  /**
892
- * @deprecated Use merchant.appId instead
629
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
630
+ * decimals, i.e. 10.23 represents EUR 10.23.
893
631
  */
894
- merchantAppId: string;
632
+ amount: number;
895
633
  /**
896
- * - `settlement`: The payment is initially settled into a virtual account. The
897
- * funds are then disbursed in batches to the merchant. Refunds are instantly
898
- * processed from the virtual account.
899
- * - `direct`: The payment will be settled to the specified `settlementDestination`
900
- * account. `settlementDestination` is required if `paymentMode` is `direct`.
634
+ * The name of the line item.
901
635
  */
902
- paymentMode: 'settlement' | 'direct';
636
+ name: string;
903
637
  /**
904
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
905
- * represents EUR 10.23. Any amount of decimal places can be provided on
906
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
907
- * as this is the format accepted by most banks.
638
+ * The quantity of the line item.
908
639
  */
909
- price: CheckoutSession.Price;
640
+ quantity: number;
910
641
  /**
911
- * Only applicable for express Checkout Sessions. The given fields will be required
912
- * input within the Ivy express Checkout.
642
+ * The net amount of a single item.
913
643
  */
914
- required: CheckoutSession.Required;
915
- status: 'open' | 'closed' | 'expired';
916
- abortReason?: string;
644
+ singleNet: number;
917
645
  /**
918
- * The billing address of the customer. Required when handshake=true.
646
+ * The VAT amount of a single item.
919
647
  */
920
- billingAddress?: CheckoutSession.BillingAddress;
648
+ singleVat: number;
921
649
  /**
922
- * The merchant category code or
923
- * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
650
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
651
+ * the line item.
924
652
  */
925
653
  category?: string;
926
654
  /**
927
- * Only applicable for express Checkouts. Complete Callback requests will be sent
928
- * to this URL.
929
- */
930
- completeCallbackUrl?: string;
931
- /**
932
- * The Epoch time in seconds at which the Checkout Session was created. By default,
933
- * time of Checkout creation at Ivy.
934
- */
935
- created?: number;
936
- customer?: CheckoutSession.Customer;
937
- /**
938
- * False by default. If set to true, customers cannot modify the pre-selected bank
939
- * from `prefill.bankId`.
940
- */
941
- disableBankSelection?: boolean;
942
- /**
943
- * The customer facing id. This id is displayed to the user during the checkout and
944
- * in the merchant dashboard.
945
- */
946
- displayId?: string;
947
- /**
948
- * Required if not set in the dashboard. Users will be redirected here after an
949
- * unsuccessful Payment attempt.
655
+ * The
656
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
657
+ * of the line item.
950
658
  */
951
- errorCallbackUrl?: string;
659
+ EAN?: string;
952
660
  /**
953
- * False by default. If set to true, the Checkout is displayed in express mode.
661
+ * The image of the line item as a URL.
954
662
  */
955
- express?: boolean;
663
+ image?: string;
956
664
  /**
957
- * False by default. If set to true, customers skip email input and jump directly
958
- * to their bank login. For express Checkout Sessions this is always false.
665
+ * The internal unique identifier of the line item.
959
666
  */
960
- guest?: boolean;
667
+ referenceId?: string;
668
+ }
669
+ interface Mandate {
670
+ setup: boolean;
961
671
  /**
962
- * If true, the order must be confirmed through the merchant with an additional
963
- * complete callback endpoint. Always true for express sessions.
672
+ * The name of the account holder who signs the mandate
964
673
  */
965
- handshake?: boolean;
966
- impactOffsetProjects?: Array<string>;
674
+ accountHolderName?: string;
675
+ referenceId?: string;
676
+ userNotificationEmail?: string;
677
+ }
678
+ /**
679
+ * Prefill known data to skip steps in the checkout.
680
+ */
681
+ interface Prefill {
967
682
  /**
968
- * The incentive mode of the checkout session. For any use-case apart from
969
- * e-commerce, please use `white_label` as the value. If set to `white_label`, the
970
- * checkout session will be white labeled. If set to `sustainable`, the checkout
971
- * session will contain sustainable incentives for users.
683
+ * The known bank id. Customers will skip the bank selection and go directly to the
684
+ * bank's login. Required for financial address prefill.
972
685
  */
973
- incentiveMode?: 'white_label' | 'sustainable';
974
- lineItems?: Array<CheckoutSession.LineItem>;
686
+ bankId?: string;
687
+ }
688
+ /**
689
+ * Only applicable for express Checkout Sessions. The given fields will be required
690
+ * input within the Ivy express Checkout.
691
+ */
692
+ interface Required {
975
693
  /**
976
- * The locale of the Checkout. If provided, the Checkout will be displayed in the
977
- * given language. Users can change the language in the Checkout. If not provided,
978
- * the language of the Checkout is determined by the browser's language.
694
+ * If set to true, the phone number will be required input within the Ivy express
695
+ * Checkout.
979
696
  */
980
- locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
981
- mandate?: CheckoutSession.Mandate;
697
+ phone: boolean;
698
+ }
699
+ interface ShippingAddress {
700
+ city: string;
982
701
  /**
983
- * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
984
- * located. If provided, the Checkout will display the market's banks first. Not
985
- * relevant if `prefill.bankId` is provided.
702
+ * The country code in
703
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
986
704
  */
987
- market?: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
705
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
706
+ line1: string;
707
+ zipCode: string;
708
+ firstName?: string;
709
+ lastName?: string;
710
+ line2?: string;
711
+ region?: string;
712
+ }
713
+ /**
714
+ * The shipping methods of the Checkout.
715
+ */
716
+ interface ShippingMethod {
988
717
  /**
989
- * Any data which will be stored and returned for this checkout session and
990
- * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
991
- * more info.
718
+ * The customer-facing name of the shipping method.
992
719
  */
993
- metadata?: Record<string, unknown>;
994
- offsetProject?: string;
720
+ name: string;
995
721
  /**
996
- * The shop-plugin version.
722
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
997
723
  */
998
- plugin?: string;
724
+ price: number;
999
725
  /**
1000
- * Use this to prefill data of the user in the Checkout.
726
+ * The unique identifier of the shipping method within Ivy.
1001
727
  */
1002
- prefill?: CheckoutSession.Prefill;
728
+ id?: string;
1003
729
  /**
1004
- * Only applicable for express Checkouts. Quote Callback requests will be sent to
1005
- * this URL.
730
+ * The list of countries where the shipping method is available.
1006
731
  */
1007
- quoteCallbackUrl?: string;
1008
- redirectUrl?: string;
732
+ countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
1009
733
  /**
1010
- * An internal reference id which will be stored with the checkout & corresponding
1011
- * order. Needs to be unique per shop per order and can be up to 200 characters. We
1012
- * recommend to use your internal order id here.
734
+ * The delivery estimate of the shipping method.
1013
735
  */
1014
- referenceId?: string;
1015
- selectedShippingMethodId?: string;
1016
- shippingAddress?: CheckoutSession.ShippingAddress;
1017
- shippingMethods?: Array<CheckoutSession.ShippingMethod>;
736
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
1018
737
  /**
1019
- * The logo of the shop provided as a URL.
738
+ * The unique identifier within your system of the shipping method.
1020
739
  */
1021
- shopLogo?: string;
1022
- shopName?: string;
740
+ reference?: string;
1023
741
  /**
1024
- * Required if not set in the dashboard. Users will be redirected here after a
1025
- * successful Payment attempt.
742
+ * @deprecated Deprecated in favor of deliveryEstimate
1026
743
  */
1027
- successCallbackUrl?: string;
1028
- updatedAt?: string;
744
+ timeFrame?: string;
1029
745
  }
1030
- namespace CheckoutSession {
1031
- interface Merchant {
1032
- id: string;
1033
- appId: string;
1034
- legalName: string;
1035
- address?: Merchant.Address;
1036
- }
1037
- namespace Merchant {
1038
- interface Address {
1039
- city: string;
1040
- /**
1041
- * The country code in
1042
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
1043
- */
1044
- country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
1045
- line1: string;
1046
- zipCode: string;
1047
- firstName?: string;
1048
- lastName?: string;
1049
- line2?: string;
1050
- region?: string;
1051
- }
1052
- }
1053
- /**
1054
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
1055
- * represents EUR 10.23. Any amount of decimal places can be provided on
1056
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
1057
- * as this is the format accepted by most banks.
1058
- */
1059
- interface Price {
1060
- currency: 'EUR' | 'GBP' | 'PLN';
1061
- /**
1062
- * The total amount to be paid.
1063
- */
1064
- total: number;
1065
- /**
1066
- * The shipping amount.
1067
- */
1068
- shipping?: number;
1069
- /**
1070
- * The subtotal amount, i.e. the total amount without VAT and shipping.
1071
- */
1072
- subTotal?: number;
1073
- /**
1074
- * The total net amount, i.e. the total amount without VAT. This value is rounded
1075
- * to 2 decimal places for the actual transfer.
1076
- */
1077
- totalNet?: number;
1078
- /**
1079
- * The VAT amount.
1080
- */
1081
- vat?: number;
1082
- }
1083
- /**
1084
- * Only applicable for express Checkout Sessions. The given fields will be required
1085
- * input within the Ivy express Checkout.
1086
- */
1087
- interface Required {
1088
- /**
1089
- * If set to true, the phone number will be required input within the Ivy express
1090
- * Checkout.
1091
- */
1092
- phone: boolean;
1093
- }
1094
- /**
1095
- * The billing address of the customer. Required when handshake=true.
1096
- */
1097
- interface BillingAddress {
1098
- city: string;
1099
- /**
1100
- * The country code in
1101
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
1102
- */
1103
- country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
1104
- line1: string;
1105
- zipCode: string;
1106
- firstName?: string;
1107
- lastName?: string;
1108
- line2?: string;
1109
- region?: string;
1110
- }
1111
- interface Customer {
1112
- id: string;
1113
- }
1114
- /**
1115
- * The line items of the Checkout.
1116
- */
1117
- interface LineItem {
1118
- /**
1119
- * The total amount of all line items, i.e. single amount \* quantity. Given in
1120
- * decimals, i.e. 10.23 represents EUR 10.23.
1121
- */
1122
- amount: number;
1123
- /**
1124
- * The name of the line item.
1125
- */
1126
- name: string;
1127
- /**
1128
- * The quantity of the line item.
1129
- */
1130
- quantity: number;
1131
- /**
1132
- * The net amount of a single item.
1133
- */
1134
- singleNet: number;
1135
- /**
1136
- * The VAT amount of a single item.
1137
- */
1138
- singleVat: number;
1139
- /**
1140
- * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
1141
- * the line item.
1142
- */
1143
- category?: string;
1144
- /**
1145
- * The
1146
- * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
1147
- * of the line item.
1148
- */
1149
- EAN?: string;
1150
- /**
1151
- * The image of the line item as a URL.
1152
- */
1153
- image?: string;
1154
- /**
1155
- * The internal unique identifier of the line item.
1156
- */
1157
- referenceId?: string;
1158
- }
1159
- interface Mandate {
1160
- setup: boolean;
1161
- /**
1162
- * The name of the account holder who signs the mandate
1163
- */
1164
- accountHolderName?: string;
1165
- referenceId?: string;
1166
- userNotificationEmail?: string;
1167
- }
1168
- /**
1169
- * Use this to prefill data of the user in the Checkout.
1170
- */
1171
- interface Prefill {
1172
- /**
1173
- * The id of the bank to preselect in the Checkout. Users will skip the bank
1174
- * selection if given. Required for financial address prefill.
1175
- */
1176
- bankId?: string;
1177
- email?: string;
1178
- /**
1179
- * The financial address prefill is used to preselect the payer account that will
1180
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
1181
- * for UK GBP payments. For other markets and currencies use your discretion. The
1182
- * validation logic is based on the "type" field. For example, if "type" is set to
1183
- * "iban", the "iban" object must be filled out.
1184
- */
1185
- payerFinancialAddress?: Prefill.PayerFinancialAddress;
1186
- phone?: string;
1187
- }
1188
- namespace Prefill {
1189
- /**
1190
- * The financial address prefill is used to preselect the payer account that will
1191
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
1192
- * for UK GBP payments. For other markets and currencies use your discretion. The
1193
- * validation logic is based on the "type" field. For example, if "type" is set to
1194
- * "iban", the "iban" object must be filled out.
1195
- */
1196
- interface PayerFinancialAddress {
1197
- /**
1198
- * The type of the financial address. The actual destination is determined by this
1199
- * field which can be either "iban", "sortCode", "bankCode", or "bban". The
1200
- * validation will fail if you set e.g. type="iban", but then not fill any values
1201
- * in the "iban" object.
1202
- *
1203
- * - iban: The IBAN of the account
1204
- * - sort_code: The sort code of the account
1205
- * - bank_code: The bank code of the account
1206
- * - bban: The BBAN of the account
1207
- */
1208
- type: string;
1209
- bankCode?: PayerFinancialAddress.BankCode;
1210
- bban?: PayerFinancialAddress.Bban;
1211
- iban?: PayerFinancialAddress.Iban;
1212
- sortCode?: PayerFinancialAddress.SortCode;
1213
- }
1214
- namespace PayerFinancialAddress {
1215
- interface BankCode {
1216
- accountNumber: string;
1217
- code: string;
1218
- /**
1219
- * The name of the account holder.
1220
- */
1221
- accountHolderName?: string;
1222
- }
1223
- interface Bban {
1224
- bban: string;
1225
- /**
1226
- * The name of the account holder.
1227
- */
1228
- accountHolderName?: string;
1229
- bic?: string;
1230
- }
1231
- interface Iban {
1232
- iban: string;
1233
- /**
1234
- * The name of the account holder.
1235
- */
1236
- accountHolderName?: string;
1237
- bic?: string;
1238
- }
1239
- interface SortCode {
1240
- accountNumber: string;
1241
- sortCode: string;
1242
- /**
1243
- * The name of the account holder.
1244
- */
1245
- accountHolderName?: string;
1246
- }
1247
- }
1248
- }
1249
- interface ShippingAddress {
1250
- city: string;
1251
- /**
1252
- * The country code in
1253
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
1254
- */
1255
- country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
1256
- line1: string;
1257
- zipCode: string;
1258
- firstName?: string;
1259
- lastName?: string;
1260
- line2?: string;
1261
- region?: string;
1262
- }
746
+ namespace ShippingMethod {
1263
747
  /**
1264
- * The shipping methods of the Checkout.
748
+ * The delivery estimate of the shipping method.
1265
749
  */
1266
- interface ShippingMethod {
1267
- /**
1268
- * The customer-facing name of the shipping method.
1269
- */
1270
- name: string;
1271
- /**
1272
- * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
1273
- */
1274
- price: number;
1275
- /**
1276
- * The unique identifier of the shipping method within Ivy.
1277
- */
1278
- id?: string;
1279
- /**
1280
- * The list of countries where the shipping method is available.
1281
- */
1282
- countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
1283
- /**
1284
- * The delivery estimate of the shipping method.
1285
- */
1286
- deliveryEstimate?: ShippingMethod.DeliveryEstimate;
750
+ interface DeliveryEstimate {
1287
751
  /**
1288
- * The unique identifier within your system of the shipping method.
752
+ * The maximum delivery time.
1289
753
  */
1290
- reference?: string;
754
+ maximum?: DeliveryEstimate.Maximum;
1291
755
  /**
1292
- * @deprecated Deprecated in favor of deliveryEstimate
756
+ * The minimum delivery time.
1293
757
  */
1294
- timeFrame?: string;
758
+ minimum?: DeliveryEstimate.Minimum;
1295
759
  }
1296
- namespace ShippingMethod {
760
+ namespace DeliveryEstimate {
1297
761
  /**
1298
- * The delivery estimate of the shipping method.
762
+ * The maximum delivery time.
1299
763
  */
1300
- interface DeliveryEstimate {
764
+ interface Maximum {
1301
765
  /**
1302
- * The maximum delivery time.
766
+ * The unit of the time duration.
1303
767
  */
1304
- maximum?: DeliveryEstimate.Maximum;
768
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1305
769
  /**
1306
- * The minimum delivery time.
770
+ * The value of the time duration.
1307
771
  */
1308
- minimum?: DeliveryEstimate.Minimum;
772
+ value: number;
1309
773
  }
1310
- namespace DeliveryEstimate {
774
+ /**
775
+ * The minimum delivery time.
776
+ */
777
+ interface Minimum {
1311
778
  /**
1312
- * The maximum delivery time.
779
+ * The unit of the time duration.
1313
780
  */
1314
- interface Maximum {
1315
- /**
1316
- * The unit of the time duration.
1317
- */
1318
- unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1319
- /**
1320
- * The value of the time duration.
1321
- */
1322
- value: number;
1323
- }
781
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1324
782
  /**
1325
- * The minimum delivery time.
783
+ * The value of the time duration.
1326
784
  */
1327
- interface Minimum {
1328
- /**
1329
- * The unit of the time duration.
1330
- */
1331
- unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1332
- /**
1333
- * The value of the time duration.
1334
- */
1335
- value: number;
1336
- }
785
+ value: number;
1337
786
  }
1338
787
  }
1339
788
  }
@@ -1343,23 +792,22 @@ export interface CheckoutsessionExpireResponse {
1343
792
  * The unique identifier of the Checkout within Ivy.
1344
793
  */
1345
794
  id: string;
1346
- appId: string;
1347
795
  /**
1348
796
  * The markets where the user of the Checkout can select banks from.
1349
797
  */
1350
798
  availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
1351
799
  createdAt: string;
1352
800
  /**
1353
- * The Epoch time in seconds at which the Checkout Session will expire. It can be
1354
- * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
1355
- * default, this value is 1 hour from creation.
801
+ * The customer facing id. This id is displayed to the user during the checkout and
802
+ * in the merchant dashboard.
1356
803
  */
1357
- expiresAt: number;
1358
- merchant: CheckoutsessionExpireResponse.Merchant;
804
+ displayId: string;
1359
805
  /**
1360
- * @deprecated Use merchant.appId instead
806
+ * Required if not set in the dashboard. Users will be redirected here after an
807
+ * unsuccessful Payment attempt.
1361
808
  */
1362
- merchantAppId: string;
809
+ errorCallbackUrl: string;
810
+ merchant: CheckoutsessionExpireResponse.Merchant;
1363
811
  /**
1364
812
  * - `settlement`: The payment is initially settled into a virtual account. The
1365
813
  * funds are then disbursed in batches to the merchant. Refunds are instantly
@@ -1369,19 +817,28 @@ export interface CheckoutsessionExpireResponse {
1369
817
  */
1370
818
  paymentMode: 'settlement' | 'direct';
1371
819
  /**
1372
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
820
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1373
821
  * represents EUR 10.23. Any amount of decimal places can be provided on
1374
822
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
1375
823
  * as this is the format accepted by most banks.
1376
824
  */
1377
825
  price: CheckoutsessionExpireResponse.Price;
826
+ redirectUrl: string;
1378
827
  /**
1379
- * Only applicable for express Checkout Sessions. The given fields will be required
1380
- * input within the Ivy express Checkout.
828
+ * An internal reference id which will be stored with the checkout & corresponding
829
+ * order. Needs to be unique per shop per order and can be up to 200 characters. We
830
+ * recommend to use your internal order id here.
1381
831
  */
1382
- required: CheckoutsessionExpireResponse.Required;
832
+ referenceId: string;
1383
833
  status: 'open' | 'closed' | 'expired';
834
+ /**
835
+ * Required if not set in the dashboard. Users will be redirected here after a
836
+ * successful Payment attempt.
837
+ */
838
+ successCallbackUrl: string;
839
+ updatedAt: string;
1384
840
  abortReason?: string;
841
+ appId?: string;
1385
842
  /**
1386
843
  * The billing address of the customer. Required when handshake=true.
1387
844
  */
@@ -1408,15 +865,11 @@ export interface CheckoutsessionExpireResponse {
1408
865
  */
1409
866
  disableBankSelection?: boolean;
1410
867
  /**
1411
- * The customer facing id. This id is displayed to the user during the checkout and
1412
- * in the merchant dashboard.
1413
- */
1414
- displayId?: string;
1415
- /**
1416
- * Required if not set in the dashboard. Users will be redirected here after an
1417
- * unsuccessful Payment attempt.
868
+ * The Epoch time in seconds at which the Checkout Session will expire. It can be
869
+ * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
870
+ * default, this value is 1 hour from creation.
1418
871
  */
1419
- errorCallbackUrl?: string;
872
+ expiresAt?: number;
1420
873
  /**
1421
874
  * False by default. If set to true, the Checkout is displayed in express mode.
1422
875
  */
@@ -1453,6 +906,10 @@ export interface CheckoutsessionExpireResponse {
1453
906
  * relevant if `prefill.bankId` is provided.
1454
907
  */
1455
908
  market?: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
909
+ /**
910
+ * @deprecated Use merchant.appId instead
911
+ */
912
+ merchantAppId?: string;
1456
913
  /**
1457
914
  * Any data which will be stored and returned for this checkout session and
1458
915
  * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
@@ -1460,12 +917,13 @@ export interface CheckoutsessionExpireResponse {
1460
917
  */
1461
918
  metadata?: Record<string, unknown>;
1462
919
  offsetProject?: string;
920
+ paymentSchemeSelection?: string;
1463
921
  /**
1464
922
  * The shop-plugin version.
1465
923
  */
1466
924
  plugin?: string;
1467
925
  /**
1468
- * Use this to prefill data of the user in the Checkout.
926
+ * Prefill known data to skip steps in the checkout.
1469
927
  */
1470
928
  prefill?: CheckoutsessionExpireResponse.Prefill;
1471
929
  /**
@@ -1473,13 +931,11 @@ export interface CheckoutsessionExpireResponse {
1473
931
  * this URL.
1474
932
  */
1475
933
  quoteCallbackUrl?: string;
1476
- redirectUrl?: string;
1477
934
  /**
1478
- * An internal reference id which will be stored with the checkout & corresponding
1479
- * order. Needs to be unique per shop per order and can be up to 200 characters. We
1480
- * recommend to use your internal order id here.
935
+ * Only applicable for express Checkout Sessions. The given fields will be required
936
+ * input within the Ivy express Checkout.
1481
937
  */
1482
- referenceId?: string;
938
+ required?: CheckoutsessionExpireResponse.Required;
1483
939
  selectedShippingMethodId?: string;
1484
940
  shippingAddress?: CheckoutsessionExpireResponse.ShippingAddress;
1485
941
  shippingMethods?: Array<CheckoutsessionExpireResponse.ShippingMethod>;
@@ -1488,12 +944,7 @@ export interface CheckoutsessionExpireResponse {
1488
944
  */
1489
945
  shopLogo?: string;
1490
946
  shopName?: string;
1491
- /**
1492
- * Required if not set in the dashboard. Users will be redirected here after a
1493
- * successful Payment attempt.
1494
- */
1495
- successCallbackUrl?: string;
1496
- updatedAt?: string;
947
+ subaccountId?: string;
1497
948
  }
1498
949
  export declare namespace CheckoutsessionExpireResponse {
1499
950
  interface Merchant {
@@ -1519,45 +970,21 @@ export declare namespace CheckoutsessionExpireResponse {
1519
970
  }
1520
971
  }
1521
972
  /**
1522
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
973
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1523
974
  * represents EUR 10.23. Any amount of decimal places can be provided on
1524
975
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
1525
976
  * as this is the format accepted by most banks.
1526
977
  */
1527
- interface Price {
1528
- currency: 'EUR' | 'GBP' | 'PLN';
1529
- /**
1530
- * The total amount to be paid.
1531
- */
1532
- total: number;
1533
- /**
1534
- * The shipping amount.
1535
- */
1536
- shipping?: number;
1537
- /**
1538
- * The subtotal amount, i.e. the total amount without VAT and shipping.
1539
- */
1540
- subTotal?: number;
1541
- /**
1542
- * The total net amount, i.e. the total amount without VAT. This value is rounded
1543
- * to 2 decimal places for the actual transfer.
1544
- */
1545
- totalNet?: number;
1546
- /**
1547
- * The VAT amount.
1548
- */
1549
- vat?: number;
1550
- }
1551
- /**
1552
- * Only applicable for express Checkout Sessions. The given fields will be required
1553
- * input within the Ivy express Checkout.
1554
- */
1555
- interface Required {
978
+ interface Price {
979
+ currency: 'EUR' | 'GBP' | 'PLN';
1556
980
  /**
1557
- * If set to true, the phone number will be required input within the Ivy express
1558
- * Checkout.
981
+ * The total amount to be paid.
1559
982
  */
1560
- phone: boolean;
983
+ total: number;
984
+ shipping?: number;
985
+ subTotal?: number;
986
+ totalNet?: number;
987
+ vat?: number;
1561
988
  }
1562
989
  /**
1563
990
  * The billing address of the customer. Required when handshake=true.
@@ -1634,85 +1061,25 @@ export declare namespace CheckoutsessionExpireResponse {
1634
1061
  userNotificationEmail?: string;
1635
1062
  }
1636
1063
  /**
1637
- * Use this to prefill data of the user in the Checkout.
1064
+ * Prefill known data to skip steps in the checkout.
1638
1065
  */
1639
1066
  interface Prefill {
1640
1067
  /**
1641
- * The id of the bank to preselect in the Checkout. Users will skip the bank
1642
- * selection if given. Required for financial address prefill.
1068
+ * The known bank id. Customers will skip the bank selection and go directly to the
1069
+ * bank's login. Required for financial address prefill.
1643
1070
  */
1644
1071
  bankId?: string;
1645
- email?: string;
1646
- /**
1647
- * The financial address prefill is used to preselect the payer account that will
1648
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
1649
- * for UK GBP payments. For other markets and currencies use your discretion. The
1650
- * validation logic is based on the "type" field. For example, if "type" is set to
1651
- * "iban", the "iban" object must be filled out.
1652
- */
1653
- payerFinancialAddress?: Prefill.PayerFinancialAddress;
1654
- phone?: string;
1655
1072
  }
1656
- namespace Prefill {
1073
+ /**
1074
+ * Only applicable for express Checkout Sessions. The given fields will be required
1075
+ * input within the Ivy express Checkout.
1076
+ */
1077
+ interface Required {
1657
1078
  /**
1658
- * The financial address prefill is used to preselect the payer account that will
1659
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
1660
- * for UK GBP payments. For other markets and currencies use your discretion. The
1661
- * validation logic is based on the "type" field. For example, if "type" is set to
1662
- * "iban", the "iban" object must be filled out.
1079
+ * If set to true, the phone number will be required input within the Ivy express
1080
+ * Checkout.
1663
1081
  */
1664
- interface PayerFinancialAddress {
1665
- /**
1666
- * The type of the financial address. The actual destination is determined by this
1667
- * field which can be either "iban", "sortCode", "bankCode", or "bban". The
1668
- * validation will fail if you set e.g. type="iban", but then not fill any values
1669
- * in the "iban" object.
1670
- *
1671
- * - iban: The IBAN of the account
1672
- * - sort_code: The sort code of the account
1673
- * - bank_code: The bank code of the account
1674
- * - bban: The BBAN of the account
1675
- */
1676
- type: string;
1677
- bankCode?: PayerFinancialAddress.BankCode;
1678
- bban?: PayerFinancialAddress.Bban;
1679
- iban?: PayerFinancialAddress.Iban;
1680
- sortCode?: PayerFinancialAddress.SortCode;
1681
- }
1682
- namespace PayerFinancialAddress {
1683
- interface BankCode {
1684
- accountNumber: string;
1685
- code: string;
1686
- /**
1687
- * The name of the account holder.
1688
- */
1689
- accountHolderName?: string;
1690
- }
1691
- interface Bban {
1692
- bban: string;
1693
- /**
1694
- * The name of the account holder.
1695
- */
1696
- accountHolderName?: string;
1697
- bic?: string;
1698
- }
1699
- interface Iban {
1700
- iban: string;
1701
- /**
1702
- * The name of the account holder.
1703
- */
1704
- accountHolderName?: string;
1705
- bic?: string;
1706
- }
1707
- interface SortCode {
1708
- accountNumber: string;
1709
- sortCode: string;
1710
- /**
1711
- * The name of the account holder.
1712
- */
1713
- accountHolderName?: string;
1714
- }
1715
- }
1082
+ phone: boolean;
1716
1083
  }
1717
1084
  interface ShippingAddress {
1718
1085
  city: string;
@@ -1807,7 +1174,7 @@ export declare namespace CheckoutsessionExpireResponse {
1807
1174
  }
1808
1175
  export interface CheckoutsessionCreateParams {
1809
1176
  /**
1810
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
1177
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1811
1178
  * represents EUR 10.23. Any amount of decimal places can be provided on
1812
1179
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
1813
1180
  * as this is the format accepted by most banks.
@@ -1815,19 +1182,15 @@ export interface CheckoutsessionCreateParams {
1815
1182
  price: CheckoutsessionCreateParams.Price;
1816
1183
  /**
1817
1184
  * An internal reference id which will be stored with the checkout & corresponding
1818
- * order. Needs to be unique per shop per order and can be up to 200 characters. We
1819
- * recommend to use your internal order id here.
1185
+ * order. Needs to be unique per merchant per order and can be up to 200
1186
+ * characters. We recommend to use your internal unique id for this customer's
1187
+ * payment process.
1820
1188
  */
1821
1189
  referenceId: string;
1822
1190
  /**
1823
- * The billing address of the user. Required when handshake=true.
1191
+ * The billing address of the customer.
1824
1192
  */
1825
1193
  billingAddress?: CheckoutsessionCreateParams.BillingAddress;
1826
- /**
1827
- * The merchant category code or
1828
- * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
1829
- */
1830
- category?: string;
1831
1194
  /**
1832
1195
  * Only applicable for express Checkouts. Complete Callback requests will be sent
1833
1196
  * to this URL.
@@ -1843,23 +1206,19 @@ export interface CheckoutsessionCreateParams {
1843
1206
  */
1844
1207
  customer?: CheckoutsessionCreateParams.Email | CheckoutsessionCreateParams.ID;
1845
1208
  /**
1846
- * False by default. If set to true, customers cannot modify the pre-selected bank
1847
- * from `prefill.bankId`.
1209
+ * False by default. If set to true, customers cannot choose another bank than the
1210
+ * pre-selected one.
1848
1211
  */
1849
1212
  disableBankSelection?: boolean;
1850
- /**
1851
- * Relevant for e-commerce only. The already applied discounts of the Checkout.
1852
- * Discounts will be shown in the lineItems after Checkout Session creation.
1853
- */
1854
- discounts?: Array<CheckoutsessionCreateParams.Discount>;
1855
1213
  /**
1856
1214
  * The customer facing id. This id is displayed to the user during the checkout and
1857
- * in the merchant dashboard.
1215
+ * in the merchant dashboard. It does not need to be unique and should be a
1216
+ * customer-friendly id.
1858
1217
  */
1859
1218
  displayId?: string;
1860
1219
  /**
1861
- * Required if not set in the dashboard. Users will be redirected here after an
1862
- * unsuccessful Payment attempt.
1220
+ * Required if not set in the dashboard. Customers will be redirected here after an
1221
+ * unsuccessful payment attempt.
1863
1222
  */
1864
1223
  errorCallbackUrl?: string;
1865
1224
  /**
@@ -1874,31 +1233,13 @@ export interface CheckoutsessionCreateParams {
1874
1233
  */
1875
1234
  express?: boolean;
1876
1235
  /**
1877
- * False by default. Set to true to allow customers skip email input and jump
1878
- * directly to their bank login. For express Checkout Sessions this is always
1879
- * false.
1880
- */
1881
- guest?: boolean;
1882
- /**
1883
- * Deprecated. If true, the order must be confirmed through the merchant with an
1884
- * additional complete callback endpoint. Always true for express sessions.
1885
- */
1886
- handshake?: boolean;
1887
- /**
1888
- * The incentive mode of the checkout session. For any use-case apart from
1889
- * e-commerce, please use `white_label` as the value. If set to `white_label`, the
1890
- * checkout session will be white labeled. If set to `sustainable`, the checkout
1891
- * session will contain sustainable incentives for users.
1892
- */
1893
- incentiveMode?: 'white_label' | 'sustainable';
1894
- /**
1895
- * Relevant for e-commerce only. The line items of the Checkout.
1236
+ * Relevant for e-commerce only. The line items of the checkout.
1896
1237
  */
1897
1238
  lineItems?: Array<CheckoutsessionCreateParams.LineItem>;
1898
1239
  /**
1899
- * The locale of the Checkout. If provided, the Checkout will be displayed in the
1900
- * given language. Users can change the language in the Checkout. If not provided,
1901
- * the language of the Checkout is determined by the browser's language.
1240
+ * The locale of the customer, i.e. the language of the checkout. Customers can
1241
+ * change the language in the checkout. If not provided, the language of the
1242
+ * checkout is determined by the browser's language.
1902
1243
  */
1903
1244
  locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
1904
1245
  /**
@@ -1907,9 +1248,9 @@ export interface CheckoutsessionCreateParams {
1907
1248
  */
1908
1249
  mandate?: CheckoutsessionCreateParams.Mandate;
1909
1250
  /**
1910
- * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
1911
- * located. If provided, the Checkout will display the market's banks first. Not
1912
- * relevant if `prefill.bankId` is provided.
1251
+ * ISO 3166-1 alpha-2 country code. The market where the customer is located. If
1252
+ * provided, the checkout will display the market's default banks. Not relevant if
1253
+ * `prefill.bankId` is provided.
1913
1254
  */
1914
1255
  market?: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
1915
1256
  /**
@@ -1929,18 +1270,14 @@ export interface CheckoutsessionCreateParams {
1929
1270
  /**
1930
1271
  * The scheme selection for the payment. `instant_only` enforces instant payments,
1931
1272
  * meaning no banks that do not support it can be selected. `instant_preferred`
1932
- * means that the payment is done via instant rails. It will fallback to standard
1933
- * rails, if not supported by the bank. Standard means that only cost-free, but
1934
- * potentially slower bank rails are used for the transfer. Defaults to value set
1935
- * on merchant dashboard if not provided.
1273
+ * means that the payment is done via instant rails, if supported by the bank. It
1274
+ * will use standard rails, if not supported by the bank. Standard means that only
1275
+ * cost-free, but potentially slower bank rails are used for the transfer. Defaults
1276
+ * to value set on merchant dashboard if not provided.
1936
1277
  */
1937
1278
  paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
1938
1279
  /**
1939
- * The shop-plugin integration version e.g. `shopware-6.4.0`.
1940
- */
1941
- plugin?: string;
1942
- /**
1943
- * Use this to prefill data of the user in the Checkout.
1280
+ * Prefill known data to skip steps in the checkout.
1944
1281
  */
1945
1282
  prefill?: CheckoutsessionCreateParams.Prefill;
1946
1283
  /**
@@ -1948,16 +1285,6 @@ export interface CheckoutsessionCreateParams {
1948
1285
  * this URL.
1949
1286
  */
1950
1287
  quoteCallbackUrl?: string;
1951
- /**
1952
- * Only applicable for express Checkout Sessions. The given fields will be required
1953
- * input within the Ivy express Checkout.
1954
- */
1955
- required?: CheckoutsessionCreateParams.Required;
1956
- /**
1957
- * If set to true, a [risk check](https://docs.getivy.de/docs/froud-prevention)
1958
- * will be performed. This is currently in beta and defaults to true.
1959
- */
1960
- riskCheck?: boolean;
1961
1288
  /**
1962
1289
  * The settlement destination of the payment. If not provided, the financial
1963
1290
  * address of the merchant's direct payout destination will be used with a randomly
@@ -1965,33 +1292,25 @@ export interface CheckoutsessionCreateParams {
1965
1292
  */
1966
1293
  settlementDestination?: CheckoutsessionCreateParams.SettlementDestination;
1967
1294
  /**
1968
- * The shipping methods of the Checkout.
1969
- */
1970
- shippingMethods?: Array<CheckoutsessionCreateParams.ShippingMethod>;
1971
- /**
1972
- * The logo of the shop provided as a URL.
1973
- */
1974
- shopLogo?: string;
1975
- /**
1976
- * Relevant for PSPs only. The subaccount id of the relevant subaccount who owns
1977
- * the payment. You can create new subaccounts
1978
- * [here](https://docs.getivy.de/reference/merchantsubaccountcreate-1)
1295
+ * Usually relevant for PSPs. Create a subaccount for each underlying storefront or
1296
+ * merchant which processes payments with your Ivy account. You can create new
1297
+ * subaccounts [here](https://docs.getivy.de/reference/merchantsubaccountcreate-1)
1979
1298
  */
1980
1299
  subaccountId?: string;
1981
1300
  /**
1982
- * Required if not set in the dashboard. Users will be redirected here after a
1983
- * successful Payment attempt.
1301
+ * Required if not set in the dashboard. Customers will be redirected here after a
1302
+ * successful payment attempt.
1984
1303
  */
1985
1304
  successCallbackUrl?: string;
1986
1305
  /**
1987
- * Deprecated in favor of metadata. A token which is returned as a query parameter
1988
- * of the success callback url.
1306
+ * The theme variant which will be used in checkout. If not provided, the default
1307
+ * light theme will be used.
1989
1308
  */
1990
- verificationToken?: string;
1309
+ themeVariant?: 'light' | 'dark';
1991
1310
  }
1992
1311
  export declare namespace CheckoutsessionCreateParams {
1993
1312
  /**
1994
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
1313
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1995
1314
  * represents EUR 10.23. Any amount of decimal places can be provided on
1996
1315
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
1997
1316
  * as this is the format accepted by most banks.
@@ -2002,26 +1321,13 @@ export declare namespace CheckoutsessionCreateParams {
2002
1321
  * The total amount to be paid.
2003
1322
  */
2004
1323
  total: number;
2005
- /**
2006
- * The shipping amount.
2007
- */
2008
1324
  shipping?: number;
2009
- /**
2010
- * The subtotal amount, i.e. the total amount without VAT and shipping.
2011
- */
2012
1325
  subTotal?: number;
2013
- /**
2014
- * The total net amount, i.e. the total amount without VAT. This value is rounded
2015
- * to 2 decimal places for the actual transfer.
2016
- */
2017
1326
  totalNet?: number;
2018
- /**
2019
- * The VAT amount.
2020
- */
2021
1327
  vat?: number;
2022
1328
  }
2023
1329
  /**
2024
- * The billing address of the user. Required when handshake=true.
1330
+ * The billing address of the customer.
2025
1331
  */
2026
1332
  interface BillingAddress {
2027
1333
  city: string;
@@ -2049,18 +1355,6 @@ export declare namespace CheckoutsessionCreateParams {
2049
1355
  */
2050
1356
  id: string;
2051
1357
  }
2052
- interface Discount {
2053
- /**
2054
- * The amount of the discount. The amount is in decimals, i.e. 10.23 represents EUR
2055
- * 10.23.
2056
- */
2057
- amount: number;
2058
- /**
2059
- * The activation code of the discount. This will be displayed to the user during
2060
- * the checkout.
2061
- */
2062
- code: string;
2063
- }
2064
1358
  interface LineItem {
2065
1359
  /**
2066
1360
  * The total amount of all line items, i.e. single amount \* quantity. Given in
@@ -2117,96 +1411,14 @@ export declare namespace CheckoutsessionCreateParams {
2117
1411
  userNotificationEmail?: string;
2118
1412
  }
2119
1413
  /**
2120
- * Use this to prefill data of the user in the Checkout.
1414
+ * Prefill known data to skip steps in the checkout.
2121
1415
  */
2122
1416
  interface Prefill {
2123
1417
  /**
2124
- * The id of the bank to preselect in the Checkout. Users will skip the bank
2125
- * selection if given. Required for financial address prefill.
1418
+ * The known bank id. Customers will skip the bank selection and go directly to the
1419
+ * bank's login. Required for financial address prefill.
2126
1420
  */
2127
1421
  bankId?: string;
2128
- email?: string;
2129
- /**
2130
- * The financial address prefill is used to preselect the payer account that will
2131
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
2132
- * for UK GBP payments. For other markets and currencies use your discretion. The
2133
- * validation logic is based on the "type" field. For example, if "type" is set to
2134
- * "iban", the "iban" object must be filled out.
2135
- */
2136
- payerFinancialAddress?: Prefill.PayerFinancialAddress;
2137
- phone?: string;
2138
- }
2139
- namespace Prefill {
2140
- /**
2141
- * The financial address prefill is used to preselect the payer account that will
2142
- * be used to make the payment from. Use IBAN for SEPA EUR payments and Sort Code
2143
- * for UK GBP payments. For other markets and currencies use your discretion. The
2144
- * validation logic is based on the "type" field. For example, if "type" is set to
2145
- * "iban", the "iban" object must be filled out.
2146
- */
2147
- interface PayerFinancialAddress {
2148
- /**
2149
- * The type of the financial address. The actual destination is determined by this
2150
- * field which can be either "iban", "sortCode", "bankCode", or "bban". The
2151
- * validation will fail if you set e.g. type="iban", but then not fill any values
2152
- * in the "iban" object.
2153
- *
2154
- * - iban: The IBAN of the account
2155
- * - sort_code: The sort code of the account
2156
- * - bank_code: The bank code of the account
2157
- * - bban: The BBAN of the account
2158
- */
2159
- type: string;
2160
- bankCode?: PayerFinancialAddress.BankCode;
2161
- bban?: PayerFinancialAddress.Bban;
2162
- iban?: PayerFinancialAddress.Iban;
2163
- sortCode?: PayerFinancialAddress.SortCode;
2164
- }
2165
- namespace PayerFinancialAddress {
2166
- interface BankCode {
2167
- accountNumber: string;
2168
- code: string;
2169
- /**
2170
- * The name of the account holder.
2171
- */
2172
- accountHolderName?: string;
2173
- }
2174
- interface Bban {
2175
- bban: string;
2176
- /**
2177
- * The name of the account holder.
2178
- */
2179
- accountHolderName?: string;
2180
- bic?: string;
2181
- }
2182
- interface Iban {
2183
- iban: string;
2184
- /**
2185
- * The name of the account holder.
2186
- */
2187
- accountHolderName?: string;
2188
- bic?: string;
2189
- }
2190
- interface SortCode {
2191
- accountNumber: string;
2192
- sortCode: string;
2193
- /**
2194
- * The name of the account holder.
2195
- */
2196
- accountHolderName?: string;
2197
- }
2198
- }
2199
- }
2200
- /**
2201
- * @deprecated Only applicable for express Checkout Sessions. The given fields will
2202
- * be required input within the Ivy express Checkout.
2203
- */
2204
- interface Required {
2205
- /**
2206
- * If set to true, the phone number will be required input within the Ivy express
2207
- * Checkout.
2208
- */
2209
- phone?: boolean;
2210
1422
  }
2211
1423
  /**
2212
1424
  * The settlement destination of the payment. If not provided, the financial
@@ -2284,79 +1496,6 @@ export declare namespace CheckoutsessionCreateParams {
2284
1496
  }
2285
1497
  }
2286
1498
  }
2287
- interface ShippingMethod {
2288
- /**
2289
- * The customer-facing name of the shipping method.
2290
- */
2291
- name: string;
2292
- /**
2293
- * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
2294
- */
2295
- price: number;
2296
- /**
2297
- * The unique identifier of the shipping method within Ivy.
2298
- */
2299
- id?: string;
2300
- /**
2301
- * The list of countries where the shipping method is available.
2302
- */
2303
- countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
2304
- /**
2305
- * The delivery estimate of the shipping method.
2306
- */
2307
- deliveryEstimate?: ShippingMethod.DeliveryEstimate;
2308
- /**
2309
- * The unique identifier within your system of the shipping method.
2310
- */
2311
- reference?: string;
2312
- /**
2313
- * @deprecated Deprecated in favor of deliveryEstimate
2314
- */
2315
- timeFrame?: string;
2316
- }
2317
- namespace ShippingMethod {
2318
- /**
2319
- * The delivery estimate of the shipping method.
2320
- */
2321
- interface DeliveryEstimate {
2322
- /**
2323
- * The maximum delivery time.
2324
- */
2325
- maximum?: DeliveryEstimate.Maximum;
2326
- /**
2327
- * The minimum delivery time.
2328
- */
2329
- minimum?: DeliveryEstimate.Minimum;
2330
- }
2331
- namespace DeliveryEstimate {
2332
- /**
2333
- * The maximum delivery time.
2334
- */
2335
- interface Maximum {
2336
- /**
2337
- * The unit of the time duration.
2338
- */
2339
- unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
2340
- /**
2341
- * The value of the time duration.
2342
- */
2343
- value: number;
2344
- }
2345
- /**
2346
- * The minimum delivery time.
2347
- */
2348
- interface Minimum {
2349
- /**
2350
- * The unit of the time duration.
2351
- */
2352
- unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
2353
- /**
2354
- * The value of the time duration.
2355
- */
2356
- value: number;
2357
- }
2358
- }
2359
- }
2360
1499
  }
2361
1500
  export interface CheckoutsessionRetrieveParams {
2362
1501
  id: string;