@getivy/node-sdk 0.1.0-alpha.5 → 0.1.0-alpha.7

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.
@@ -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,32 +291,30 @@ 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
302
  /**
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.
303
+ * Prefill the customer's financial address to skip bank selection and enforce the
304
+ * customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
305
+ * and Sort Code for UK GBP payments. The validation logic is based on the "type"
306
+ * field. For example, if "type" is set to "iban", the "iban" object must be filled
307
+ * out.
331
308
  */
332
309
  payerFinancialAddress?: Prefill.PayerFinancialAddress;
333
- phone?: string;
334
310
  }
335
311
  namespace Prefill {
336
312
  /**
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.
313
+ * Prefill the customer's financial address to skip bank selection and enforce the
314
+ * customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
315
+ * and Sort Code for UK GBP payments. The validation logic is based on the "type"
316
+ * field. For example, if "type" is set to "iban", the "iban" object must be filled
317
+ * out.
342
318
  */
343
319
  interface PayerFinancialAddress {
344
320
  /**
@@ -393,6 +369,17 @@ export declare namespace CheckoutsessionCreateResponse {
393
369
  }
394
370
  }
395
371
  }
372
+ /**
373
+ * Only applicable for express Checkout Sessions. The given fields will be required
374
+ * input within the Ivy express Checkout.
375
+ */
376
+ interface Required {
377
+ /**
378
+ * If set to true, the phone number will be required input within the Ivy express
379
+ * Checkout.
380
+ */
381
+ phone: boolean;
382
+ }
396
383
  interface ShippingAddress {
397
384
  city: string;
398
385
  /**
@@ -484,856 +471,456 @@ export declare namespace CheckoutsessionCreateResponse {
484
471
  }
485
472
  }
486
473
  }
487
- export type CheckoutsessionRetrieveResponse = CheckoutsessionRetrieveResponse.PublicCheckoutSession | CheckoutsessionRetrieveResponse.CheckoutSession;
474
+ export interface CheckoutsessionRetrieveResponse {
475
+ /**
476
+ * The unique identifier of the Checkout within Ivy.
477
+ */
478
+ id: string;
479
+ /**
480
+ * The markets where the user of the Checkout can select banks from.
481
+ */
482
+ 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'>;
483
+ createdAt: string;
484
+ /**
485
+ * The customer facing id. This id is displayed to the user during the checkout and
486
+ * in the merchant dashboard.
487
+ */
488
+ displayId: string;
489
+ /**
490
+ * Required if not set in the dashboard. Users will be redirected here after an
491
+ * unsuccessful Payment attempt.
492
+ */
493
+ errorCallbackUrl: string;
494
+ merchant: CheckoutsessionRetrieveResponse.Merchant;
495
+ /**
496
+ * - `settlement`: The payment is initially settled into a virtual account. The
497
+ * funds are then disbursed in batches to the merchant. Refunds are instantly
498
+ * processed from the virtual account.
499
+ * - `direct`: The payment will be settled to the specified `settlementDestination`
500
+ * account. `settlementDestination` is required if `paymentMode` is `direct`.
501
+ */
502
+ paymentMode: 'settlement' | 'direct';
503
+ /**
504
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
505
+ * represents EUR 10.23. Any amount of decimal places can be provided on
506
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
507
+ * as this is the format accepted by most banks.
508
+ */
509
+ price: CheckoutsessionRetrieveResponse.Price;
510
+ redirectUrl: string;
511
+ /**
512
+ * An internal reference id which will be stored with the checkout & corresponding
513
+ * order. Needs to be unique per shop per order and can be up to 200 characters. We
514
+ * recommend to use your internal order id here.
515
+ */
516
+ referenceId: string;
517
+ status: 'open' | 'closed' | 'expired';
518
+ /**
519
+ * Required if not set in the dashboard. Users will be redirected here after a
520
+ * successful Payment attempt.
521
+ */
522
+ successCallbackUrl: string;
523
+ updatedAt: string;
524
+ abortReason?: string;
525
+ appId?: string;
526
+ /**
527
+ * The billing address of the customer. Required when handshake=true.
528
+ */
529
+ billingAddress?: CheckoutsessionRetrieveResponse.BillingAddress;
530
+ /**
531
+ * The merchant category code or
532
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
533
+ */
534
+ category?: string;
535
+ /**
536
+ * Only applicable for express Checkouts. Complete Callback requests will be sent
537
+ * to this URL.
538
+ */
539
+ completeCallbackUrl?: string;
540
+ /**
541
+ * The Epoch time in seconds at which the Checkout Session was created. By default,
542
+ * time of Checkout creation at Ivy.
543
+ */
544
+ created?: number;
545
+ customer?: CheckoutsessionRetrieveResponse.Customer;
546
+ /**
547
+ * False by default. If set to true, customers cannot modify the pre-selected bank
548
+ * from `prefill.bankId`.
549
+ */
550
+ disableBankSelection?: boolean;
551
+ /**
552
+ * The Epoch time in seconds at which the Checkout Session will expire. It can be
553
+ * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
554
+ * default, this value is 1 hour from creation.
555
+ */
556
+ expiresAt?: number;
557
+ /**
558
+ * False by default. If set to true, the Checkout is displayed in express mode.
559
+ */
560
+ express?: boolean;
561
+ /**
562
+ * False by default. If set to true, customers skip email input and jump directly
563
+ * to their bank login. For express Checkout Sessions this is always false.
564
+ */
565
+ guest?: boolean;
566
+ /**
567
+ * If true, the order must be confirmed through the merchant with an additional
568
+ * complete callback endpoint. Always true for express sessions.
569
+ */
570
+ handshake?: boolean;
571
+ impactOffsetProjects?: Array<string>;
572
+ /**
573
+ * The incentive mode of the checkout session. For any use-case apart from
574
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
575
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
576
+ * session will contain sustainable incentives for users.
577
+ */
578
+ incentiveMode?: 'white_label' | 'sustainable';
579
+ lineItems?: Array<CheckoutsessionRetrieveResponse.LineItem>;
580
+ /**
581
+ * The locale of the Checkout. If provided, the Checkout will be displayed in the
582
+ * given language. Users can change the language in the Checkout. If not provided,
583
+ * the language of the Checkout is determined by the browser's language.
584
+ */
585
+ locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
586
+ mandate?: CheckoutsessionRetrieveResponse.Mandate;
587
+ /**
588
+ * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
589
+ * located. If provided, the Checkout will display the market's banks first. Not
590
+ * relevant if `prefill.bankId` is provided.
591
+ */
592
+ 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';
593
+ /**
594
+ * @deprecated Use merchant.appId instead
595
+ */
596
+ merchantAppId?: string;
597
+ /**
598
+ * Any data which will be stored and returned for this checkout session and
599
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
600
+ * more info.
601
+ */
602
+ metadata?: Record<string, unknown>;
603
+ offsetProject?: string;
604
+ paymentSchemeSelection?: string;
605
+ /**
606
+ * The shop-plugin version.
607
+ */
608
+ plugin?: string;
609
+ /**
610
+ * Prefill known data to skip steps in the checkout.
611
+ */
612
+ prefill?: CheckoutsessionRetrieveResponse.Prefill;
613
+ /**
614
+ * Only applicable for express Checkouts. Quote Callback requests will be sent to
615
+ * this URL.
616
+ */
617
+ quoteCallbackUrl?: string;
618
+ /**
619
+ * Only applicable for express Checkout Sessions. The given fields will be required
620
+ * input within the Ivy express Checkout.
621
+ */
622
+ required?: CheckoutsessionRetrieveResponse.Required;
623
+ selectedShippingMethodId?: string;
624
+ shippingAddress?: CheckoutsessionRetrieveResponse.ShippingAddress;
625
+ shippingMethods?: Array<CheckoutsessionRetrieveResponse.ShippingMethod>;
626
+ /**
627
+ * The logo of the shop provided as a URL.
628
+ */
629
+ shopLogo?: string;
630
+ shopName?: string;
631
+ subaccountId?: string;
632
+ }
488
633
  export declare namespace CheckoutsessionRetrieveResponse {
489
- interface PublicCheckoutSession {
490
- /**
491
- * The unique identifier of the Checkout within Ivy.
492
- */
634
+ interface Merchant {
493
635
  id: string;
494
636
  appId: string;
637
+ legalName: string;
638
+ address?: Merchant.Address;
639
+ }
640
+ namespace Merchant {
641
+ interface Address {
642
+ city: string;
643
+ /**
644
+ * The country code in
645
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
646
+ */
647
+ 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';
648
+ line1: string;
649
+ zipCode: string;
650
+ firstName?: string;
651
+ lastName?: string;
652
+ line2?: string;
653
+ region?: string;
654
+ }
655
+ }
656
+ /**
657
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
658
+ * represents EUR 10.23. Any amount of decimal places can be provided on
659
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
660
+ * as this is the format accepted by most banks.
661
+ */
662
+ interface Price {
663
+ currency: 'EUR' | 'GBP' | 'PLN';
495
664
  /**
496
- * The markets where the user of the Checkout can select banks from.
665
+ * The total amount to be paid.
497
666
  */
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'>;
667
+ total: number;
668
+ shipping?: number;
669
+ subTotal?: number;
670
+ totalNet?: number;
671
+ vat?: number;
672
+ }
673
+ /**
674
+ * The billing address of the customer. Required when handshake=true.
675
+ */
676
+ interface BillingAddress {
677
+ city: string;
499
678
  /**
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`.
679
+ * The country code in
680
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
540
681
  */
541
- disableBankSelection?: boolean;
682
+ 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';
683
+ line1: string;
684
+ zipCode: string;
685
+ firstName?: string;
686
+ lastName?: string;
687
+ line2?: string;
688
+ region?: string;
689
+ }
690
+ interface Customer {
691
+ id: string;
692
+ }
693
+ /**
694
+ * The line items of the Checkout.
695
+ */
696
+ interface LineItem {
542
697
  /**
543
- * False by default. If set to true, the Checkout is displayed in express mode.
698
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
699
+ * decimals, i.e. 10.23 represents EUR 10.23.
544
700
  */
545
- express?: boolean;
701
+ amount: number;
546
702
  /**
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.
703
+ * The name of the line item.
549
704
  */
550
- guest?: boolean;
705
+ name: string;
551
706
  /**
552
- * If true, the order must be confirmed through the merchant with an additional
553
- * complete callback endpoint. Always true for express sessions.
707
+ * The quantity of the line item.
554
708
  */
555
- handshake?: boolean;
556
- impactOffsetProjects?: Array<string>;
709
+ quantity: number;
557
710
  /**
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.
711
+ * The net amount of a single item.
562
712
  */
563
- incentiveMode?: 'white_label' | 'sustainable';
564
- lineItems?: Array<PublicCheckoutSession.LineItem>;
713
+ singleNet: number;
565
714
  /**
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.
715
+ * The VAT amount of a single item.
569
716
  */
570
- locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
571
- mandate?: PublicCheckoutSession.Mandate;
717
+ singleVat: number;
572
718
  /**
573
- * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
574
- * located. Provided when creating the Checkout.
719
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
720
+ * the line item.
575
721
  */
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;
722
+ category?: string;
578
723
  /**
579
- * The shop-plugin version.
724
+ * The
725
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
726
+ * of the line item.
580
727
  */
581
- plugin?: string;
728
+ EAN?: string;
582
729
  /**
583
- * Use this to prefill data of the user in the Checkout.
730
+ * The image of the line item as a URL.
584
731
  */
585
- prefill?: PublicCheckoutSession.Prefill;
586
- selectedShippingMethodId?: string;
587
- shippingMethods?: Array<PublicCheckoutSession.ShippingMethod>;
732
+ image?: string;
588
733
  /**
589
- * The logo of the shop provided as a URL.
734
+ * The internal unique identifier of the line item.
590
735
  */
591
- shopLogo?: string;
592
- shopName?: string;
736
+ referenceId?: string;
593
737
  }
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
- }
738
+ interface Mandate {
739
+ setup: boolean;
617
740
  /**
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.
741
+ * The name of the account holder who signs the mandate
622
742
  */
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
- }
743
+ accountHolderName?: string;
744
+ referenceId?: string;
745
+ userNotificationEmail?: string;
746
+ }
747
+ /**
748
+ * Prefill known data to skip steps in the checkout.
749
+ */
750
+ interface Prefill {
647
751
  /**
648
- * Only applicable for express Checkout Sessions. The given fields will be required
649
- * input within the Ivy express Checkout.
752
+ * The known bank id. Customers will skip the bank selection and go directly to the
753
+ * bank's login. Required for financial address prefill.
650
754
  */
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
- }
755
+ bankId?: string;
661
756
  /**
662
- * The line items of the Checkout.
757
+ * Prefill the customer's financial address to skip bank selection and enforce the
758
+ * customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
759
+ * and Sort Code for UK GBP payments. The validation logic is based on the "type"
760
+ * field. For example, if "type" is set to "iban", the "iban" object must be filled
761
+ * out.
663
762
  */
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
- }
763
+ payerFinancialAddress?: Prefill.PayerFinancialAddress;
764
+ }
765
+ namespace Prefill {
715
766
  /**
716
- * Use this to prefill data of the user in the Checkout.
767
+ * Prefill the customer's financial address to skip bank selection and enforce the
768
+ * customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
769
+ * and Sort Code for UK GBP payments. The validation logic is based on the "type"
770
+ * field. For example, if "type" is set to "iban", the "iban" object must be filled
771
+ * out.
717
772
  */
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;
773
+ interface PayerFinancialAddress {
725
774
  /**
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.
775
+ * The type of the financial address. The actual destination is determined by this
776
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
777
+ * validation will fail if you set e.g. type="iban", but then not fill any values
778
+ * in the "iban" object.
779
+ *
780
+ * - iban: The IBAN of the account
781
+ * - sort_code: The sort code of the account
782
+ * - bank_code: The bank code of the account
783
+ * - bban: The BBAN of the account
731
784
  */
732
- payerFinancialAddress?: Prefill.PayerFinancialAddress;
733
- phone?: string;
785
+ type: string;
786
+ bankCode?: PayerFinancialAddress.BankCode;
787
+ bban?: PayerFinancialAddress.Bban;
788
+ iban?: PayerFinancialAddress.Iban;
789
+ sortCode?: PayerFinancialAddress.SortCode;
734
790
  }
735
- namespace Prefill {
736
- /**
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.
742
- */
743
- interface PayerFinancialAddress {
791
+ namespace PayerFinancialAddress {
792
+ interface BankCode {
793
+ accountNumber: string;
794
+ code: string;
744
795
  /**
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
796
+ * The name of the account holder.
754
797
  */
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
- }
798
+ accountHolderName?: string;
794
799
  }
795
- }
796
- /**
797
- * The shipping methods of the Checkout.
798
- */
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;
800
+ interface Bban {
801
+ bban: string;
838
802
  /**
839
- * The minimum delivery time.
803
+ * The name of the account holder.
840
804
  */
841
- minimum?: DeliveryEstimate.Minimum;
805
+ accountHolderName?: string;
806
+ bic?: string;
842
807
  }
843
- namespace DeliveryEstimate {
808
+ interface Iban {
809
+ iban: string;
844
810
  /**
845
- * The maximum delivery time.
811
+ * The name of the account holder.
846
812
  */
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
- }
813
+ accountHolderName?: string;
814
+ bic?: string;
815
+ }
816
+ interface SortCode {
817
+ accountNumber: string;
818
+ sortCode: string;
857
819
  /**
858
- * The minimum delivery time.
820
+ * The name of the account holder.
859
821
  */
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
- }
822
+ accountHolderName?: string;
870
823
  }
871
824
  }
872
825
  }
873
- interface CheckoutSession {
874
- /**
875
- * The unique identifier of the Checkout within Ivy.
876
- */
877
- 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;
891
- /**
892
- * @deprecated Use merchant.appId instead
893
- */
894
- merchantAppId: string;
895
- /**
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`.
901
- */
902
- paymentMode: 'settlement' | 'direct';
903
- /**
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.
908
- */
909
- price: CheckoutSession.Price;
910
- /**
911
- * Only applicable for express Checkout Sessions. The given fields will be required
912
- * input within the Ivy express Checkout.
913
- */
914
- required: CheckoutSession.Required;
915
- status: 'open' | 'closed' | 'expired';
916
- abortReason?: string;
917
- /**
918
- * The billing address of the customer. Required when handshake=true.
919
- */
920
- billingAddress?: CheckoutSession.BillingAddress;
921
- /**
922
- * The merchant category code or
923
- * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
924
- */
925
- category?: string;
926
- /**
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.
950
- */
951
- errorCallbackUrl?: string;
952
- /**
953
- * False by default. If set to true, the Checkout is displayed in express mode.
954
- */
955
- express?: boolean;
956
- /**
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.
959
- */
960
- guest?: boolean;
961
- /**
962
- * If true, the order must be confirmed through the merchant with an additional
963
- * complete callback endpoint. Always true for express sessions.
964
- */
965
- handshake?: boolean;
966
- impactOffsetProjects?: Array<string>;
967
- /**
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.
972
- */
973
- incentiveMode?: 'white_label' | 'sustainable';
974
- lineItems?: Array<CheckoutSession.LineItem>;
826
+ /**
827
+ * Only applicable for express Checkout Sessions. The given fields will be required
828
+ * input within the Ivy express Checkout.
829
+ */
830
+ interface Required {
975
831
  /**
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.
832
+ * If set to true, the phone number will be required input within the Ivy express
833
+ * Checkout.
979
834
  */
980
- locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
981
- mandate?: CheckoutSession.Mandate;
835
+ phone: boolean;
836
+ }
837
+ interface ShippingAddress {
838
+ city: string;
982
839
  /**
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.
840
+ * The country code in
841
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
986
842
  */
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';
843
+ 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';
844
+ line1: string;
845
+ zipCode: string;
846
+ firstName?: string;
847
+ lastName?: string;
848
+ line2?: string;
849
+ region?: string;
850
+ }
851
+ /**
852
+ * The shipping methods of the Checkout.
853
+ */
854
+ interface ShippingMethod {
988
855
  /**
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.
856
+ * The customer-facing name of the shipping method.
992
857
  */
993
- metadata?: Record<string, unknown>;
994
- offsetProject?: string;
858
+ name: string;
995
859
  /**
996
- * The shop-plugin version.
860
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
997
861
  */
998
- plugin?: string;
862
+ price: number;
999
863
  /**
1000
- * Use this to prefill data of the user in the Checkout.
864
+ * The unique identifier of the shipping method within Ivy.
1001
865
  */
1002
- prefill?: CheckoutSession.Prefill;
866
+ id?: string;
1003
867
  /**
1004
- * Only applicable for express Checkouts. Quote Callback requests will be sent to
1005
- * this URL.
868
+ * The list of countries where the shipping method is available.
1006
869
  */
1007
- quoteCallbackUrl?: string;
1008
- redirectUrl?: string;
870
+ 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
871
  /**
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.
872
+ * The delivery estimate of the shipping method.
1013
873
  */
1014
- referenceId?: string;
1015
- selectedShippingMethodId?: string;
1016
- shippingAddress?: CheckoutSession.ShippingAddress;
1017
- shippingMethods?: Array<CheckoutSession.ShippingMethod>;
874
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
1018
875
  /**
1019
- * The logo of the shop provided as a URL.
876
+ * The unique identifier within your system of the shipping method.
1020
877
  */
1021
- shopLogo?: string;
1022
- shopName?: string;
878
+ reference?: string;
1023
879
  /**
1024
- * Required if not set in the dashboard. Users will be redirected here after a
1025
- * successful Payment attempt.
880
+ * @deprecated Deprecated in favor of deliveryEstimate
1026
881
  */
1027
- successCallbackUrl?: string;
1028
- updatedAt?: string;
882
+ timeFrame?: string;
1029
883
  }
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
- }
884
+ namespace ShippingMethod {
1263
885
  /**
1264
- * The shipping methods of the Checkout.
886
+ * The delivery estimate of the shipping method.
1265
887
  */
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;
888
+ interface DeliveryEstimate {
1287
889
  /**
1288
- * The unique identifier within your system of the shipping method.
890
+ * The maximum delivery time.
1289
891
  */
1290
- reference?: string;
892
+ maximum?: DeliveryEstimate.Maximum;
1291
893
  /**
1292
- * @deprecated Deprecated in favor of deliveryEstimate
894
+ * The minimum delivery time.
1293
895
  */
1294
- timeFrame?: string;
896
+ minimum?: DeliveryEstimate.Minimum;
1295
897
  }
1296
- namespace ShippingMethod {
898
+ namespace DeliveryEstimate {
1297
899
  /**
1298
- * The delivery estimate of the shipping method.
900
+ * The maximum delivery time.
1299
901
  */
1300
- interface DeliveryEstimate {
902
+ interface Maximum {
1301
903
  /**
1302
- * The maximum delivery time.
904
+ * The unit of the time duration.
1303
905
  */
1304
- maximum?: DeliveryEstimate.Maximum;
906
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1305
907
  /**
1306
- * The minimum delivery time.
908
+ * The value of the time duration.
1307
909
  */
1308
- minimum?: DeliveryEstimate.Minimum;
910
+ value: number;
1309
911
  }
1310
- namespace DeliveryEstimate {
912
+ /**
913
+ * The minimum delivery time.
914
+ */
915
+ interface Minimum {
1311
916
  /**
1312
- * The maximum delivery time.
917
+ * The unit of the time duration.
1313
918
  */
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
- }
919
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1324
920
  /**
1325
- * The minimum delivery time.
921
+ * The value of the time duration.
1326
922
  */
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
- }
923
+ value: number;
1337
924
  }
1338
925
  }
1339
926
  }
@@ -1343,23 +930,22 @@ export interface CheckoutsessionExpireResponse {
1343
930
  * The unique identifier of the Checkout within Ivy.
1344
931
  */
1345
932
  id: string;
1346
- appId: string;
1347
933
  /**
1348
934
  * The markets where the user of the Checkout can select banks from.
1349
935
  */
1350
936
  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
937
  createdAt: string;
1352
938
  /**
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.
939
+ * The customer facing id. This id is displayed to the user during the checkout and
940
+ * in the merchant dashboard.
1356
941
  */
1357
- expiresAt: number;
1358
- merchant: CheckoutsessionExpireResponse.Merchant;
942
+ displayId: string;
1359
943
  /**
1360
- * @deprecated Use merchant.appId instead
944
+ * Required if not set in the dashboard. Users will be redirected here after an
945
+ * unsuccessful Payment attempt.
1361
946
  */
1362
- merchantAppId: string;
947
+ errorCallbackUrl: string;
948
+ merchant: CheckoutsessionExpireResponse.Merchant;
1363
949
  /**
1364
950
  * - `settlement`: The payment is initially settled into a virtual account. The
1365
951
  * funds are then disbursed in batches to the merchant. Refunds are instantly
@@ -1369,19 +955,28 @@ export interface CheckoutsessionExpireResponse {
1369
955
  */
1370
956
  paymentMode: 'settlement' | 'direct';
1371
957
  /**
1372
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
958
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1373
959
  * represents EUR 10.23. Any amount of decimal places can be provided on
1374
960
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
1375
961
  * as this is the format accepted by most banks.
1376
962
  */
1377
963
  price: CheckoutsessionExpireResponse.Price;
964
+ redirectUrl: string;
1378
965
  /**
1379
- * Only applicable for express Checkout Sessions. The given fields will be required
1380
- * input within the Ivy express Checkout.
966
+ * An internal reference id which will be stored with the checkout & corresponding
967
+ * order. Needs to be unique per shop per order and can be up to 200 characters. We
968
+ * recommend to use your internal order id here.
1381
969
  */
1382
- required: CheckoutsessionExpireResponse.Required;
970
+ referenceId: string;
1383
971
  status: 'open' | 'closed' | 'expired';
972
+ /**
973
+ * Required if not set in the dashboard. Users will be redirected here after a
974
+ * successful Payment attempt.
975
+ */
976
+ successCallbackUrl: string;
977
+ updatedAt: string;
1384
978
  abortReason?: string;
979
+ appId?: string;
1385
980
  /**
1386
981
  * The billing address of the customer. Required when handshake=true.
1387
982
  */
@@ -1408,15 +1003,11 @@ export interface CheckoutsessionExpireResponse {
1408
1003
  */
1409
1004
  disableBankSelection?: boolean;
1410
1005
  /**
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.
1006
+ * The Epoch time in seconds at which the Checkout Session will expire. It can be
1007
+ * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
1008
+ * default, this value is 1 hour from creation.
1418
1009
  */
1419
- errorCallbackUrl?: string;
1010
+ expiresAt?: number;
1420
1011
  /**
1421
1012
  * False by default. If set to true, the Checkout is displayed in express mode.
1422
1013
  */
@@ -1453,6 +1044,10 @@ export interface CheckoutsessionExpireResponse {
1453
1044
  * relevant if `prefill.bankId` is provided.
1454
1045
  */
1455
1046
  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';
1047
+ /**
1048
+ * @deprecated Use merchant.appId instead
1049
+ */
1050
+ merchantAppId?: string;
1456
1051
  /**
1457
1052
  * Any data which will be stored and returned for this checkout session and
1458
1053
  * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
@@ -1460,12 +1055,13 @@ export interface CheckoutsessionExpireResponse {
1460
1055
  */
1461
1056
  metadata?: Record<string, unknown>;
1462
1057
  offsetProject?: string;
1058
+ paymentSchemeSelection?: string;
1463
1059
  /**
1464
1060
  * The shop-plugin version.
1465
1061
  */
1466
1062
  plugin?: string;
1467
1063
  /**
1468
- * Use this to prefill data of the user in the Checkout.
1064
+ * Prefill known data to skip steps in the checkout.
1469
1065
  */
1470
1066
  prefill?: CheckoutsessionExpireResponse.Prefill;
1471
1067
  /**
@@ -1473,13 +1069,11 @@ export interface CheckoutsessionExpireResponse {
1473
1069
  * this URL.
1474
1070
  */
1475
1071
  quoteCallbackUrl?: string;
1476
- redirectUrl?: string;
1477
1072
  /**
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.
1073
+ * Only applicable for express Checkout Sessions. The given fields will be required
1074
+ * input within the Ivy express Checkout.
1481
1075
  */
1482
- referenceId?: string;
1076
+ required?: CheckoutsessionExpireResponse.Required;
1483
1077
  selectedShippingMethodId?: string;
1484
1078
  shippingAddress?: CheckoutsessionExpireResponse.ShippingAddress;
1485
1079
  shippingMethods?: Array<CheckoutsessionExpireResponse.ShippingMethod>;
@@ -1488,12 +1082,7 @@ export interface CheckoutsessionExpireResponse {
1488
1082
  */
1489
1083
  shopLogo?: string;
1490
1084
  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;
1085
+ subaccountId?: string;
1497
1086
  }
1498
1087
  export declare namespace CheckoutsessionExpireResponse {
1499
1088
  interface Merchant {
@@ -1519,7 +1108,7 @@ export declare namespace CheckoutsessionExpireResponse {
1519
1108
  }
1520
1109
  }
1521
1110
  /**
1522
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
1111
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1523
1112
  * represents EUR 10.23. Any amount of decimal places can be provided on
1524
1113
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
1525
1114
  * as this is the format accepted by most banks.
@@ -1530,35 +1119,11 @@ export declare namespace CheckoutsessionExpireResponse {
1530
1119
  * The total amount to be paid.
1531
1120
  */
1532
1121
  total: number;
1533
- /**
1534
- * The shipping amount.
1535
- */
1536
1122
  shipping?: number;
1537
- /**
1538
- * The subtotal amount, i.e. the total amount without VAT and shipping.
1539
- */
1540
1123
  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
1124
  totalNet?: number;
1546
- /**
1547
- * The VAT amount.
1548
- */
1549
1125
  vat?: number;
1550
1126
  }
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 {
1556
- /**
1557
- * If set to true, the phone number will be required input within the Ivy express
1558
- * Checkout.
1559
- */
1560
- phone: boolean;
1561
- }
1562
1127
  /**
1563
1128
  * The billing address of the customer. Required when handshake=true.
1564
1129
  */
@@ -1634,32 +1199,30 @@ export declare namespace CheckoutsessionExpireResponse {
1634
1199
  userNotificationEmail?: string;
1635
1200
  }
1636
1201
  /**
1637
- * Use this to prefill data of the user in the Checkout.
1202
+ * Prefill known data to skip steps in the checkout.
1638
1203
  */
1639
1204
  interface Prefill {
1640
1205
  /**
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.
1206
+ * The known bank id. Customers will skip the bank selection and go directly to the
1207
+ * bank's login. Required for financial address prefill.
1643
1208
  */
1644
1209
  bankId?: string;
1645
- email?: string;
1646
1210
  /**
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.
1211
+ * Prefill the customer's financial address to skip bank selection and enforce the
1212
+ * customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
1213
+ * and Sort Code for UK GBP payments. The validation logic is based on the "type"
1214
+ * field. For example, if "type" is set to "iban", the "iban" object must be filled
1215
+ * out.
1652
1216
  */
1653
1217
  payerFinancialAddress?: Prefill.PayerFinancialAddress;
1654
- phone?: string;
1655
1218
  }
1656
1219
  namespace Prefill {
1657
1220
  /**
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.
1221
+ * Prefill the customer's financial address to skip bank selection and enforce the
1222
+ * customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
1223
+ * and Sort Code for UK GBP payments. The validation logic is based on the "type"
1224
+ * field. For example, if "type" is set to "iban", the "iban" object must be filled
1225
+ * out.
1663
1226
  */
1664
1227
  interface PayerFinancialAddress {
1665
1228
  /**
@@ -1714,6 +1277,17 @@ export declare namespace CheckoutsessionExpireResponse {
1714
1277
  }
1715
1278
  }
1716
1279
  }
1280
+ /**
1281
+ * Only applicable for express Checkout Sessions. The given fields will be required
1282
+ * input within the Ivy express Checkout.
1283
+ */
1284
+ interface Required {
1285
+ /**
1286
+ * If set to true, the phone number will be required input within the Ivy express
1287
+ * Checkout.
1288
+ */
1289
+ phone: boolean;
1290
+ }
1717
1291
  interface ShippingAddress {
1718
1292
  city: string;
1719
1293
  /**
@@ -1807,7 +1381,7 @@ export declare namespace CheckoutsessionExpireResponse {
1807
1381
  }
1808
1382
  export interface CheckoutsessionCreateParams {
1809
1383
  /**
1810
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
1384
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1811
1385
  * represents EUR 10.23. Any amount of decimal places can be provided on
1812
1386
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
1813
1387
  * as this is the format accepted by most banks.
@@ -1815,19 +1389,15 @@ export interface CheckoutsessionCreateParams {
1815
1389
  price: CheckoutsessionCreateParams.Price;
1816
1390
  /**
1817
1391
  * 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.
1392
+ * order. Needs to be unique per merchant per order and can be up to 200
1393
+ * characters. We recommend to use your internal unique id for this customer's
1394
+ * payment process.
1820
1395
  */
1821
1396
  referenceId: string;
1822
1397
  /**
1823
- * The billing address of the user. Required when handshake=true.
1398
+ * The billing address of the customer.
1824
1399
  */
1825
1400
  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
1401
  /**
1832
1402
  * Only applicable for express Checkouts. Complete Callback requests will be sent
1833
1403
  * to this URL.
@@ -1843,23 +1413,19 @@ export interface CheckoutsessionCreateParams {
1843
1413
  */
1844
1414
  customer?: CheckoutsessionCreateParams.Email | CheckoutsessionCreateParams.ID;
1845
1415
  /**
1846
- * False by default. If set to true, customers cannot modify the pre-selected bank
1847
- * from `prefill.bankId`.
1416
+ * False by default. If set to true, customers cannot choose another bank than the
1417
+ * pre-selected one.
1848
1418
  */
1849
1419
  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
1420
  /**
1856
1421
  * The customer facing id. This id is displayed to the user during the checkout and
1857
- * in the merchant dashboard.
1422
+ * in the merchant dashboard. It does not need to be unique and should be a
1423
+ * customer-friendly id.
1858
1424
  */
1859
1425
  displayId?: string;
1860
1426
  /**
1861
- * Required if not set in the dashboard. Users will be redirected here after an
1862
- * unsuccessful Payment attempt.
1427
+ * Required if not set in the dashboard. Customers will be redirected here after an
1428
+ * unsuccessful payment attempt.
1863
1429
  */
1864
1430
  errorCallbackUrl?: string;
1865
1431
  /**
@@ -1874,31 +1440,13 @@ export interface CheckoutsessionCreateParams {
1874
1440
  */
1875
1441
  express?: boolean;
1876
1442
  /**
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.
1443
+ * Relevant for e-commerce only. The line items of the checkout.
1896
1444
  */
1897
1445
  lineItems?: Array<CheckoutsessionCreateParams.LineItem>;
1898
1446
  /**
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.
1447
+ * The locale of the customer, i.e. the language of the checkout. Customers can
1448
+ * change the language in the checkout. If not provided, the language of the
1449
+ * checkout is determined by the browser's language.
1902
1450
  */
1903
1451
  locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
1904
1452
  /**
@@ -1907,9 +1455,9 @@ export interface CheckoutsessionCreateParams {
1907
1455
  */
1908
1456
  mandate?: CheckoutsessionCreateParams.Mandate;
1909
1457
  /**
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.
1458
+ * ISO 3166-1 alpha-2 country code. The market where the customer is located. If
1459
+ * provided, the checkout will display the market's default banks. Not relevant if
1460
+ * `prefill.bankId` is provided.
1913
1461
  */
1914
1462
  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
1463
  /**
@@ -1929,18 +1477,14 @@ export interface CheckoutsessionCreateParams {
1929
1477
  /**
1930
1478
  * The scheme selection for the payment. `instant_only` enforces instant payments,
1931
1479
  * 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.
1480
+ * means that the payment is done via instant rails, if supported by the bank. It
1481
+ * will use standard rails, if not supported by the bank. Standard means that only
1482
+ * cost-free, but potentially slower bank rails are used for the transfer. Defaults
1483
+ * to value set on merchant dashboard if not provided.
1936
1484
  */
1937
1485
  paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
1938
1486
  /**
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.
1487
+ * Prefill known data to skip steps in the checkout.
1944
1488
  */
1945
1489
  prefill?: CheckoutsessionCreateParams.Prefill;
1946
1490
  /**
@@ -1948,16 +1492,6 @@ export interface CheckoutsessionCreateParams {
1948
1492
  * this URL.
1949
1493
  */
1950
1494
  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
1495
  /**
1962
1496
  * The settlement destination of the payment. If not provided, the financial
1963
1497
  * address of the merchant's direct payout destination will be used with a randomly
@@ -1965,33 +1499,20 @@ export interface CheckoutsessionCreateParams {
1965
1499
  */
1966
1500
  settlementDestination?: CheckoutsessionCreateParams.SettlementDestination;
1967
1501
  /**
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)
1502
+ * Usually relevant for PSPs. Create a subaccount for each underlying storefront or
1503
+ * merchant which processes payments with your Ivy account. You can create new
1504
+ * subaccounts [here](https://docs.getivy.de/reference/merchantsubaccountcreate-1)
1979
1505
  */
1980
1506
  subaccountId?: string;
1981
1507
  /**
1982
- * Required if not set in the dashboard. Users will be redirected here after a
1983
- * successful Payment attempt.
1508
+ * Required if not set in the dashboard. Customers will be redirected here after a
1509
+ * successful payment attempt.
1984
1510
  */
1985
1511
  successCallbackUrl?: string;
1986
- /**
1987
- * Deprecated in favor of metadata. A token which is returned as a query parameter
1988
- * of the success callback url.
1989
- */
1990
- verificationToken?: string;
1991
1512
  }
1992
1513
  export declare namespace CheckoutsessionCreateParams {
1993
1514
  /**
1994
- * The price to be paid by the user. All amounts are in decimals, i.e. 10.23
1515
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1995
1516
  * represents EUR 10.23. Any amount of decimal places can be provided on
1996
1517
  * initialization, but the actual transfer amount is rounded to 2 decimal places,
1997
1518
  * as this is the format accepted by most banks.
@@ -2002,26 +1523,13 @@ export declare namespace CheckoutsessionCreateParams {
2002
1523
  * The total amount to be paid.
2003
1524
  */
2004
1525
  total: number;
2005
- /**
2006
- * The shipping amount.
2007
- */
2008
1526
  shipping?: number;
2009
- /**
2010
- * The subtotal amount, i.e. the total amount without VAT and shipping.
2011
- */
2012
1527
  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
1528
  totalNet?: number;
2018
- /**
2019
- * The VAT amount.
2020
- */
2021
1529
  vat?: number;
2022
1530
  }
2023
1531
  /**
2024
- * The billing address of the user. Required when handshake=true.
1532
+ * The billing address of the customer.
2025
1533
  */
2026
1534
  interface BillingAddress {
2027
1535
  city: string;
@@ -2049,18 +1557,6 @@ export declare namespace CheckoutsessionCreateParams {
2049
1557
  */
2050
1558
  id: string;
2051
1559
  }
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
1560
  interface LineItem {
2065
1561
  /**
2066
1562
  * The total amount of all line items, i.e. single amount \* quantity. Given in
@@ -2117,32 +1613,30 @@ export declare namespace CheckoutsessionCreateParams {
2117
1613
  userNotificationEmail?: string;
2118
1614
  }
2119
1615
  /**
2120
- * Use this to prefill data of the user in the Checkout.
1616
+ * Prefill known data to skip steps in the checkout.
2121
1617
  */
2122
1618
  interface Prefill {
2123
1619
  /**
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.
1620
+ * The known bank id. Customers will skip the bank selection and go directly to the
1621
+ * bank's login. Required for financial address prefill.
2126
1622
  */
2127
1623
  bankId?: string;
2128
- email?: string;
2129
1624
  /**
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.
1625
+ * Prefill the customer's financial address to skip bank selection and enforce the
1626
+ * customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
1627
+ * and Sort Code for UK GBP payments. The validation logic is based on the "type"
1628
+ * field. For example, if "type" is set to "iban", the "iban" object must be filled
1629
+ * out.
2135
1630
  */
2136
1631
  payerFinancialAddress?: Prefill.PayerFinancialAddress;
2137
- phone?: string;
2138
1632
  }
2139
1633
  namespace Prefill {
2140
1634
  /**
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.
1635
+ * Prefill the customer's financial address to skip bank selection and enforce the
1636
+ * customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
1637
+ * and Sort Code for UK GBP payments. The validation logic is based on the "type"
1638
+ * field. For example, if "type" is set to "iban", the "iban" object must be filled
1639
+ * out.
2146
1640
  */
2147
1641
  interface PayerFinancialAddress {
2148
1642
  /**
@@ -2197,17 +1691,6 @@ export declare namespace CheckoutsessionCreateParams {
2197
1691
  }
2198
1692
  }
2199
1693
  }
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
- }
2211
1694
  /**
2212
1695
  * The settlement destination of the payment. If not provided, the financial
2213
1696
  * address of the merchant's direct payout destination will be used with a randomly
@@ -2284,79 +1767,6 @@ export declare namespace CheckoutsessionCreateParams {
2284
1767
  }
2285
1768
  }
2286
1769
  }
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
1770
  }
2361
1771
  export interface CheckoutsessionRetrieveParams {
2362
1772
  id: string;