@getivy/node-sdk 0.1.0-alpha.2

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