@getivy/node-sdk 0.1.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (256) hide show
  1. package/CHANGELOG.md +130 -0
  2. package/LICENSE +201 -0
  3. package/README.md +303 -0
  4. package/_shims/MultipartBody.d.ts +9 -0
  5. package/_shims/MultipartBody.d.ts.map +1 -0
  6. package/_shims/MultipartBody.js +16 -0
  7. package/_shims/MultipartBody.js.map +1 -0
  8. package/_shims/MultipartBody.mjs +12 -0
  9. package/_shims/MultipartBody.mjs.map +1 -0
  10. package/_shims/README.md +46 -0
  11. package/_shims/auto/runtime-bun.d.ts +5 -0
  12. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  13. package/_shims/auto/runtime-bun.js +21 -0
  14. package/_shims/auto/runtime-bun.js.map +1 -0
  15. package/_shims/auto/runtime-bun.mjs +2 -0
  16. package/_shims/auto/runtime-bun.mjs.map +1 -0
  17. package/_shims/auto/runtime-node.d.ts +5 -0
  18. package/_shims/auto/runtime-node.d.ts.map +1 -0
  19. package/_shims/auto/runtime-node.js +21 -0
  20. package/_shims/auto/runtime-node.js.map +1 -0
  21. package/_shims/auto/runtime-node.mjs +2 -0
  22. package/_shims/auto/runtime-node.mjs.map +1 -0
  23. package/_shims/auto/runtime.d.ts +5 -0
  24. package/_shims/auto/runtime.d.ts.map +1 -0
  25. package/_shims/auto/runtime.js +21 -0
  26. package/_shims/auto/runtime.js.map +1 -0
  27. package/_shims/auto/runtime.mjs +2 -0
  28. package/_shims/auto/runtime.mjs.map +1 -0
  29. package/_shims/auto/types-node.d.ts +5 -0
  30. package/_shims/auto/types-node.d.ts.map +1 -0
  31. package/_shims/auto/types-node.js +21 -0
  32. package/_shims/auto/types-node.js.map +1 -0
  33. package/_shims/auto/types-node.mjs +2 -0
  34. package/_shims/auto/types-node.mjs.map +1 -0
  35. package/_shims/auto/types.d.ts +101 -0
  36. package/_shims/auto/types.js +3 -0
  37. package/_shims/auto/types.mjs +3 -0
  38. package/_shims/bun-runtime.d.ts +6 -0
  39. package/_shims/bun-runtime.d.ts.map +1 -0
  40. package/_shims/bun-runtime.js +14 -0
  41. package/_shims/bun-runtime.js.map +1 -0
  42. package/_shims/bun-runtime.mjs +10 -0
  43. package/_shims/bun-runtime.mjs.map +1 -0
  44. package/_shims/index.d.ts +81 -0
  45. package/_shims/index.js +13 -0
  46. package/_shims/index.mjs +7 -0
  47. package/_shims/manual-types.d.ts +12 -0
  48. package/_shims/manual-types.js +3 -0
  49. package/_shims/manual-types.mjs +3 -0
  50. package/_shims/node-runtime.d.ts +3 -0
  51. package/_shims/node-runtime.d.ts.map +1 -0
  52. package/_shims/node-runtime.js +89 -0
  53. package/_shims/node-runtime.js.map +1 -0
  54. package/_shims/node-runtime.mjs +56 -0
  55. package/_shims/node-runtime.mjs.map +1 -0
  56. package/_shims/node-types.d.ts +42 -0
  57. package/_shims/node-types.js +3 -0
  58. package/_shims/node-types.mjs +3 -0
  59. package/_shims/registry.d.ts +37 -0
  60. package/_shims/registry.d.ts.map +1 -0
  61. package/_shims/registry.js +41 -0
  62. package/_shims/registry.js.map +1 -0
  63. package/_shims/registry.mjs +37 -0
  64. package/_shims/registry.mjs.map +1 -0
  65. package/_shims/web-runtime.d.ts +5 -0
  66. package/_shims/web-runtime.d.ts.map +1 -0
  67. package/_shims/web-runtime.js +78 -0
  68. package/_shims/web-runtime.js.map +1 -0
  69. package/_shims/web-runtime.mjs +71 -0
  70. package/_shims/web-runtime.mjs.map +1 -0
  71. package/_shims/web-types.d.ts +83 -0
  72. package/_shims/web-types.js +3 -0
  73. package/_shims/web-types.mjs +3 -0
  74. package/core.d.ts +241 -0
  75. package/core.d.ts.map +1 -0
  76. package/core.js +915 -0
  77. package/core.js.map +1 -0
  78. package/core.mjs +883 -0
  79. package/core.mjs.map +1 -0
  80. package/error.d.ts +47 -0
  81. package/error.d.ts.map +1 -0
  82. package/error.js +113 -0
  83. package/error.js.map +1 -0
  84. package/error.mjs +97 -0
  85. package/error.mjs.map +1 -0
  86. package/index.d.mts +160 -0
  87. package/index.d.ts +160 -0
  88. package/index.d.ts.map +1 -0
  89. package/index.js +167 -0
  90. package/index.js.map +1 -0
  91. package/index.mjs +124 -0
  92. package/index.mjs.map +1 -0
  93. package/package.json +124 -0
  94. package/resource.d.ts +6 -0
  95. package/resource.d.ts.map +1 -0
  96. package/resource.js +11 -0
  97. package/resource.js.map +1 -0
  98. package/resource.mjs +7 -0
  99. package/resource.mjs.map +1 -0
  100. package/resources/balance.d.ts +34 -0
  101. package/resources/balance.d.ts.map +1 -0
  102. package/resources/balance.js +16 -0
  103. package/resources/balance.js.map +1 -0
  104. package/resources/balance.mjs +12 -0
  105. package/resources/balance.mjs.map +1 -0
  106. package/resources/banks.d.ts +235 -0
  107. package/resources/banks.d.ts.map +1 -0
  108. package/resources/banks.js +30 -0
  109. package/resources/banks.js.map +1 -0
  110. package/resources/banks.mjs +26 -0
  111. package/resources/banks.mjs.map +1 -0
  112. package/resources/capabilities.d.ts +28 -0
  113. package/resources/capabilities.d.ts.map +1 -0
  114. package/resources/capabilities.js +16 -0
  115. package/resources/capabilities.js.map +1 -0
  116. package/resources/capabilities.mjs +12 -0
  117. package/resources/capabilities.mjs.map +1 -0
  118. package/resources/charges.d.ts +73 -0
  119. package/resources/charges.d.ts.map +1 -0
  120. package/resources/charges.js +15 -0
  121. package/resources/charges.js.map +1 -0
  122. package/resources/charges.mjs +11 -0
  123. package/resources/charges.mjs.map +1 -0
  124. package/resources/checkoutsession.d.ts +1504 -0
  125. package/resources/checkoutsession.d.ts.map +1 -0
  126. package/resources/checkoutsession.js +30 -0
  127. package/resources/checkoutsession.js.map +1 -0
  128. package/resources/checkoutsession.mjs +26 -0
  129. package/resources/checkoutsession.mjs.map +1 -0
  130. package/resources/customers.d.ts +82 -0
  131. package/resources/customers.d.ts.map +1 -0
  132. package/resources/customers.js +21 -0
  133. package/resources/customers.js.map +1 -0
  134. package/resources/customers.mjs +17 -0
  135. package/resources/customers.mjs.map +1 -0
  136. package/resources/index.d.ts +14 -0
  137. package/resources/index.d.ts.map +1 -0
  138. package/resources/index.js +31 -0
  139. package/resources/index.js.map +1 -0
  140. package/resources/index.mjs +15 -0
  141. package/resources/index.mjs.map +1 -0
  142. package/resources/mandates.d.ts +91 -0
  143. package/resources/mandates.d.ts.map +1 -0
  144. package/resources/mandates.js +27 -0
  145. package/resources/mandates.js.map +1 -0
  146. package/resources/mandates.mjs +23 -0
  147. package/resources/mandates.mjs.map +1 -0
  148. package/resources/orders.d.ts +1239 -0
  149. package/resources/orders.d.ts.map +1 -0
  150. package/resources/orders.js +23 -0
  151. package/resources/orders.js.map +1 -0
  152. package/resources/orders.mjs +19 -0
  153. package/resources/orders.mjs.map +1 -0
  154. package/resources/payouts.d.ts +224 -0
  155. package/resources/payouts.d.ts.map +1 -0
  156. package/resources/payouts.js +28 -0
  157. package/resources/payouts.js.map +1 -0
  158. package/resources/payouts.mjs +24 -0
  159. package/resources/payouts.mjs.map +1 -0
  160. package/resources/refunds.d.ts +138 -0
  161. package/resources/refunds.d.ts.map +1 -0
  162. package/resources/refunds.js +28 -0
  163. package/resources/refunds.js.map +1 -0
  164. package/resources/refunds.mjs +24 -0
  165. package/resources/refunds.mjs.map +1 -0
  166. package/resources/reports.d.ts +120 -0
  167. package/resources/reports.d.ts.map +1 -0
  168. package/resources/reports.js +31 -0
  169. package/resources/reports.js.map +1 -0
  170. package/resources/reports.mjs +27 -0
  171. package/resources/reports.mjs.map +1 -0
  172. package/resources/subaccounts.d.ts +49 -0
  173. package/resources/subaccounts.d.ts.map +1 -0
  174. package/resources/subaccounts.js +22 -0
  175. package/resources/subaccounts.js.map +1 -0
  176. package/resources/subaccounts.mjs +18 -0
  177. package/resources/subaccounts.mjs.map +1 -0
  178. package/resources/webhooksubscription.d.ts +155 -0
  179. package/resources/webhooksubscription.d.ts.map +1 -0
  180. package/resources/webhooksubscription.js +42 -0
  181. package/resources/webhooksubscription.js.map +1 -0
  182. package/resources/webhooksubscription.mjs +38 -0
  183. package/resources/webhooksubscription.mjs.map +1 -0
  184. package/shims/node.d.ts +30 -0
  185. package/shims/node.d.ts.map +1 -0
  186. package/shims/node.js +31 -0
  187. package/shims/node.js.map +1 -0
  188. package/shims/node.mjs +5 -0
  189. package/shims/node.mjs.map +1 -0
  190. package/shims/web.d.ts +26 -0
  191. package/shims/web.d.ts.map +1 -0
  192. package/shims/web.js +31 -0
  193. package/shims/web.js.map +1 -0
  194. package/shims/web.mjs +5 -0
  195. package/shims/web.mjs.map +1 -0
  196. package/src/_shims/MultipartBody.ts +9 -0
  197. package/src/_shims/README.md +46 -0
  198. package/src/_shims/auto/runtime-bun.ts +4 -0
  199. package/src/_shims/auto/runtime-node.ts +4 -0
  200. package/src/_shims/auto/runtime.ts +4 -0
  201. package/src/_shims/auto/types-node.ts +4 -0
  202. package/src/_shims/auto/types.d.ts +101 -0
  203. package/src/_shims/auto/types.js +3 -0
  204. package/src/_shims/auto/types.mjs +3 -0
  205. package/src/_shims/bun-runtime.ts +14 -0
  206. package/src/_shims/index.d.ts +81 -0
  207. package/src/_shims/index.js +13 -0
  208. package/src/_shims/index.mjs +7 -0
  209. package/src/_shims/manual-types.d.ts +12 -0
  210. package/src/_shims/manual-types.js +3 -0
  211. package/src/_shims/manual-types.mjs +3 -0
  212. package/src/_shims/node-runtime.ts +81 -0
  213. package/src/_shims/node-types.d.ts +42 -0
  214. package/src/_shims/node-types.js +3 -0
  215. package/src/_shims/node-types.mjs +3 -0
  216. package/src/_shims/registry.ts +67 -0
  217. package/src/_shims/web-runtime.ts +103 -0
  218. package/src/_shims/web-types.d.ts +83 -0
  219. package/src/_shims/web-types.js +3 -0
  220. package/src/_shims/web-types.mjs +3 -0
  221. package/src/core.ts +1208 -0
  222. package/src/error.ts +130 -0
  223. package/src/index.ts +422 -0
  224. package/src/lib/.keep +4 -0
  225. package/src/resource.ts +11 -0
  226. package/src/resources/balance.ts +49 -0
  227. package/src/resources/banks.ts +1551 -0
  228. package/src/resources/capabilities.ts +291 -0
  229. package/src/resources/charges.ts +95 -0
  230. package/src/resources/checkoutsession.ts +6935 -0
  231. package/src/resources/customers.ts +111 -0
  232. package/src/resources/index.ts +88 -0
  233. package/src/resources/mandates.ts +135 -0
  234. package/src/resources/orders.ts +3174 -0
  235. package/src/resources/payouts.ts +297 -0
  236. package/src/resources/refunds.ts +183 -0
  237. package/src/resources/reports.ts +172 -0
  238. package/src/resources/subaccounts.ts +73 -0
  239. package/src/resources/webhooksubscription.ts +353 -0
  240. package/src/shims/node.ts +50 -0
  241. package/src/shims/web.ts +50 -0
  242. package/src/tsconfig.json +11 -0
  243. package/src/uploads.ts +255 -0
  244. package/src/version.ts +1 -0
  245. package/uploads.d.ts +75 -0
  246. package/uploads.d.ts.map +1 -0
  247. package/uploads.js +171 -0
  248. package/uploads.js.map +1 -0
  249. package/uploads.mjs +158 -0
  250. package/uploads.mjs.map +1 -0
  251. package/version.d.ts +2 -0
  252. package/version.d.ts.map +1 -0
  253. package/version.js +5 -0
  254. package/version.js.map +1 -0
  255. package/version.mjs +2 -0
  256. package/version.mjs.map +1 -0
@@ -0,0 +1,1239 @@
1
+ import { APIResource } from "../resource.js";
2
+ import * as Core from "../core.js";
3
+ export declare class Orders extends APIResource {
4
+ /**
5
+ * Retrieve details of an order. You can retrieve the order by passing either the
6
+ * internal Ivy order id or the `referenceId` you specified when creating a
7
+ * Checkout Session to the `id` field.
8
+ */
9
+ retrieve(body: OrderRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<OrderRetrieveResponse>;
10
+ /**
11
+ * Update certain fields of the specified order.
12
+ */
13
+ update(body: OrderUpdateParams, options?: Core.RequestOptions): Core.APIPromise<OrderUpdateResponse>;
14
+ }
15
+ export interface OrderRetrieveResponse {
16
+ /**
17
+ * The Ivy unique identifier for the order.
18
+ */
19
+ id: string;
20
+ /**
21
+ * @deprecated The unique identifier for the merchantApp which initiated the order
22
+ * / payment attempt.
23
+ */
24
+ appId: string;
25
+ /**
26
+ * The Ivy fee for the payment.
27
+ */
28
+ applicationFeeAmount: number;
29
+ createdAt: string;
30
+ instantPaymentScheme: boolean;
31
+ /**
32
+ * @deprecated Deprecated in favor of `appId`.
33
+ */
34
+ merchantAppId: string;
35
+ /**
36
+ * The unique identifier for the merchant which initiated the order / payment
37
+ * attempt.
38
+ */
39
+ merchantId: string;
40
+ /**
41
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
42
+ * represents EUR 10.23. Any amount of decimal places can be provided on
43
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
44
+ * as this is the format accepted by most banks.
45
+ */
46
+ price: OrderRetrieveResponse.Price;
47
+ /**
48
+ * An internal reference id which will be stored with the checkout & corresponding
49
+ * order. Needs to be unique per shop per order and can be up to 200 characters.
50
+ */
51
+ referenceId: string;
52
+ /**
53
+ * The name of the merchant which initiated the order.
54
+ */
55
+ shopName: string;
56
+ /**
57
+ * The order status. This status symbolises the state of the user's payment
58
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
59
+ * information.
60
+ */
61
+ status: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused';
62
+ updatedAt: string;
63
+ /**
64
+ * The unique identifier of Ivy of the chosen bank to make the payment. Not there,
65
+ * if no payment was made.
66
+ */
67
+ bankId?: string;
68
+ /**
69
+ * The bank statement reference of the payment for the order. This is the reference
70
+ * that will be visible on the bank statement.
71
+ */
72
+ bankStatementReference?: string;
73
+ /**
74
+ * The billing address of the user. Required when handshake=true.
75
+ */
76
+ billingAddress?: OrderRetrieveResponse.BillingAddress;
77
+ /**
78
+ * The merchant category code or
79
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
80
+ */
81
+ category?: string;
82
+ /**
83
+ * @deprecated
84
+ */
85
+ climateActionMode?: OrderRetrieveResponse.ClimateActionMode;
86
+ /**
87
+ * @deprecated
88
+ */
89
+ co2Grams?: number;
90
+ /**
91
+ * The unique identifier of the customer who placed the order.
92
+ */
93
+ customerId?: string;
94
+ /**
95
+ * The customer facing id. This id is displayed to the user during the checkout and
96
+ * in the merchant dashboard.
97
+ */
98
+ displayId?: string;
99
+ /**
100
+ * False by default. If set to true, customers skip email input and jump directly
101
+ * to their bank login. For express Checkout Sessions this is always false.
102
+ */
103
+ guest?: boolean;
104
+ /**
105
+ * Only valid for sustainable incentive mode. The social / sustainable projects
106
+ * available to the user during Checkout.
107
+ */
108
+ impactOffsetProjects?: Array<string>;
109
+ /**
110
+ * The incentive mode of the checkout session. For any use-case apart from
111
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
112
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
113
+ * session will contain sustainable incentives for users.
114
+ */
115
+ incentiveMode?: 'white_label' | 'sustainable';
116
+ /**
117
+ * The line items of the Checkout.
118
+ */
119
+ lineItems?: Array<OrderRetrieveResponse.LineItem>;
120
+ mandate?: OrderRetrieveResponse.Mandate;
121
+ /**
122
+ * The destination bank account where the money will be sent to.
123
+ */
124
+ merchantFinancialAddress?: OrderRetrieveResponse.MerchantFinancialAddress;
125
+ /**
126
+ * Any data which will be stored and returned for this checkout session and
127
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
128
+ * more info.
129
+ */
130
+ metadata?: Record<string, unknown>;
131
+ /**
132
+ * Only valid for sustainable incentive mode. The social / sustainability project
133
+ * chosen by the user during Checkout.
134
+ */
135
+ offsetProject?: string;
136
+ /**
137
+ * The source bank account where the money is send from.
138
+ */
139
+ payerFinancialAddress?: OrderRetrieveResponse.PayerFinancialAddress;
140
+ paymentMethodType?: 'sepa_debit' | 'customer_balance';
141
+ /**
142
+ * The payment mode of the order. Can be either 'settlement' or 'direct'.
143
+ */
144
+ paymentMode?: 'settlement' | 'direct';
145
+ /**
146
+ * @deprecated Deprecated in favor of `status`. Do not use this field to trigger
147
+ * actions in your system.
148
+ */
149
+ paymentStatus?: 'failed' | 'canceled' | 'processing' | 'requires_action' | 'succeeded' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'not_settled' | 'disputed';
150
+ /**
151
+ * The total amount in the currency of all successful refunds for this order
152
+ */
153
+ refundAmount?: number;
154
+ /**
155
+ * The list of refunds connected to this order.
156
+ */
157
+ refunds?: Array<OrderRetrieveResponse.Refund>;
158
+ /**
159
+ * The shipping address of the user. This is only collected in express Checkouts.
160
+ */
161
+ shippingAddress?: OrderRetrieveResponse.ShippingAddress;
162
+ /**
163
+ * The selected shipping method by the user. Can either be selected during an
164
+ * express Checkout Session or passed during Checkout Session creation.
165
+ */
166
+ shippingMethod?: OrderRetrieveResponse.ShippingMethod;
167
+ /**
168
+ * The logo of the shop provided as a URL.
169
+ */
170
+ shopLogo?: string;
171
+ /**
172
+ * The shopper object. Contains information collected from the user during the
173
+ * Checkout.
174
+ */
175
+ shopper?: OrderRetrieveResponse.Shopper;
176
+ /**
177
+ * @deprecated Deprecated in favor of `shopper.email`. The email of the user if
178
+ * collected in the Checkout.
179
+ */
180
+ shopperEmail?: string;
181
+ statusClassification?: OrderRetrieveResponse.StatusClassification;
182
+ /**
183
+ * List of status history items for the order, used for logging every update on
184
+ * status.
185
+ */
186
+ statusHistoryList?: Array<OrderRetrieveResponse.StatusHistoryList>;
187
+ /**
188
+ * The subaccount id of the order.
189
+ */
190
+ subaccountId?: string;
191
+ /**
192
+ * The legal name of the subaccount
193
+ */
194
+ subaccountLegalName?: string;
195
+ /**
196
+ * @deprecated
197
+ */
198
+ trees?: number;
199
+ }
200
+ export declare namespace OrderRetrieveResponse {
201
+ /**
202
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
203
+ * represents EUR 10.23. Any amount of decimal places can be provided on
204
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
205
+ * as this is the format accepted by most banks.
206
+ */
207
+ interface Price {
208
+ currency: 'EUR' | 'GBP' | 'PLN';
209
+ /**
210
+ * The total amount to be paid.
211
+ */
212
+ total: number;
213
+ shipping?: number;
214
+ subTotal?: number;
215
+ totalNet?: number;
216
+ vat?: number;
217
+ }
218
+ /**
219
+ * The billing address of the user. Required when handshake=true.
220
+ */
221
+ interface BillingAddress {
222
+ city: string;
223
+ /**
224
+ * The country code in
225
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
226
+ */
227
+ 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';
228
+ line1: string;
229
+ zipCode: string;
230
+ firstName?: string;
231
+ lastName?: string;
232
+ line2?: string;
233
+ region?: string;
234
+ }
235
+ /**
236
+ * @deprecated
237
+ */
238
+ interface ClimateActionMode {
239
+ amount: number;
240
+ type: 'transaction' | 'amount';
241
+ }
242
+ interface LineItem {
243
+ /**
244
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
245
+ * decimals, i.e. 10.23 represents EUR 10.23.
246
+ */
247
+ amount: number;
248
+ /**
249
+ * The name of the line item.
250
+ */
251
+ name: string;
252
+ /**
253
+ * The quantity of the line item.
254
+ */
255
+ quantity: number;
256
+ /**
257
+ * The net amount of a single item.
258
+ */
259
+ singleNet: number;
260
+ /**
261
+ * The VAT amount of a single item.
262
+ */
263
+ singleVat: number;
264
+ /**
265
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
266
+ * the line item.
267
+ */
268
+ category?: string;
269
+ /**
270
+ * The
271
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
272
+ * of the line item.
273
+ */
274
+ EAN?: string;
275
+ /**
276
+ * The image of the line item as a URL.
277
+ */
278
+ image?: string;
279
+ /**
280
+ * The internal unique identifier of the line item.
281
+ */
282
+ referenceId?: string;
283
+ }
284
+ interface Mandate {
285
+ /**
286
+ * The name of the account holder who signs the mandate.
287
+ */
288
+ accountHolderName?: string;
289
+ /**
290
+ * Additional information to display to the user during the mandate setup. This
291
+ * information is not used to setup any recurrence on the mandate. It is only
292
+ * displayed to the user during checkout.
293
+ */
294
+ additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
295
+ /**
296
+ * Mandate creditor data
297
+ */
298
+ creditor?: Mandate.Creditor;
299
+ /**
300
+ * The reference of the mandate going to be setup
301
+ */
302
+ reference?: string;
303
+ /**
304
+ * The mandate referenceId. Set this to match incoming `mandate_setup_started`,
305
+ * `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
306
+ * mandate setup request.
307
+ */
308
+ referenceId?: string;
309
+ /**
310
+ * If true, a ready to use mandate will be set up after the payment flow.
311
+ */
312
+ setup?: boolean;
313
+ /**
314
+ * The email of the user who signs the mandate.
315
+ */
316
+ userNotificationEmail?: string;
317
+ }
318
+ namespace Mandate {
319
+ /**
320
+ * Additional information to display to the user during the mandate setup. This
321
+ * information is not used to setup any recurrence on the mandate. It is only
322
+ * displayed to the user during checkout.
323
+ */
324
+ interface AdditionalDisplayInformation {
325
+ /**
326
+ * The intended cadence of charges used for displaying purpose only. On demand
327
+ * would be used for unscheduled charges.
328
+ */
329
+ cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
330
+ price?: AdditionalDisplayInformation.Price;
331
+ }
332
+ namespace AdditionalDisplayInformation {
333
+ interface Price {
334
+ /**
335
+ * The amount displayed to the user as decimal e.g. 10.23 would be displayed as
336
+ * 10.23 EUR.
337
+ */
338
+ amount?: number;
339
+ currency?: 'EUR' | 'GBP' | 'PLN';
340
+ }
341
+ }
342
+ /**
343
+ * Mandate creditor data
344
+ */
345
+ interface Creditor {
346
+ id?: string;
347
+ name?: string;
348
+ }
349
+ }
350
+ /**
351
+ * The destination bank account where the money will be sent to.
352
+ */
353
+ interface MerchantFinancialAddress {
354
+ bankCode?: MerchantFinancialAddress.BankCode;
355
+ bban?: MerchantFinancialAddress.Bban;
356
+ iban?: MerchantFinancialAddress.Iban;
357
+ /**
358
+ * The payment reference for the order. This is the reference that will be visible
359
+ * on the bank statement.
360
+ */
361
+ paymentReference?: string;
362
+ sortCode?: MerchantFinancialAddress.SortCode;
363
+ /**
364
+ * The type of the financial address. The actual destination is determined by this
365
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
366
+ * validation will fail if you set e.g. type="iban", but then not fill any values
367
+ * in the "iban" object.
368
+ *
369
+ * - iban: The IBAN of the account
370
+ * - sort_code: The sort code of the account
371
+ * - bank_code: The bank code of the account
372
+ * - bban: The BBAN of the account
373
+ */
374
+ type?: string;
375
+ }
376
+ namespace MerchantFinancialAddress {
377
+ interface BankCode {
378
+ /**
379
+ * The name of the account holder.
380
+ */
381
+ accountHolderName: string;
382
+ accountNumber: string;
383
+ code: string;
384
+ }
385
+ interface Bban {
386
+ /**
387
+ * The name of the account holder.
388
+ */
389
+ accountHolderName: string;
390
+ bban: string;
391
+ bic?: string;
392
+ }
393
+ interface Iban {
394
+ /**
395
+ * The name of the account holder.
396
+ */
397
+ accountHolderName: string;
398
+ iban: string;
399
+ bic?: string;
400
+ }
401
+ interface SortCode {
402
+ /**
403
+ * The name of the account holder.
404
+ */
405
+ accountHolderName: string;
406
+ accountNumber: string;
407
+ sortCode: string;
408
+ }
409
+ }
410
+ /**
411
+ * The source bank account where the money is send from.
412
+ */
413
+ interface PayerFinancialAddress {
414
+ /**
415
+ * The type of the financial address. The actual destination is determined by this
416
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
417
+ * validation will fail if you set e.g. type="iban", but then not fill any values
418
+ * in the "iban" object.
419
+ *
420
+ * - iban: The IBAN of the account
421
+ * - sort_code: The sort code of the account
422
+ * - bank_code: The bank code of the account
423
+ * - bban: The BBAN of the account
424
+ */
425
+ type: string;
426
+ bankCode?: PayerFinancialAddress.BankCode;
427
+ bban?: PayerFinancialAddress.Bban;
428
+ iban?: PayerFinancialAddress.Iban;
429
+ sortCode?: PayerFinancialAddress.SortCode;
430
+ }
431
+ namespace PayerFinancialAddress {
432
+ interface BankCode {
433
+ accountNumber: string;
434
+ code: string;
435
+ /**
436
+ * The name of the account holder.
437
+ */
438
+ accountHolderName?: string;
439
+ }
440
+ interface Bban {
441
+ bban: string;
442
+ /**
443
+ * The name of the account holder.
444
+ */
445
+ accountHolderName?: string;
446
+ bic?: string;
447
+ }
448
+ interface Iban {
449
+ iban: string;
450
+ /**
451
+ * The name of the account holder.
452
+ */
453
+ accountHolderName?: string;
454
+ bic?: string;
455
+ }
456
+ interface SortCode {
457
+ accountNumber: string;
458
+ sortCode: string;
459
+ /**
460
+ * The name of the account holder.
461
+ */
462
+ accountHolderName?: string;
463
+ }
464
+ }
465
+ /**
466
+ * A Refund object. This corresponds to one Refund request.
467
+ */
468
+ interface Refund {
469
+ id: string;
470
+ amount: number;
471
+ createdAt: string;
472
+ referenceId: string;
473
+ /**
474
+ * The status of the refund. Always use the status of the order as your source of
475
+ * truth to trigger actions in your dashboard.
476
+ */
477
+ status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
478
+ updatedAt: string;
479
+ description?: string;
480
+ }
481
+ /**
482
+ * The shipping address of the user. This is only collected in express Checkouts.
483
+ */
484
+ interface ShippingAddress {
485
+ city: string;
486
+ /**
487
+ * The country code in
488
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
489
+ */
490
+ 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';
491
+ line1: string;
492
+ zipCode: string;
493
+ firstName?: string;
494
+ lastName?: string;
495
+ line2?: string;
496
+ region?: string;
497
+ }
498
+ /**
499
+ * The selected shipping method by the user. Can either be selected during an
500
+ * express Checkout Session or passed during Checkout Session creation.
501
+ */
502
+ interface ShippingMethod {
503
+ /**
504
+ * The customer-facing name of the shipping method.
505
+ */
506
+ name: string;
507
+ /**
508
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
509
+ */
510
+ price: number;
511
+ /**
512
+ * The unique identifier of the shipping method within Ivy.
513
+ */
514
+ id?: string;
515
+ /**
516
+ * The list of countries where the shipping method is available.
517
+ */
518
+ 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'>;
519
+ /**
520
+ * The delivery estimate of the shipping method.
521
+ */
522
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
523
+ /**
524
+ * The unique identifier within your system of the shipping method.
525
+ */
526
+ reference?: string;
527
+ /**
528
+ * @deprecated Deprecated in favor of deliveryEstimate
529
+ */
530
+ timeFrame?: string;
531
+ }
532
+ namespace ShippingMethod {
533
+ /**
534
+ * The delivery estimate of the shipping method.
535
+ */
536
+ interface DeliveryEstimate {
537
+ /**
538
+ * The maximum delivery time.
539
+ */
540
+ maximum?: DeliveryEstimate.Maximum;
541
+ /**
542
+ * The minimum delivery time.
543
+ */
544
+ minimum?: DeliveryEstimate.Minimum;
545
+ }
546
+ namespace DeliveryEstimate {
547
+ /**
548
+ * The maximum delivery time.
549
+ */
550
+ interface Maximum {
551
+ /**
552
+ * The unit of the time duration.
553
+ */
554
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
555
+ /**
556
+ * The value of the time duration.
557
+ */
558
+ value: number;
559
+ }
560
+ /**
561
+ * The minimum delivery time.
562
+ */
563
+ interface Minimum {
564
+ /**
565
+ * The unit of the time duration.
566
+ */
567
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
568
+ /**
569
+ * The value of the time duration.
570
+ */
571
+ value: number;
572
+ }
573
+ }
574
+ }
575
+ /**
576
+ * The shopper object. Contains information collected from the user during the
577
+ * Checkout.
578
+ */
579
+ interface Shopper {
580
+ email?: string;
581
+ phoneNumber?: string;
582
+ }
583
+ interface StatusClassification {
584
+ /**
585
+ * Populated with the primary payment initiation failure classsification if
586
+ * available.
587
+ */
588
+ primary?: string;
589
+ /**
590
+ * Populated with the secondary payment initiation failure classsification if
591
+ * available.
592
+ */
593
+ secondary?: string;
594
+ }
595
+ interface StatusHistoryList {
596
+ /**
597
+ * The order status. This status symbolises the state of the user's payment
598
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
599
+ * information.
600
+ */
601
+ currentStatus: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused';
602
+ reason: string;
603
+ updatedAt: string;
604
+ /**
605
+ * The order status. This status symbolises the state of the user's payment
606
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
607
+ * information.
608
+ */
609
+ previousStatus?: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | null;
610
+ }
611
+ }
612
+ export interface OrderUpdateResponse {
613
+ /**
614
+ * The Ivy unique identifier for the order.
615
+ */
616
+ id: string;
617
+ /**
618
+ * @deprecated The unique identifier for the merchantApp which initiated the order
619
+ * / payment attempt.
620
+ */
621
+ appId: string;
622
+ /**
623
+ * The Ivy fee for the payment.
624
+ */
625
+ applicationFeeAmount: number;
626
+ createdAt: string;
627
+ instantPaymentScheme: boolean;
628
+ /**
629
+ * @deprecated Deprecated in favor of `appId`.
630
+ */
631
+ merchantAppId: string;
632
+ /**
633
+ * The unique identifier for the merchant which initiated the order / payment
634
+ * attempt.
635
+ */
636
+ merchantId: string;
637
+ /**
638
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
639
+ * represents EUR 10.23. Any amount of decimal places can be provided on
640
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
641
+ * as this is the format accepted by most banks.
642
+ */
643
+ price: OrderUpdateResponse.Price;
644
+ /**
645
+ * An internal reference id which will be stored with the checkout & corresponding
646
+ * order. Needs to be unique per shop per order and can be up to 200 characters.
647
+ */
648
+ referenceId: string;
649
+ /**
650
+ * The name of the merchant which initiated the order.
651
+ */
652
+ shopName: string;
653
+ /**
654
+ * The order status. This status symbolises the state of the user's payment
655
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
656
+ * information.
657
+ */
658
+ status: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused';
659
+ updatedAt: string;
660
+ /**
661
+ * The unique identifier of Ivy of the chosen bank to make the payment. Not there,
662
+ * if no payment was made.
663
+ */
664
+ bankId?: string;
665
+ /**
666
+ * The bank statement reference of the payment for the order. This is the reference
667
+ * that will be visible on the bank statement.
668
+ */
669
+ bankStatementReference?: string;
670
+ /**
671
+ * The billing address of the user. Required when handshake=true.
672
+ */
673
+ billingAddress?: OrderUpdateResponse.BillingAddress;
674
+ /**
675
+ * The merchant category code or
676
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
677
+ */
678
+ category?: string;
679
+ /**
680
+ * @deprecated
681
+ */
682
+ climateActionMode?: OrderUpdateResponse.ClimateActionMode;
683
+ /**
684
+ * @deprecated
685
+ */
686
+ co2Grams?: number;
687
+ /**
688
+ * The unique identifier of the customer who placed the order.
689
+ */
690
+ customerId?: string;
691
+ /**
692
+ * The customer facing id. This id is displayed to the user during the checkout and
693
+ * in the merchant dashboard.
694
+ */
695
+ displayId?: string;
696
+ /**
697
+ * False by default. If set to true, customers skip email input and jump directly
698
+ * to their bank login. For express Checkout Sessions this is always false.
699
+ */
700
+ guest?: boolean;
701
+ /**
702
+ * Only valid for sustainable incentive mode. The social / sustainable projects
703
+ * available to the user during Checkout.
704
+ */
705
+ impactOffsetProjects?: Array<string>;
706
+ /**
707
+ * The incentive mode of the checkout session. For any use-case apart from
708
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
709
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
710
+ * session will contain sustainable incentives for users.
711
+ */
712
+ incentiveMode?: 'white_label' | 'sustainable';
713
+ /**
714
+ * The line items of the Checkout.
715
+ */
716
+ lineItems?: Array<OrderUpdateResponse.LineItem>;
717
+ mandate?: OrderUpdateResponse.Mandate;
718
+ /**
719
+ * The destination bank account where the money will be sent to.
720
+ */
721
+ merchantFinancialAddress?: OrderUpdateResponse.MerchantFinancialAddress;
722
+ /**
723
+ * Any data which will be stored and returned for this checkout session and
724
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
725
+ * more info.
726
+ */
727
+ metadata?: Record<string, unknown>;
728
+ /**
729
+ * Only valid for sustainable incentive mode. The social / sustainability project
730
+ * chosen by the user during Checkout.
731
+ */
732
+ offsetProject?: string;
733
+ /**
734
+ * The source bank account where the money is send from.
735
+ */
736
+ payerFinancialAddress?: OrderUpdateResponse.PayerFinancialAddress;
737
+ paymentMethodType?: 'sepa_debit' | 'customer_balance';
738
+ /**
739
+ * The payment mode of the order. Can be either 'settlement' or 'direct'.
740
+ */
741
+ paymentMode?: 'settlement' | 'direct';
742
+ /**
743
+ * @deprecated Deprecated in favor of `status`. Do not use this field to trigger
744
+ * actions in your system.
745
+ */
746
+ paymentStatus?: 'failed' | 'canceled' | 'processing' | 'requires_action' | 'succeeded' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'not_settled' | 'disputed';
747
+ /**
748
+ * The total amount in the currency of all successful refunds for this order
749
+ */
750
+ refundAmount?: number;
751
+ /**
752
+ * The list of refunds connected to this order.
753
+ */
754
+ refunds?: Array<OrderUpdateResponse.Refund>;
755
+ /**
756
+ * The shipping address of the user. This is only collected in express Checkouts.
757
+ */
758
+ shippingAddress?: OrderUpdateResponse.ShippingAddress;
759
+ /**
760
+ * The selected shipping method by the user. Can either be selected during an
761
+ * express Checkout Session or passed during Checkout Session creation.
762
+ */
763
+ shippingMethod?: OrderUpdateResponse.ShippingMethod;
764
+ /**
765
+ * The logo of the shop provided as a URL.
766
+ */
767
+ shopLogo?: string;
768
+ /**
769
+ * The shopper object. Contains information collected from the user during the
770
+ * Checkout.
771
+ */
772
+ shopper?: OrderUpdateResponse.Shopper;
773
+ /**
774
+ * @deprecated Deprecated in favor of `shopper.email`. The email of the user if
775
+ * collected in the Checkout.
776
+ */
777
+ shopperEmail?: string;
778
+ statusClassification?: OrderUpdateResponse.StatusClassification;
779
+ /**
780
+ * List of status history items for the order, used for logging every update on
781
+ * status.
782
+ */
783
+ statusHistoryList?: Array<OrderUpdateResponse.StatusHistoryList>;
784
+ /**
785
+ * The subaccount id of the order.
786
+ */
787
+ subaccountId?: string;
788
+ /**
789
+ * The legal name of the subaccount
790
+ */
791
+ subaccountLegalName?: string;
792
+ /**
793
+ * @deprecated
794
+ */
795
+ trees?: number;
796
+ }
797
+ export declare namespace OrderUpdateResponse {
798
+ /**
799
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
800
+ * represents EUR 10.23. Any amount of decimal places can be provided on
801
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
802
+ * as this is the format accepted by most banks.
803
+ */
804
+ interface Price {
805
+ currency: 'EUR' | 'GBP' | 'PLN';
806
+ /**
807
+ * The total amount to be paid.
808
+ */
809
+ total: number;
810
+ shipping?: number;
811
+ subTotal?: number;
812
+ totalNet?: number;
813
+ vat?: number;
814
+ }
815
+ /**
816
+ * The billing address of the user. Required when handshake=true.
817
+ */
818
+ interface BillingAddress {
819
+ city: string;
820
+ /**
821
+ * The country code in
822
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
823
+ */
824
+ 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';
825
+ line1: string;
826
+ zipCode: string;
827
+ firstName?: string;
828
+ lastName?: string;
829
+ line2?: string;
830
+ region?: string;
831
+ }
832
+ /**
833
+ * @deprecated
834
+ */
835
+ interface ClimateActionMode {
836
+ amount: number;
837
+ type: 'transaction' | 'amount';
838
+ }
839
+ interface LineItem {
840
+ /**
841
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
842
+ * decimals, i.e. 10.23 represents EUR 10.23.
843
+ */
844
+ amount: number;
845
+ /**
846
+ * The name of the line item.
847
+ */
848
+ name: string;
849
+ /**
850
+ * The quantity of the line item.
851
+ */
852
+ quantity: number;
853
+ /**
854
+ * The net amount of a single item.
855
+ */
856
+ singleNet: number;
857
+ /**
858
+ * The VAT amount of a single item.
859
+ */
860
+ singleVat: number;
861
+ /**
862
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
863
+ * the line item.
864
+ */
865
+ category?: string;
866
+ /**
867
+ * The
868
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
869
+ * of the line item.
870
+ */
871
+ EAN?: string;
872
+ /**
873
+ * The image of the line item as a URL.
874
+ */
875
+ image?: string;
876
+ /**
877
+ * The internal unique identifier of the line item.
878
+ */
879
+ referenceId?: string;
880
+ }
881
+ interface Mandate {
882
+ /**
883
+ * The name of the account holder who signs the mandate.
884
+ */
885
+ accountHolderName?: string;
886
+ /**
887
+ * Additional information to display to the user during the mandate setup. This
888
+ * information is not used to setup any recurrence on the mandate. It is only
889
+ * displayed to the user during checkout.
890
+ */
891
+ additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
892
+ /**
893
+ * Mandate creditor data
894
+ */
895
+ creditor?: Mandate.Creditor;
896
+ /**
897
+ * The reference of the mandate going to be setup
898
+ */
899
+ reference?: string;
900
+ /**
901
+ * The mandate referenceId. Set this to match incoming `mandate_setup_started`,
902
+ * `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
903
+ * mandate setup request.
904
+ */
905
+ referenceId?: string;
906
+ /**
907
+ * If true, a ready to use mandate will be set up after the payment flow.
908
+ */
909
+ setup?: boolean;
910
+ /**
911
+ * The email of the user who signs the mandate.
912
+ */
913
+ userNotificationEmail?: string;
914
+ }
915
+ namespace Mandate {
916
+ /**
917
+ * Additional information to display to the user during the mandate setup. This
918
+ * information is not used to setup any recurrence on the mandate. It is only
919
+ * displayed to the user during checkout.
920
+ */
921
+ interface AdditionalDisplayInformation {
922
+ /**
923
+ * The intended cadence of charges used for displaying purpose only. On demand
924
+ * would be used for unscheduled charges.
925
+ */
926
+ cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
927
+ price?: AdditionalDisplayInformation.Price;
928
+ }
929
+ namespace AdditionalDisplayInformation {
930
+ interface Price {
931
+ /**
932
+ * The amount displayed to the user as decimal e.g. 10.23 would be displayed as
933
+ * 10.23 EUR.
934
+ */
935
+ amount?: number;
936
+ currency?: 'EUR' | 'GBP' | 'PLN';
937
+ }
938
+ }
939
+ /**
940
+ * Mandate creditor data
941
+ */
942
+ interface Creditor {
943
+ id?: string;
944
+ name?: string;
945
+ }
946
+ }
947
+ /**
948
+ * The destination bank account where the money will be sent to.
949
+ */
950
+ interface MerchantFinancialAddress {
951
+ bankCode?: MerchantFinancialAddress.BankCode;
952
+ bban?: MerchantFinancialAddress.Bban;
953
+ iban?: MerchantFinancialAddress.Iban;
954
+ /**
955
+ * The payment reference for the order. This is the reference that will be visible
956
+ * on the bank statement.
957
+ */
958
+ paymentReference?: string;
959
+ sortCode?: MerchantFinancialAddress.SortCode;
960
+ /**
961
+ * The type of the financial address. The actual destination is determined by this
962
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
963
+ * validation will fail if you set e.g. type="iban", but then not fill any values
964
+ * in the "iban" object.
965
+ *
966
+ * - iban: The IBAN of the account
967
+ * - sort_code: The sort code of the account
968
+ * - bank_code: The bank code of the account
969
+ * - bban: The BBAN of the account
970
+ */
971
+ type?: string;
972
+ }
973
+ namespace MerchantFinancialAddress {
974
+ interface BankCode {
975
+ /**
976
+ * The name of the account holder.
977
+ */
978
+ accountHolderName: string;
979
+ accountNumber: string;
980
+ code: string;
981
+ }
982
+ interface Bban {
983
+ /**
984
+ * The name of the account holder.
985
+ */
986
+ accountHolderName: string;
987
+ bban: string;
988
+ bic?: string;
989
+ }
990
+ interface Iban {
991
+ /**
992
+ * The name of the account holder.
993
+ */
994
+ accountHolderName: string;
995
+ iban: string;
996
+ bic?: string;
997
+ }
998
+ interface SortCode {
999
+ /**
1000
+ * The name of the account holder.
1001
+ */
1002
+ accountHolderName: string;
1003
+ accountNumber: string;
1004
+ sortCode: string;
1005
+ }
1006
+ }
1007
+ /**
1008
+ * The source bank account where the money is send from.
1009
+ */
1010
+ interface PayerFinancialAddress {
1011
+ /**
1012
+ * The type of the financial address. The actual destination is determined by this
1013
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
1014
+ * validation will fail if you set e.g. type="iban", but then not fill any values
1015
+ * in the "iban" object.
1016
+ *
1017
+ * - iban: The IBAN of the account
1018
+ * - sort_code: The sort code of the account
1019
+ * - bank_code: The bank code of the account
1020
+ * - bban: The BBAN of the account
1021
+ */
1022
+ type: string;
1023
+ bankCode?: PayerFinancialAddress.BankCode;
1024
+ bban?: PayerFinancialAddress.Bban;
1025
+ iban?: PayerFinancialAddress.Iban;
1026
+ sortCode?: PayerFinancialAddress.SortCode;
1027
+ }
1028
+ namespace PayerFinancialAddress {
1029
+ interface BankCode {
1030
+ accountNumber: string;
1031
+ code: string;
1032
+ /**
1033
+ * The name of the account holder.
1034
+ */
1035
+ accountHolderName?: string;
1036
+ }
1037
+ interface Bban {
1038
+ bban: string;
1039
+ /**
1040
+ * The name of the account holder.
1041
+ */
1042
+ accountHolderName?: string;
1043
+ bic?: string;
1044
+ }
1045
+ interface Iban {
1046
+ iban: string;
1047
+ /**
1048
+ * The name of the account holder.
1049
+ */
1050
+ accountHolderName?: string;
1051
+ bic?: string;
1052
+ }
1053
+ interface SortCode {
1054
+ accountNumber: string;
1055
+ sortCode: string;
1056
+ /**
1057
+ * The name of the account holder.
1058
+ */
1059
+ accountHolderName?: string;
1060
+ }
1061
+ }
1062
+ /**
1063
+ * A Refund object. This corresponds to one Refund request.
1064
+ */
1065
+ interface Refund {
1066
+ id: string;
1067
+ amount: number;
1068
+ createdAt: string;
1069
+ referenceId: string;
1070
+ /**
1071
+ * The status of the refund. Always use the status of the order as your source of
1072
+ * truth to trigger actions in your dashboard.
1073
+ */
1074
+ status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
1075
+ updatedAt: string;
1076
+ description?: string;
1077
+ }
1078
+ /**
1079
+ * The shipping address of the user. This is only collected in express Checkouts.
1080
+ */
1081
+ interface ShippingAddress {
1082
+ city: string;
1083
+ /**
1084
+ * The country code in
1085
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
1086
+ */
1087
+ 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';
1088
+ line1: string;
1089
+ zipCode: string;
1090
+ firstName?: string;
1091
+ lastName?: string;
1092
+ line2?: string;
1093
+ region?: string;
1094
+ }
1095
+ /**
1096
+ * The selected shipping method by the user. Can either be selected during an
1097
+ * express Checkout Session or passed during Checkout Session creation.
1098
+ */
1099
+ interface ShippingMethod {
1100
+ /**
1101
+ * The customer-facing name of the shipping method.
1102
+ */
1103
+ name: string;
1104
+ /**
1105
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
1106
+ */
1107
+ price: number;
1108
+ /**
1109
+ * The unique identifier of the shipping method within Ivy.
1110
+ */
1111
+ id?: string;
1112
+ /**
1113
+ * The list of countries where the shipping method is available.
1114
+ */
1115
+ 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'>;
1116
+ /**
1117
+ * The delivery estimate of the shipping method.
1118
+ */
1119
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
1120
+ /**
1121
+ * The unique identifier within your system of the shipping method.
1122
+ */
1123
+ reference?: string;
1124
+ /**
1125
+ * @deprecated Deprecated in favor of deliveryEstimate
1126
+ */
1127
+ timeFrame?: string;
1128
+ }
1129
+ namespace ShippingMethod {
1130
+ /**
1131
+ * The delivery estimate of the shipping method.
1132
+ */
1133
+ interface DeliveryEstimate {
1134
+ /**
1135
+ * The maximum delivery time.
1136
+ */
1137
+ maximum?: DeliveryEstimate.Maximum;
1138
+ /**
1139
+ * The minimum delivery time.
1140
+ */
1141
+ minimum?: DeliveryEstimate.Minimum;
1142
+ }
1143
+ namespace DeliveryEstimate {
1144
+ /**
1145
+ * The maximum delivery time.
1146
+ */
1147
+ interface Maximum {
1148
+ /**
1149
+ * The unit of the time duration.
1150
+ */
1151
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1152
+ /**
1153
+ * The value of the time duration.
1154
+ */
1155
+ value: number;
1156
+ }
1157
+ /**
1158
+ * The minimum delivery time.
1159
+ */
1160
+ interface Minimum {
1161
+ /**
1162
+ * The unit of the time duration.
1163
+ */
1164
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1165
+ /**
1166
+ * The value of the time duration.
1167
+ */
1168
+ value: number;
1169
+ }
1170
+ }
1171
+ }
1172
+ /**
1173
+ * The shopper object. Contains information collected from the user during the
1174
+ * Checkout.
1175
+ */
1176
+ interface Shopper {
1177
+ email?: string;
1178
+ phoneNumber?: string;
1179
+ }
1180
+ interface StatusClassification {
1181
+ /**
1182
+ * Populated with the primary payment initiation failure classsification if
1183
+ * available.
1184
+ */
1185
+ primary?: string;
1186
+ /**
1187
+ * Populated with the secondary payment initiation failure classsification if
1188
+ * available.
1189
+ */
1190
+ secondary?: string;
1191
+ }
1192
+ interface StatusHistoryList {
1193
+ /**
1194
+ * The order status. This status symbolises the state of the user's payment
1195
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
1196
+ * information.
1197
+ */
1198
+ currentStatus: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused';
1199
+ reason: string;
1200
+ updatedAt: string;
1201
+ /**
1202
+ * The order status. This status symbolises the state of the user's payment
1203
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
1204
+ * information.
1205
+ */
1206
+ previousStatus?: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | null;
1207
+ }
1208
+ }
1209
+ export interface OrderRetrieveParams {
1210
+ id: string;
1211
+ }
1212
+ export interface OrderUpdateParams {
1213
+ id: string;
1214
+ /**
1215
+ * The customer-facing id of the order. This id will also be shown next to the
1216
+ * orders in the Ivy Dashboard.
1217
+ */
1218
+ displayId?: string;
1219
+ /**
1220
+ * An internal reference id which will be stored with the checkout & corresponding
1221
+ * order. Needs to be unique per shop per order and can be up to 200 characters. We
1222
+ * recommend to use your internal order id here.
1223
+ */
1224
+ referenceId?: string;
1225
+ /**
1226
+ * The customer-facing name of the shop.
1227
+ */
1228
+ shopName?: string;
1229
+ /**
1230
+ * The order status. This status symbolises the state of the user's payment
1231
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
1232
+ * information.
1233
+ */
1234
+ status?: 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused';
1235
+ }
1236
+ export declare namespace Orders {
1237
+ export { type OrderRetrieveResponse as OrderRetrieveResponse, type OrderUpdateResponse as OrderUpdateResponse, type OrderRetrieveParams as OrderRetrieveParams, type OrderUpdateParams as OrderUpdateParams, };
1238
+ }
1239
+ //# sourceMappingURL=orders.d.ts.map