@getivy/node-sdk 0.1.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (256) hide show
  1. package/CHANGELOG.md +130 -0
  2. package/LICENSE +201 -0
  3. package/README.md +303 -0
  4. package/_shims/MultipartBody.d.ts +9 -0
  5. package/_shims/MultipartBody.d.ts.map +1 -0
  6. package/_shims/MultipartBody.js +16 -0
  7. package/_shims/MultipartBody.js.map +1 -0
  8. package/_shims/MultipartBody.mjs +12 -0
  9. package/_shims/MultipartBody.mjs.map +1 -0
  10. package/_shims/README.md +46 -0
  11. package/_shims/auto/runtime-bun.d.ts +5 -0
  12. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  13. package/_shims/auto/runtime-bun.js +21 -0
  14. package/_shims/auto/runtime-bun.js.map +1 -0
  15. package/_shims/auto/runtime-bun.mjs +2 -0
  16. package/_shims/auto/runtime-bun.mjs.map +1 -0
  17. package/_shims/auto/runtime-node.d.ts +5 -0
  18. package/_shims/auto/runtime-node.d.ts.map +1 -0
  19. package/_shims/auto/runtime-node.js +21 -0
  20. package/_shims/auto/runtime-node.js.map +1 -0
  21. package/_shims/auto/runtime-node.mjs +2 -0
  22. package/_shims/auto/runtime-node.mjs.map +1 -0
  23. package/_shims/auto/runtime.d.ts +5 -0
  24. package/_shims/auto/runtime.d.ts.map +1 -0
  25. package/_shims/auto/runtime.js +21 -0
  26. package/_shims/auto/runtime.js.map +1 -0
  27. package/_shims/auto/runtime.mjs +2 -0
  28. package/_shims/auto/runtime.mjs.map +1 -0
  29. package/_shims/auto/types-node.d.ts +5 -0
  30. package/_shims/auto/types-node.d.ts.map +1 -0
  31. package/_shims/auto/types-node.js +21 -0
  32. package/_shims/auto/types-node.js.map +1 -0
  33. package/_shims/auto/types-node.mjs +2 -0
  34. package/_shims/auto/types-node.mjs.map +1 -0
  35. package/_shims/auto/types.d.ts +101 -0
  36. package/_shims/auto/types.js +3 -0
  37. package/_shims/auto/types.mjs +3 -0
  38. package/_shims/bun-runtime.d.ts +6 -0
  39. package/_shims/bun-runtime.d.ts.map +1 -0
  40. package/_shims/bun-runtime.js +14 -0
  41. package/_shims/bun-runtime.js.map +1 -0
  42. package/_shims/bun-runtime.mjs +10 -0
  43. package/_shims/bun-runtime.mjs.map +1 -0
  44. package/_shims/index.d.ts +81 -0
  45. package/_shims/index.js +13 -0
  46. package/_shims/index.mjs +7 -0
  47. package/_shims/manual-types.d.ts +12 -0
  48. package/_shims/manual-types.js +3 -0
  49. package/_shims/manual-types.mjs +3 -0
  50. package/_shims/node-runtime.d.ts +3 -0
  51. package/_shims/node-runtime.d.ts.map +1 -0
  52. package/_shims/node-runtime.js +89 -0
  53. package/_shims/node-runtime.js.map +1 -0
  54. package/_shims/node-runtime.mjs +56 -0
  55. package/_shims/node-runtime.mjs.map +1 -0
  56. package/_shims/node-types.d.ts +42 -0
  57. package/_shims/node-types.js +3 -0
  58. package/_shims/node-types.mjs +3 -0
  59. package/_shims/registry.d.ts +37 -0
  60. package/_shims/registry.d.ts.map +1 -0
  61. package/_shims/registry.js +41 -0
  62. package/_shims/registry.js.map +1 -0
  63. package/_shims/registry.mjs +37 -0
  64. package/_shims/registry.mjs.map +1 -0
  65. package/_shims/web-runtime.d.ts +5 -0
  66. package/_shims/web-runtime.d.ts.map +1 -0
  67. package/_shims/web-runtime.js +78 -0
  68. package/_shims/web-runtime.js.map +1 -0
  69. package/_shims/web-runtime.mjs +71 -0
  70. package/_shims/web-runtime.mjs.map +1 -0
  71. package/_shims/web-types.d.ts +83 -0
  72. package/_shims/web-types.js +3 -0
  73. package/_shims/web-types.mjs +3 -0
  74. package/core.d.ts +241 -0
  75. package/core.d.ts.map +1 -0
  76. package/core.js +915 -0
  77. package/core.js.map +1 -0
  78. package/core.mjs +883 -0
  79. package/core.mjs.map +1 -0
  80. package/error.d.ts +47 -0
  81. package/error.d.ts.map +1 -0
  82. package/error.js +113 -0
  83. package/error.js.map +1 -0
  84. package/error.mjs +97 -0
  85. package/error.mjs.map +1 -0
  86. package/index.d.mts +160 -0
  87. package/index.d.ts +160 -0
  88. package/index.d.ts.map +1 -0
  89. package/index.js +167 -0
  90. package/index.js.map +1 -0
  91. package/index.mjs +124 -0
  92. package/index.mjs.map +1 -0
  93. package/package.json +124 -0
  94. package/resource.d.ts +6 -0
  95. package/resource.d.ts.map +1 -0
  96. package/resource.js +11 -0
  97. package/resource.js.map +1 -0
  98. package/resource.mjs +7 -0
  99. package/resource.mjs.map +1 -0
  100. package/resources/balance.d.ts +34 -0
  101. package/resources/balance.d.ts.map +1 -0
  102. package/resources/balance.js +16 -0
  103. package/resources/balance.js.map +1 -0
  104. package/resources/balance.mjs +12 -0
  105. package/resources/balance.mjs.map +1 -0
  106. package/resources/banks.d.ts +235 -0
  107. package/resources/banks.d.ts.map +1 -0
  108. package/resources/banks.js +30 -0
  109. package/resources/banks.js.map +1 -0
  110. package/resources/banks.mjs +26 -0
  111. package/resources/banks.mjs.map +1 -0
  112. package/resources/capabilities.d.ts +28 -0
  113. package/resources/capabilities.d.ts.map +1 -0
  114. package/resources/capabilities.js +16 -0
  115. package/resources/capabilities.js.map +1 -0
  116. package/resources/capabilities.mjs +12 -0
  117. package/resources/capabilities.mjs.map +1 -0
  118. package/resources/charges.d.ts +73 -0
  119. package/resources/charges.d.ts.map +1 -0
  120. package/resources/charges.js +15 -0
  121. package/resources/charges.js.map +1 -0
  122. package/resources/charges.mjs +11 -0
  123. package/resources/charges.mjs.map +1 -0
  124. package/resources/checkoutsession.d.ts +1504 -0
  125. package/resources/checkoutsession.d.ts.map +1 -0
  126. package/resources/checkoutsession.js +30 -0
  127. package/resources/checkoutsession.js.map +1 -0
  128. package/resources/checkoutsession.mjs +26 -0
  129. package/resources/checkoutsession.mjs.map +1 -0
  130. package/resources/customers.d.ts +82 -0
  131. package/resources/customers.d.ts.map +1 -0
  132. package/resources/customers.js +21 -0
  133. package/resources/customers.js.map +1 -0
  134. package/resources/customers.mjs +17 -0
  135. package/resources/customers.mjs.map +1 -0
  136. package/resources/index.d.ts +14 -0
  137. package/resources/index.d.ts.map +1 -0
  138. package/resources/index.js +31 -0
  139. package/resources/index.js.map +1 -0
  140. package/resources/index.mjs +15 -0
  141. package/resources/index.mjs.map +1 -0
  142. package/resources/mandates.d.ts +91 -0
  143. package/resources/mandates.d.ts.map +1 -0
  144. package/resources/mandates.js +27 -0
  145. package/resources/mandates.js.map +1 -0
  146. package/resources/mandates.mjs +23 -0
  147. package/resources/mandates.mjs.map +1 -0
  148. package/resources/orders.d.ts +1239 -0
  149. package/resources/orders.d.ts.map +1 -0
  150. package/resources/orders.js +23 -0
  151. package/resources/orders.js.map +1 -0
  152. package/resources/orders.mjs +19 -0
  153. package/resources/orders.mjs.map +1 -0
  154. package/resources/payouts.d.ts +224 -0
  155. package/resources/payouts.d.ts.map +1 -0
  156. package/resources/payouts.js +28 -0
  157. package/resources/payouts.js.map +1 -0
  158. package/resources/payouts.mjs +24 -0
  159. package/resources/payouts.mjs.map +1 -0
  160. package/resources/refunds.d.ts +138 -0
  161. package/resources/refunds.d.ts.map +1 -0
  162. package/resources/refunds.js +28 -0
  163. package/resources/refunds.js.map +1 -0
  164. package/resources/refunds.mjs +24 -0
  165. package/resources/refunds.mjs.map +1 -0
  166. package/resources/reports.d.ts +120 -0
  167. package/resources/reports.d.ts.map +1 -0
  168. package/resources/reports.js +31 -0
  169. package/resources/reports.js.map +1 -0
  170. package/resources/reports.mjs +27 -0
  171. package/resources/reports.mjs.map +1 -0
  172. package/resources/subaccounts.d.ts +49 -0
  173. package/resources/subaccounts.d.ts.map +1 -0
  174. package/resources/subaccounts.js +22 -0
  175. package/resources/subaccounts.js.map +1 -0
  176. package/resources/subaccounts.mjs +18 -0
  177. package/resources/subaccounts.mjs.map +1 -0
  178. package/resources/webhooksubscription.d.ts +155 -0
  179. package/resources/webhooksubscription.d.ts.map +1 -0
  180. package/resources/webhooksubscription.js +42 -0
  181. package/resources/webhooksubscription.js.map +1 -0
  182. package/resources/webhooksubscription.mjs +38 -0
  183. package/resources/webhooksubscription.mjs.map +1 -0
  184. package/shims/node.d.ts +30 -0
  185. package/shims/node.d.ts.map +1 -0
  186. package/shims/node.js +31 -0
  187. package/shims/node.js.map +1 -0
  188. package/shims/node.mjs +5 -0
  189. package/shims/node.mjs.map +1 -0
  190. package/shims/web.d.ts +26 -0
  191. package/shims/web.d.ts.map +1 -0
  192. package/shims/web.js +31 -0
  193. package/shims/web.js.map +1 -0
  194. package/shims/web.mjs +5 -0
  195. package/shims/web.mjs.map +1 -0
  196. package/src/_shims/MultipartBody.ts +9 -0
  197. package/src/_shims/README.md +46 -0
  198. package/src/_shims/auto/runtime-bun.ts +4 -0
  199. package/src/_shims/auto/runtime-node.ts +4 -0
  200. package/src/_shims/auto/runtime.ts +4 -0
  201. package/src/_shims/auto/types-node.ts +4 -0
  202. package/src/_shims/auto/types.d.ts +101 -0
  203. package/src/_shims/auto/types.js +3 -0
  204. package/src/_shims/auto/types.mjs +3 -0
  205. package/src/_shims/bun-runtime.ts +14 -0
  206. package/src/_shims/index.d.ts +81 -0
  207. package/src/_shims/index.js +13 -0
  208. package/src/_shims/index.mjs +7 -0
  209. package/src/_shims/manual-types.d.ts +12 -0
  210. package/src/_shims/manual-types.js +3 -0
  211. package/src/_shims/manual-types.mjs +3 -0
  212. package/src/_shims/node-runtime.ts +81 -0
  213. package/src/_shims/node-types.d.ts +42 -0
  214. package/src/_shims/node-types.js +3 -0
  215. package/src/_shims/node-types.mjs +3 -0
  216. package/src/_shims/registry.ts +67 -0
  217. package/src/_shims/web-runtime.ts +103 -0
  218. package/src/_shims/web-types.d.ts +83 -0
  219. package/src/_shims/web-types.js +3 -0
  220. package/src/_shims/web-types.mjs +3 -0
  221. package/src/core.ts +1208 -0
  222. package/src/error.ts +130 -0
  223. package/src/index.ts +422 -0
  224. package/src/lib/.keep +4 -0
  225. package/src/resource.ts +11 -0
  226. package/src/resources/balance.ts +49 -0
  227. package/src/resources/banks.ts +1551 -0
  228. package/src/resources/capabilities.ts +291 -0
  229. package/src/resources/charges.ts +95 -0
  230. package/src/resources/checkoutsession.ts +6935 -0
  231. package/src/resources/customers.ts +111 -0
  232. package/src/resources/index.ts +88 -0
  233. package/src/resources/mandates.ts +135 -0
  234. package/src/resources/orders.ts +3174 -0
  235. package/src/resources/payouts.ts +297 -0
  236. package/src/resources/refunds.ts +183 -0
  237. package/src/resources/reports.ts +172 -0
  238. package/src/resources/subaccounts.ts +73 -0
  239. package/src/resources/webhooksubscription.ts +353 -0
  240. package/src/shims/node.ts +50 -0
  241. package/src/shims/web.ts +50 -0
  242. package/src/tsconfig.json +11 -0
  243. package/src/uploads.ts +255 -0
  244. package/src/version.ts +1 -0
  245. package/uploads.d.ts +75 -0
  246. package/uploads.d.ts.map +1 -0
  247. package/uploads.js +171 -0
  248. package/uploads.js.map +1 -0
  249. package/uploads.mjs +158 -0
  250. package/uploads.mjs.map +1 -0
  251. package/version.d.ts +2 -0
  252. package/version.d.ts.map +1 -0
  253. package/version.js +5 -0
  254. package/version.js.map +1 -0
  255. package/version.mjs +2 -0
  256. package/version.mjs.map +1 -0
@@ -0,0 +1,1504 @@
1
+ import { APIResource } from "../resource.js";
2
+ import * as Core from "../core.js";
3
+ export declare class Checkoutsession extends APIResource {
4
+ /**
5
+ * Creates a Checkout Session for the merchant corresponding to the given API key.
6
+ * See [the guide](https://docs.getivy.de/docs/payment-integration) for more
7
+ * information.
8
+ */
9
+ create(body: CheckoutsessionCreateParams, options?: Core.RequestOptions): Core.APIPromise<CheckoutsessionCreateResponse>;
10
+ /**
11
+ * Retrieve a Checkout Session and its details by Ivy id.
12
+ */
13
+ retrieve(body: CheckoutsessionRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<CheckoutsessionRetrieveResponse>;
14
+ /**
15
+ * Expire a Checkout Session by Ivy id. By expiring a Checkout Session, users will
16
+ * not be able to access this Checkout Session anymore.
17
+ */
18
+ expire(body: CheckoutsessionExpireParams, options?: Core.RequestOptions): Core.APIPromise<CheckoutsessionExpireResponse>;
19
+ }
20
+ export interface CheckoutsessionCreateResponse {
21
+ /**
22
+ * The unique identifier of the Checkout within Ivy.
23
+ */
24
+ id: string;
25
+ /**
26
+ * The markets where the user of the Checkout can select banks from.
27
+ */
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'>;
29
+ createdAt: string;
30
+ /**
31
+ * The customer facing id. This id is displayed to the user during the checkout and
32
+ * in the merchant dashboard.
33
+ */
34
+ displayId: string;
35
+ /**
36
+ * Required if not set in the dashboard. Users will be redirected here after an
37
+ * unsuccessful Payment attempt.
38
+ */
39
+ errorCallbackUrl: string;
40
+ merchant: CheckoutsessionCreateResponse.Merchant;
41
+ /**
42
+ * - `settlement`: The payment is initially settled into a virtual account. The
43
+ * funds are then disbursed in batches to the merchant. Refunds are instantly
44
+ * processed from the virtual account.
45
+ * - `direct`: The payment will be settled to the specified `settlementDestination`
46
+ * account. `settlementDestination` is required if `paymentMode` is `direct`.
47
+ */
48
+ paymentMode: 'settlement' | 'direct';
49
+ /**
50
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
51
+ * represents EUR 10.23. Any amount of decimal places can be provided on
52
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
53
+ * as this is the format accepted by most banks.
54
+ */
55
+ price: CheckoutsessionCreateResponse.Price;
56
+ redirectUrl: string;
57
+ /**
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.
61
+ */
62
+ referenceId: string;
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;
70
+ abortReason?: string;
71
+ appId?: string;
72
+ /**
73
+ * The billing address of the customer. Required when handshake=true.
74
+ */
75
+ billingAddress?: CheckoutsessionCreateResponse.BillingAddress;
76
+ /**
77
+ * The merchant category code or
78
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
79
+ */
80
+ category?: string;
81
+ /**
82
+ * Only applicable for express Checkouts. Complete Callback requests will be sent
83
+ * to this URL.
84
+ */
85
+ completeCallbackUrl?: string;
86
+ /**
87
+ * The Epoch time in seconds at which the Checkout Session was created. By default,
88
+ * time of Checkout creation at Ivy.
89
+ */
90
+ created?: number;
91
+ customer?: CheckoutsessionCreateResponse.Customer;
92
+ /**
93
+ * False by default. If set to true, customers cannot modify the pre-selected bank
94
+ * from `prefill.bankId`.
95
+ */
96
+ disableBankSelection?: boolean;
97
+ /**
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.
101
+ */
102
+ expiresAt?: number;
103
+ /**
104
+ * False by default. If set to true, the Checkout is displayed in express mode.
105
+ */
106
+ express?: boolean;
107
+ /**
108
+ * False by default. If set to true, customers skip email input and jump directly
109
+ * to their bank login. For express Checkout Sessions this is always false.
110
+ */
111
+ guest?: boolean;
112
+ /**
113
+ * If true, the order must be confirmed through the merchant with an additional
114
+ * complete callback endpoint. Always true for express sessions.
115
+ */
116
+ handshake?: boolean;
117
+ impactOffsetProjects?: Array<string>;
118
+ /**
119
+ * The incentive mode of the checkout session. For any use-case apart from
120
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
121
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
122
+ * session will contain sustainable incentives for users.
123
+ */
124
+ incentiveMode?: 'white_label' | 'sustainable';
125
+ lineItems?: Array<CheckoutsessionCreateResponse.LineItem>;
126
+ /**
127
+ * The locale of the Checkout. If provided, the Checkout will be displayed in the
128
+ * given language. Users can change the language in the Checkout. If not provided,
129
+ * the language of the Checkout is determined by the browser's language.
130
+ */
131
+ locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
132
+ mandate?: CheckoutsessionCreateResponse.Mandate;
133
+ /**
134
+ * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
135
+ * located. If provided, the Checkout will display the market's banks first. Not
136
+ * relevant if `prefill.bankId` is provided.
137
+ */
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;
143
+ /**
144
+ * Any data which will be stored and returned for this checkout session and
145
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
146
+ * more info.
147
+ */
148
+ metadata?: Record<string, unknown>;
149
+ offsetProject?: string;
150
+ paymentSchemeSelection?: string;
151
+ /**
152
+ * The shop-plugin version.
153
+ */
154
+ plugin?: string;
155
+ /**
156
+ * Prefill known data to skip steps in the checkout.
157
+ */
158
+ prefill?: CheckoutsessionCreateResponse.Prefill;
159
+ /**
160
+ * Only applicable for express Checkouts. Quote Callback requests will be sent to
161
+ * this URL.
162
+ */
163
+ quoteCallbackUrl?: string;
164
+ /**
165
+ * Only applicable for express Checkout Sessions. The given fields will be required
166
+ * input within the Ivy express Checkout.
167
+ */
168
+ required?: CheckoutsessionCreateResponse.Required;
169
+ selectedShippingMethodId?: string;
170
+ shippingAddress?: CheckoutsessionCreateResponse.ShippingAddress;
171
+ shippingMethods?: Array<CheckoutsessionCreateResponse.ShippingMethod>;
172
+ /**
173
+ * The logo of the shop provided as a URL.
174
+ */
175
+ shopLogo?: string;
176
+ shopName?: string;
177
+ subaccountId?: string;
178
+ }
179
+ export declare namespace CheckoutsessionCreateResponse {
180
+ interface Merchant {
181
+ id: string;
182
+ appId: string;
183
+ legalName: string;
184
+ address?: Merchant.Address;
185
+ }
186
+ namespace Merchant {
187
+ interface Address {
188
+ city: string;
189
+ /**
190
+ * The country code in
191
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
192
+ */
193
+ 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';
194
+ line1: string;
195
+ zipCode: string;
196
+ firstName?: string;
197
+ lastName?: string;
198
+ line2?: string;
199
+ region?: string;
200
+ }
201
+ }
202
+ /**
203
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
204
+ * represents EUR 10.23. Any amount of decimal places can be provided on
205
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
206
+ * as this is the format accepted by most banks.
207
+ */
208
+ interface Price {
209
+ currency: 'EUR' | 'GBP' | 'PLN';
210
+ /**
211
+ * The total amount to be paid.
212
+ */
213
+ total: number;
214
+ shipping?: number;
215
+ subTotal?: number;
216
+ totalNet?: number;
217
+ vat?: number;
218
+ }
219
+ /**
220
+ * The billing address of the customer. Required when handshake=true.
221
+ */
222
+ interface BillingAddress {
223
+ city: string;
224
+ /**
225
+ * The country code in
226
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
227
+ */
228
+ 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';
229
+ line1: string;
230
+ zipCode: string;
231
+ firstName?: string;
232
+ lastName?: string;
233
+ line2?: string;
234
+ region?: string;
235
+ }
236
+ interface Customer {
237
+ id: string;
238
+ }
239
+ /**
240
+ * The line items of the Checkout.
241
+ */
242
+ interface LineItem {
243
+ /**
244
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
245
+ * decimals, i.e. 10.23 represents EUR 10.23.
246
+ */
247
+ amount: number;
248
+ /**
249
+ * The name of the line item.
250
+ */
251
+ name: string;
252
+ /**
253
+ * The quantity of the line item.
254
+ */
255
+ quantity: number;
256
+ /**
257
+ * The net amount of a single item.
258
+ */
259
+ singleNet: number;
260
+ /**
261
+ * The VAT amount of a single item.
262
+ */
263
+ singleVat: number;
264
+ /**
265
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
266
+ * the line item.
267
+ */
268
+ category?: string;
269
+ /**
270
+ * The
271
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
272
+ * of the line item.
273
+ */
274
+ EAN?: string;
275
+ /**
276
+ * The image of the line item as a URL.
277
+ */
278
+ image?: string;
279
+ /**
280
+ * The internal unique identifier of the line item.
281
+ */
282
+ referenceId?: string;
283
+ }
284
+ interface Mandate {
285
+ setup: boolean;
286
+ /**
287
+ * The name of the account holder who signs the mandate
288
+ */
289
+ accountHolderName?: string;
290
+ referenceId?: string;
291
+ userNotificationEmail?: string;
292
+ }
293
+ /**
294
+ * Prefill known data to skip steps in the checkout.
295
+ */
296
+ interface Prefill {
297
+ /**
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.
300
+ */
301
+ bankId?: string;
302
+ }
303
+ /**
304
+ * Only applicable for express Checkout Sessions. The given fields will be required
305
+ * input within the Ivy express Checkout.
306
+ */
307
+ interface Required {
308
+ /**
309
+ * If set to true, the phone number will be required input within the Ivy express
310
+ * Checkout.
311
+ */
312
+ phone: boolean;
313
+ }
314
+ interface ShippingAddress {
315
+ city: string;
316
+ /**
317
+ * The country code in
318
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
319
+ */
320
+ 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';
321
+ line1: string;
322
+ zipCode: string;
323
+ firstName?: string;
324
+ lastName?: string;
325
+ line2?: string;
326
+ region?: string;
327
+ }
328
+ /**
329
+ * The shipping methods of the Checkout.
330
+ */
331
+ interface ShippingMethod {
332
+ /**
333
+ * The customer-facing name of the shipping method.
334
+ */
335
+ name: string;
336
+ /**
337
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
338
+ */
339
+ price: number;
340
+ /**
341
+ * The unique identifier of the shipping method within Ivy.
342
+ */
343
+ id?: string;
344
+ /**
345
+ * The list of countries where the shipping method is available.
346
+ */
347
+ 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'>;
348
+ /**
349
+ * The delivery estimate of the shipping method.
350
+ */
351
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
352
+ /**
353
+ * The unique identifier within your system of the shipping method.
354
+ */
355
+ reference?: string;
356
+ /**
357
+ * @deprecated Deprecated in favor of deliveryEstimate
358
+ */
359
+ timeFrame?: string;
360
+ }
361
+ namespace ShippingMethod {
362
+ /**
363
+ * The delivery estimate of the shipping method.
364
+ */
365
+ interface DeliveryEstimate {
366
+ /**
367
+ * The maximum delivery time.
368
+ */
369
+ maximum?: DeliveryEstimate.Maximum;
370
+ /**
371
+ * The minimum delivery time.
372
+ */
373
+ minimum?: DeliveryEstimate.Minimum;
374
+ }
375
+ namespace DeliveryEstimate {
376
+ /**
377
+ * The maximum delivery time.
378
+ */
379
+ interface Maximum {
380
+ /**
381
+ * The unit of the time duration.
382
+ */
383
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
384
+ /**
385
+ * The value of the time duration.
386
+ */
387
+ value: number;
388
+ }
389
+ /**
390
+ * The minimum delivery time.
391
+ */
392
+ interface Minimum {
393
+ /**
394
+ * The unit of the time duration.
395
+ */
396
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
397
+ /**
398
+ * The value of the time duration.
399
+ */
400
+ value: number;
401
+ }
402
+ }
403
+ }
404
+ }
405
+ export interface CheckoutsessionRetrieveResponse {
406
+ /**
407
+ * The unique identifier of the Checkout within Ivy.
408
+ */
409
+ id: string;
410
+ /**
411
+ * The markets where the user of the Checkout can select banks from.
412
+ */
413
+ availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
414
+ createdAt: string;
415
+ /**
416
+ * The customer facing id. This id is displayed to the user during the checkout and
417
+ * in the merchant dashboard.
418
+ */
419
+ displayId: string;
420
+ /**
421
+ * Required if not set in the dashboard. Users will be redirected here after an
422
+ * unsuccessful Payment attempt.
423
+ */
424
+ errorCallbackUrl: string;
425
+ merchant: CheckoutsessionRetrieveResponse.Merchant;
426
+ /**
427
+ * - `settlement`: The payment is initially settled into a virtual account. The
428
+ * funds are then disbursed in batches to the merchant. Refunds are instantly
429
+ * processed from the virtual account.
430
+ * - `direct`: The payment will be settled to the specified `settlementDestination`
431
+ * account. `settlementDestination` is required if `paymentMode` is `direct`.
432
+ */
433
+ paymentMode: 'settlement' | 'direct';
434
+ /**
435
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
436
+ * represents EUR 10.23. Any amount of decimal places can be provided on
437
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
438
+ * as this is the format accepted by most banks.
439
+ */
440
+ price: CheckoutsessionRetrieveResponse.Price;
441
+ redirectUrl: string;
442
+ /**
443
+ * An internal reference id which will be stored with the checkout & corresponding
444
+ * order. Needs to be unique per shop per order and can be up to 200 characters. We
445
+ * recommend to use your internal order id here.
446
+ */
447
+ referenceId: string;
448
+ status: 'open' | 'closed' | 'expired';
449
+ /**
450
+ * Required if not set in the dashboard. Users will be redirected here after a
451
+ * successful Payment attempt.
452
+ */
453
+ successCallbackUrl: string;
454
+ updatedAt: string;
455
+ abortReason?: string;
456
+ appId?: string;
457
+ /**
458
+ * The billing address of the customer. Required when handshake=true.
459
+ */
460
+ billingAddress?: CheckoutsessionRetrieveResponse.BillingAddress;
461
+ /**
462
+ * The merchant category code or
463
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
464
+ */
465
+ category?: string;
466
+ /**
467
+ * Only applicable for express Checkouts. Complete Callback requests will be sent
468
+ * to this URL.
469
+ */
470
+ completeCallbackUrl?: string;
471
+ /**
472
+ * The Epoch time in seconds at which the Checkout Session was created. By default,
473
+ * time of Checkout creation at Ivy.
474
+ */
475
+ created?: number;
476
+ customer?: CheckoutsessionRetrieveResponse.Customer;
477
+ /**
478
+ * False by default. If set to true, customers cannot modify the pre-selected bank
479
+ * from `prefill.bankId`.
480
+ */
481
+ disableBankSelection?: boolean;
482
+ /**
483
+ * The Epoch time in seconds at which the Checkout Session will expire. It can be
484
+ * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
485
+ * default, this value is 1 hour from creation.
486
+ */
487
+ expiresAt?: number;
488
+ /**
489
+ * False by default. If set to true, the Checkout is displayed in express mode.
490
+ */
491
+ express?: boolean;
492
+ /**
493
+ * False by default. If set to true, customers skip email input and jump directly
494
+ * to their bank login. For express Checkout Sessions this is always false.
495
+ */
496
+ guest?: boolean;
497
+ /**
498
+ * If true, the order must be confirmed through the merchant with an additional
499
+ * complete callback endpoint. Always true for express sessions.
500
+ */
501
+ handshake?: boolean;
502
+ impactOffsetProjects?: Array<string>;
503
+ /**
504
+ * The incentive mode of the checkout session. For any use-case apart from
505
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
506
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
507
+ * session will contain sustainable incentives for users.
508
+ */
509
+ incentiveMode?: 'white_label' | 'sustainable';
510
+ lineItems?: Array<CheckoutsessionRetrieveResponse.LineItem>;
511
+ /**
512
+ * The locale of the Checkout. If provided, the Checkout will be displayed in the
513
+ * given language. Users can change the language in the Checkout. If not provided,
514
+ * the language of the Checkout is determined by the browser's language.
515
+ */
516
+ locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
517
+ mandate?: CheckoutsessionRetrieveResponse.Mandate;
518
+ /**
519
+ * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
520
+ * located. If provided, the Checkout will display the market's banks first. Not
521
+ * relevant if `prefill.bankId` is provided.
522
+ */
523
+ market?: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
524
+ /**
525
+ * @deprecated Use merchant.appId instead
526
+ */
527
+ merchantAppId?: string;
528
+ /**
529
+ * Any data which will be stored and returned for this checkout session and
530
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
531
+ * more info.
532
+ */
533
+ metadata?: Record<string, unknown>;
534
+ offsetProject?: string;
535
+ paymentSchemeSelection?: string;
536
+ /**
537
+ * The shop-plugin version.
538
+ */
539
+ plugin?: string;
540
+ /**
541
+ * Prefill known data to skip steps in the checkout.
542
+ */
543
+ prefill?: CheckoutsessionRetrieveResponse.Prefill;
544
+ /**
545
+ * Only applicable for express Checkouts. Quote Callback requests will be sent to
546
+ * this URL.
547
+ */
548
+ quoteCallbackUrl?: string;
549
+ /**
550
+ * Only applicable for express Checkout Sessions. The given fields will be required
551
+ * input within the Ivy express Checkout.
552
+ */
553
+ required?: CheckoutsessionRetrieveResponse.Required;
554
+ selectedShippingMethodId?: string;
555
+ shippingAddress?: CheckoutsessionRetrieveResponse.ShippingAddress;
556
+ shippingMethods?: Array<CheckoutsessionRetrieveResponse.ShippingMethod>;
557
+ /**
558
+ * The logo of the shop provided as a URL.
559
+ */
560
+ shopLogo?: string;
561
+ shopName?: string;
562
+ subaccountId?: string;
563
+ }
564
+ export declare namespace CheckoutsessionRetrieveResponse {
565
+ interface Merchant {
566
+ id: string;
567
+ appId: string;
568
+ legalName: string;
569
+ address?: Merchant.Address;
570
+ }
571
+ namespace Merchant {
572
+ interface Address {
573
+ city: string;
574
+ /**
575
+ * The country code in
576
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
577
+ */
578
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
579
+ line1: string;
580
+ zipCode: string;
581
+ firstName?: string;
582
+ lastName?: string;
583
+ line2?: string;
584
+ region?: string;
585
+ }
586
+ }
587
+ /**
588
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
589
+ * represents EUR 10.23. Any amount of decimal places can be provided on
590
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
591
+ * as this is the format accepted by most banks.
592
+ */
593
+ interface Price {
594
+ currency: 'EUR' | 'GBP' | 'PLN';
595
+ /**
596
+ * The total amount to be paid.
597
+ */
598
+ total: number;
599
+ shipping?: number;
600
+ subTotal?: number;
601
+ totalNet?: number;
602
+ vat?: number;
603
+ }
604
+ /**
605
+ * The billing address of the customer. Required when handshake=true.
606
+ */
607
+ interface BillingAddress {
608
+ city: string;
609
+ /**
610
+ * The country code in
611
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
612
+ */
613
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
614
+ line1: string;
615
+ zipCode: string;
616
+ firstName?: string;
617
+ lastName?: string;
618
+ line2?: string;
619
+ region?: string;
620
+ }
621
+ interface Customer {
622
+ id: string;
623
+ }
624
+ /**
625
+ * The line items of the Checkout.
626
+ */
627
+ interface LineItem {
628
+ /**
629
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
630
+ * decimals, i.e. 10.23 represents EUR 10.23.
631
+ */
632
+ amount: number;
633
+ /**
634
+ * The name of the line item.
635
+ */
636
+ name: string;
637
+ /**
638
+ * The quantity of the line item.
639
+ */
640
+ quantity: number;
641
+ /**
642
+ * The net amount of a single item.
643
+ */
644
+ singleNet: number;
645
+ /**
646
+ * The VAT amount of a single item.
647
+ */
648
+ singleVat: number;
649
+ /**
650
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
651
+ * the line item.
652
+ */
653
+ category?: string;
654
+ /**
655
+ * The
656
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
657
+ * of the line item.
658
+ */
659
+ EAN?: string;
660
+ /**
661
+ * The image of the line item as a URL.
662
+ */
663
+ image?: string;
664
+ /**
665
+ * The internal unique identifier of the line item.
666
+ */
667
+ referenceId?: string;
668
+ }
669
+ interface Mandate {
670
+ setup: boolean;
671
+ /**
672
+ * The name of the account holder who signs the mandate
673
+ */
674
+ accountHolderName?: string;
675
+ referenceId?: string;
676
+ userNotificationEmail?: string;
677
+ }
678
+ /**
679
+ * Prefill known data to skip steps in the checkout.
680
+ */
681
+ interface Prefill {
682
+ /**
683
+ * The known bank id. Customers will skip the bank selection and go directly to the
684
+ * bank's login. Required for financial address prefill.
685
+ */
686
+ bankId?: string;
687
+ }
688
+ /**
689
+ * Only applicable for express Checkout Sessions. The given fields will be required
690
+ * input within the Ivy express Checkout.
691
+ */
692
+ interface Required {
693
+ /**
694
+ * If set to true, the phone number will be required input within the Ivy express
695
+ * Checkout.
696
+ */
697
+ phone: boolean;
698
+ }
699
+ interface ShippingAddress {
700
+ city: string;
701
+ /**
702
+ * The country code in
703
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
704
+ */
705
+ country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
706
+ line1: string;
707
+ zipCode: string;
708
+ firstName?: string;
709
+ lastName?: string;
710
+ line2?: string;
711
+ region?: string;
712
+ }
713
+ /**
714
+ * The shipping methods of the Checkout.
715
+ */
716
+ interface ShippingMethod {
717
+ /**
718
+ * The customer-facing name of the shipping method.
719
+ */
720
+ name: string;
721
+ /**
722
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
723
+ */
724
+ price: number;
725
+ /**
726
+ * The unique identifier of the shipping method within Ivy.
727
+ */
728
+ id?: string;
729
+ /**
730
+ * The list of countries where the shipping method is available.
731
+ */
732
+ countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
733
+ /**
734
+ * The delivery estimate of the shipping method.
735
+ */
736
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
737
+ /**
738
+ * The unique identifier within your system of the shipping method.
739
+ */
740
+ reference?: string;
741
+ /**
742
+ * @deprecated Deprecated in favor of deliveryEstimate
743
+ */
744
+ timeFrame?: string;
745
+ }
746
+ namespace ShippingMethod {
747
+ /**
748
+ * The delivery estimate of the shipping method.
749
+ */
750
+ interface DeliveryEstimate {
751
+ /**
752
+ * The maximum delivery time.
753
+ */
754
+ maximum?: DeliveryEstimate.Maximum;
755
+ /**
756
+ * The minimum delivery time.
757
+ */
758
+ minimum?: DeliveryEstimate.Minimum;
759
+ }
760
+ namespace DeliveryEstimate {
761
+ /**
762
+ * The maximum delivery time.
763
+ */
764
+ interface Maximum {
765
+ /**
766
+ * The unit of the time duration.
767
+ */
768
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
769
+ /**
770
+ * The value of the time duration.
771
+ */
772
+ value: number;
773
+ }
774
+ /**
775
+ * The minimum delivery time.
776
+ */
777
+ interface Minimum {
778
+ /**
779
+ * The unit of the time duration.
780
+ */
781
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
782
+ /**
783
+ * The value of the time duration.
784
+ */
785
+ value: number;
786
+ }
787
+ }
788
+ }
789
+ }
790
+ export interface CheckoutsessionExpireResponse {
791
+ /**
792
+ * The unique identifier of the Checkout within Ivy.
793
+ */
794
+ id: string;
795
+ /**
796
+ * The markets where the user of the Checkout can select banks from.
797
+ */
798
+ availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
799
+ createdAt: string;
800
+ /**
801
+ * The customer facing id. This id is displayed to the user during the checkout and
802
+ * in the merchant dashboard.
803
+ */
804
+ displayId: string;
805
+ /**
806
+ * Required if not set in the dashboard. Users will be redirected here after an
807
+ * unsuccessful Payment attempt.
808
+ */
809
+ errorCallbackUrl: string;
810
+ merchant: CheckoutsessionExpireResponse.Merchant;
811
+ /**
812
+ * - `settlement`: The payment is initially settled into a virtual account. The
813
+ * funds are then disbursed in batches to the merchant. Refunds are instantly
814
+ * processed from the virtual account.
815
+ * - `direct`: The payment will be settled to the specified `settlementDestination`
816
+ * account. `settlementDestination` is required if `paymentMode` is `direct`.
817
+ */
818
+ paymentMode: 'settlement' | 'direct';
819
+ /**
820
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
821
+ * represents EUR 10.23. Any amount of decimal places can be provided on
822
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
823
+ * as this is the format accepted by most banks.
824
+ */
825
+ price: CheckoutsessionExpireResponse.Price;
826
+ redirectUrl: string;
827
+ /**
828
+ * An internal reference id which will be stored with the checkout & corresponding
829
+ * order. Needs to be unique per shop per order and can be up to 200 characters. We
830
+ * recommend to use your internal order id here.
831
+ */
832
+ referenceId: string;
833
+ status: 'open' | 'closed' | 'expired';
834
+ /**
835
+ * Required if not set in the dashboard. Users will be redirected here after a
836
+ * successful Payment attempt.
837
+ */
838
+ successCallbackUrl: string;
839
+ updatedAt: string;
840
+ abortReason?: string;
841
+ appId?: string;
842
+ /**
843
+ * The billing address of the customer. Required when handshake=true.
844
+ */
845
+ billingAddress?: CheckoutsessionExpireResponse.BillingAddress;
846
+ /**
847
+ * The merchant category code or
848
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
849
+ */
850
+ category?: string;
851
+ /**
852
+ * Only applicable for express Checkouts. Complete Callback requests will be sent
853
+ * to this URL.
854
+ */
855
+ completeCallbackUrl?: string;
856
+ /**
857
+ * The Epoch time in seconds at which the Checkout Session was created. By default,
858
+ * time of Checkout creation at Ivy.
859
+ */
860
+ created?: number;
861
+ customer?: CheckoutsessionExpireResponse.Customer;
862
+ /**
863
+ * False by default. If set to true, customers cannot modify the pre-selected bank
864
+ * from `prefill.bankId`.
865
+ */
866
+ disableBankSelection?: boolean;
867
+ /**
868
+ * The Epoch time in seconds at which the Checkout Session will expire. It can be
869
+ * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
870
+ * default, this value is 1 hour from creation.
871
+ */
872
+ expiresAt?: number;
873
+ /**
874
+ * False by default. If set to true, the Checkout is displayed in express mode.
875
+ */
876
+ express?: boolean;
877
+ /**
878
+ * False by default. If set to true, customers skip email input and jump directly
879
+ * to their bank login. For express Checkout Sessions this is always false.
880
+ */
881
+ guest?: boolean;
882
+ /**
883
+ * If true, the order must be confirmed through the merchant with an additional
884
+ * complete callback endpoint. Always true for express sessions.
885
+ */
886
+ handshake?: boolean;
887
+ impactOffsetProjects?: Array<string>;
888
+ /**
889
+ * The incentive mode of the checkout session. For any use-case apart from
890
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
891
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
892
+ * session will contain sustainable incentives for users.
893
+ */
894
+ incentiveMode?: 'white_label' | 'sustainable';
895
+ lineItems?: Array<CheckoutsessionExpireResponse.LineItem>;
896
+ /**
897
+ * The locale of the Checkout. If provided, the Checkout will be displayed in the
898
+ * given language. Users can change the language in the Checkout. If not provided,
899
+ * the language of the Checkout is determined by the browser's language.
900
+ */
901
+ locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
902
+ mandate?: CheckoutsessionExpireResponse.Mandate;
903
+ /**
904
+ * ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
905
+ * located. If provided, the Checkout will display the market's banks first. Not
906
+ * relevant if `prefill.bankId` is provided.
907
+ */
908
+ market?: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
909
+ /**
910
+ * @deprecated Use merchant.appId instead
911
+ */
912
+ merchantAppId?: string;
913
+ /**
914
+ * Any data which will be stored and returned for this checkout session and
915
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
916
+ * more info.
917
+ */
918
+ metadata?: Record<string, unknown>;
919
+ offsetProject?: string;
920
+ paymentSchemeSelection?: string;
921
+ /**
922
+ * The shop-plugin version.
923
+ */
924
+ plugin?: string;
925
+ /**
926
+ * Prefill known data to skip steps in the checkout.
927
+ */
928
+ prefill?: CheckoutsessionExpireResponse.Prefill;
929
+ /**
930
+ * Only applicable for express Checkouts. Quote Callback requests will be sent to
931
+ * this URL.
932
+ */
933
+ quoteCallbackUrl?: string;
934
+ /**
935
+ * Only applicable for express Checkout Sessions. The given fields will be required
936
+ * input within the Ivy express Checkout.
937
+ */
938
+ required?: CheckoutsessionExpireResponse.Required;
939
+ selectedShippingMethodId?: string;
940
+ shippingAddress?: CheckoutsessionExpireResponse.ShippingAddress;
941
+ shippingMethods?: Array<CheckoutsessionExpireResponse.ShippingMethod>;
942
+ /**
943
+ * The logo of the shop provided as a URL.
944
+ */
945
+ shopLogo?: string;
946
+ shopName?: string;
947
+ subaccountId?: string;
948
+ }
949
+ export declare namespace CheckoutsessionExpireResponse {
950
+ interface Merchant {
951
+ id: string;
952
+ appId: string;
953
+ legalName: string;
954
+ address?: Merchant.Address;
955
+ }
956
+ namespace Merchant {
957
+ interface Address {
958
+ city: string;
959
+ /**
960
+ * The country code in
961
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
962
+ */
963
+ 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';
964
+ line1: string;
965
+ zipCode: string;
966
+ firstName?: string;
967
+ lastName?: string;
968
+ line2?: string;
969
+ region?: string;
970
+ }
971
+ }
972
+ /**
973
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
974
+ * represents EUR 10.23. Any amount of decimal places can be provided on
975
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
976
+ * as this is the format accepted by most banks.
977
+ */
978
+ interface Price {
979
+ currency: 'EUR' | 'GBP' | 'PLN';
980
+ /**
981
+ * The total amount to be paid.
982
+ */
983
+ total: number;
984
+ shipping?: number;
985
+ subTotal?: number;
986
+ totalNet?: number;
987
+ vat?: number;
988
+ }
989
+ /**
990
+ * The billing address of the customer. Required when handshake=true.
991
+ */
992
+ interface BillingAddress {
993
+ city: string;
994
+ /**
995
+ * The country code in
996
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
997
+ */
998
+ 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';
999
+ line1: string;
1000
+ zipCode: string;
1001
+ firstName?: string;
1002
+ lastName?: string;
1003
+ line2?: string;
1004
+ region?: string;
1005
+ }
1006
+ interface Customer {
1007
+ id: string;
1008
+ }
1009
+ /**
1010
+ * The line items of the Checkout.
1011
+ */
1012
+ interface LineItem {
1013
+ /**
1014
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
1015
+ * decimals, i.e. 10.23 represents EUR 10.23.
1016
+ */
1017
+ amount: number;
1018
+ /**
1019
+ * The name of the line item.
1020
+ */
1021
+ name: string;
1022
+ /**
1023
+ * The quantity of the line item.
1024
+ */
1025
+ quantity: number;
1026
+ /**
1027
+ * The net amount of a single item.
1028
+ */
1029
+ singleNet: number;
1030
+ /**
1031
+ * The VAT amount of a single item.
1032
+ */
1033
+ singleVat: number;
1034
+ /**
1035
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
1036
+ * the line item.
1037
+ */
1038
+ category?: string;
1039
+ /**
1040
+ * The
1041
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
1042
+ * of the line item.
1043
+ */
1044
+ EAN?: string;
1045
+ /**
1046
+ * The image of the line item as a URL.
1047
+ */
1048
+ image?: string;
1049
+ /**
1050
+ * The internal unique identifier of the line item.
1051
+ */
1052
+ referenceId?: string;
1053
+ }
1054
+ interface Mandate {
1055
+ setup: boolean;
1056
+ /**
1057
+ * The name of the account holder who signs the mandate
1058
+ */
1059
+ accountHolderName?: string;
1060
+ referenceId?: string;
1061
+ userNotificationEmail?: string;
1062
+ }
1063
+ /**
1064
+ * Prefill known data to skip steps in the checkout.
1065
+ */
1066
+ interface Prefill {
1067
+ /**
1068
+ * The known bank id. Customers will skip the bank selection and go directly to the
1069
+ * bank's login. Required for financial address prefill.
1070
+ */
1071
+ bankId?: string;
1072
+ }
1073
+ /**
1074
+ * Only applicable for express Checkout Sessions. The given fields will be required
1075
+ * input within the Ivy express Checkout.
1076
+ */
1077
+ interface Required {
1078
+ /**
1079
+ * If set to true, the phone number will be required input within the Ivy express
1080
+ * Checkout.
1081
+ */
1082
+ phone: boolean;
1083
+ }
1084
+ interface ShippingAddress {
1085
+ city: string;
1086
+ /**
1087
+ * The country code in
1088
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
1089
+ */
1090
+ 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';
1091
+ line1: string;
1092
+ zipCode: string;
1093
+ firstName?: string;
1094
+ lastName?: string;
1095
+ line2?: string;
1096
+ region?: string;
1097
+ }
1098
+ /**
1099
+ * The shipping methods of the Checkout.
1100
+ */
1101
+ interface ShippingMethod {
1102
+ /**
1103
+ * The customer-facing name of the shipping method.
1104
+ */
1105
+ name: string;
1106
+ /**
1107
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
1108
+ */
1109
+ price: number;
1110
+ /**
1111
+ * The unique identifier of the shipping method within Ivy.
1112
+ */
1113
+ id?: string;
1114
+ /**
1115
+ * The list of countries where the shipping method is available.
1116
+ */
1117
+ 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'>;
1118
+ /**
1119
+ * The delivery estimate of the shipping method.
1120
+ */
1121
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
1122
+ /**
1123
+ * The unique identifier within your system of the shipping method.
1124
+ */
1125
+ reference?: string;
1126
+ /**
1127
+ * @deprecated Deprecated in favor of deliveryEstimate
1128
+ */
1129
+ timeFrame?: string;
1130
+ }
1131
+ namespace ShippingMethod {
1132
+ /**
1133
+ * The delivery estimate of the shipping method.
1134
+ */
1135
+ interface DeliveryEstimate {
1136
+ /**
1137
+ * The maximum delivery time.
1138
+ */
1139
+ maximum?: DeliveryEstimate.Maximum;
1140
+ /**
1141
+ * The minimum delivery time.
1142
+ */
1143
+ minimum?: DeliveryEstimate.Minimum;
1144
+ }
1145
+ namespace DeliveryEstimate {
1146
+ /**
1147
+ * The maximum delivery time.
1148
+ */
1149
+ interface Maximum {
1150
+ /**
1151
+ * The unit of the time duration.
1152
+ */
1153
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1154
+ /**
1155
+ * The value of the time duration.
1156
+ */
1157
+ value: number;
1158
+ }
1159
+ /**
1160
+ * The minimum delivery time.
1161
+ */
1162
+ interface Minimum {
1163
+ /**
1164
+ * The unit of the time duration.
1165
+ */
1166
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1167
+ /**
1168
+ * The value of the time duration.
1169
+ */
1170
+ value: number;
1171
+ }
1172
+ }
1173
+ }
1174
+ }
1175
+ export interface CheckoutsessionCreateParams {
1176
+ /**
1177
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1178
+ * represents EUR 10.23. Any amount of decimal places can be provided on
1179
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
1180
+ * as this is the format accepted by most banks.
1181
+ */
1182
+ price: CheckoutsessionCreateParams.Price;
1183
+ /**
1184
+ * An internal reference id which will be stored with the checkout & corresponding
1185
+ * order. Needs to be unique per merchant per order and can be up to 200
1186
+ * characters. We recommend to use your internal unique id for this customer's
1187
+ * payment process.
1188
+ */
1189
+ referenceId: string;
1190
+ /**
1191
+ * The billing address of the customer.
1192
+ */
1193
+ billingAddress?: CheckoutsessionCreateParams.BillingAddress;
1194
+ /**
1195
+ * Only applicable for express Checkouts. Complete Callback requests will be sent
1196
+ * to this URL.
1197
+ */
1198
+ completeCallbackUrl?: string;
1199
+ /**
1200
+ * The Epoch time in seconds at which the Checkout Session was created. By default,
1201
+ * time of Checkout creation at Ivy.
1202
+ */
1203
+ created?: number;
1204
+ /**
1205
+ * The customer of the merchant.
1206
+ */
1207
+ customer?: CheckoutsessionCreateParams.Email | CheckoutsessionCreateParams.ID;
1208
+ /**
1209
+ * False by default. If set to true, customers cannot choose another bank than the
1210
+ * pre-selected one.
1211
+ */
1212
+ disableBankSelection?: boolean;
1213
+ /**
1214
+ * The customer facing id. This id is displayed to the user during the checkout and
1215
+ * in the merchant dashboard. It does not need to be unique and should be a
1216
+ * customer-friendly id.
1217
+ */
1218
+ displayId?: string;
1219
+ /**
1220
+ * Required if not set in the dashboard. Customers will be redirected here after an
1221
+ * unsuccessful payment attempt.
1222
+ */
1223
+ errorCallbackUrl?: string;
1224
+ /**
1225
+ * The Epoch time in seconds at which the Checkout Session will expire. It can be
1226
+ * anywhere from 30 minutes to 24 hours after Checkout Session creation. By
1227
+ * default, this value is 1 hour from creation.
1228
+ */
1229
+ expiresAt?: number;
1230
+ /**
1231
+ * Relevant for e-commerce only. If true, the checkout session will be an express
1232
+ * checkout session.
1233
+ */
1234
+ express?: boolean;
1235
+ /**
1236
+ * Relevant for e-commerce only. The line items of the checkout.
1237
+ */
1238
+ lineItems?: Array<CheckoutsessionCreateParams.LineItem>;
1239
+ /**
1240
+ * The locale of the customer, i.e. the language of the checkout. Customers can
1241
+ * change the language in the checkout. If not provided, the language of the
1242
+ * checkout is determined by the browser's language.
1243
+ */
1244
+ locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
1245
+ /**
1246
+ * The mandate setup for the payment. Relevant for
1247
+ * [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
1248
+ */
1249
+ mandate?: CheckoutsessionCreateParams.Mandate;
1250
+ /**
1251
+ * ISO 3166-1 alpha-2 country code. The market where the customer is located. If
1252
+ * provided, the checkout will display the market's default banks. Not relevant if
1253
+ * `prefill.bankId` is provided.
1254
+ */
1255
+ market?: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
1256
+ /**
1257
+ * Any data which will be stored and returned for this checkout session and
1258
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
1259
+ * more info.
1260
+ */
1261
+ metadata?: Array<Record<string, unknown>>;
1262
+ /**
1263
+ * - `settlement`: The payment is initially settled into a virtual account. The
1264
+ * funds are then disbursed in batches to the merchant. Refunds are instantly
1265
+ * processed from the virtual account.
1266
+ * - `direct`: The payment will be settled to the specified `settlementDestination`
1267
+ * account. `settlementDestination` is required if `paymentMode` is `direct`.
1268
+ */
1269
+ paymentMode?: 'settlement' | 'direct';
1270
+ /**
1271
+ * The scheme selection for the payment. `instant_only` enforces instant payments,
1272
+ * meaning no banks that do not support it can be selected. `instant_preferred`
1273
+ * means that the payment is done via instant rails, if supported by the bank. It
1274
+ * will use standard rails, if not supported by the bank. Standard means that only
1275
+ * cost-free, but potentially slower bank rails are used for the transfer. Defaults
1276
+ * to value set on merchant dashboard if not provided.
1277
+ */
1278
+ paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
1279
+ /**
1280
+ * Prefill known data to skip steps in the checkout.
1281
+ */
1282
+ prefill?: CheckoutsessionCreateParams.Prefill;
1283
+ /**
1284
+ * Only applicable for express Checkouts. Quote Callback requests will be sent to
1285
+ * this URL.
1286
+ */
1287
+ quoteCallbackUrl?: string;
1288
+ /**
1289
+ * The settlement destination of the payment. If not provided, the financial
1290
+ * address of the merchant's direct payout destination will be used with a randomly
1291
+ * generated payment reference.
1292
+ */
1293
+ settlementDestination?: CheckoutsessionCreateParams.SettlementDestination;
1294
+ /**
1295
+ * Usually relevant for PSPs. Create a subaccount for each underlying storefront or
1296
+ * merchant which processes payments with your Ivy account. You can create new
1297
+ * subaccounts [here](https://docs.getivy.de/reference/merchantsubaccountcreate-1)
1298
+ */
1299
+ subaccountId?: string;
1300
+ /**
1301
+ * Required if not set in the dashboard. Customers will be redirected here after a
1302
+ * successful payment attempt.
1303
+ */
1304
+ successCallbackUrl?: string;
1305
+ }
1306
+ export declare namespace CheckoutsessionCreateParams {
1307
+ /**
1308
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
1309
+ * represents EUR 10.23. Any amount of decimal places can be provided on
1310
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
1311
+ * as this is the format accepted by most banks.
1312
+ */
1313
+ interface Price {
1314
+ currency: 'EUR' | 'GBP' | 'PLN';
1315
+ /**
1316
+ * The total amount to be paid.
1317
+ */
1318
+ total: number;
1319
+ shipping?: number;
1320
+ subTotal?: number;
1321
+ totalNet?: number;
1322
+ vat?: number;
1323
+ }
1324
+ /**
1325
+ * The billing address of the customer.
1326
+ */
1327
+ interface BillingAddress {
1328
+ city: string;
1329
+ /**
1330
+ * The country code in
1331
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
1332
+ */
1333
+ 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';
1334
+ line1: string;
1335
+ zipCode: string;
1336
+ firstName?: string;
1337
+ lastName?: string;
1338
+ line2?: string;
1339
+ region?: string;
1340
+ }
1341
+ interface Email {
1342
+ /**
1343
+ * The email of the customer.
1344
+ */
1345
+ email: string;
1346
+ }
1347
+ interface ID {
1348
+ /**
1349
+ * The Ivy id of the customer.
1350
+ */
1351
+ id: string;
1352
+ }
1353
+ interface LineItem {
1354
+ /**
1355
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
1356
+ * decimals, i.e. 10.23 represents EUR 10.23.
1357
+ */
1358
+ amount: number;
1359
+ /**
1360
+ * The name of the line item.
1361
+ */
1362
+ name: string;
1363
+ /**
1364
+ * The quantity of the line item.
1365
+ */
1366
+ quantity: number;
1367
+ /**
1368
+ * The net amount of a single item.
1369
+ */
1370
+ singleNet: number;
1371
+ /**
1372
+ * The VAT amount of a single item.
1373
+ */
1374
+ singleVat: number;
1375
+ /**
1376
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
1377
+ * the line item.
1378
+ */
1379
+ category?: string;
1380
+ /**
1381
+ * The
1382
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
1383
+ * of the line item.
1384
+ */
1385
+ EAN?: string;
1386
+ /**
1387
+ * The image of the line item as a URL.
1388
+ */
1389
+ image?: string;
1390
+ /**
1391
+ * The internal unique identifier of the line item.
1392
+ */
1393
+ referenceId?: string;
1394
+ }
1395
+ /**
1396
+ * The mandate setup for the payment. Relevant for
1397
+ * [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
1398
+ */
1399
+ interface Mandate {
1400
+ setup: boolean;
1401
+ /**
1402
+ * The name of the account holder who signs the mandate
1403
+ */
1404
+ accountHolderName?: string;
1405
+ referenceId?: string;
1406
+ userNotificationEmail?: string;
1407
+ }
1408
+ /**
1409
+ * Prefill known data to skip steps in the checkout.
1410
+ */
1411
+ interface Prefill {
1412
+ /**
1413
+ * The known bank id. Customers will skip the bank selection and go directly to the
1414
+ * bank's login. Required for financial address prefill.
1415
+ */
1416
+ bankId?: string;
1417
+ }
1418
+ /**
1419
+ * The settlement destination of the payment. If not provided, the financial
1420
+ * address of the merchant's direct payout destination will be used with a randomly
1421
+ * generated payment reference.
1422
+ */
1423
+ interface SettlementDestination {
1424
+ /**
1425
+ * The payment reference of the payment. This will be displayed in the receiving
1426
+ * bank account statement. For GBP payments the reference can be up to 18
1427
+ * characters, otherwise 35.
1428
+ */
1429
+ reference: string;
1430
+ /**
1431
+ * The validation logic is based on the "type" field. For example, if "type" is set
1432
+ * to "iban", the "iban" object must be filled out.
1433
+ */
1434
+ financialAddress?: SettlementDestination.FinancialAddress;
1435
+ }
1436
+ namespace SettlementDestination {
1437
+ /**
1438
+ * The validation logic is based on the "type" field. For example, if "type" is set
1439
+ * to "iban", the "iban" object must be filled out.
1440
+ */
1441
+ interface FinancialAddress {
1442
+ /**
1443
+ * The type of the financial address. The actual destination is determined by this
1444
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
1445
+ * validation will fail if you set e.g. type="iban", but then not fill any values
1446
+ * in the "iban" object.
1447
+ *
1448
+ * - iban: The IBAN of the account
1449
+ * - sort_code: The sort code of the account
1450
+ * - bank_code: The bank code of the account
1451
+ * - bban: The BBAN of the account
1452
+ */
1453
+ type: string;
1454
+ bankCode?: FinancialAddress.BankCode;
1455
+ bban?: FinancialAddress.Bban;
1456
+ iban?: FinancialAddress.Iban;
1457
+ sortCode?: FinancialAddress.SortCode;
1458
+ }
1459
+ namespace FinancialAddress {
1460
+ interface BankCode {
1461
+ /**
1462
+ * The name of the account holder.
1463
+ */
1464
+ accountHolderName: string;
1465
+ accountNumber: string;
1466
+ code: string;
1467
+ }
1468
+ interface Bban {
1469
+ /**
1470
+ * The name of the account holder.
1471
+ */
1472
+ accountHolderName: string;
1473
+ bban: string;
1474
+ bic?: string;
1475
+ }
1476
+ interface Iban {
1477
+ /**
1478
+ * The name of the account holder.
1479
+ */
1480
+ accountHolderName: string;
1481
+ iban: string;
1482
+ bic?: string;
1483
+ }
1484
+ interface SortCode {
1485
+ /**
1486
+ * The name of the account holder.
1487
+ */
1488
+ accountHolderName: string;
1489
+ accountNumber: string;
1490
+ sortCode: string;
1491
+ }
1492
+ }
1493
+ }
1494
+ }
1495
+ export interface CheckoutsessionRetrieveParams {
1496
+ id: string;
1497
+ }
1498
+ export interface CheckoutsessionExpireParams {
1499
+ id: string;
1500
+ }
1501
+ export declare namespace Checkoutsession {
1502
+ export { type CheckoutsessionCreateResponse as CheckoutsessionCreateResponse, type CheckoutsessionRetrieveResponse as CheckoutsessionRetrieveResponse, type CheckoutsessionExpireResponse as CheckoutsessionExpireResponse, type CheckoutsessionCreateParams as CheckoutsessionCreateParams, type CheckoutsessionRetrieveParams as CheckoutsessionRetrieveParams, type CheckoutsessionExpireParams as CheckoutsessionExpireParams, };
1503
+ }
1504
+ //# sourceMappingURL=checkoutsession.d.ts.map