@getivy/node-sdk 0.1.0-alpha.32 → 0.1.0-alpha.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/index.d.mts +14 -14
  3. package/index.d.ts +14 -14
  4. package/index.d.ts.map +1 -1
  5. package/index.js.map +1 -1
  6. package/index.mjs +1 -1
  7. package/index.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resource.d.ts +1 -1
  10. package/resource.d.ts.map +1 -1
  11. package/resource.js.map +1 -1
  12. package/resource.mjs.map +1 -1
  13. package/resources/balance.d.ts +6 -3
  14. package/resources/balance.d.ts.map +1 -1
  15. package/resources/banks.d.ts +38 -59
  16. package/resources/banks.d.ts.map +1 -1
  17. package/resources/capabilities.d.ts +1 -10
  18. package/resources/capabilities.d.ts.map +1 -1
  19. package/resources/charges.d.ts +30 -21
  20. package/resources/charges.d.ts.map +1 -1
  21. package/resources/checkoutsession.d.ts +311 -803
  22. package/resources/checkoutsession.d.ts.map +1 -1
  23. package/resources/customers.d.ts +9 -12
  24. package/resources/customers.d.ts.map +1 -1
  25. package/resources/data/accounts.d.ts +0 -100
  26. package/resources/data/accounts.d.ts.map +1 -1
  27. package/resources/data/accounts.js +0 -6
  28. package/resources/data/accounts.js.map +1 -1
  29. package/resources/data/accounts.mjs +0 -6
  30. package/resources/data/accounts.mjs.map +1 -1
  31. package/resources/data/balances.d.ts +0 -41
  32. package/resources/data/balances.d.ts.map +1 -1
  33. package/resources/data/balances.js +0 -6
  34. package/resources/data/balances.js.map +1 -1
  35. package/resources/data/balances.mjs +0 -6
  36. package/resources/data/balances.mjs.map +1 -1
  37. package/resources/data/consent.d.ts +0 -76
  38. package/resources/data/consent.d.ts.map +1 -1
  39. package/resources/data/consent.js +0 -12
  40. package/resources/data/consent.js.map +1 -1
  41. package/resources/data/consent.mjs +0 -12
  42. package/resources/data/consent.mjs.map +1 -1
  43. package/resources/data/data.d.ts +10 -10
  44. package/resources/data/data.d.ts.map +1 -1
  45. package/resources/data/data.js.map +1 -1
  46. package/resources/data/data.mjs +2 -2
  47. package/resources/data/data.mjs.map +1 -1
  48. package/resources/data/index.d.ts +5 -5
  49. package/resources/data/index.d.ts.map +1 -1
  50. package/resources/data/index.js.map +1 -1
  51. package/resources/data/index.mjs +2 -2
  52. package/resources/data/index.mjs.map +1 -1
  53. package/resources/data/session.d.ts +0 -230
  54. package/resources/data/session.d.ts.map +1 -1
  55. package/resources/data/session.js +0 -12
  56. package/resources/data/session.js.map +1 -1
  57. package/resources/data/session.mjs +0 -12
  58. package/resources/data/session.mjs.map +1 -1
  59. package/resources/data/transactions.d.ts +0 -50
  60. package/resources/data/transactions.d.ts.map +1 -1
  61. package/resources/data/transactions.js +0 -7
  62. package/resources/data/transactions.js.map +1 -1
  63. package/resources/data/transactions.mjs +0 -7
  64. package/resources/data/transactions.mjs.map +1 -1
  65. package/resources/index.d.ts +7 -7
  66. package/resources/index.d.ts.map +1 -1
  67. package/resources/index.js.map +1 -1
  68. package/resources/index.mjs +1 -1
  69. package/resources/index.mjs.map +1 -1
  70. package/resources/mandates.d.ts +55 -17
  71. package/resources/mandates.d.ts.map +1 -1
  72. package/resources/mandates.js.map +1 -1
  73. package/resources/mandates.mjs.map +1 -1
  74. package/resources/orders.d.ts +242 -524
  75. package/resources/orders.d.ts.map +1 -1
  76. package/resources/payouts.d.ts +146 -70
  77. package/resources/payouts.d.ts.map +1 -1
  78. package/resources/payouts.js.map +1 -1
  79. package/resources/payouts.mjs.map +1 -1
  80. package/resources/refunds.d.ts +16 -92
  81. package/resources/refunds.d.ts.map +1 -1
  82. package/resources/refunds.js +4 -4
  83. package/resources/refunds.js.map +1 -1
  84. package/resources/refunds.mjs +4 -4
  85. package/resources/refunds.mjs.map +1 -1
  86. package/resources/reports.d.ts +4 -78
  87. package/resources/reports.d.ts.map +1 -1
  88. package/resources/reports.js +5 -1
  89. package/resources/reports.js.map +1 -1
  90. package/resources/reports.mjs +5 -1
  91. package/resources/reports.mjs.map +1 -1
  92. package/resources/subaccounts.d.ts +19 -7
  93. package/resources/subaccounts.d.ts.map +1 -1
  94. package/resources/subaccounts.js.map +1 -1
  95. package/resources/subaccounts.mjs.map +1 -1
  96. package/resources/webhooksubscription.d.ts +0 -151
  97. package/resources/webhooksubscription.d.ts.map +1 -1
  98. package/resources/webhooksubscription.js +0 -33
  99. package/resources/webhooksubscription.js.map +1 -1
  100. package/resources/webhooksubscription.mjs +0 -33
  101. package/resources/webhooksubscription.mjs.map +1 -1
  102. package/src/index.ts +22 -38
  103. package/src/resource.ts +1 -1
  104. package/src/resources/balance.ts +6 -3
  105. package/src/resources/banks.ts +41 -59
  106. package/src/resources/capabilities.ts +1 -10
  107. package/src/resources/charges.ts +32 -23
  108. package/src/resources/checkoutsession.ts +1395 -999
  109. package/src/resources/customers.ts +9 -12
  110. package/src/resources/data/accounts.ts +1 -130
  111. package/src/resources/data/balances.ts +1 -53
  112. package/src/resources/data/consent.ts +1 -106
  113. package/src/resources/data/data.ts +10 -46
  114. package/src/resources/data/index.ts +5 -17
  115. package/src/resources/data/session.ts +1 -1295
  116. package/src/resources/data/transactions.ts +1 -67
  117. package/src/resources/index.ts +9 -19
  118. package/src/resources/mandates.ts +82 -17
  119. package/src/resources/orders.ts +1149 -805
  120. package/src/resources/payouts.ts +239 -70
  121. package/src/resources/refunds.ts +33 -94
  122. package/src/resources/reports.ts +8 -98
  123. package/src/resources/subaccounts.ts +36 -7
  124. package/src/resources/webhooksubscription.ts +1 -349
  125. package/src/version.ts +1 -1
  126. package/version.d.ts +1 -1
  127. package/version.js +1 -1
  128. package/version.mjs +1 -1
@@ -39,15 +39,37 @@ export class Checkoutsession extends APIResource {
39
39
  }
40
40
 
41
41
  export interface CheckoutsessionCreateResponse {
42
- /**
43
- * The unique identifier of the Checkout within Ivy.
44
- */
45
42
  id: string;
46
43
 
47
- /**
48
- * The markets where the user of the Checkout can select banks from.
49
- */
50
- availableMarkets: Array<
44
+ appId: string;
45
+
46
+ created: number;
47
+
48
+ displayId: string;
49
+
50
+ errorCallbackUrl: string;
51
+
52
+ expiresAt: number;
53
+
54
+ lineItems: Array<CheckoutsessionCreateResponse.LineItem>;
55
+
56
+ merchant: CheckoutsessionCreateResponse.Merchant;
57
+
58
+ merchantAppId: string;
59
+
60
+ price: CheckoutsessionCreateResponse.Price;
61
+
62
+ redirectUrl: string;
63
+
64
+ referenceId: string;
65
+
66
+ status: 'open' | 'closed' | 'expired';
67
+
68
+ successCallbackUrl: string;
69
+
70
+ abortReason?: string;
71
+
72
+ availableMarkets?: Array<
51
73
  | 'AF'
52
74
  | 'AL'
53
75
  | 'DZ'
@@ -300,136 +322,32 @@ export interface CheckoutsessionCreateResponse {
300
322
  | 'XK'
301
323
  >;
302
324
 
303
- createdAt: string;
304
-
305
- /**
306
- * @deprecated Currently only visible in the merchant dashboard. This id used to be
307
- * displayed to the user during the checkout.
308
- */
309
- displayId: string;
310
-
311
- /**
312
- * Required if not set in the dashboard. Users will be redirected here after an
313
- * unsuccessful Payment attempt.
314
- */
315
- errorCallbackUrl: string;
316
-
317
- merchant: CheckoutsessionCreateResponse.Merchant;
318
-
319
- /**
320
- * - `settlement`: The payment is initially settled into a virtual account. The
321
- * funds are then disbursed in batches to the merchant. Refunds are instantly
322
- * processed from the virtual account.
323
- * - `direct`: The payment will be settled to the specified `settlementDestination`
324
- * account. `settlementDestination` is required if `paymentMode` is `direct`.
325
- */
326
- paymentMode: 'settlement' | 'direct';
327
-
328
- /**
329
- * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
330
- * represents EUR 10.23. Any amount of decimal places can be provided on
331
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
332
- * as this is the format accepted by most banks.
333
- */
334
- price: CheckoutsessionCreateResponse.Price;
335
-
336
- redirectUrl: string;
337
-
338
- /**
339
- * An internal reference id which will be stored with the checkout & corresponding
340
- * order. Needs to be unique per shop per order and can be up to 200 characters. We
341
- * recommend to use your internal order id here.
342
- */
343
- referenceId: string;
344
-
345
- status: 'open' | 'closed' | 'expired';
346
-
347
- /**
348
- * Required if not set in the dashboard. Users will be redirected here after a
349
- * successful Payment attempt.
350
- */
351
- successCallbackUrl: string;
352
-
353
- updatedAt: string;
354
-
355
- abortReason?: string;
356
-
357
- appId?: string;
358
-
359
- /**
360
- * The billing address of the customer.
361
- */
362
325
  billingAddress?: CheckoutsessionCreateResponse.BillingAddress;
363
326
 
364
- /**
365
- * The merchant category code or
366
- * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
367
- */
368
327
  category?: string;
369
328
 
370
- /**
371
- * Only applicable for express Checkouts. Complete Callback requests will be sent
372
- * to this URL.
373
- */
374
329
  completeCallbackUrl?: string;
375
330
 
376
- /**
377
- * The Epoch time in seconds at which the Checkout Session was created. By default,
378
- * time of Checkout creation at Ivy.
379
- */
380
- created?: number;
331
+ createdAt?: unknown;
381
332
 
382
333
  customer?: CheckoutsessionCreateResponse.Customer;
383
334
 
384
- /**
385
- * False by default. If set to true, customers cannot modify the pre-selected bank
386
- * from `prefill.bankId`.
387
- */
388
335
  disableBankSelection?: boolean;
389
336
 
390
- /**
391
- * The Epoch time in seconds at which the Checkout Session will expire. It can be
392
- * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
393
- * default, this value is 1 hour from creation.
394
- */
395
- expiresAt?: number;
396
-
397
- /**
398
- * False by default. If set to true, the Checkout is displayed in express mode.
399
- */
400
337
  express?: boolean;
401
338
 
402
- /**
403
- * False by default. If set to true, customers skip email input and jump directly
404
- * to their bank login. For express Checkout Sessions this is always false.
405
- */
406
339
  guest?: boolean;
407
340
 
408
- /**
409
- * If true, the order must be confirmed through the merchant with an additional
410
- * complete callback endpoint. Always true for express sessions.
411
- */
412
341
  handshake?: boolean;
413
342
 
414
- /**
415
- * @deprecated
416
- */
417
- lineItems?: Array<CheckoutsessionCreateResponse.LineItem>;
343
+ impactOffsetProjects?: Array<string>;
344
+
345
+ incentiveMode?: string;
418
346
 
419
- /**
420
- * The locale of the Checkout. If provided, the Checkout will be displayed in the
421
- * given language. Users can change the language in the Checkout. If not provided,
422
- * the language of the Checkout is determined by the browser's language.
423
- */
424
347
  locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
425
348
 
426
349
  mandate?: CheckoutsessionCreateResponse.Mandate;
427
350
 
428
- /**
429
- * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
430
- * located. If provided, the Checkout will display the market's banks first. Not
431
- * relevant if `prefill.bankId` is provided.
432
- */
433
351
  market?:
434
352
  | 'AF'
435
353
  | 'AL'
@@ -682,48 +600,92 @@ export interface CheckoutsessionCreateResponse {
682
600
  | 'SS'
683
601
  | 'XK';
684
602
 
685
- /**
686
- * @deprecated Use merchant.appId instead
687
- */
688
- merchantAppId?: string;
689
-
690
- /**
691
- * Any data which will be stored and returned for this checkout session and
692
- * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
693
- * more info.
694
- */
695
603
  metadata?: Record<string, unknown>;
696
604
 
697
- paymentSchemeSelection?: string;
605
+ offsetProject?: string;
698
606
 
699
- /**
700
- * Prefill known data to skip steps in the checkout.
701
- */
702
- prefill?: CheckoutsessionCreateResponse.Prefill;
607
+ paymentMode?: 'direct' | 'settlement';
608
+
609
+ paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
610
+
611
+ plugin?: string;
612
+
613
+ prefill?: unknown;
703
614
 
704
- /**
705
- * Only applicable for express Checkouts. Quote Callback requests will be sent to
706
- * this URL.
707
- */
708
615
  quoteCallbackUrl?: string;
709
616
 
710
- /**
711
- * Only applicable for express Checkout Sessions. The given fields will be required
712
- * input within the Ivy express Checkout.
713
- */
714
617
  required?: CheckoutsessionCreateResponse.Required;
715
618
 
716
- /**
717
- * The logo of the shop provided as a URL.
718
- */
619
+ selectedShippingMethodId?: string;
620
+
621
+ shippingAddress?: CheckoutsessionCreateResponse.ShippingAddress;
622
+
623
+ shippingMethods?: Array<unknown>;
624
+
719
625
  shopLogo?: string;
720
626
 
721
627
  shopName?: string;
722
628
 
723
629
  subaccountId?: string;
630
+
631
+ updatedAt?: unknown;
724
632
  }
725
633
 
726
634
  export namespace CheckoutsessionCreateResponse {
635
+ export interface LineItem {
636
+ /**
637
+ * Accumulated cost in decimals. For example, for a lineItem with total price 3.00
638
+ * and quantity 4, amount would be equal to 12.00.
639
+ */
640
+ amount: number;
641
+
642
+ /**
643
+ * Customer-facing name of the line item.
644
+ */
645
+ name: string;
646
+
647
+ singleNet: number;
648
+
649
+ singleVat: number;
650
+
651
+ category?:
652
+ | '5045'
653
+ | '5065'
654
+ | '5094'
655
+ | '5192'
656
+ | '5193'
657
+ | '5499'
658
+ | '5655'
659
+ | '5691'
660
+ | '5712'
661
+ | '5722'
662
+ | '5812'
663
+ | '5814'
664
+ | '5912'
665
+ | '5977'
666
+ | '5999'
667
+ | '7629';
668
+
669
+ co2Grams?: number;
670
+
671
+ EAN?: string;
672
+
673
+ /**
674
+ * An image of the line item. Valid URLs are accepted only.
675
+ */
676
+ image?: string;
677
+
678
+ /**
679
+ * Quantity of this lineItem.
680
+ */
681
+ quantity?: number;
682
+
683
+ /**
684
+ * An internal unique id stored to this line item.
685
+ */
686
+ referenceId?: string;
687
+ }
688
+
727
689
  export interface Merchant {
728
690
  id: string;
729
691
 
@@ -738,10 +700,6 @@ export namespace CheckoutsessionCreateResponse {
738
700
  export interface Address {
739
701
  city: string;
740
702
 
741
- /**
742
- * The country code in
743
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
744
- */
745
703
  country:
746
704
  | 'AF'
747
705
  | 'AL'
@@ -994,32 +952,23 @@ export namespace CheckoutsessionCreateResponse {
994
952
  | 'SS'
995
953
  | 'XK';
996
954
 
997
- line1: string;
955
+ firstName: string;
998
956
 
999
- zipCode: string;
957
+ lastName: string;
1000
958
 
1001
- firstName?: string;
959
+ line1: string;
1002
960
 
1003
- lastName?: string;
961
+ line2: string;
1004
962
 
1005
- line2?: string;
963
+ region: string;
1006
964
 
1007
- region?: string;
965
+ zipCode: string;
1008
966
  }
1009
967
  }
1010
968
 
1011
- /**
1012
- * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1013
- * represents EUR 10.23. Any amount of decimal places can be provided on
1014
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
1015
- * as this is the format accepted by most banks.
1016
- */
1017
969
  export interface Price {
1018
970
  currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
1019
971
 
1020
- /**
1021
- * The total amount to be paid.
1022
- */
1023
972
  total: number;
1024
973
 
1025
974
  shipping?: number;
@@ -1031,16 +980,9 @@ export namespace CheckoutsessionCreateResponse {
1031
980
  vat?: number;
1032
981
  }
1033
982
 
1034
- /**
1035
- * The billing address of the customer.
1036
- */
1037
983
  export interface BillingAddress {
1038
984
  city: string;
1039
985
 
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
986
  country:
1045
987
  | 'AF'
1046
988
  | 'AL'
@@ -1293,153 +1235,388 @@ export namespace CheckoutsessionCreateResponse {
1293
1235
  | 'SS'
1294
1236
  | 'XK';
1295
1237
 
1296
- line1: string;
1238
+ firstName: string;
1297
1239
 
1298
- zipCode: string;
1240
+ lastName: string;
1299
1241
 
1300
- firstName?: string;
1242
+ line1: string;
1301
1243
 
1302
- lastName?: string;
1244
+ line2: string;
1303
1245
 
1304
- line2?: string;
1246
+ region: string;
1305
1247
 
1306
- region?: string;
1248
+ zipCode: string;
1307
1249
  }
1308
1250
 
1309
1251
  export interface Customer {
1310
1252
  id: string;
1311
1253
  }
1312
1254
 
1313
- export interface LineItem {
1314
- /**
1315
- * The total amount of all line items, i.e. single amount \* quantity. Given in
1316
- * decimals, i.e. 10.23 represents EUR 10.23.
1317
- */
1318
- amount: number;
1319
-
1320
- /**
1321
- * The name of the line item.
1322
- */
1323
- name: string;
1324
-
1325
- /**
1326
- * The quantity of the line item.
1327
- */
1328
- quantity: number;
1329
-
1330
- /**
1331
- * The net amount of a single item.
1332
- */
1333
- singleNet: number;
1334
-
1335
- /**
1336
- * The VAT amount of a single item.
1337
- */
1338
- singleVat: number;
1255
+ export interface Mandate {
1256
+ accountHolderName?: string;
1339
1257
 
1340
- /**
1341
- * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
1342
- * the line item.
1343
- */
1344
- category?: string;
1258
+ additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
1345
1259
 
1346
- /**
1347
- * The
1348
- * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
1349
- * of the line item.
1350
- */
1351
- EAN?: string;
1260
+ referenceId?: string;
1352
1261
 
1353
- /**
1354
- * The image of the line item as a URL.
1355
- */
1356
- image?: string;
1262
+ setup?: boolean;
1357
1263
 
1358
- /**
1359
- * The internal unique identifier of the line item.
1360
- */
1361
- referenceId?: string;
1264
+ userNotificationEmail?: string;
1362
1265
  }
1363
1266
 
1364
- export interface Mandate {
1365
- setup: boolean;
1366
-
1367
- /**
1368
- * The name of the account holder who signs the mandate
1369
- */
1370
- accountHolderName?: string;
1267
+ export namespace Mandate {
1268
+ export interface AdditionalDisplayInformation {
1269
+ cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
1371
1270
 
1372
- referenceId?: string;
1271
+ price?: AdditionalDisplayInformation.Price;
1272
+ }
1373
1273
 
1374
- userNotificationEmail?: string;
1375
- }
1274
+ export namespace AdditionalDisplayInformation {
1275
+ export interface Price {
1276
+ amount: number;
1376
1277
 
1377
- /**
1378
- * Prefill known data to skip steps in the checkout.
1379
- */
1380
- export interface Prefill {
1381
- /**
1382
- * The known bank id. Customers will skip the bank selection and go directly to the
1383
- * bank's login. Required for financial address prefill.
1384
- */
1385
- bankId?: string;
1278
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
1279
+ }
1280
+ }
1386
1281
  }
1387
1282
 
1388
- /**
1389
- * Only applicable for express Checkout Sessions. The given fields will be required
1390
- * input within the Ivy express Checkout.
1391
- */
1392
1283
  export interface Required {
1393
- /**
1394
- * If set to true, the phone number will be required input within the Ivy express
1395
- * Checkout.
1396
- */
1397
1284
  phone: boolean;
1398
1285
  }
1399
- }
1400
1286
 
1401
- export interface CheckoutsessionRetrieveResponse {
1402
- /**
1403
- * The unique identifier of the Checkout within Ivy.
1404
- */
1405
- id: string;
1287
+ export interface ShippingAddress {
1288
+ city: string;
1406
1289
 
1407
- /**
1408
- * The markets where the user of the Checkout can select banks from.
1409
- */
1410
- availableMarkets: Array<
1411
- | 'AF'
1412
- | 'AL'
1413
- | 'DZ'
1414
- | 'AS'
1415
- | 'AD'
1416
- | 'AO'
1417
- | 'AI'
1418
- | 'AQ'
1419
- | 'AG'
1420
- | 'AR'
1421
- | 'AM'
1422
- | 'AW'
1423
- | 'AU'
1424
- | 'AT'
1425
- | 'AZ'
1426
- | 'BS'
1427
- | 'BH'
1428
- | 'BD'
1429
- | 'BB'
1430
- | 'BY'
1431
- | 'BE'
1432
- | 'BZ'
1433
- | 'BJ'
1434
- | 'BM'
1435
- | 'BT'
1436
- | 'BO'
1437
- | 'BA'
1438
- | 'BW'
1439
- | 'BV'
1440
- | 'BR'
1441
- | 'IO'
1442
- | 'BN'
1290
+ country:
1291
+ | 'AF'
1292
+ | 'AL'
1293
+ | 'DZ'
1294
+ | 'AS'
1295
+ | 'AD'
1296
+ | 'AO'
1297
+ | 'AI'
1298
+ | 'AQ'
1299
+ | 'AG'
1300
+ | 'AR'
1301
+ | 'AM'
1302
+ | 'AW'
1303
+ | 'AU'
1304
+ | 'AT'
1305
+ | 'AZ'
1306
+ | 'BS'
1307
+ | 'BH'
1308
+ | 'BD'
1309
+ | 'BB'
1310
+ | 'BY'
1311
+ | 'BE'
1312
+ | 'BZ'
1313
+ | 'BJ'
1314
+ | 'BM'
1315
+ | 'BT'
1316
+ | 'BO'
1317
+ | 'BA'
1318
+ | 'BW'
1319
+ | 'BV'
1320
+ | 'BR'
1321
+ | 'IO'
1322
+ | 'BN'
1323
+ | 'BG'
1324
+ | 'BF'
1325
+ | 'BI'
1326
+ | 'KH'
1327
+ | 'CM'
1328
+ | 'CA'
1329
+ | 'CV'
1330
+ | 'KY'
1331
+ | 'CF'
1332
+ | 'TD'
1333
+ | 'CL'
1334
+ | 'CN'
1335
+ | 'CX'
1336
+ | 'CC'
1337
+ | 'CO'
1338
+ | 'KM'
1339
+ | 'CG'
1340
+ | 'CD'
1341
+ | 'CK'
1342
+ | 'CR'
1343
+ | 'CI'
1344
+ | 'HR'
1345
+ | 'CU'
1346
+ | 'CY'
1347
+ | 'CZ'
1348
+ | 'DK'
1349
+ | 'DJ'
1350
+ | 'DM'
1351
+ | 'DO'
1352
+ | 'EC'
1353
+ | 'EG'
1354
+ | 'SV'
1355
+ | 'GQ'
1356
+ | 'ER'
1357
+ | 'EE'
1358
+ | 'ET'
1359
+ | 'FK'
1360
+ | 'FO'
1361
+ | 'FJ'
1362
+ | 'FI'
1363
+ | 'FR'
1364
+ | 'GF'
1365
+ | 'PF'
1366
+ | 'TF'
1367
+ | 'GA'
1368
+ | 'GM'
1369
+ | 'GE'
1370
+ | 'DE'
1371
+ | 'GH'
1372
+ | 'GI'
1373
+ | 'GR'
1374
+ | 'GL'
1375
+ | 'GD'
1376
+ | 'GP'
1377
+ | 'GU'
1378
+ | 'GT'
1379
+ | 'GN'
1380
+ | 'GW'
1381
+ | 'GY'
1382
+ | 'HT'
1383
+ | 'HM'
1384
+ | 'VA'
1385
+ | 'HN'
1386
+ | 'HK'
1387
+ | 'HU'
1388
+ | 'IS'
1389
+ | 'IN'
1390
+ | 'ID'
1391
+ | 'IR'
1392
+ | 'IQ'
1393
+ | 'IE'
1394
+ | 'IL'
1395
+ | 'IT'
1396
+ | 'JM'
1397
+ | 'JP'
1398
+ | 'JO'
1399
+ | 'KZ'
1400
+ | 'KE'
1401
+ | 'KI'
1402
+ | 'KP'
1403
+ | 'KR'
1404
+ | 'KW'
1405
+ | 'KG'
1406
+ | 'LA'
1407
+ | 'LV'
1408
+ | 'LB'
1409
+ | 'LS'
1410
+ | 'LR'
1411
+ | 'LY'
1412
+ | 'LI'
1413
+ | 'LT'
1414
+ | 'LU'
1415
+ | 'MO'
1416
+ | 'MG'
1417
+ | 'MW'
1418
+ | 'MY'
1419
+ | 'MV'
1420
+ | 'ML'
1421
+ | 'MT'
1422
+ | 'MH'
1423
+ | 'MQ'
1424
+ | 'MR'
1425
+ | 'MU'
1426
+ | 'YT'
1427
+ | 'MX'
1428
+ | 'FM'
1429
+ | 'MD'
1430
+ | 'MC'
1431
+ | 'MN'
1432
+ | 'MS'
1433
+ | 'MA'
1434
+ | 'MZ'
1435
+ | 'MM'
1436
+ | 'NA'
1437
+ | 'NR'
1438
+ | 'NP'
1439
+ | 'NL'
1440
+ | 'NC'
1441
+ | 'NZ'
1442
+ | 'NI'
1443
+ | 'NE'
1444
+ | 'NG'
1445
+ | 'NU'
1446
+ | 'NF'
1447
+ | 'MP'
1448
+ | 'MK'
1449
+ | 'NO'
1450
+ | 'OM'
1451
+ | 'PK'
1452
+ | 'PW'
1453
+ | 'PS'
1454
+ | 'PA'
1455
+ | 'PG'
1456
+ | 'PY'
1457
+ | 'PE'
1458
+ | 'PH'
1459
+ | 'PN'
1460
+ | 'PL'
1461
+ | 'PT'
1462
+ | 'PR'
1463
+ | 'QA'
1464
+ | 'RE'
1465
+ | 'RO'
1466
+ | 'RU'
1467
+ | 'RW'
1468
+ | 'SH'
1469
+ | 'KN'
1470
+ | 'LC'
1471
+ | 'PM'
1472
+ | 'VC'
1473
+ | 'WS'
1474
+ | 'SM'
1475
+ | 'ST'
1476
+ | 'SA'
1477
+ | 'SN'
1478
+ | 'SC'
1479
+ | 'SL'
1480
+ | 'SG'
1481
+ | 'SK'
1482
+ | 'SI'
1483
+ | 'SB'
1484
+ | 'SO'
1485
+ | 'ZA'
1486
+ | 'GS'
1487
+ | 'ES'
1488
+ | 'LK'
1489
+ | 'SD'
1490
+ | 'SR'
1491
+ | 'SJ'
1492
+ | 'SZ'
1493
+ | 'SE'
1494
+ | 'CH'
1495
+ | 'SY'
1496
+ | 'TW'
1497
+ | 'TJ'
1498
+ | 'TZ'
1499
+ | 'TH'
1500
+ | 'TL'
1501
+ | 'TG'
1502
+ | 'TK'
1503
+ | 'TO'
1504
+ | 'TT'
1505
+ | 'TN'
1506
+ | 'TR'
1507
+ | 'TM'
1508
+ | 'TC'
1509
+ | 'TV'
1510
+ | 'UG'
1511
+ | 'UA'
1512
+ | 'AE'
1513
+ | 'GB'
1514
+ | 'US'
1515
+ | 'UM'
1516
+ | 'UY'
1517
+ | 'UZ'
1518
+ | 'VU'
1519
+ | 'VE'
1520
+ | 'VN'
1521
+ | 'VG'
1522
+ | 'VI'
1523
+ | 'WF'
1524
+ | 'EH'
1525
+ | 'YE'
1526
+ | 'ZM'
1527
+ | 'ZW'
1528
+ | 'AX'
1529
+ | 'BQ'
1530
+ | 'CW'
1531
+ | 'GG'
1532
+ | 'IM'
1533
+ | 'JE'
1534
+ | 'ME'
1535
+ | 'BL'
1536
+ | 'MF'
1537
+ | 'RS'
1538
+ | 'SX'
1539
+ | 'SS'
1540
+ | 'XK';
1541
+
1542
+ firstName: string;
1543
+
1544
+ lastName: string;
1545
+
1546
+ line1: string;
1547
+
1548
+ line2: string;
1549
+
1550
+ region: string;
1551
+
1552
+ zipCode: string;
1553
+ }
1554
+ }
1555
+
1556
+ export interface CheckoutsessionRetrieveResponse {
1557
+ id: string;
1558
+
1559
+ appId: string;
1560
+
1561
+ created: number;
1562
+
1563
+ displayId: string;
1564
+
1565
+ errorCallbackUrl: string;
1566
+
1567
+ expiresAt: number;
1568
+
1569
+ lineItems: Array<CheckoutsessionRetrieveResponse.LineItem>;
1570
+
1571
+ merchant: CheckoutsessionRetrieveResponse.Merchant;
1572
+
1573
+ merchantAppId: string;
1574
+
1575
+ price: CheckoutsessionRetrieveResponse.Price;
1576
+
1577
+ redirectUrl: string;
1578
+
1579
+ referenceId: string;
1580
+
1581
+ status: 'open' | 'closed' | 'expired';
1582
+
1583
+ successCallbackUrl: string;
1584
+
1585
+ abortReason?: string;
1586
+
1587
+ availableMarkets?: Array<
1588
+ | 'AF'
1589
+ | 'AL'
1590
+ | 'DZ'
1591
+ | 'AS'
1592
+ | 'AD'
1593
+ | 'AO'
1594
+ | 'AI'
1595
+ | 'AQ'
1596
+ | 'AG'
1597
+ | 'AR'
1598
+ | 'AM'
1599
+ | 'AW'
1600
+ | 'AU'
1601
+ | 'AT'
1602
+ | 'AZ'
1603
+ | 'BS'
1604
+ | 'BH'
1605
+ | 'BD'
1606
+ | 'BB'
1607
+ | 'BY'
1608
+ | 'BE'
1609
+ | 'BZ'
1610
+ | 'BJ'
1611
+ | 'BM'
1612
+ | 'BT'
1613
+ | 'BO'
1614
+ | 'BA'
1615
+ | 'BW'
1616
+ | 'BV'
1617
+ | 'BR'
1618
+ | 'IO'
1619
+ | 'BN'
1443
1620
  | 'BG'
1444
1621
  | 'BF'
1445
1622
  | 'BI'
@@ -1660,136 +1837,32 @@ export interface CheckoutsessionRetrieveResponse {
1660
1837
  | 'XK'
1661
1838
  >;
1662
1839
 
1663
- createdAt: string;
1664
-
1665
- /**
1666
- * @deprecated Currently only visible in the merchant dashboard. This id used to be
1667
- * displayed to the user during the checkout.
1668
- */
1669
- displayId: string;
1670
-
1671
- /**
1672
- * Required if not set in the dashboard. Users will be redirected here after an
1673
- * unsuccessful Payment attempt.
1674
- */
1675
- errorCallbackUrl: string;
1676
-
1677
- merchant: CheckoutsessionRetrieveResponse.Merchant;
1678
-
1679
- /**
1680
- * - `settlement`: The payment is initially settled into a virtual account. The
1681
- * funds are then disbursed in batches to the merchant. Refunds are instantly
1682
- * processed from the virtual account.
1683
- * - `direct`: The payment will be settled to the specified `settlementDestination`
1684
- * account. `settlementDestination` is required if `paymentMode` is `direct`.
1685
- */
1686
- paymentMode: 'settlement' | 'direct';
1687
-
1688
- /**
1689
- * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1690
- * represents EUR 10.23. Any amount of decimal places can be provided on
1691
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
1692
- * as this is the format accepted by most banks.
1693
- */
1694
- price: CheckoutsessionRetrieveResponse.Price;
1695
-
1696
- redirectUrl: string;
1697
-
1698
- /**
1699
- * An internal reference id which will be stored with the checkout & corresponding
1700
- * order. Needs to be unique per shop per order and can be up to 200 characters. We
1701
- * recommend to use your internal order id here.
1702
- */
1703
- referenceId: string;
1704
-
1705
- status: 'open' | 'closed' | 'expired';
1706
-
1707
- /**
1708
- * Required if not set in the dashboard. Users will be redirected here after a
1709
- * successful Payment attempt.
1710
- */
1711
- successCallbackUrl: string;
1712
-
1713
- updatedAt: string;
1714
-
1715
- abortReason?: string;
1716
-
1717
- appId?: string;
1718
-
1719
- /**
1720
- * The billing address of the customer.
1721
- */
1722
1840
  billingAddress?: CheckoutsessionRetrieveResponse.BillingAddress;
1723
1841
 
1724
- /**
1725
- * The merchant category code or
1726
- * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
1727
- */
1728
1842
  category?: string;
1729
1843
 
1730
- /**
1731
- * Only applicable for express Checkouts. Complete Callback requests will be sent
1732
- * to this URL.
1733
- */
1734
1844
  completeCallbackUrl?: string;
1735
1845
 
1736
- /**
1737
- * The Epoch time in seconds at which the Checkout Session was created. By default,
1738
- * time of Checkout creation at Ivy.
1739
- */
1740
- created?: number;
1846
+ createdAt?: unknown;
1741
1847
 
1742
1848
  customer?: CheckoutsessionRetrieveResponse.Customer;
1743
1849
 
1744
- /**
1745
- * False by default. If set to true, customers cannot modify the pre-selected bank
1746
- * from `prefill.bankId`.
1747
- */
1748
1850
  disableBankSelection?: boolean;
1749
1851
 
1750
- /**
1751
- * The Epoch time in seconds at which the Checkout Session will expire. It can be
1752
- * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
1753
- * default, this value is 1 hour from creation.
1754
- */
1755
- expiresAt?: number;
1756
-
1757
- /**
1758
- * False by default. If set to true, the Checkout is displayed in express mode.
1759
- */
1760
1852
  express?: boolean;
1761
1853
 
1762
- /**
1763
- * False by default. If set to true, customers skip email input and jump directly
1764
- * to their bank login. For express Checkout Sessions this is always false.
1765
- */
1766
1854
  guest?: boolean;
1767
1855
 
1768
- /**
1769
- * If true, the order must be confirmed through the merchant with an additional
1770
- * complete callback endpoint. Always true for express sessions.
1771
- */
1772
1856
  handshake?: boolean;
1773
1857
 
1774
- /**
1775
- * @deprecated
1776
- */
1777
- lineItems?: Array<CheckoutsessionRetrieveResponse.LineItem>;
1858
+ impactOffsetProjects?: Array<string>;
1859
+
1860
+ incentiveMode?: string;
1778
1861
 
1779
- /**
1780
- * The locale of the Checkout. If provided, the Checkout will be displayed in the
1781
- * given language. Users can change the language in the Checkout. If not provided,
1782
- * the language of the Checkout is determined by the browser's language.
1783
- */
1784
1862
  locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
1785
1863
 
1786
1864
  mandate?: CheckoutsessionRetrieveResponse.Mandate;
1787
1865
 
1788
- /**
1789
- * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
1790
- * located. If provided, the Checkout will display the market's banks first. Not
1791
- * relevant if `prefill.bankId` is provided.
1792
- */
1793
1866
  market?:
1794
1867
  | 'AF'
1795
1868
  | 'AL'
@@ -2042,48 +2115,92 @@ export interface CheckoutsessionRetrieveResponse {
2042
2115
  | 'SS'
2043
2116
  | 'XK';
2044
2117
 
2045
- /**
2046
- * @deprecated Use merchant.appId instead
2047
- */
2048
- merchantAppId?: string;
2049
-
2050
- /**
2051
- * Any data which will be stored and returned for this checkout session and
2052
- * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
2053
- * more info.
2054
- */
2055
2118
  metadata?: Record<string, unknown>;
2056
2119
 
2057
- paymentSchemeSelection?: string;
2120
+ offsetProject?: string;
2058
2121
 
2059
- /**
2060
- * Prefill known data to skip steps in the checkout.
2061
- */
2062
- prefill?: CheckoutsessionRetrieveResponse.Prefill;
2122
+ paymentMode?: 'direct' | 'settlement';
2063
2123
 
2064
- /**
2065
- * Only applicable for express Checkouts. Quote Callback requests will be sent to
2066
- * this URL.
2067
- */
2068
- quoteCallbackUrl?: string;
2124
+ paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
2125
+
2126
+ plugin?: string;
2127
+
2128
+ prefill?: unknown;
2129
+
2130
+ quoteCallbackUrl?: string;
2069
2131
 
2070
- /**
2071
- * Only applicable for express Checkout Sessions. The given fields will be required
2072
- * input within the Ivy express Checkout.
2073
- */
2074
2132
  required?: CheckoutsessionRetrieveResponse.Required;
2075
2133
 
2076
- /**
2077
- * The logo of the shop provided as a URL.
2078
- */
2134
+ selectedShippingMethodId?: string;
2135
+
2136
+ shippingAddress?: CheckoutsessionRetrieveResponse.ShippingAddress;
2137
+
2138
+ shippingMethods?: Array<unknown>;
2139
+
2079
2140
  shopLogo?: string;
2080
2141
 
2081
2142
  shopName?: string;
2082
2143
 
2083
2144
  subaccountId?: string;
2145
+
2146
+ updatedAt?: unknown;
2084
2147
  }
2085
2148
 
2086
2149
  export namespace CheckoutsessionRetrieveResponse {
2150
+ export interface LineItem {
2151
+ /**
2152
+ * Accumulated cost in decimals. For example, for a lineItem with total price 3.00
2153
+ * and quantity 4, amount would be equal to 12.00.
2154
+ */
2155
+ amount: number;
2156
+
2157
+ /**
2158
+ * Customer-facing name of the line item.
2159
+ */
2160
+ name: string;
2161
+
2162
+ singleNet: number;
2163
+
2164
+ singleVat: number;
2165
+
2166
+ category?:
2167
+ | '5045'
2168
+ | '5065'
2169
+ | '5094'
2170
+ | '5192'
2171
+ | '5193'
2172
+ | '5499'
2173
+ | '5655'
2174
+ | '5691'
2175
+ | '5712'
2176
+ | '5722'
2177
+ | '5812'
2178
+ | '5814'
2179
+ | '5912'
2180
+ | '5977'
2181
+ | '5999'
2182
+ | '7629';
2183
+
2184
+ co2Grams?: number;
2185
+
2186
+ EAN?: string;
2187
+
2188
+ /**
2189
+ * An image of the line item. Valid URLs are accepted only.
2190
+ */
2191
+ image?: string;
2192
+
2193
+ /**
2194
+ * Quantity of this lineItem.
2195
+ */
2196
+ quantity?: number;
2197
+
2198
+ /**
2199
+ * An internal unique id stored to this line item.
2200
+ */
2201
+ referenceId?: string;
2202
+ }
2203
+
2087
2204
  export interface Merchant {
2088
2205
  id: string;
2089
2206
 
@@ -2098,10 +2215,6 @@ export namespace CheckoutsessionRetrieveResponse {
2098
2215
  export interface Address {
2099
2216
  city: string;
2100
2217
 
2101
- /**
2102
- * The country code in
2103
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
2104
- */
2105
2218
  country:
2106
2219
  | 'AF'
2107
2220
  | 'AL'
@@ -2354,53 +2467,341 @@ export namespace CheckoutsessionRetrieveResponse {
2354
2467
  | 'SS'
2355
2468
  | 'XK';
2356
2469
 
2357
- line1: string;
2470
+ firstName: string;
2471
+
2472
+ lastName: string;
2473
+
2474
+ line1: string;
2475
+
2476
+ line2: string;
2477
+
2478
+ region: string;
2479
+
2480
+ zipCode: string;
2481
+ }
2482
+ }
2483
+
2484
+ export interface Price {
2485
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
2486
+
2487
+ total: number;
2488
+
2489
+ shipping?: number;
2490
+
2491
+ subTotal?: number;
2492
+
2493
+ totalNet?: number;
2494
+
2495
+ vat?: number;
2496
+ }
2497
+
2498
+ export interface BillingAddress {
2499
+ city: string;
2500
+
2501
+ country:
2502
+ | 'AF'
2503
+ | 'AL'
2504
+ | 'DZ'
2505
+ | 'AS'
2506
+ | 'AD'
2507
+ | 'AO'
2508
+ | 'AI'
2509
+ | 'AQ'
2510
+ | 'AG'
2511
+ | 'AR'
2512
+ | 'AM'
2513
+ | 'AW'
2514
+ | 'AU'
2515
+ | 'AT'
2516
+ | 'AZ'
2517
+ | 'BS'
2518
+ | 'BH'
2519
+ | 'BD'
2520
+ | 'BB'
2521
+ | 'BY'
2522
+ | 'BE'
2523
+ | 'BZ'
2524
+ | 'BJ'
2525
+ | 'BM'
2526
+ | 'BT'
2527
+ | 'BO'
2528
+ | 'BA'
2529
+ | 'BW'
2530
+ | 'BV'
2531
+ | 'BR'
2532
+ | 'IO'
2533
+ | 'BN'
2534
+ | 'BG'
2535
+ | 'BF'
2536
+ | 'BI'
2537
+ | 'KH'
2538
+ | 'CM'
2539
+ | 'CA'
2540
+ | 'CV'
2541
+ | 'KY'
2542
+ | 'CF'
2543
+ | 'TD'
2544
+ | 'CL'
2545
+ | 'CN'
2546
+ | 'CX'
2547
+ | 'CC'
2548
+ | 'CO'
2549
+ | 'KM'
2550
+ | 'CG'
2551
+ | 'CD'
2552
+ | 'CK'
2553
+ | 'CR'
2554
+ | 'CI'
2555
+ | 'HR'
2556
+ | 'CU'
2557
+ | 'CY'
2558
+ | 'CZ'
2559
+ | 'DK'
2560
+ | 'DJ'
2561
+ | 'DM'
2562
+ | 'DO'
2563
+ | 'EC'
2564
+ | 'EG'
2565
+ | 'SV'
2566
+ | 'GQ'
2567
+ | 'ER'
2568
+ | 'EE'
2569
+ | 'ET'
2570
+ | 'FK'
2571
+ | 'FO'
2572
+ | 'FJ'
2573
+ | 'FI'
2574
+ | 'FR'
2575
+ | 'GF'
2576
+ | 'PF'
2577
+ | 'TF'
2578
+ | 'GA'
2579
+ | 'GM'
2580
+ | 'GE'
2581
+ | 'DE'
2582
+ | 'GH'
2583
+ | 'GI'
2584
+ | 'GR'
2585
+ | 'GL'
2586
+ | 'GD'
2587
+ | 'GP'
2588
+ | 'GU'
2589
+ | 'GT'
2590
+ | 'GN'
2591
+ | 'GW'
2592
+ | 'GY'
2593
+ | 'HT'
2594
+ | 'HM'
2595
+ | 'VA'
2596
+ | 'HN'
2597
+ | 'HK'
2598
+ | 'HU'
2599
+ | 'IS'
2600
+ | 'IN'
2601
+ | 'ID'
2602
+ | 'IR'
2603
+ | 'IQ'
2604
+ | 'IE'
2605
+ | 'IL'
2606
+ | 'IT'
2607
+ | 'JM'
2608
+ | 'JP'
2609
+ | 'JO'
2610
+ | 'KZ'
2611
+ | 'KE'
2612
+ | 'KI'
2613
+ | 'KP'
2614
+ | 'KR'
2615
+ | 'KW'
2616
+ | 'KG'
2617
+ | 'LA'
2618
+ | 'LV'
2619
+ | 'LB'
2620
+ | 'LS'
2621
+ | 'LR'
2622
+ | 'LY'
2623
+ | 'LI'
2624
+ | 'LT'
2625
+ | 'LU'
2626
+ | 'MO'
2627
+ | 'MG'
2628
+ | 'MW'
2629
+ | 'MY'
2630
+ | 'MV'
2631
+ | 'ML'
2632
+ | 'MT'
2633
+ | 'MH'
2634
+ | 'MQ'
2635
+ | 'MR'
2636
+ | 'MU'
2637
+ | 'YT'
2638
+ | 'MX'
2639
+ | 'FM'
2640
+ | 'MD'
2641
+ | 'MC'
2642
+ | 'MN'
2643
+ | 'MS'
2644
+ | 'MA'
2645
+ | 'MZ'
2646
+ | 'MM'
2647
+ | 'NA'
2648
+ | 'NR'
2649
+ | 'NP'
2650
+ | 'NL'
2651
+ | 'NC'
2652
+ | 'NZ'
2653
+ | 'NI'
2654
+ | 'NE'
2655
+ | 'NG'
2656
+ | 'NU'
2657
+ | 'NF'
2658
+ | 'MP'
2659
+ | 'MK'
2660
+ | 'NO'
2661
+ | 'OM'
2662
+ | 'PK'
2663
+ | 'PW'
2664
+ | 'PS'
2665
+ | 'PA'
2666
+ | 'PG'
2667
+ | 'PY'
2668
+ | 'PE'
2669
+ | 'PH'
2670
+ | 'PN'
2671
+ | 'PL'
2672
+ | 'PT'
2673
+ | 'PR'
2674
+ | 'QA'
2675
+ | 'RE'
2676
+ | 'RO'
2677
+ | 'RU'
2678
+ | 'RW'
2679
+ | 'SH'
2680
+ | 'KN'
2681
+ | 'LC'
2682
+ | 'PM'
2683
+ | 'VC'
2684
+ | 'WS'
2685
+ | 'SM'
2686
+ | 'ST'
2687
+ | 'SA'
2688
+ | 'SN'
2689
+ | 'SC'
2690
+ | 'SL'
2691
+ | 'SG'
2692
+ | 'SK'
2693
+ | 'SI'
2694
+ | 'SB'
2695
+ | 'SO'
2696
+ | 'ZA'
2697
+ | 'GS'
2698
+ | 'ES'
2699
+ | 'LK'
2700
+ | 'SD'
2701
+ | 'SR'
2702
+ | 'SJ'
2703
+ | 'SZ'
2704
+ | 'SE'
2705
+ | 'CH'
2706
+ | 'SY'
2707
+ | 'TW'
2708
+ | 'TJ'
2709
+ | 'TZ'
2710
+ | 'TH'
2711
+ | 'TL'
2712
+ | 'TG'
2713
+ | 'TK'
2714
+ | 'TO'
2715
+ | 'TT'
2716
+ | 'TN'
2717
+ | 'TR'
2718
+ | 'TM'
2719
+ | 'TC'
2720
+ | 'TV'
2721
+ | 'UG'
2722
+ | 'UA'
2723
+ | 'AE'
2724
+ | 'GB'
2725
+ | 'US'
2726
+ | 'UM'
2727
+ | 'UY'
2728
+ | 'UZ'
2729
+ | 'VU'
2730
+ | 'VE'
2731
+ | 'VN'
2732
+ | 'VG'
2733
+ | 'VI'
2734
+ | 'WF'
2735
+ | 'EH'
2736
+ | 'YE'
2737
+ | 'ZM'
2738
+ | 'ZW'
2739
+ | 'AX'
2740
+ | 'BQ'
2741
+ | 'CW'
2742
+ | 'GG'
2743
+ | 'IM'
2744
+ | 'JE'
2745
+ | 'ME'
2746
+ | 'BL'
2747
+ | 'MF'
2748
+ | 'RS'
2749
+ | 'SX'
2750
+ | 'SS'
2751
+ | 'XK';
2752
+
2753
+ firstName: string;
2358
2754
 
2359
- zipCode: string;
2755
+ lastName: string;
2360
2756
 
2361
- firstName?: string;
2757
+ line1: string;
2362
2758
 
2363
- lastName?: string;
2759
+ line2: string;
2364
2760
 
2365
- line2?: string;
2761
+ region: string;
2366
2762
 
2367
- region?: string;
2368
- }
2763
+ zipCode: string;
2369
2764
  }
2370
2765
 
2371
- /**
2372
- * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
2373
- * represents EUR 10.23. Any amount of decimal places can be provided on
2374
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
2375
- * as this is the format accepted by most banks.
2376
- */
2377
- export interface Price {
2378
- currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
2766
+ export interface Customer {
2767
+ id: string;
2768
+ }
2379
2769
 
2380
- /**
2381
- * The total amount to be paid.
2382
- */
2383
- total: number;
2770
+ export interface Mandate {
2771
+ accountHolderName?: string;
2384
2772
 
2385
- shipping?: number;
2773
+ additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
2386
2774
 
2387
- subTotal?: number;
2775
+ referenceId?: string;
2388
2776
 
2389
- totalNet?: number;
2777
+ setup?: boolean;
2390
2778
 
2391
- vat?: number;
2779
+ userNotificationEmail?: string;
2392
2780
  }
2393
2781
 
2394
- /**
2395
- * The billing address of the customer.
2396
- */
2397
- export interface BillingAddress {
2782
+ export namespace Mandate {
2783
+ export interface AdditionalDisplayInformation {
2784
+ cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
2785
+
2786
+ price?: AdditionalDisplayInformation.Price;
2787
+ }
2788
+
2789
+ export namespace AdditionalDisplayInformation {
2790
+ export interface Price {
2791
+ amount: number;
2792
+
2793
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
2794
+ }
2795
+ }
2796
+ }
2797
+
2798
+ export interface Required {
2799
+ phone: boolean;
2800
+ }
2801
+
2802
+ export interface ShippingAddress {
2398
2803
  city: string;
2399
2804
 
2400
- /**
2401
- * The country code in
2402
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
2403
- */
2404
2805
  country:
2405
2806
  | 'AF'
2406
2807
  | 'AL'
@@ -2653,121 +3054,52 @@ export namespace CheckoutsessionRetrieveResponse {
2653
3054
  | 'SS'
2654
3055
  | 'XK';
2655
3056
 
2656
- line1: string;
2657
-
2658
- zipCode: string;
3057
+ firstName: string;
2659
3058
 
2660
- firstName?: string;
3059
+ lastName: string;
2661
3060
 
2662
- lastName?: string;
3061
+ line1: string;
2663
3062
 
2664
- line2?: string;
3063
+ line2: string;
2665
3064
 
2666
- region?: string;
2667
- }
3065
+ region: string;
2668
3066
 
2669
- export interface Customer {
2670
- id: string;
3067
+ zipCode: string;
2671
3068
  }
3069
+ }
2672
3070
 
2673
- export interface LineItem {
2674
- /**
2675
- * The total amount of all line items, i.e. single amount \* quantity. Given in
2676
- * decimals, i.e. 10.23 represents EUR 10.23.
2677
- */
2678
- amount: number;
2679
-
2680
- /**
2681
- * The name of the line item.
2682
- */
2683
- name: string;
3071
+ export interface CheckoutsessionExpireResponse {
3072
+ id: string;
2684
3073
 
2685
- /**
2686
- * The quantity of the line item.
2687
- */
2688
- quantity: number;
3074
+ appId: string;
2689
3075
 
2690
- /**
2691
- * The net amount of a single item.
2692
- */
2693
- singleNet: number;
3076
+ created: number;
2694
3077
 
2695
- /**
2696
- * The VAT amount of a single item.
2697
- */
2698
- singleVat: number;
3078
+ displayId: string;
2699
3079
 
2700
- /**
2701
- * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
2702
- * the line item.
2703
- */
2704
- category?: string;
3080
+ errorCallbackUrl: string;
2705
3081
 
2706
- /**
2707
- * The
2708
- * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
2709
- * of the line item.
2710
- */
2711
- EAN?: string;
3082
+ expiresAt: number;
2712
3083
 
2713
- /**
2714
- * The image of the line item as a URL.
2715
- */
2716
- image?: string;
3084
+ lineItems: Array<CheckoutsessionExpireResponse.LineItem>;
2717
3085
 
2718
- /**
2719
- * The internal unique identifier of the line item.
2720
- */
2721
- referenceId?: string;
2722
- }
3086
+ merchant: CheckoutsessionExpireResponse.Merchant;
2723
3087
 
2724
- export interface Mandate {
2725
- setup: boolean;
3088
+ merchantAppId: string;
2726
3089
 
2727
- /**
2728
- * The name of the account holder who signs the mandate
2729
- */
2730
- accountHolderName?: string;
3090
+ price: CheckoutsessionExpireResponse.Price;
2731
3091
 
2732
- referenceId?: string;
3092
+ redirectUrl: string;
2733
3093
 
2734
- userNotificationEmail?: string;
2735
- }
3094
+ referenceId: string;
2736
3095
 
2737
- /**
2738
- * Prefill known data to skip steps in the checkout.
2739
- */
2740
- export interface Prefill {
2741
- /**
2742
- * The known bank id. Customers will skip the bank selection and go directly to the
2743
- * bank's login. Required for financial address prefill.
2744
- */
2745
- bankId?: string;
2746
- }
3096
+ status: 'open' | 'closed' | 'expired';
2747
3097
 
2748
- /**
2749
- * Only applicable for express Checkout Sessions. The given fields will be required
2750
- * input within the Ivy express Checkout.
2751
- */
2752
- export interface Required {
2753
- /**
2754
- * If set to true, the phone number will be required input within the Ivy express
2755
- * Checkout.
2756
- */
2757
- phone: boolean;
2758
- }
2759
- }
3098
+ successCallbackUrl: string;
2760
3099
 
2761
- export interface CheckoutsessionExpireResponse {
2762
- /**
2763
- * The unique identifier of the Checkout within Ivy.
2764
- */
2765
- id: string;
3100
+ abortReason?: string;
2766
3101
 
2767
- /**
2768
- * The markets where the user of the Checkout can select banks from.
2769
- */
2770
- availableMarkets: Array<
3102
+ availableMarkets?: Array<
2771
3103
  | 'AF'
2772
3104
  | 'AL'
2773
3105
  | 'DZ'
@@ -3020,136 +3352,32 @@ export interface CheckoutsessionExpireResponse {
3020
3352
  | 'XK'
3021
3353
  >;
3022
3354
 
3023
- createdAt: string;
3024
-
3025
- /**
3026
- * @deprecated Currently only visible in the merchant dashboard. This id used to be
3027
- * displayed to the user during the checkout.
3028
- */
3029
- displayId: string;
3030
-
3031
- /**
3032
- * Required if not set in the dashboard. Users will be redirected here after an
3033
- * unsuccessful Payment attempt.
3034
- */
3035
- errorCallbackUrl: string;
3036
-
3037
- merchant: CheckoutsessionExpireResponse.Merchant;
3038
-
3039
- /**
3040
- * - `settlement`: The payment is initially settled into a virtual account. The
3041
- * funds are then disbursed in batches to the merchant. Refunds are instantly
3042
- * processed from the virtual account.
3043
- * - `direct`: The payment will be settled to the specified `settlementDestination`
3044
- * account. `settlementDestination` is required if `paymentMode` is `direct`.
3045
- */
3046
- paymentMode: 'settlement' | 'direct';
3047
-
3048
- /**
3049
- * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
3050
- * represents EUR 10.23. Any amount of decimal places can be provided on
3051
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
3052
- * as this is the format accepted by most banks.
3053
- */
3054
- price: CheckoutsessionExpireResponse.Price;
3055
-
3056
- redirectUrl: string;
3057
-
3058
- /**
3059
- * An internal reference id which will be stored with the checkout & corresponding
3060
- * order. Needs to be unique per shop per order and can be up to 200 characters. We
3061
- * recommend to use your internal order id here.
3062
- */
3063
- referenceId: string;
3064
-
3065
- status: 'open' | 'closed' | 'expired';
3066
-
3067
- /**
3068
- * Required if not set in the dashboard. Users will be redirected here after a
3069
- * successful Payment attempt.
3070
- */
3071
- successCallbackUrl: string;
3072
-
3073
- updatedAt: string;
3074
-
3075
- abortReason?: string;
3076
-
3077
- appId?: string;
3078
-
3079
- /**
3080
- * The billing address of the customer.
3081
- */
3082
3355
  billingAddress?: CheckoutsessionExpireResponse.BillingAddress;
3083
3356
 
3084
- /**
3085
- * The merchant category code or
3086
- * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
3087
- */
3088
3357
  category?: string;
3089
3358
 
3090
- /**
3091
- * Only applicable for express Checkouts. Complete Callback requests will be sent
3092
- * to this URL.
3093
- */
3094
3359
  completeCallbackUrl?: string;
3095
3360
 
3096
- /**
3097
- * The Epoch time in seconds at which the Checkout Session was created. By default,
3098
- * time of Checkout creation at Ivy.
3099
- */
3100
- created?: number;
3361
+ createdAt?: unknown;
3101
3362
 
3102
3363
  customer?: CheckoutsessionExpireResponse.Customer;
3103
3364
 
3104
- /**
3105
- * False by default. If set to true, customers cannot modify the pre-selected bank
3106
- * from `prefill.bankId`.
3107
- */
3108
3365
  disableBankSelection?: boolean;
3109
3366
 
3110
- /**
3111
- * The Epoch time in seconds at which the Checkout Session will expire. It can be
3112
- * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
3113
- * default, this value is 1 hour from creation.
3114
- */
3115
- expiresAt?: number;
3116
-
3117
- /**
3118
- * False by default. If set to true, the Checkout is displayed in express mode.
3119
- */
3120
3367
  express?: boolean;
3121
3368
 
3122
- /**
3123
- * False by default. If set to true, customers skip email input and jump directly
3124
- * to their bank login. For express Checkout Sessions this is always false.
3125
- */
3126
3369
  guest?: boolean;
3127
3370
 
3128
- /**
3129
- * If true, the order must be confirmed through the merchant with an additional
3130
- * complete callback endpoint. Always true for express sessions.
3131
- */
3132
3371
  handshake?: boolean;
3133
3372
 
3134
- /**
3135
- * @deprecated
3136
- */
3137
- lineItems?: Array<CheckoutsessionExpireResponse.LineItem>;
3373
+ impactOffsetProjects?: Array<string>;
3374
+
3375
+ incentiveMode?: string;
3138
3376
 
3139
- /**
3140
- * The locale of the Checkout. If provided, the Checkout will be displayed in the
3141
- * given language. Users can change the language in the Checkout. If not provided,
3142
- * the language of the Checkout is determined by the browser's language.
3143
- */
3144
3377
  locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
3145
3378
 
3146
3379
  mandate?: CheckoutsessionExpireResponse.Mandate;
3147
3380
 
3148
- /**
3149
- * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
3150
- * located. If provided, the Checkout will display the market's banks first. Not
3151
- * relevant if `prefill.bankId` is provided.
3152
- */
3153
3381
  market?:
3154
3382
  | 'AF'
3155
3383
  | 'AL'
@@ -3402,48 +3630,92 @@ export interface CheckoutsessionExpireResponse {
3402
3630
  | 'SS'
3403
3631
  | 'XK';
3404
3632
 
3405
- /**
3406
- * @deprecated Use merchant.appId instead
3407
- */
3408
- merchantAppId?: string;
3409
-
3410
- /**
3411
- * Any data which will be stored and returned for this checkout session and
3412
- * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
3413
- * more info.
3414
- */
3415
3633
  metadata?: Record<string, unknown>;
3416
3634
 
3417
- paymentSchemeSelection?: string;
3635
+ offsetProject?: string;
3418
3636
 
3419
- /**
3420
- * Prefill known data to skip steps in the checkout.
3421
- */
3422
- prefill?: CheckoutsessionExpireResponse.Prefill;
3637
+ paymentMode?: 'direct' | 'settlement';
3638
+
3639
+ paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
3640
+
3641
+ plugin?: string;
3642
+
3643
+ prefill?: unknown;
3423
3644
 
3424
- /**
3425
- * Only applicable for express Checkouts. Quote Callback requests will be sent to
3426
- * this URL.
3427
- */
3428
3645
  quoteCallbackUrl?: string;
3429
3646
 
3430
- /**
3431
- * Only applicable for express Checkout Sessions. The given fields will be required
3432
- * input within the Ivy express Checkout.
3433
- */
3434
3647
  required?: CheckoutsessionExpireResponse.Required;
3435
3648
 
3436
- /**
3437
- * The logo of the shop provided as a URL.
3438
- */
3649
+ selectedShippingMethodId?: string;
3650
+
3651
+ shippingAddress?: CheckoutsessionExpireResponse.ShippingAddress;
3652
+
3653
+ shippingMethods?: Array<unknown>;
3654
+
3439
3655
  shopLogo?: string;
3440
3656
 
3441
3657
  shopName?: string;
3442
3658
 
3443
3659
  subaccountId?: string;
3660
+
3661
+ updatedAt?: unknown;
3444
3662
  }
3445
3663
 
3446
3664
  export namespace CheckoutsessionExpireResponse {
3665
+ export interface LineItem {
3666
+ /**
3667
+ * Accumulated cost in decimals. For example, for a lineItem with total price 3.00
3668
+ * and quantity 4, amount would be equal to 12.00.
3669
+ */
3670
+ amount: number;
3671
+
3672
+ /**
3673
+ * Customer-facing name of the line item.
3674
+ */
3675
+ name: string;
3676
+
3677
+ singleNet: number;
3678
+
3679
+ singleVat: number;
3680
+
3681
+ category?:
3682
+ | '5045'
3683
+ | '5065'
3684
+ | '5094'
3685
+ | '5192'
3686
+ | '5193'
3687
+ | '5499'
3688
+ | '5655'
3689
+ | '5691'
3690
+ | '5712'
3691
+ | '5722'
3692
+ | '5812'
3693
+ | '5814'
3694
+ | '5912'
3695
+ | '5977'
3696
+ | '5999'
3697
+ | '7629';
3698
+
3699
+ co2Grams?: number;
3700
+
3701
+ EAN?: string;
3702
+
3703
+ /**
3704
+ * An image of the line item. Valid URLs are accepted only.
3705
+ */
3706
+ image?: string;
3707
+
3708
+ /**
3709
+ * Quantity of this lineItem.
3710
+ */
3711
+ quantity?: number;
3712
+
3713
+ /**
3714
+ * An internal unique id stored to this line item.
3715
+ */
3716
+ referenceId?: string;
3717
+ }
3718
+
3447
3719
  export interface Merchant {
3448
3720
  id: string;
3449
3721
 
@@ -3458,10 +3730,6 @@ export namespace CheckoutsessionExpireResponse {
3458
3730
  export interface Address {
3459
3731
  city: string;
3460
3732
 
3461
- /**
3462
- * The country code in
3463
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
3464
- */
3465
3733
  country:
3466
3734
  | 'AF'
3467
3735
  | 'AL'
@@ -3714,53 +3982,341 @@ export namespace CheckoutsessionExpireResponse {
3714
3982
  | 'SS'
3715
3983
  | 'XK';
3716
3984
 
3717
- line1: string;
3985
+ firstName: string;
3986
+
3987
+ lastName: string;
3988
+
3989
+ line1: string;
3990
+
3991
+ line2: string;
3992
+
3993
+ region: string;
3994
+
3995
+ zipCode: string;
3996
+ }
3997
+ }
3998
+
3999
+ export interface Price {
4000
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
4001
+
4002
+ total: number;
4003
+
4004
+ shipping?: number;
4005
+
4006
+ subTotal?: number;
4007
+
4008
+ totalNet?: number;
4009
+
4010
+ vat?: number;
4011
+ }
4012
+
4013
+ export interface BillingAddress {
4014
+ city: string;
4015
+
4016
+ country:
4017
+ | 'AF'
4018
+ | 'AL'
4019
+ | 'DZ'
4020
+ | 'AS'
4021
+ | 'AD'
4022
+ | 'AO'
4023
+ | 'AI'
4024
+ | 'AQ'
4025
+ | 'AG'
4026
+ | 'AR'
4027
+ | 'AM'
4028
+ | 'AW'
4029
+ | 'AU'
4030
+ | 'AT'
4031
+ | 'AZ'
4032
+ | 'BS'
4033
+ | 'BH'
4034
+ | 'BD'
4035
+ | 'BB'
4036
+ | 'BY'
4037
+ | 'BE'
4038
+ | 'BZ'
4039
+ | 'BJ'
4040
+ | 'BM'
4041
+ | 'BT'
4042
+ | 'BO'
4043
+ | 'BA'
4044
+ | 'BW'
4045
+ | 'BV'
4046
+ | 'BR'
4047
+ | 'IO'
4048
+ | 'BN'
4049
+ | 'BG'
4050
+ | 'BF'
4051
+ | 'BI'
4052
+ | 'KH'
4053
+ | 'CM'
4054
+ | 'CA'
4055
+ | 'CV'
4056
+ | 'KY'
4057
+ | 'CF'
4058
+ | 'TD'
4059
+ | 'CL'
4060
+ | 'CN'
4061
+ | 'CX'
4062
+ | 'CC'
4063
+ | 'CO'
4064
+ | 'KM'
4065
+ | 'CG'
4066
+ | 'CD'
4067
+ | 'CK'
4068
+ | 'CR'
4069
+ | 'CI'
4070
+ | 'HR'
4071
+ | 'CU'
4072
+ | 'CY'
4073
+ | 'CZ'
4074
+ | 'DK'
4075
+ | 'DJ'
4076
+ | 'DM'
4077
+ | 'DO'
4078
+ | 'EC'
4079
+ | 'EG'
4080
+ | 'SV'
4081
+ | 'GQ'
4082
+ | 'ER'
4083
+ | 'EE'
4084
+ | 'ET'
4085
+ | 'FK'
4086
+ | 'FO'
4087
+ | 'FJ'
4088
+ | 'FI'
4089
+ | 'FR'
4090
+ | 'GF'
4091
+ | 'PF'
4092
+ | 'TF'
4093
+ | 'GA'
4094
+ | 'GM'
4095
+ | 'GE'
4096
+ | 'DE'
4097
+ | 'GH'
4098
+ | 'GI'
4099
+ | 'GR'
4100
+ | 'GL'
4101
+ | 'GD'
4102
+ | 'GP'
4103
+ | 'GU'
4104
+ | 'GT'
4105
+ | 'GN'
4106
+ | 'GW'
4107
+ | 'GY'
4108
+ | 'HT'
4109
+ | 'HM'
4110
+ | 'VA'
4111
+ | 'HN'
4112
+ | 'HK'
4113
+ | 'HU'
4114
+ | 'IS'
4115
+ | 'IN'
4116
+ | 'ID'
4117
+ | 'IR'
4118
+ | 'IQ'
4119
+ | 'IE'
4120
+ | 'IL'
4121
+ | 'IT'
4122
+ | 'JM'
4123
+ | 'JP'
4124
+ | 'JO'
4125
+ | 'KZ'
4126
+ | 'KE'
4127
+ | 'KI'
4128
+ | 'KP'
4129
+ | 'KR'
4130
+ | 'KW'
4131
+ | 'KG'
4132
+ | 'LA'
4133
+ | 'LV'
4134
+ | 'LB'
4135
+ | 'LS'
4136
+ | 'LR'
4137
+ | 'LY'
4138
+ | 'LI'
4139
+ | 'LT'
4140
+ | 'LU'
4141
+ | 'MO'
4142
+ | 'MG'
4143
+ | 'MW'
4144
+ | 'MY'
4145
+ | 'MV'
4146
+ | 'ML'
4147
+ | 'MT'
4148
+ | 'MH'
4149
+ | 'MQ'
4150
+ | 'MR'
4151
+ | 'MU'
4152
+ | 'YT'
4153
+ | 'MX'
4154
+ | 'FM'
4155
+ | 'MD'
4156
+ | 'MC'
4157
+ | 'MN'
4158
+ | 'MS'
4159
+ | 'MA'
4160
+ | 'MZ'
4161
+ | 'MM'
4162
+ | 'NA'
4163
+ | 'NR'
4164
+ | 'NP'
4165
+ | 'NL'
4166
+ | 'NC'
4167
+ | 'NZ'
4168
+ | 'NI'
4169
+ | 'NE'
4170
+ | 'NG'
4171
+ | 'NU'
4172
+ | 'NF'
4173
+ | 'MP'
4174
+ | 'MK'
4175
+ | 'NO'
4176
+ | 'OM'
4177
+ | 'PK'
4178
+ | 'PW'
4179
+ | 'PS'
4180
+ | 'PA'
4181
+ | 'PG'
4182
+ | 'PY'
4183
+ | 'PE'
4184
+ | 'PH'
4185
+ | 'PN'
4186
+ | 'PL'
4187
+ | 'PT'
4188
+ | 'PR'
4189
+ | 'QA'
4190
+ | 'RE'
4191
+ | 'RO'
4192
+ | 'RU'
4193
+ | 'RW'
4194
+ | 'SH'
4195
+ | 'KN'
4196
+ | 'LC'
4197
+ | 'PM'
4198
+ | 'VC'
4199
+ | 'WS'
4200
+ | 'SM'
4201
+ | 'ST'
4202
+ | 'SA'
4203
+ | 'SN'
4204
+ | 'SC'
4205
+ | 'SL'
4206
+ | 'SG'
4207
+ | 'SK'
4208
+ | 'SI'
4209
+ | 'SB'
4210
+ | 'SO'
4211
+ | 'ZA'
4212
+ | 'GS'
4213
+ | 'ES'
4214
+ | 'LK'
4215
+ | 'SD'
4216
+ | 'SR'
4217
+ | 'SJ'
4218
+ | 'SZ'
4219
+ | 'SE'
4220
+ | 'CH'
4221
+ | 'SY'
4222
+ | 'TW'
4223
+ | 'TJ'
4224
+ | 'TZ'
4225
+ | 'TH'
4226
+ | 'TL'
4227
+ | 'TG'
4228
+ | 'TK'
4229
+ | 'TO'
4230
+ | 'TT'
4231
+ | 'TN'
4232
+ | 'TR'
4233
+ | 'TM'
4234
+ | 'TC'
4235
+ | 'TV'
4236
+ | 'UG'
4237
+ | 'UA'
4238
+ | 'AE'
4239
+ | 'GB'
4240
+ | 'US'
4241
+ | 'UM'
4242
+ | 'UY'
4243
+ | 'UZ'
4244
+ | 'VU'
4245
+ | 'VE'
4246
+ | 'VN'
4247
+ | 'VG'
4248
+ | 'VI'
4249
+ | 'WF'
4250
+ | 'EH'
4251
+ | 'YE'
4252
+ | 'ZM'
4253
+ | 'ZW'
4254
+ | 'AX'
4255
+ | 'BQ'
4256
+ | 'CW'
4257
+ | 'GG'
4258
+ | 'IM'
4259
+ | 'JE'
4260
+ | 'ME'
4261
+ | 'BL'
4262
+ | 'MF'
4263
+ | 'RS'
4264
+ | 'SX'
4265
+ | 'SS'
4266
+ | 'XK';
4267
+
4268
+ firstName: string;
3718
4269
 
3719
- zipCode: string;
4270
+ lastName: string;
3720
4271
 
3721
- firstName?: string;
4272
+ line1: string;
3722
4273
 
3723
- lastName?: string;
4274
+ line2: string;
3724
4275
 
3725
- line2?: string;
4276
+ region: string;
3726
4277
 
3727
- region?: string;
3728
- }
4278
+ zipCode: string;
3729
4279
  }
3730
4280
 
3731
- /**
3732
- * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
3733
- * represents EUR 10.23. Any amount of decimal places can be provided on
3734
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
3735
- * as this is the format accepted by most banks.
3736
- */
3737
- export interface Price {
3738
- currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
4281
+ export interface Customer {
4282
+ id: string;
4283
+ }
3739
4284
 
3740
- /**
3741
- * The total amount to be paid.
3742
- */
3743
- total: number;
4285
+ export interface Mandate {
4286
+ accountHolderName?: string;
3744
4287
 
3745
- shipping?: number;
4288
+ additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
3746
4289
 
3747
- subTotal?: number;
4290
+ referenceId?: string;
3748
4291
 
3749
- totalNet?: number;
4292
+ setup?: boolean;
3750
4293
 
3751
- vat?: number;
4294
+ userNotificationEmail?: string;
3752
4295
  }
3753
4296
 
3754
- /**
3755
- * The billing address of the customer.
3756
- */
3757
- export interface BillingAddress {
4297
+ export namespace Mandate {
4298
+ export interface AdditionalDisplayInformation {
4299
+ cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
4300
+
4301
+ price?: AdditionalDisplayInformation.Price;
4302
+ }
4303
+
4304
+ export namespace AdditionalDisplayInformation {
4305
+ export interface Price {
4306
+ amount: number;
4307
+
4308
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
4309
+ }
4310
+ }
4311
+ }
4312
+
4313
+ export interface Required {
4314
+ phone: boolean;
4315
+ }
4316
+
4317
+ export interface ShippingAddress {
3758
4318
  city: string;
3759
4319
 
3760
- /**
3761
- * The country code in
3762
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
3763
- */
3764
4320
  country:
3765
4321
  | 'AF'
3766
4322
  | 'AL'
@@ -4013,125 +4569,29 @@ export namespace CheckoutsessionExpireResponse {
4013
4569
  | 'SS'
4014
4570
  | 'XK';
4015
4571
 
4016
- line1: string;
4017
-
4018
- zipCode: string;
4019
-
4020
- firstName?: string;
4021
-
4022
- lastName?: string;
4023
-
4024
- line2?: string;
4025
-
4026
- region?: string;
4027
- }
4028
-
4029
- export interface Customer {
4030
- id: string;
4031
- }
4032
-
4033
- export interface LineItem {
4034
- /**
4035
- * The total amount of all line items, i.e. single amount \* quantity. Given in
4036
- * decimals, i.e. 10.23 represents EUR 10.23.
4037
- */
4038
- amount: number;
4039
-
4040
- /**
4041
- * The name of the line item.
4042
- */
4043
- name: string;
4044
-
4045
- /**
4046
- * The quantity of the line item.
4047
- */
4048
- quantity: number;
4049
-
4050
- /**
4051
- * The net amount of a single item.
4052
- */
4053
- singleNet: number;
4054
-
4055
- /**
4056
- * The VAT amount of a single item.
4057
- */
4058
- singleVat: number;
4059
-
4060
- /**
4061
- * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
4062
- * the line item.
4063
- */
4064
- category?: string;
4065
-
4066
- /**
4067
- * The
4068
- * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
4069
- * of the line item.
4070
- */
4071
- EAN?: string;
4072
-
4073
- /**
4074
- * The image of the line item as a URL.
4075
- */
4076
- image?: string;
4077
-
4078
- /**
4079
- * The internal unique identifier of the line item.
4080
- */
4081
- referenceId?: string;
4082
- }
4572
+ firstName: string;
4083
4573
 
4084
- export interface Mandate {
4085
- setup: boolean;
4086
-
4087
- /**
4088
- * The name of the account holder who signs the mandate
4089
- */
4090
- accountHolderName?: string;
4574
+ lastName: string;
4091
4575
 
4092
- referenceId?: string;
4576
+ line1: string;
4093
4577
 
4094
- userNotificationEmail?: string;
4095
- }
4578
+ line2: string;
4096
4579
 
4097
- /**
4098
- * Prefill known data to skip steps in the checkout.
4099
- */
4100
- export interface Prefill {
4101
- /**
4102
- * The known bank id. Customers will skip the bank selection and go directly to the
4103
- * bank's login. Required for financial address prefill.
4104
- */
4105
- bankId?: string;
4106
- }
4580
+ region: string;
4107
4581
 
4108
- /**
4109
- * Only applicable for express Checkout Sessions. The given fields will be required
4110
- * input within the Ivy express Checkout.
4111
- */
4112
- export interface Required {
4113
- /**
4114
- * If set to true, the phone number will be required input within the Ivy express
4115
- * Checkout.
4116
- */
4117
- phone: boolean;
4582
+ zipCode: string;
4118
4583
  }
4119
4584
  }
4120
4585
 
4121
4586
  export interface CheckoutsessionCreateParams {
4122
4587
  /**
4123
- * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
4124
- * represents EUR 10.23. Any amount of decimal places can be provided on
4125
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
4126
- * as this is the format accepted by most banks.
4588
+ * Price of the checkout session
4127
4589
  */
4128
4590
  price: CheckoutsessionCreateParams.Price;
4129
4591
 
4130
4592
  /**
4131
- * An internal reference id which will be stored with the checkout & corresponding
4132
- * order. Needs to be unique per merchant per order and can be up to 200
4133
- * characters. We recommend to use your internal unique id for this customer's
4134
- * payment process.
4593
+ * An internal reference id which will be stored with the order. Needs to be unique
4594
+ * per shop and can be up to 200 characters.
4135
4595
  */
4136
4596
  referenceId: string;
4137
4597
 
@@ -4141,75 +4601,59 @@ export interface CheckoutsessionCreateParams {
4141
4601
  billingAddress?: CheckoutsessionCreateParams.BillingAddress;
4142
4602
 
4143
4603
  /**
4144
- * @deprecated Only applicable for express Checkouts. Complete Callback requests
4145
- * will be sent to this URL.
4604
+ * Complete Callback requests will be sent to this URL on default.
4146
4605
  */
4147
4606
  completeCallbackUrl?: string;
4148
4607
 
4149
4608
  /**
4150
- * @deprecated The Epoch time in seconds at which the Checkout Session was created.
4151
- * By default, time of Checkout creation at Ivy.
4609
+ * The Epoch time in seconds at which the Checkout Session was created. By default,
4610
+ * time of api CheckoutSession creation at Ivy.
4152
4611
  */
4153
4612
  created?: number;
4154
4613
 
4155
- /**
4156
- * The customer of the merchant.
4157
- */
4158
- customer?: CheckoutsessionCreateParams.Email | CheckoutsessionCreateParams.ID;
4614
+ customer?: CheckoutsessionCreateParams.Customer;
4159
4615
 
4160
4616
  /**
4161
- * False by default. If set to true, customers cannot choose another bank than the
4162
- * pre-selected one.
4617
+ * Disable bank selection mode. If set to true, customers cannot modify the pre
4618
+ * selected bank.
4163
4619
  */
4164
4620
  disableBankSelection?: boolean;
4165
4621
 
4166
4622
  /**
4167
- * @deprecated Currently only visible in the merchant dashboard. This id used to be
4168
- * displayed to the user during the checkout.
4623
+ * The order id which will be displayed to the user and in the merchant dashboard.
4624
+ * At most 200 characters are allowed.
4169
4625
  */
4170
4626
  displayId?: string;
4171
4627
 
4172
4628
  /**
4173
- * Required if not set in the dashboard. Customers will be redirected here after an
4174
- * unsuccessful payment attempt.
4629
+ * Users will be redirected here on default after an unsuccessful checkout.
4175
4630
  */
4176
4631
  errorCallbackUrl?: string;
4177
4632
 
4178
4633
  /**
4179
4634
  * The Epoch time in seconds at which the Checkout Session will expire. It can be
4180
- * anywhere from 5 minutes to 6 days after Checkout Session creation. By default,
4181
- * this value is 1 hour from creation.
4635
+ * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
4636
+ * default, this value is 1 hour from creation.
4182
4637
  */
4183
4638
  expiresAt?: number;
4184
4639
 
4185
4640
  /**
4186
- * @deprecated Relevant for e-commerce only. If true, the checkout session will be
4187
- * an express checkout session.
4641
+ * Sets the checkout to a express version
4188
4642
  */
4189
4643
  express?: boolean;
4190
4644
 
4191
4645
  /**
4192
- * @deprecated Relevant for e-commerce only. The line items of the checkout.
4646
+ * All line items of this checkout session. At least one line item required
4193
4647
  */
4194
4648
  lineItems?: Array<CheckoutsessionCreateParams.LineItem>;
4195
4649
 
4196
- /**
4197
- * The locale of the customer, i.e. the language of the checkout. Customers can
4198
- * change the language in the checkout. If not provided, the language of the
4199
- * checkout is determined by the browser's language.
4200
- */
4201
4650
  locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
4202
4651
 
4203
- /**
4204
- * The mandate setup for the payment. Relevant for
4205
- * [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
4206
- */
4207
4652
  mandate?: CheckoutsessionCreateParams.Mandate;
4208
4653
 
4209
4654
  /**
4210
- * ISO 3166-1 alpha-2 country code. The market where the customer is located. If
4211
- * provided, the checkout will display the market's default banks. Not relevant if
4212
- * `prefill.bankId` is provided.
4655
+ * The market of the checkoutSession. Will show the market banks connected with
4656
+ * this market
4213
4657
  */
4214
4658
  market?:
4215
4659
  | 'AF'
@@ -4465,81 +4909,47 @@ export interface CheckoutsessionCreateParams {
4465
4909
 
4466
4910
  /**
4467
4911
  * Any data which will be stored and returned for this checkout session and
4468
- * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
4469
- * more info.
4912
+ * corresponding order
4470
4913
  */
4471
- metadata?: Array<Record<string, unknown>>;
4914
+ metadata?: Record<string, unknown>;
4472
4915
 
4473
4916
  /**
4474
- * - `settlement`: The payment is initially settled into a virtual account. The
4475
- * funds are then disbursed in batches to the merchant. Refunds are instantly
4476
- * processed from the virtual account.
4477
- * - `direct`: The payment will be settled to the specified `settlementDestination`
4478
- * account. `settlementDestination` is required if `paymentMode` is `direct`.
4917
+ * The mode in which the payment should be processed. If direct is used, you need
4918
+ * to provide a settlementDestination
4479
4919
  */
4480
- paymentMode?: 'settlement' | 'direct';
4920
+ paymentMode?: 'direct' | 'settlement';
4481
4921
 
4482
- /**
4483
- * The scheme selection for the payment. `instant_only` enforces instant payments,
4484
- * meaning no banks that do not support it can be selected. `instant_preferred`
4485
- * means that the payment is done via instant rails, if supported by the bank. It
4486
- * will use standard rails, if not supported by the bank. Standard means that only
4487
- * cost-free, but potentially slower bank rails are used for the transfer. Defaults
4488
- * to value set on merchant dashboard if not provided.
4489
- */
4490
4922
  paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
4491
4923
 
4492
4924
  /**
4493
- * Prefill known data to skip steps in the checkout.
4925
+ * The values specified here will be pre-filled in the Ivy Checkout.
4494
4926
  */
4495
4927
  prefill?: CheckoutsessionCreateParams.Prefill;
4496
4928
 
4497
4929
  /**
4498
- * @deprecated Only applicable for express Checkouts. Quote Callback requests will
4499
- * be sent to this URL.
4930
+ * Quote Callback requests will be sent to this URL on default.
4500
4931
  */
4501
4932
  quoteCallbackUrl?: string;
4502
4933
 
4503
- /**
4504
- * The settlement destination of the payment. If not provided, the financial
4505
- * address of the merchant's direct payout destination will be used with a randomly
4506
- * generated payment reference.
4507
- */
4508
4934
  settlementDestination?: CheckoutsessionCreateParams.SettlementDestination;
4509
4935
 
4510
- /**
4511
- * Usually relevant for PSPs. Create a subaccount for each underlying storefront or
4512
- * merchant which processes payments with your Ivy account. You can create new
4513
- * subaccounts [here](https://docs.getivy.de/reference/merchantsubaccountcreate-1)
4514
- */
4515
4936
  subaccountId?: string;
4516
4937
 
4517
4938
  /**
4518
- * Required if not set in the dashboard. Customers will be redirected here after a
4519
- * successful payment attempt.
4939
+ * Users will be redirected here on default after a successful checkout.
4520
4940
  */
4521
4941
  successCallbackUrl?: string;
4522
4942
 
4523
- /**
4524
- * The theme variant which will be used in checkout. If not provided, the default
4525
- * light theme will be used.
4526
- */
4527
4943
  themeVariant?: 'light' | 'dark';
4528
4944
  }
4529
4945
 
4530
4946
  export namespace CheckoutsessionCreateParams {
4531
4947
  /**
4532
- * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
4533
- * represents EUR 10.23. Any amount of decimal places can be provided on
4534
- * initialization, but the actual transfer amount is rounded to 2 decimal places,
4535
- * as this is the format accepted by most banks.
4948
+ * Price of the checkout session
4536
4949
  */
4537
4950
  export interface Price {
4538
4951
  currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
4539
4952
 
4540
- /**
4541
- * The total amount to be paid.
4542
- */
4543
4953
  total: number;
4544
4954
 
4545
4955
  shipping?: number;
@@ -4557,10 +4967,6 @@ export namespace CheckoutsessionCreateParams {
4557
4967
  export interface BillingAddress {
4558
4968
  city: string;
4559
4969
 
4560
- /**
4561
- * The country code in
4562
- * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
4563
- */
4564
4970
  country:
4565
4971
  | 'AF'
4566
4972
  | 'AL'
@@ -4813,150 +5219,127 @@ export namespace CheckoutsessionCreateParams {
4813
5219
  | 'SS'
4814
5220
  | 'XK';
4815
5221
 
4816
- line1: string;
5222
+ firstName: string;
4817
5223
 
4818
- zipCode: string;
5224
+ lastName: string;
4819
5225
 
4820
- firstName?: string;
5226
+ line1: string;
4821
5227
 
4822
- lastName?: string;
5228
+ line2: string;
4823
5229
 
4824
- line2?: string;
5230
+ region: string;
4825
5231
 
4826
- region?: string;
5232
+ zipCode: string;
4827
5233
  }
4828
5234
 
4829
- export interface Email {
4830
- /**
4831
- * The email of the customer.
4832
- */
4833
- email: string;
4834
- }
5235
+ export interface Customer {
5236
+ id?: string;
4835
5237
 
4836
- export interface ID {
4837
- /**
4838
- * The Ivy id of the customer.
4839
- */
4840
- id: string;
5238
+ email?: string;
4841
5239
  }
4842
5240
 
4843
5241
  export interface LineItem {
4844
5242
  /**
4845
- * The total amount of all line items, i.e. single amount \* quantity. Given in
4846
- * decimals, i.e. 10.23 represents EUR 10.23.
5243
+ * Accumulated cost in decimals. For example, for a lineItem with total price 3.00
5244
+ * and quantity 4, amount would be equal to 12.00.
4847
5245
  */
4848
5246
  amount: number;
4849
5247
 
4850
5248
  /**
4851
- * The name of the line item.
5249
+ * Customer-facing name of the line item.
4852
5250
  */
4853
5251
  name: string;
4854
5252
 
4855
- /**
4856
- * The quantity of the line item.
4857
- */
4858
- quantity: number;
4859
-
4860
- /**
4861
- * The net amount of a single item.
4862
- */
4863
5253
  singleNet: number;
4864
5254
 
4865
- /**
4866
- * The VAT amount of a single item.
4867
- */
4868
5255
  singleVat: number;
4869
5256
 
4870
- /**
4871
- * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
4872
- * the line item.
4873
- */
4874
- category?: string;
5257
+ category?:
5258
+ | '5045'
5259
+ | '5065'
5260
+ | '5094'
5261
+ | '5192'
5262
+ | '5193'
5263
+ | '5499'
5264
+ | '5655'
5265
+ | '5691'
5266
+ | '5712'
5267
+ | '5722'
5268
+ | '5812'
5269
+ | '5814'
5270
+ | '5912'
5271
+ | '5977'
5272
+ | '5999'
5273
+ | '7629';
4875
5274
 
4876
- /**
4877
- * The
4878
- * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
4879
- * of the line item.
4880
- */
4881
5275
  EAN?: string;
4882
5276
 
4883
5277
  /**
4884
- * The image of the line item as a URL.
5278
+ * An image of the line item. Valid URLs are accepted only.
4885
5279
  */
4886
5280
  image?: string;
4887
5281
 
4888
5282
  /**
4889
- * The internal unique identifier of the line item.
5283
+ * Quantity of this lineItem.
5284
+ */
5285
+ quantity?: number;
5286
+
5287
+ /**
5288
+ * An internal unique id stored to this line item.
4890
5289
  */
4891
5290
  referenceId?: string;
4892
5291
  }
4893
5292
 
4894
- /**
4895
- * The mandate setup for the payment. Relevant for
4896
- * [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
4897
- */
4898
5293
  export interface Mandate {
4899
- setup: boolean;
4900
-
4901
- /**
4902
- * The name of the account holder who signs the mandate
4903
- */
4904
5294
  accountHolderName?: string;
4905
5295
 
5296
+ additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
5297
+
4906
5298
  referenceId?: string;
4907
5299
 
5300
+ setup?: boolean;
5301
+
4908
5302
  userNotificationEmail?: string;
4909
5303
  }
4910
5304
 
5305
+ export namespace Mandate {
5306
+ export interface AdditionalDisplayInformation {
5307
+ cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
5308
+
5309
+ price?: AdditionalDisplayInformation.Price;
5310
+ }
5311
+
5312
+ export namespace AdditionalDisplayInformation {
5313
+ export interface Price {
5314
+ amount: number;
5315
+
5316
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
5317
+ }
5318
+ }
5319
+ }
5320
+
4911
5321
  /**
4912
- * Prefill known data to skip steps in the checkout.
5322
+ * The values specified here will be pre-filled in the Ivy Checkout.
4913
5323
  */
4914
5324
  export interface Prefill {
4915
5325
  /**
4916
- * The known bank id. Customers will skip the bank selection and go directly to the
4917
- * bank's login. Required for financial address prefill.
5326
+ * Retrieve a valid bankId with the POST /banks/search endpoint. When presented in
5327
+ * this field, the customer will skip the bank selection in the Ivy Checkout.
4918
5328
  */
4919
5329
  bankId?: string;
4920
5330
  }
4921
5331
 
4922
- /**
4923
- * The settlement destination of the payment. If not provided, the financial
4924
- * address of the merchant's direct payout destination will be used with a randomly
4925
- * generated payment reference.
4926
- */
4927
5332
  export interface SettlementDestination {
4928
- /**
4929
- * The payment reference of the payment. This will be displayed in the receiving
4930
- * bank account statement. For GBP payments the reference can be up to 18
4931
- * characters, otherwise 35.
4932
- */
4933
5333
  reference: string;
4934
5334
 
4935
- /**
4936
- * The validation logic is based on the "type" field. For example, if "type" is set
4937
- * to "iban", the "iban" object must be filled out.
4938
- */
4939
5335
  financialAddress?: SettlementDestination.FinancialAddress;
4940
5336
  }
4941
5337
 
4942
5338
  export namespace SettlementDestination {
4943
- /**
4944
- * The validation logic is based on the "type" field. For example, if "type" is set
4945
- * to "iban", the "iban" object must be filled out.
4946
- */
4947
5339
  export interface FinancialAddress {
4948
- /**
4949
- * The type of the financial address. The actual destination is determined by this
4950
- * field which can be either "iban", "sortCode", "bankCode", or "bban". The
4951
- * validation will fail if you set e.g. type="iban", but then not fill any values
4952
- * in the "iban" object.
4953
- *
4954
- * - iban: The IBAN of the account
4955
- * - sort_code: The sort code of the account
4956
- * - bank_code: The bank code of the account
4957
- * - bban: The BBAN of the account
4958
- */
4959
- type: string;
5340
+ psuData: FinancialAddress.PsuData | null;
5341
+
5342
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
4960
5343
 
4961
5344
  bankCode?: FinancialAddress.BankCode;
4962
5345
 
@@ -4964,14 +5347,29 @@ export namespace CheckoutsessionCreateParams {
4964
5347
 
4965
5348
  iban?: FinancialAddress.Iban;
4966
5349
 
5350
+ paymentReference?: string;
5351
+
4967
5352
  sortCode?: FinancialAddress.SortCode;
4968
5353
  }
4969
5354
 
4970
5355
  export namespace FinancialAddress {
5356
+ export interface PsuData {
5357
+ branchNumber?: string;
5358
+
5359
+ clientId?: string;
5360
+
5361
+ ipAddress?: string;
5362
+
5363
+ oib?: string;
5364
+
5365
+ psuId?: string;
5366
+
5367
+ ssn?: string;
5368
+
5369
+ username?: string;
5370
+ }
5371
+
4971
5372
  export interface BankCode {
4972
- /**
4973
- * The name of the account holder.
4974
- */
4975
5373
  accountHolderName: string;
4976
5374
 
4977
5375
  accountNumber: string;
@@ -4980,9 +5378,6 @@ export namespace CheckoutsessionCreateParams {
4980
5378
  }
4981
5379
 
4982
5380
  export interface Bban {
4983
- /**
4984
- * The name of the account holder.
4985
- */
4986
5381
  accountHolderName: string;
4987
5382
 
4988
5383
  bban: string;
@@ -4991,9 +5386,6 @@ export namespace CheckoutsessionCreateParams {
4991
5386
  }
4992
5387
 
4993
5388
  export interface Iban {
4994
- /**
4995
- * The name of the account holder.
4996
- */
4997
5389
  accountHolderName: string;
4998
5390
 
4999
5391
  iban: string;
@@ -5002,9 +5394,6 @@ export namespace CheckoutsessionCreateParams {
5002
5394
  }
5003
5395
 
5004
5396
  export interface SortCode {
5005
- /**
5006
- * The name of the account holder.
5007
- */
5008
5397
  accountHolderName: string;
5009
5398
 
5010
5399
  accountNumber: string;
@@ -5016,10 +5405,17 @@ export namespace CheckoutsessionCreateParams {
5016
5405
  }
5017
5406
 
5018
5407
  export interface CheckoutsessionRetrieveParams {
5408
+ /**
5409
+ * The checkout session id to retrieve details for
5410
+ */
5019
5411
  id: string;
5020
5412
  }
5021
5413
 
5022
5414
  export interface CheckoutsessionExpireParams {
5415
+ /**
5416
+ * The checkout session id to expire. By expiring a Checkout Session, users will
5417
+ * not be able to access this Checkout Session anymore.
5418
+ */
5023
5419
  id: string;
5024
5420
  }
5025
5421