@getivy/node-sdk 0.1.0-alpha.8 → 1.0.0

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