@getivy/node-sdk 0.1.0-alpha.3 → 0.1.0-alpha.31
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.
- package/CHANGELOG.md +328 -0
- package/README.md +15 -27
- package/_shims/index.d.ts +2 -0
- package/_shims/index.js +5 -1
- package/_shims/index.mjs +5 -1
- package/core.d.ts +12 -1
- package/core.d.ts.map +1 -1
- package/core.js +20 -11
- package/core.js.map +1 -1
- package/core.mjs +21 -12
- package/core.mjs.map +1 -1
- package/index.d.mts +8 -2
- package/index.d.ts +8 -2
- package/index.d.ts.map +1 -1
- package/index.js +6 -0
- package/index.js.map +1 -1
- package/index.mjs +6 -0
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/balance.d.ts +2 -2
- package/resources/balance.d.ts.map +1 -1
- package/resources/banks.d.ts +53 -5
- package/resources/banks.d.ts.map +1 -1
- package/resources/charges.d.ts +3 -16
- package/resources/charges.d.ts.map +1 -1
- package/resources/checkoutsession.d.ts +397 -1577
- package/resources/checkoutsession.d.ts.map +1 -1
- package/resources/customers.d.ts +56 -6
- package/resources/customers.d.ts.map +1 -1
- package/resources/customers.js +3 -2
- package/resources/customers.js.map +1 -1
- package/resources/customers.mjs +3 -2
- package/resources/customers.mjs.map +1 -1
- package/resources/data/accounts.d.ts +104 -0
- package/resources/data/accounts.d.ts.map +1 -0
- package/resources/data/accounts.js +15 -0
- package/resources/data/accounts.js.map +1 -0
- package/resources/data/accounts.mjs +11 -0
- package/resources/data/accounts.mjs.map +1 -0
- package/resources/data/balances.d.ts +45 -0
- package/resources/data/balances.d.ts.map +1 -0
- package/resources/data/balances.js +15 -0
- package/resources/data/balances.js.map +1 -0
- package/resources/data/balances.mjs +11 -0
- package/resources/data/balances.mjs.map +1 -0
- package/resources/data/consent.d.ts +80 -0
- package/resources/data/consent.d.ts.map +1 -0
- package/resources/data/consent.js +21 -0
- package/resources/data/consent.js.map +1 -0
- package/resources/data/consent.mjs +17 -0
- package/resources/data/consent.mjs.map +1 -0
- package/resources/data/data.d.ts +26 -0
- package/resources/data/data.d.ts.map +1 -0
- package/resources/data/data.js +55 -0
- package/resources/data/data.js.map +1 -0
- package/resources/data/data.mjs +28 -0
- package/resources/data/data.mjs.map +1 -0
- package/resources/data/index.d.ts +7 -0
- package/resources/data/index.d.ts.map +1 -0
- package/resources/data/index.js +17 -0
- package/resources/data/index.js.map +1 -0
- package/resources/data/index.mjs +8 -0
- package/resources/data/index.mjs.map +1 -0
- package/resources/data/session.d.ts +234 -0
- package/resources/data/session.d.ts.map +1 -0
- package/resources/data/session.js +21 -0
- package/resources/data/session.js.map +1 -0
- package/resources/data/session.mjs +17 -0
- package/resources/data/session.mjs.map +1 -0
- package/resources/data/transactions.d.ts +54 -0
- package/resources/data/transactions.d.ts.map +1 -0
- package/resources/data/transactions.js +16 -0
- package/resources/data/transactions.js.map +1 -0
- package/resources/data/transactions.mjs +12 -0
- package/resources/data/transactions.mjs.map +1 -0
- package/resources/data.d.ts +2 -0
- package/resources/data.d.ts.map +1 -0
- package/resources/data.js +19 -0
- package/resources/data.js.map +1 -0
- package/resources/data.mjs +3 -0
- package/resources/data.mjs.map +1 -0
- package/resources/index.d.ts +3 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -0
- package/resources/index.mjs.map +1 -1
- package/resources/orders.d.ts +255 -405
- package/resources/orders.d.ts.map +1 -1
- package/resources/orders.js +10 -6
- package/resources/orders.js.map +1 -1
- package/resources/orders.mjs +10 -6
- package/resources/orders.mjs.map +1 -1
- package/resources/payouts.d.ts +2 -2
- package/resources/payouts.d.ts.map +1 -1
- package/resources/refunds.d.ts +1 -1
- package/resources/refunds.d.ts.map +1 -1
- package/resources/reports.d.ts +2 -2
- package/resources/reports.d.ts.map +1 -1
- package/resources/webhooksubscription.d.ts +155 -0
- package/resources/webhooksubscription.d.ts.map +1 -0
- package/resources/webhooksubscription.js +42 -0
- package/resources/webhooksubscription.js.map +1 -0
- package/resources/webhooksubscription.mjs +38 -0
- package/resources/webhooksubscription.mjs.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +18 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/_shims/index.d.ts +2 -0
- package/src/_shims/index.js +5 -1
- package/src/_shims/index.mjs +5 -1
- package/src/core.ts +39 -12
- package/src/index.ts +38 -4
- package/src/resources/balance.ts +2 -2
- package/src/resources/banks.ts +92 -5
- package/src/resources/charges.ts +3 -16
- package/src/resources/checkoutsession.ts +2338 -6557
- package/src/resources/customers.ts +61 -6
- package/src/resources/data/accounts.ts +134 -0
- package/src/resources/data/balances.ts +57 -0
- package/src/resources/data/consent.ts +110 -0
- package/src/resources/data/data.ts +75 -0
- package/src/resources/data/index.ts +20 -0
- package/src/resources/data/session.ts +1299 -0
- package/src/resources/data/transactions.ts +71 -0
- package/src/resources/data.ts +3 -0
- package/src/resources/index.ts +16 -2
- package/src/resources/orders.ts +812 -1970
- package/src/resources/payouts.ts +2 -2
- package/src/resources/refunds.ts +0 -1
- package/src/resources/reports.ts +2 -2
- package/src/resources/webhooksubscription.ts +353 -0
- package/src/resources.ts +1 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
package/src/resources/orders.ts
CHANGED
|
@@ -4,6 +4,17 @@ import { APIResource } from '../resource';
|
|
|
4
4
|
import * as Core from '../core';
|
|
5
5
|
|
|
6
6
|
export class Orders extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Create a new order. By creating a new order, you will create a new settlement
|
|
9
|
+
* destination which you can use to settle expected incoming payments efficiently.
|
|
10
|
+
* After creating the order, Ivy provides you with a destination for the expected
|
|
11
|
+
* incoming payment. As soon as a payment with the same details arrives, Ivy will
|
|
12
|
+
* update the status of the order.
|
|
13
|
+
*/
|
|
14
|
+
create(body: OrderCreateParams, options?: Core.RequestOptions): Core.APIPromise<OrderCreateResponse> {
|
|
15
|
+
return this._client.post('/api/service/order/create', { body, ...options });
|
|
16
|
+
}
|
|
17
|
+
|
|
7
18
|
/**
|
|
8
19
|
* Retrieve details of an order. You can retrieve the order by passing either the
|
|
9
20
|
* internal Ivy order id or the `referenceId` you specified when creating a
|
|
@@ -12,16 +23,9 @@ export class Orders extends APIResource {
|
|
|
12
23
|
retrieve(body: OrderRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<OrderRetrieveResponse> {
|
|
13
24
|
return this._client.post('/api/service/order/details', { body, ...options });
|
|
14
25
|
}
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* Update certain fields of the specified order.
|
|
18
|
-
*/
|
|
19
|
-
update(body: OrderUpdateParams, options?: Core.RequestOptions): Core.APIPromise<OrderUpdateResponse> {
|
|
20
|
-
return this._client.post('/api/service/order/update', { body, ...options });
|
|
21
|
-
}
|
|
22
26
|
}
|
|
23
27
|
|
|
24
|
-
export interface
|
|
28
|
+
export interface OrderCreateResponse {
|
|
25
29
|
/**
|
|
26
30
|
* The Ivy unique identifier for the order.
|
|
27
31
|
*/
|
|
@@ -54,12 +58,12 @@ export interface OrderRetrieveResponse {
|
|
|
54
58
|
merchantId: string;
|
|
55
59
|
|
|
56
60
|
/**
|
|
57
|
-
* The
|
|
61
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
58
62
|
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
59
63
|
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
60
64
|
* as this is the format accepted by most banks.
|
|
61
65
|
*/
|
|
62
|
-
price:
|
|
66
|
+
price: OrderCreateResponse.Price;
|
|
63
67
|
|
|
64
68
|
/**
|
|
65
69
|
* An internal reference id which will be stored with the checkout & corresponding
|
|
@@ -81,7 +85,6 @@ export interface OrderRetrieveResponse {
|
|
|
81
85
|
| 'failed'
|
|
82
86
|
| 'canceled'
|
|
83
87
|
| 'processing'
|
|
84
|
-
| 'in_handshake'
|
|
85
88
|
| 'waiting_for_payment'
|
|
86
89
|
| 'paid'
|
|
87
90
|
| 'in_refund'
|
|
@@ -95,15 +98,21 @@ export interface OrderRetrieveResponse {
|
|
|
95
98
|
updatedAt: string;
|
|
96
99
|
|
|
97
100
|
/**
|
|
98
|
-
* The
|
|
99
|
-
*
|
|
101
|
+
* The unique identifier of Ivy of the chosen bank to make the payment. Not there,
|
|
102
|
+
* if no payment was made.
|
|
103
|
+
*/
|
|
104
|
+
bankId?: string;
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* @deprecated The bank statement reference of the payment for the order. This is
|
|
108
|
+
* the reference that will be visible on the bank statement.
|
|
100
109
|
*/
|
|
101
110
|
bankStatementReference?: string;
|
|
102
111
|
|
|
103
112
|
/**
|
|
104
|
-
* The billing address of the
|
|
113
|
+
* The billing address of the customer.
|
|
105
114
|
*/
|
|
106
|
-
billingAddress?:
|
|
115
|
+
billingAddress?: OrderCreateResponse.BillingAddress;
|
|
107
116
|
|
|
108
117
|
/**
|
|
109
118
|
* The merchant category code or
|
|
@@ -111,58 +120,30 @@ export interface OrderRetrieveResponse {
|
|
|
111
120
|
*/
|
|
112
121
|
category?: string;
|
|
113
122
|
|
|
114
|
-
/**
|
|
115
|
-
* @deprecated
|
|
116
|
-
*/
|
|
117
|
-
climateActionMode?: OrderRetrieveResponse.ClimateActionMode;
|
|
118
|
-
|
|
119
|
-
/**
|
|
120
|
-
* @deprecated
|
|
121
|
-
*/
|
|
122
|
-
co2Grams?: number;
|
|
123
|
-
|
|
124
123
|
/**
|
|
125
124
|
* The unique identifier of the customer who placed the order.
|
|
126
125
|
*/
|
|
127
126
|
customerId?: string;
|
|
128
127
|
|
|
129
|
-
|
|
130
|
-
* The customer facing id. This id is displayed to the user during the checkout and
|
|
131
|
-
* in the merchant dashboard.
|
|
132
|
-
*/
|
|
133
|
-
displayId?: string;
|
|
134
|
-
|
|
135
|
-
/**
|
|
136
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
137
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
138
|
-
*/
|
|
139
|
-
guest?: boolean;
|
|
140
|
-
|
|
141
|
-
/**
|
|
142
|
-
* Only valid for sustainable incentive mode. The social / sustainable projects
|
|
143
|
-
* available to the user during Checkout.
|
|
144
|
-
*/
|
|
145
|
-
impactOffsetProjects?: Array<string>;
|
|
128
|
+
destination?: OrderCreateResponse.Destination;
|
|
146
129
|
|
|
147
130
|
/**
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
151
|
-
* session will contain sustainable incentives for users.
|
|
131
|
+
* @deprecated Currently only visible in the merchant dashboard. This id used to be
|
|
132
|
+
* displayed to the user during the checkout.
|
|
152
133
|
*/
|
|
153
|
-
|
|
134
|
+
displayId?: string;
|
|
154
135
|
|
|
155
136
|
/**
|
|
156
|
-
* The line items
|
|
137
|
+
* @deprecated The list of line items for the order.
|
|
157
138
|
*/
|
|
158
|
-
lineItems?: Array<
|
|
139
|
+
lineItems?: Array<OrderCreateResponse.LineItem>;
|
|
159
140
|
|
|
160
|
-
mandate?:
|
|
141
|
+
mandate?: OrderCreateResponse.Mandate;
|
|
161
142
|
|
|
162
143
|
/**
|
|
163
|
-
*
|
|
144
|
+
* @deprecated
|
|
164
145
|
*/
|
|
165
|
-
merchantFinancialAddress?:
|
|
146
|
+
merchantFinancialAddress?: OrderCreateResponse.MerchantFinancialAddress;
|
|
166
147
|
|
|
167
148
|
/**
|
|
168
149
|
* Any data which will be stored and returned for this checkout session and
|
|
@@ -171,18 +152,12 @@ export interface OrderRetrieveResponse {
|
|
|
171
152
|
*/
|
|
172
153
|
metadata?: Record<string, unknown>;
|
|
173
154
|
|
|
174
|
-
/**
|
|
175
|
-
* Only valid for sustainable incentive mode. The social / sustainability project
|
|
176
|
-
* chosen by the user during Checkout.
|
|
177
|
-
*/
|
|
178
|
-
offsetProject?: string;
|
|
179
|
-
|
|
180
155
|
/**
|
|
181
156
|
* The source bank account where the money is send from.
|
|
182
157
|
*/
|
|
183
|
-
payerFinancialAddress?:
|
|
158
|
+
payerFinancialAddress?: OrderCreateResponse.PayerFinancialAddress;
|
|
184
159
|
|
|
185
|
-
paymentMethodType?: 'sepa_debit' | 'customer_balance';
|
|
160
|
+
paymentMethodType?: 'sepa_debit' | 'customer_balance' | 'manual_bank_transfer';
|
|
186
161
|
|
|
187
162
|
/**
|
|
188
163
|
* The payment mode of the order. Can be either 'settlement' or 'direct'.
|
|
@@ -214,29 +189,13 @@ export interface OrderRetrieveResponse {
|
|
|
214
189
|
/**
|
|
215
190
|
* The list of refunds connected to this order.
|
|
216
191
|
*/
|
|
217
|
-
refunds?: Array<
|
|
218
|
-
|
|
219
|
-
/**
|
|
220
|
-
* The shipping address of the user. This is only collected in express Checkouts.
|
|
221
|
-
*/
|
|
222
|
-
shippingAddress?: OrderRetrieveResponse.ShippingAddress;
|
|
223
|
-
|
|
224
|
-
/**
|
|
225
|
-
* The selected shipping method by the user. Can either be selected during an
|
|
226
|
-
* express Checkout Session or passed during Checkout Session creation.
|
|
227
|
-
*/
|
|
228
|
-
shippingMethod?: OrderRetrieveResponse.ShippingMethod;
|
|
229
|
-
|
|
230
|
-
/**
|
|
231
|
-
* The logo of the shop provided as a URL.
|
|
232
|
-
*/
|
|
233
|
-
shopLogo?: string;
|
|
192
|
+
refunds?: Array<OrderCreateResponse.Refund>;
|
|
234
193
|
|
|
235
194
|
/**
|
|
236
195
|
* The shopper object. Contains information collected from the user during the
|
|
237
196
|
* Checkout.
|
|
238
197
|
*/
|
|
239
|
-
shopper?:
|
|
198
|
+
shopper?: OrderCreateResponse.Shopper;
|
|
240
199
|
|
|
241
200
|
/**
|
|
242
201
|
* @deprecated Deprecated in favor of `shopper.email`. The email of the user if
|
|
@@ -244,13 +203,13 @@ export interface OrderRetrieveResponse {
|
|
|
244
203
|
*/
|
|
245
204
|
shopperEmail?: string;
|
|
246
205
|
|
|
247
|
-
statusClassification?:
|
|
206
|
+
statusClassification?: OrderCreateResponse.StatusClassification;
|
|
248
207
|
|
|
249
208
|
/**
|
|
250
209
|
* List of status history items for the order, used for logging every update on
|
|
251
210
|
* status.
|
|
252
211
|
*/
|
|
253
|
-
statusHistoryList?: Array<
|
|
212
|
+
statusHistoryList?: Array<OrderCreateResponse.StatusHistoryList>;
|
|
254
213
|
|
|
255
214
|
/**
|
|
256
215
|
* The subaccount id of the order.
|
|
@@ -261,52 +220,34 @@ export interface OrderRetrieveResponse {
|
|
|
261
220
|
* The legal name of the subaccount
|
|
262
221
|
*/
|
|
263
222
|
subaccountLegalName?: string;
|
|
264
|
-
|
|
265
|
-
/**
|
|
266
|
-
* @deprecated
|
|
267
|
-
*/
|
|
268
|
-
trees?: number;
|
|
269
223
|
}
|
|
270
224
|
|
|
271
|
-
export namespace
|
|
225
|
+
export namespace OrderCreateResponse {
|
|
272
226
|
/**
|
|
273
|
-
* The
|
|
227
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
274
228
|
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
275
229
|
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
276
230
|
* as this is the format accepted by most banks.
|
|
277
231
|
*/
|
|
278
232
|
export interface Price {
|
|
279
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
233
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
280
234
|
|
|
281
235
|
/**
|
|
282
236
|
* The total amount to be paid.
|
|
283
237
|
*/
|
|
284
238
|
total: number;
|
|
285
239
|
|
|
286
|
-
/**
|
|
287
|
-
* The shipping amount.
|
|
288
|
-
*/
|
|
289
240
|
shipping?: number;
|
|
290
241
|
|
|
291
|
-
/**
|
|
292
|
-
* The subtotal amount, i.e. the total amount without VAT and shipping.
|
|
293
|
-
*/
|
|
294
242
|
subTotal?: number;
|
|
295
243
|
|
|
296
|
-
/**
|
|
297
|
-
* The total net amount, i.e. the total amount without VAT. This value is rounded
|
|
298
|
-
* to 2 decimal places for the actual transfer.
|
|
299
|
-
*/
|
|
300
244
|
totalNet?: number;
|
|
301
245
|
|
|
302
|
-
/**
|
|
303
|
-
* The VAT amount.
|
|
304
|
-
*/
|
|
305
246
|
vat?: number;
|
|
306
247
|
}
|
|
307
248
|
|
|
308
249
|
/**
|
|
309
|
-
* The billing address of the
|
|
250
|
+
* The billing address of the customer.
|
|
310
251
|
*/
|
|
311
252
|
export interface BillingAddress {
|
|
312
253
|
city: string;
|
|
@@ -580,13 +521,93 @@ export namespace OrderRetrieveResponse {
|
|
|
580
521
|
region?: string;
|
|
581
522
|
}
|
|
582
523
|
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
524
|
+
export interface Destination {
|
|
525
|
+
/**
|
|
526
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
527
|
+
* to "iban", the "iban" object must be filled out.
|
|
528
|
+
*/
|
|
529
|
+
bankAccount: Destination.BankAccount;
|
|
530
|
+
|
|
531
|
+
/**
|
|
532
|
+
* The bank statement reference of the payment for the order. This is the reference
|
|
533
|
+
* that will be visible on the bank statement.
|
|
534
|
+
*/
|
|
535
|
+
bankStatementReference: string;
|
|
536
|
+
}
|
|
537
|
+
|
|
538
|
+
export namespace Destination {
|
|
539
|
+
/**
|
|
540
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
541
|
+
* to "iban", the "iban" object must be filled out.
|
|
542
|
+
*/
|
|
543
|
+
export interface BankAccount {
|
|
544
|
+
/**
|
|
545
|
+
* The type of the financial address. The actual destination is determined by this
|
|
546
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
547
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
548
|
+
* in the "iban" object.
|
|
549
|
+
*
|
|
550
|
+
* - iban: The IBAN of the account
|
|
551
|
+
* - sort_code: The sort code of the account
|
|
552
|
+
* - bank_code: The bank code of the account
|
|
553
|
+
* - bban: The BBAN of the account
|
|
554
|
+
*/
|
|
555
|
+
type: string;
|
|
556
|
+
|
|
557
|
+
bankCode?: BankAccount.BankCode;
|
|
558
|
+
|
|
559
|
+
bban?: BankAccount.Bban;
|
|
560
|
+
|
|
561
|
+
iban?: BankAccount.Iban;
|
|
562
|
+
|
|
563
|
+
sortCode?: BankAccount.SortCode;
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
export namespace BankAccount {
|
|
567
|
+
export interface BankCode {
|
|
568
|
+
/**
|
|
569
|
+
* The name of the account holder.
|
|
570
|
+
*/
|
|
571
|
+
accountHolderName: string;
|
|
572
|
+
|
|
573
|
+
accountNumber: string;
|
|
574
|
+
|
|
575
|
+
code: string;
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
export interface Bban {
|
|
579
|
+
/**
|
|
580
|
+
* The name of the account holder.
|
|
581
|
+
*/
|
|
582
|
+
accountHolderName: string;
|
|
583
|
+
|
|
584
|
+
bban: string;
|
|
585
|
+
|
|
586
|
+
bic?: string;
|
|
587
|
+
}
|
|
588
|
+
|
|
589
|
+
export interface Iban {
|
|
590
|
+
/**
|
|
591
|
+
* The name of the account holder.
|
|
592
|
+
*/
|
|
593
|
+
accountHolderName: string;
|
|
594
|
+
|
|
595
|
+
iban: string;
|
|
596
|
+
|
|
597
|
+
bic?: string;
|
|
598
|
+
}
|
|
599
|
+
|
|
600
|
+
export interface SortCode {
|
|
601
|
+
/**
|
|
602
|
+
* The name of the account holder.
|
|
603
|
+
*/
|
|
604
|
+
accountHolderName: string;
|
|
588
605
|
|
|
589
|
-
|
|
606
|
+
accountNumber: string;
|
|
607
|
+
|
|
608
|
+
sortCode: string;
|
|
609
|
+
}
|
|
610
|
+
}
|
|
590
611
|
}
|
|
591
612
|
|
|
592
613
|
export interface LineItem {
|
|
@@ -705,7 +726,7 @@ export namespace OrderRetrieveResponse {
|
|
|
705
726
|
*/
|
|
706
727
|
amount?: number;
|
|
707
728
|
|
|
708
|
-
currency?: 'EUR' | 'GBP' | 'PLN';
|
|
729
|
+
currency?: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
709
730
|
}
|
|
710
731
|
}
|
|
711
732
|
|
|
@@ -720,7 +741,7 @@ export namespace OrderRetrieveResponse {
|
|
|
720
741
|
}
|
|
721
742
|
|
|
722
743
|
/**
|
|
723
|
-
*
|
|
744
|
+
* @deprecated
|
|
724
745
|
*/
|
|
725
746
|
export interface MerchantFinancialAddress {
|
|
726
747
|
bankCode?: MerchantFinancialAddress.BankCode;
|
|
@@ -893,743 +914,142 @@ export namespace OrderRetrieveResponse {
|
|
|
893
914
|
}
|
|
894
915
|
|
|
895
916
|
/**
|
|
896
|
-
* The
|
|
917
|
+
* The shopper object. Contains information collected from the user during the
|
|
918
|
+
* Checkout.
|
|
897
919
|
*/
|
|
898
|
-
export interface
|
|
899
|
-
|
|
920
|
+
export interface Shopper {
|
|
921
|
+
email?: string;
|
|
922
|
+
|
|
923
|
+
phoneNumber?: string;
|
|
924
|
+
}
|
|
900
925
|
|
|
926
|
+
export interface StatusClassification {
|
|
901
927
|
/**
|
|
902
|
-
*
|
|
903
|
-
*
|
|
928
|
+
* Populated with the primary payment initiation failure classsification if
|
|
929
|
+
* available.
|
|
904
930
|
*/
|
|
905
|
-
|
|
906
|
-
| 'AF'
|
|
907
|
-
| 'AL'
|
|
908
|
-
| 'DZ'
|
|
909
|
-
| 'AS'
|
|
910
|
-
| 'AD'
|
|
911
|
-
| 'AO'
|
|
912
|
-
| 'AI'
|
|
913
|
-
| 'AQ'
|
|
914
|
-
| 'AG'
|
|
915
|
-
| 'AR'
|
|
916
|
-
| 'AM'
|
|
917
|
-
| 'AW'
|
|
918
|
-
| 'AU'
|
|
919
|
-
| 'AT'
|
|
920
|
-
| 'AZ'
|
|
921
|
-
| 'BS'
|
|
922
|
-
| 'BH'
|
|
923
|
-
| 'BD'
|
|
924
|
-
| 'BB'
|
|
925
|
-
| 'BY'
|
|
926
|
-
| 'BE'
|
|
927
|
-
| 'BZ'
|
|
928
|
-
| 'BJ'
|
|
929
|
-
| 'BM'
|
|
930
|
-
| 'BT'
|
|
931
|
-
| 'BO'
|
|
932
|
-
| 'BA'
|
|
933
|
-
| 'BW'
|
|
934
|
-
| 'BV'
|
|
935
|
-
| 'BR'
|
|
936
|
-
| 'IO'
|
|
937
|
-
| 'BN'
|
|
938
|
-
| 'BG'
|
|
939
|
-
| 'BF'
|
|
940
|
-
| 'BI'
|
|
941
|
-
| 'KH'
|
|
942
|
-
| 'CM'
|
|
943
|
-
| 'CA'
|
|
944
|
-
| 'CV'
|
|
945
|
-
| 'KY'
|
|
946
|
-
| 'CF'
|
|
947
|
-
| 'TD'
|
|
948
|
-
| 'CL'
|
|
949
|
-
| 'CN'
|
|
950
|
-
| 'CX'
|
|
951
|
-
| 'CC'
|
|
952
|
-
| 'CO'
|
|
953
|
-
| 'KM'
|
|
954
|
-
| 'CG'
|
|
955
|
-
| 'CD'
|
|
956
|
-
| 'CK'
|
|
957
|
-
| 'CR'
|
|
958
|
-
| 'CI'
|
|
959
|
-
| 'HR'
|
|
960
|
-
| 'CU'
|
|
961
|
-
| 'CY'
|
|
962
|
-
| 'CZ'
|
|
963
|
-
| 'DK'
|
|
964
|
-
| 'DJ'
|
|
965
|
-
| 'DM'
|
|
966
|
-
| 'DO'
|
|
967
|
-
| 'EC'
|
|
968
|
-
| 'EG'
|
|
969
|
-
| 'SV'
|
|
970
|
-
| 'GQ'
|
|
971
|
-
| 'ER'
|
|
972
|
-
| 'EE'
|
|
973
|
-
| 'ET'
|
|
974
|
-
| 'FK'
|
|
975
|
-
| 'FO'
|
|
976
|
-
| 'FJ'
|
|
977
|
-
| 'FI'
|
|
978
|
-
| 'FR'
|
|
979
|
-
| 'GF'
|
|
980
|
-
| 'PF'
|
|
981
|
-
| 'TF'
|
|
982
|
-
| 'GA'
|
|
983
|
-
| 'GM'
|
|
984
|
-
| 'GE'
|
|
985
|
-
| 'DE'
|
|
986
|
-
| 'GH'
|
|
987
|
-
| 'GI'
|
|
988
|
-
| 'GR'
|
|
989
|
-
| 'GL'
|
|
990
|
-
| 'GD'
|
|
991
|
-
| 'GP'
|
|
992
|
-
| 'GU'
|
|
993
|
-
| 'GT'
|
|
994
|
-
| 'GN'
|
|
995
|
-
| 'GW'
|
|
996
|
-
| 'GY'
|
|
997
|
-
| 'HT'
|
|
998
|
-
| 'HM'
|
|
999
|
-
| 'VA'
|
|
1000
|
-
| 'HN'
|
|
1001
|
-
| 'HK'
|
|
1002
|
-
| 'HU'
|
|
1003
|
-
| 'IS'
|
|
1004
|
-
| 'IN'
|
|
1005
|
-
| 'ID'
|
|
1006
|
-
| 'IR'
|
|
1007
|
-
| 'IQ'
|
|
1008
|
-
| 'IE'
|
|
1009
|
-
| 'IL'
|
|
1010
|
-
| 'IT'
|
|
1011
|
-
| 'JM'
|
|
1012
|
-
| 'JP'
|
|
1013
|
-
| 'JO'
|
|
1014
|
-
| 'KZ'
|
|
1015
|
-
| 'KE'
|
|
1016
|
-
| 'KI'
|
|
1017
|
-
| 'KP'
|
|
1018
|
-
| 'KR'
|
|
1019
|
-
| 'KW'
|
|
1020
|
-
| 'KG'
|
|
1021
|
-
| 'LA'
|
|
1022
|
-
| 'LV'
|
|
1023
|
-
| 'LB'
|
|
1024
|
-
| 'LS'
|
|
1025
|
-
| 'LR'
|
|
1026
|
-
| 'LY'
|
|
1027
|
-
| 'LI'
|
|
1028
|
-
| 'LT'
|
|
1029
|
-
| 'LU'
|
|
1030
|
-
| 'MO'
|
|
1031
|
-
| 'MG'
|
|
1032
|
-
| 'MW'
|
|
1033
|
-
| 'MY'
|
|
1034
|
-
| 'MV'
|
|
1035
|
-
| 'ML'
|
|
1036
|
-
| 'MT'
|
|
1037
|
-
| 'MH'
|
|
1038
|
-
| 'MQ'
|
|
1039
|
-
| 'MR'
|
|
1040
|
-
| 'MU'
|
|
1041
|
-
| 'YT'
|
|
1042
|
-
| 'MX'
|
|
1043
|
-
| 'FM'
|
|
1044
|
-
| 'MD'
|
|
1045
|
-
| 'MC'
|
|
1046
|
-
| 'MN'
|
|
1047
|
-
| 'MS'
|
|
1048
|
-
| 'MA'
|
|
1049
|
-
| 'MZ'
|
|
1050
|
-
| 'MM'
|
|
1051
|
-
| 'NA'
|
|
1052
|
-
| 'NR'
|
|
1053
|
-
| 'NP'
|
|
1054
|
-
| 'NL'
|
|
1055
|
-
| 'NC'
|
|
1056
|
-
| 'NZ'
|
|
1057
|
-
| 'NI'
|
|
1058
|
-
| 'NE'
|
|
1059
|
-
| 'NG'
|
|
1060
|
-
| 'NU'
|
|
1061
|
-
| 'NF'
|
|
1062
|
-
| 'MP'
|
|
1063
|
-
| 'MK'
|
|
1064
|
-
| 'NO'
|
|
1065
|
-
| 'OM'
|
|
1066
|
-
| 'PK'
|
|
1067
|
-
| 'PW'
|
|
1068
|
-
| 'PS'
|
|
1069
|
-
| 'PA'
|
|
1070
|
-
| 'PG'
|
|
1071
|
-
| 'PY'
|
|
1072
|
-
| 'PE'
|
|
1073
|
-
| 'PH'
|
|
1074
|
-
| 'PN'
|
|
1075
|
-
| 'PL'
|
|
1076
|
-
| 'PT'
|
|
1077
|
-
| 'PR'
|
|
1078
|
-
| 'QA'
|
|
1079
|
-
| 'RE'
|
|
1080
|
-
| 'RO'
|
|
1081
|
-
| 'RU'
|
|
1082
|
-
| 'RW'
|
|
1083
|
-
| 'SH'
|
|
1084
|
-
| 'KN'
|
|
1085
|
-
| 'LC'
|
|
1086
|
-
| 'PM'
|
|
1087
|
-
| 'VC'
|
|
1088
|
-
| 'WS'
|
|
1089
|
-
| 'SM'
|
|
1090
|
-
| 'ST'
|
|
1091
|
-
| 'SA'
|
|
1092
|
-
| 'SN'
|
|
1093
|
-
| 'SC'
|
|
1094
|
-
| 'SL'
|
|
1095
|
-
| 'SG'
|
|
1096
|
-
| 'SK'
|
|
1097
|
-
| 'SI'
|
|
1098
|
-
| 'SB'
|
|
1099
|
-
| 'SO'
|
|
1100
|
-
| 'ZA'
|
|
1101
|
-
| 'GS'
|
|
1102
|
-
| 'ES'
|
|
1103
|
-
| 'LK'
|
|
1104
|
-
| 'SD'
|
|
1105
|
-
| 'SR'
|
|
1106
|
-
| 'SJ'
|
|
1107
|
-
| 'SZ'
|
|
1108
|
-
| 'SE'
|
|
1109
|
-
| 'CH'
|
|
1110
|
-
| 'SY'
|
|
1111
|
-
| 'TW'
|
|
1112
|
-
| 'TJ'
|
|
1113
|
-
| 'TZ'
|
|
1114
|
-
| 'TH'
|
|
1115
|
-
| 'TL'
|
|
1116
|
-
| 'TG'
|
|
1117
|
-
| 'TK'
|
|
1118
|
-
| 'TO'
|
|
1119
|
-
| 'TT'
|
|
1120
|
-
| 'TN'
|
|
1121
|
-
| 'TR'
|
|
1122
|
-
| 'TM'
|
|
1123
|
-
| 'TC'
|
|
1124
|
-
| 'TV'
|
|
1125
|
-
| 'UG'
|
|
1126
|
-
| 'UA'
|
|
1127
|
-
| 'AE'
|
|
1128
|
-
| 'GB'
|
|
1129
|
-
| 'US'
|
|
1130
|
-
| 'UM'
|
|
1131
|
-
| 'UY'
|
|
1132
|
-
| 'UZ'
|
|
1133
|
-
| 'VU'
|
|
1134
|
-
| 'VE'
|
|
1135
|
-
| 'VN'
|
|
1136
|
-
| 'VG'
|
|
1137
|
-
| 'VI'
|
|
1138
|
-
| 'WF'
|
|
1139
|
-
| 'EH'
|
|
1140
|
-
| 'YE'
|
|
1141
|
-
| 'ZM'
|
|
1142
|
-
| 'ZW'
|
|
1143
|
-
| 'AX'
|
|
1144
|
-
| 'BQ'
|
|
1145
|
-
| 'CW'
|
|
1146
|
-
| 'GG'
|
|
1147
|
-
| 'IM'
|
|
1148
|
-
| 'JE'
|
|
1149
|
-
| 'ME'
|
|
1150
|
-
| 'BL'
|
|
1151
|
-
| 'MF'
|
|
1152
|
-
| 'RS'
|
|
1153
|
-
| 'SX'
|
|
1154
|
-
| 'SS'
|
|
1155
|
-
| 'XK';
|
|
1156
|
-
|
|
1157
|
-
line1: string;
|
|
931
|
+
primary: 'payment_authorisation_failed' | 'payment_execution_failed' | 'payment_abandoned';
|
|
1158
932
|
|
|
1159
|
-
|
|
933
|
+
/**
|
|
934
|
+
* Populated with the secondary payment initiation failure classsification if
|
|
935
|
+
* available.
|
|
936
|
+
*/
|
|
937
|
+
secondary?:
|
|
938
|
+
| 'timeout'
|
|
939
|
+
| 'wrong_credentials'
|
|
940
|
+
| 'incorrect_2fa_response'
|
|
941
|
+
| 'payment_rejected'
|
|
942
|
+
| 'insufficient_funds'
|
|
943
|
+
| 'cancelled'
|
|
944
|
+
| 'connection_to_bank_failed'
|
|
945
|
+
| 'international_transfer_blocked'
|
|
946
|
+
| 'international_transfer_limit_exceeded'
|
|
947
|
+
| 'user_blocked'
|
|
948
|
+
| 'bank_error'
|
|
949
|
+
| 'instant_transfers_not_enabled'
|
|
950
|
+
| 'no_active_tan_methods_available'
|
|
951
|
+
| 'account_limit_exceeded'
|
|
952
|
+
| 'bank_under_maintenance'
|
|
953
|
+
| 'pin_blocked'
|
|
954
|
+
| 'payment_not_settled';
|
|
955
|
+
}
|
|
1160
956
|
|
|
1161
|
-
|
|
957
|
+
export interface StatusHistoryList {
|
|
958
|
+
/**
|
|
959
|
+
* The order status. This status symbolises the state of the user's payment
|
|
960
|
+
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
961
|
+
* information.
|
|
962
|
+
*/
|
|
963
|
+
currentStatus:
|
|
964
|
+
| 'failed'
|
|
965
|
+
| 'canceled'
|
|
966
|
+
| 'processing'
|
|
967
|
+
| 'waiting_for_payment'
|
|
968
|
+
| 'paid'
|
|
969
|
+
| 'in_refund'
|
|
970
|
+
| 'refunded'
|
|
971
|
+
| 'refund_failed'
|
|
972
|
+
| 'partially_refunded'
|
|
973
|
+
| 'in_dispute'
|
|
974
|
+
| 'disputed'
|
|
975
|
+
| 'refused';
|
|
1162
976
|
|
|
1163
|
-
|
|
977
|
+
reason: string;
|
|
1164
978
|
|
|
1165
|
-
|
|
979
|
+
updatedAt: string;
|
|
1166
980
|
|
|
1167
|
-
|
|
981
|
+
/**
|
|
982
|
+
* The order status. This status symbolises the state of the user's payment
|
|
983
|
+
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
984
|
+
* information.
|
|
985
|
+
*/
|
|
986
|
+
previousStatus?:
|
|
987
|
+
| 'failed'
|
|
988
|
+
| 'canceled'
|
|
989
|
+
| 'processing'
|
|
990
|
+
| 'waiting_for_payment'
|
|
991
|
+
| 'paid'
|
|
992
|
+
| 'in_refund'
|
|
993
|
+
| 'refunded'
|
|
994
|
+
| 'refund_failed'
|
|
995
|
+
| 'partially_refunded'
|
|
996
|
+
| 'in_dispute'
|
|
997
|
+
| 'disputed'
|
|
998
|
+
| 'refused'
|
|
999
|
+
| null;
|
|
1168
1000
|
}
|
|
1001
|
+
}
|
|
1169
1002
|
|
|
1003
|
+
export interface OrderRetrieveResponse {
|
|
1170
1004
|
/**
|
|
1171
|
-
* The
|
|
1172
|
-
* express Checkout Session or passed during Checkout Session creation.
|
|
1005
|
+
* The Ivy unique identifier for the order.
|
|
1173
1006
|
*/
|
|
1174
|
-
|
|
1175
|
-
/**
|
|
1176
|
-
* The customer-facing name of the shipping method.
|
|
1177
|
-
*/
|
|
1178
|
-
name: string;
|
|
1007
|
+
id: string;
|
|
1179
1008
|
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1009
|
+
/**
|
|
1010
|
+
* @deprecated The unique identifier for the merchantApp which initiated the order
|
|
1011
|
+
* / payment attempt.
|
|
1012
|
+
*/
|
|
1013
|
+
appId: string;
|
|
1184
1014
|
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1015
|
+
/**
|
|
1016
|
+
* The Ivy fee for the payment.
|
|
1017
|
+
*/
|
|
1018
|
+
applicationFeeAmount: number;
|
|
1189
1019
|
|
|
1190
|
-
|
|
1191
|
-
* The list of countries where the shipping method is available.
|
|
1192
|
-
*/
|
|
1193
|
-
countries?: Array<
|
|
1194
|
-
| 'AF'
|
|
1195
|
-
| 'AL'
|
|
1196
|
-
| 'DZ'
|
|
1197
|
-
| 'AS'
|
|
1198
|
-
| 'AD'
|
|
1199
|
-
| 'AO'
|
|
1200
|
-
| 'AI'
|
|
1201
|
-
| 'AQ'
|
|
1202
|
-
| 'AG'
|
|
1203
|
-
| 'AR'
|
|
1204
|
-
| 'AM'
|
|
1205
|
-
| 'AW'
|
|
1206
|
-
| 'AU'
|
|
1207
|
-
| 'AT'
|
|
1208
|
-
| 'AZ'
|
|
1209
|
-
| 'BS'
|
|
1210
|
-
| 'BH'
|
|
1211
|
-
| 'BD'
|
|
1212
|
-
| 'BB'
|
|
1213
|
-
| 'BY'
|
|
1214
|
-
| 'BE'
|
|
1215
|
-
| 'BZ'
|
|
1216
|
-
| 'BJ'
|
|
1217
|
-
| 'BM'
|
|
1218
|
-
| 'BT'
|
|
1219
|
-
| 'BO'
|
|
1220
|
-
| 'BA'
|
|
1221
|
-
| 'BW'
|
|
1222
|
-
| 'BV'
|
|
1223
|
-
| 'BR'
|
|
1224
|
-
| 'IO'
|
|
1225
|
-
| 'BN'
|
|
1226
|
-
| 'BG'
|
|
1227
|
-
| 'BF'
|
|
1228
|
-
| 'BI'
|
|
1229
|
-
| 'KH'
|
|
1230
|
-
| 'CM'
|
|
1231
|
-
| 'CA'
|
|
1232
|
-
| 'CV'
|
|
1233
|
-
| 'KY'
|
|
1234
|
-
| 'CF'
|
|
1235
|
-
| 'TD'
|
|
1236
|
-
| 'CL'
|
|
1237
|
-
| 'CN'
|
|
1238
|
-
| 'CX'
|
|
1239
|
-
| 'CC'
|
|
1240
|
-
| 'CO'
|
|
1241
|
-
| 'KM'
|
|
1242
|
-
| 'CG'
|
|
1243
|
-
| 'CD'
|
|
1244
|
-
| 'CK'
|
|
1245
|
-
| 'CR'
|
|
1246
|
-
| 'CI'
|
|
1247
|
-
| 'HR'
|
|
1248
|
-
| 'CU'
|
|
1249
|
-
| 'CY'
|
|
1250
|
-
| 'CZ'
|
|
1251
|
-
| 'DK'
|
|
1252
|
-
| 'DJ'
|
|
1253
|
-
| 'DM'
|
|
1254
|
-
| 'DO'
|
|
1255
|
-
| 'EC'
|
|
1256
|
-
| 'EG'
|
|
1257
|
-
| 'SV'
|
|
1258
|
-
| 'GQ'
|
|
1259
|
-
| 'ER'
|
|
1260
|
-
| 'EE'
|
|
1261
|
-
| 'ET'
|
|
1262
|
-
| 'FK'
|
|
1263
|
-
| 'FO'
|
|
1264
|
-
| 'FJ'
|
|
1265
|
-
| 'FI'
|
|
1266
|
-
| 'FR'
|
|
1267
|
-
| 'GF'
|
|
1268
|
-
| 'PF'
|
|
1269
|
-
| 'TF'
|
|
1270
|
-
| 'GA'
|
|
1271
|
-
| 'GM'
|
|
1272
|
-
| 'GE'
|
|
1273
|
-
| 'DE'
|
|
1274
|
-
| 'GH'
|
|
1275
|
-
| 'GI'
|
|
1276
|
-
| 'GR'
|
|
1277
|
-
| 'GL'
|
|
1278
|
-
| 'GD'
|
|
1279
|
-
| 'GP'
|
|
1280
|
-
| 'GU'
|
|
1281
|
-
| 'GT'
|
|
1282
|
-
| 'GN'
|
|
1283
|
-
| 'GW'
|
|
1284
|
-
| 'GY'
|
|
1285
|
-
| 'HT'
|
|
1286
|
-
| 'HM'
|
|
1287
|
-
| 'VA'
|
|
1288
|
-
| 'HN'
|
|
1289
|
-
| 'HK'
|
|
1290
|
-
| 'HU'
|
|
1291
|
-
| 'IS'
|
|
1292
|
-
| 'IN'
|
|
1293
|
-
| 'ID'
|
|
1294
|
-
| 'IR'
|
|
1295
|
-
| 'IQ'
|
|
1296
|
-
| 'IE'
|
|
1297
|
-
| 'IL'
|
|
1298
|
-
| 'IT'
|
|
1299
|
-
| 'JM'
|
|
1300
|
-
| 'JP'
|
|
1301
|
-
| 'JO'
|
|
1302
|
-
| 'KZ'
|
|
1303
|
-
| 'KE'
|
|
1304
|
-
| 'KI'
|
|
1305
|
-
| 'KP'
|
|
1306
|
-
| 'KR'
|
|
1307
|
-
| 'KW'
|
|
1308
|
-
| 'KG'
|
|
1309
|
-
| 'LA'
|
|
1310
|
-
| 'LV'
|
|
1311
|
-
| 'LB'
|
|
1312
|
-
| 'LS'
|
|
1313
|
-
| 'LR'
|
|
1314
|
-
| 'LY'
|
|
1315
|
-
| 'LI'
|
|
1316
|
-
| 'LT'
|
|
1317
|
-
| 'LU'
|
|
1318
|
-
| 'MO'
|
|
1319
|
-
| 'MG'
|
|
1320
|
-
| 'MW'
|
|
1321
|
-
| 'MY'
|
|
1322
|
-
| 'MV'
|
|
1323
|
-
| 'ML'
|
|
1324
|
-
| 'MT'
|
|
1325
|
-
| 'MH'
|
|
1326
|
-
| 'MQ'
|
|
1327
|
-
| 'MR'
|
|
1328
|
-
| 'MU'
|
|
1329
|
-
| 'YT'
|
|
1330
|
-
| 'MX'
|
|
1331
|
-
| 'FM'
|
|
1332
|
-
| 'MD'
|
|
1333
|
-
| 'MC'
|
|
1334
|
-
| 'MN'
|
|
1335
|
-
| 'MS'
|
|
1336
|
-
| 'MA'
|
|
1337
|
-
| 'MZ'
|
|
1338
|
-
| 'MM'
|
|
1339
|
-
| 'NA'
|
|
1340
|
-
| 'NR'
|
|
1341
|
-
| 'NP'
|
|
1342
|
-
| 'NL'
|
|
1343
|
-
| 'NC'
|
|
1344
|
-
| 'NZ'
|
|
1345
|
-
| 'NI'
|
|
1346
|
-
| 'NE'
|
|
1347
|
-
| 'NG'
|
|
1348
|
-
| 'NU'
|
|
1349
|
-
| 'NF'
|
|
1350
|
-
| 'MP'
|
|
1351
|
-
| 'MK'
|
|
1352
|
-
| 'NO'
|
|
1353
|
-
| 'OM'
|
|
1354
|
-
| 'PK'
|
|
1355
|
-
| 'PW'
|
|
1356
|
-
| 'PS'
|
|
1357
|
-
| 'PA'
|
|
1358
|
-
| 'PG'
|
|
1359
|
-
| 'PY'
|
|
1360
|
-
| 'PE'
|
|
1361
|
-
| 'PH'
|
|
1362
|
-
| 'PN'
|
|
1363
|
-
| 'PL'
|
|
1364
|
-
| 'PT'
|
|
1365
|
-
| 'PR'
|
|
1366
|
-
| 'QA'
|
|
1367
|
-
| 'RE'
|
|
1368
|
-
| 'RO'
|
|
1369
|
-
| 'RU'
|
|
1370
|
-
| 'RW'
|
|
1371
|
-
| 'SH'
|
|
1372
|
-
| 'KN'
|
|
1373
|
-
| 'LC'
|
|
1374
|
-
| 'PM'
|
|
1375
|
-
| 'VC'
|
|
1376
|
-
| 'WS'
|
|
1377
|
-
| 'SM'
|
|
1378
|
-
| 'ST'
|
|
1379
|
-
| 'SA'
|
|
1380
|
-
| 'SN'
|
|
1381
|
-
| 'SC'
|
|
1382
|
-
| 'SL'
|
|
1383
|
-
| 'SG'
|
|
1384
|
-
| 'SK'
|
|
1385
|
-
| 'SI'
|
|
1386
|
-
| 'SB'
|
|
1387
|
-
| 'SO'
|
|
1388
|
-
| 'ZA'
|
|
1389
|
-
| 'GS'
|
|
1390
|
-
| 'ES'
|
|
1391
|
-
| 'LK'
|
|
1392
|
-
| 'SD'
|
|
1393
|
-
| 'SR'
|
|
1394
|
-
| 'SJ'
|
|
1395
|
-
| 'SZ'
|
|
1396
|
-
| 'SE'
|
|
1397
|
-
| 'CH'
|
|
1398
|
-
| 'SY'
|
|
1399
|
-
| 'TW'
|
|
1400
|
-
| 'TJ'
|
|
1401
|
-
| 'TZ'
|
|
1402
|
-
| 'TH'
|
|
1403
|
-
| 'TL'
|
|
1404
|
-
| 'TG'
|
|
1405
|
-
| 'TK'
|
|
1406
|
-
| 'TO'
|
|
1407
|
-
| 'TT'
|
|
1408
|
-
| 'TN'
|
|
1409
|
-
| 'TR'
|
|
1410
|
-
| 'TM'
|
|
1411
|
-
| 'TC'
|
|
1412
|
-
| 'TV'
|
|
1413
|
-
| 'UG'
|
|
1414
|
-
| 'UA'
|
|
1415
|
-
| 'AE'
|
|
1416
|
-
| 'GB'
|
|
1417
|
-
| 'US'
|
|
1418
|
-
| 'UM'
|
|
1419
|
-
| 'UY'
|
|
1420
|
-
| 'UZ'
|
|
1421
|
-
| 'VU'
|
|
1422
|
-
| 'VE'
|
|
1423
|
-
| 'VN'
|
|
1424
|
-
| 'VG'
|
|
1425
|
-
| 'VI'
|
|
1426
|
-
| 'WF'
|
|
1427
|
-
| 'EH'
|
|
1428
|
-
| 'YE'
|
|
1429
|
-
| 'ZM'
|
|
1430
|
-
| 'ZW'
|
|
1431
|
-
| 'AX'
|
|
1432
|
-
| 'BQ'
|
|
1433
|
-
| 'CW'
|
|
1434
|
-
| 'GG'
|
|
1435
|
-
| 'IM'
|
|
1436
|
-
| 'JE'
|
|
1437
|
-
| 'ME'
|
|
1438
|
-
| 'BL'
|
|
1439
|
-
| 'MF'
|
|
1440
|
-
| 'RS'
|
|
1441
|
-
| 'SX'
|
|
1442
|
-
| 'SS'
|
|
1443
|
-
| 'XK'
|
|
1444
|
-
>;
|
|
1445
|
-
|
|
1446
|
-
/**
|
|
1447
|
-
* The delivery estimate of the shipping method.
|
|
1448
|
-
*/
|
|
1449
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
1450
|
-
|
|
1451
|
-
/**
|
|
1452
|
-
* The unique identifier within your system of the shipping method.
|
|
1453
|
-
*/
|
|
1454
|
-
reference?: string;
|
|
1455
|
-
|
|
1456
|
-
/**
|
|
1457
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
1458
|
-
*/
|
|
1459
|
-
timeFrame?: string;
|
|
1460
|
-
}
|
|
1461
|
-
|
|
1462
|
-
export namespace ShippingMethod {
|
|
1463
|
-
/**
|
|
1464
|
-
* The delivery estimate of the shipping method.
|
|
1465
|
-
*/
|
|
1466
|
-
export interface DeliveryEstimate {
|
|
1467
|
-
/**
|
|
1468
|
-
* The maximum delivery time.
|
|
1469
|
-
*/
|
|
1470
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
1471
|
-
|
|
1472
|
-
/**
|
|
1473
|
-
* The minimum delivery time.
|
|
1474
|
-
*/
|
|
1475
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
1476
|
-
}
|
|
1020
|
+
createdAt: string;
|
|
1477
1021
|
|
|
1478
|
-
|
|
1479
|
-
/**
|
|
1480
|
-
* The maximum delivery time.
|
|
1481
|
-
*/
|
|
1482
|
-
export interface Maximum {
|
|
1483
|
-
/**
|
|
1484
|
-
* The unit of the time duration.
|
|
1485
|
-
*/
|
|
1486
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
1022
|
+
instantPaymentScheme: boolean;
|
|
1487
1023
|
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
}
|
|
1024
|
+
/**
|
|
1025
|
+
* @deprecated Deprecated in favor of `appId`.
|
|
1026
|
+
*/
|
|
1027
|
+
merchantAppId: string;
|
|
1493
1028
|
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
* The unit of the time duration.
|
|
1500
|
-
*/
|
|
1501
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
1029
|
+
/**
|
|
1030
|
+
* The unique identifier for the merchant which initiated the order / payment
|
|
1031
|
+
* attempt.
|
|
1032
|
+
*/
|
|
1033
|
+
merchantId: string;
|
|
1502
1034
|
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1035
|
+
/**
|
|
1036
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
1037
|
+
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1038
|
+
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1039
|
+
* as this is the format accepted by most banks.
|
|
1040
|
+
*/
|
|
1041
|
+
price: OrderRetrieveResponse.Price;
|
|
1510
1042
|
|
|
1511
1043
|
/**
|
|
1512
|
-
*
|
|
1513
|
-
*
|
|
1044
|
+
* An internal reference id which will be stored with the checkout & corresponding
|
|
1045
|
+
* order. Needs to be unique per shop per order and can be up to 200 characters.
|
|
1514
1046
|
*/
|
|
1515
|
-
|
|
1516
|
-
email?: string;
|
|
1047
|
+
referenceId: string;
|
|
1517
1048
|
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
/**
|
|
1523
|
-
* Populated with the primary payment initiation failure classsification if
|
|
1524
|
-
* available.
|
|
1525
|
-
*/
|
|
1526
|
-
primary?: string;
|
|
1527
|
-
|
|
1528
|
-
/**
|
|
1529
|
-
* Populated with the secondary payment initiation failure classsification if
|
|
1530
|
-
* available.
|
|
1531
|
-
*/
|
|
1532
|
-
secondary?: string;
|
|
1533
|
-
}
|
|
1534
|
-
|
|
1535
|
-
export interface StatusHistoryList {
|
|
1536
|
-
/**
|
|
1537
|
-
* The order status. This status symbolises the state of the user's payment
|
|
1538
|
-
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
1539
|
-
* information.
|
|
1540
|
-
*/
|
|
1541
|
-
currentStatus:
|
|
1542
|
-
| 'failed'
|
|
1543
|
-
| 'canceled'
|
|
1544
|
-
| 'processing'
|
|
1545
|
-
| 'in_handshake'
|
|
1546
|
-
| 'waiting_for_payment'
|
|
1547
|
-
| 'paid'
|
|
1548
|
-
| 'in_refund'
|
|
1549
|
-
| 'refunded'
|
|
1550
|
-
| 'refund_failed'
|
|
1551
|
-
| 'partially_refunded'
|
|
1552
|
-
| 'in_dispute'
|
|
1553
|
-
| 'disputed'
|
|
1554
|
-
| 'refused';
|
|
1555
|
-
|
|
1556
|
-
reason: string;
|
|
1557
|
-
|
|
1558
|
-
updatedAt: string;
|
|
1559
|
-
|
|
1560
|
-
/**
|
|
1561
|
-
* The order status. This status symbolises the state of the user's payment
|
|
1562
|
-
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
1563
|
-
* information.
|
|
1564
|
-
*/
|
|
1565
|
-
previousStatus?:
|
|
1566
|
-
| 'failed'
|
|
1567
|
-
| 'canceled'
|
|
1568
|
-
| 'processing'
|
|
1569
|
-
| 'in_handshake'
|
|
1570
|
-
| 'waiting_for_payment'
|
|
1571
|
-
| 'paid'
|
|
1572
|
-
| 'in_refund'
|
|
1573
|
-
| 'refunded'
|
|
1574
|
-
| 'refund_failed'
|
|
1575
|
-
| 'partially_refunded'
|
|
1576
|
-
| 'in_dispute'
|
|
1577
|
-
| 'disputed'
|
|
1578
|
-
| 'refused'
|
|
1579
|
-
| null;
|
|
1580
|
-
}
|
|
1581
|
-
}
|
|
1582
|
-
|
|
1583
|
-
export interface OrderUpdateResponse {
|
|
1584
|
-
/**
|
|
1585
|
-
* The Ivy unique identifier for the order.
|
|
1586
|
-
*/
|
|
1587
|
-
id: string;
|
|
1588
|
-
|
|
1589
|
-
/**
|
|
1590
|
-
* @deprecated The unique identifier for the merchantApp which initiated the order
|
|
1591
|
-
* / payment attempt.
|
|
1592
|
-
*/
|
|
1593
|
-
appId: string;
|
|
1594
|
-
|
|
1595
|
-
/**
|
|
1596
|
-
* The Ivy fee for the payment.
|
|
1597
|
-
*/
|
|
1598
|
-
applicationFeeAmount: number;
|
|
1599
|
-
|
|
1600
|
-
createdAt: string;
|
|
1601
|
-
|
|
1602
|
-
instantPaymentScheme: boolean;
|
|
1603
|
-
|
|
1604
|
-
/**
|
|
1605
|
-
* @deprecated Deprecated in favor of `appId`.
|
|
1606
|
-
*/
|
|
1607
|
-
merchantAppId: string;
|
|
1608
|
-
|
|
1609
|
-
/**
|
|
1610
|
-
* The unique identifier for the merchant which initiated the order / payment
|
|
1611
|
-
* attempt.
|
|
1612
|
-
*/
|
|
1613
|
-
merchantId: string;
|
|
1614
|
-
|
|
1615
|
-
/**
|
|
1616
|
-
* The price to be paid by the user. All amounts are in decimals, i.e. 10.23
|
|
1617
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1618
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1619
|
-
* as this is the format accepted by most banks.
|
|
1620
|
-
*/
|
|
1621
|
-
price: OrderUpdateResponse.Price;
|
|
1622
|
-
|
|
1623
|
-
/**
|
|
1624
|
-
* An internal reference id which will be stored with the checkout & corresponding
|
|
1625
|
-
* order. Needs to be unique per shop per order and can be up to 200 characters.
|
|
1626
|
-
*/
|
|
1627
|
-
referenceId: string;
|
|
1628
|
-
|
|
1629
|
-
/**
|
|
1630
|
-
* The name of the merchant which initiated the order.
|
|
1631
|
-
*/
|
|
1632
|
-
shopName: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* The name of the merchant which initiated the order.
|
|
1051
|
+
*/
|
|
1052
|
+
shopName: string;
|
|
1633
1053
|
|
|
1634
1054
|
/**
|
|
1635
1055
|
* The order status. This status symbolises the state of the user's payment
|
|
@@ -1640,7 +1060,6 @@ export interface OrderUpdateResponse {
|
|
|
1640
1060
|
| 'failed'
|
|
1641
1061
|
| 'canceled'
|
|
1642
1062
|
| 'processing'
|
|
1643
|
-
| 'in_handshake'
|
|
1644
1063
|
| 'waiting_for_payment'
|
|
1645
1064
|
| 'paid'
|
|
1646
1065
|
| 'in_refund'
|
|
@@ -1654,1102 +1073,165 @@ export interface OrderUpdateResponse {
|
|
|
1654
1073
|
updatedAt: string;
|
|
1655
1074
|
|
|
1656
1075
|
/**
|
|
1657
|
-
* The
|
|
1658
|
-
*
|
|
1659
|
-
*/
|
|
1660
|
-
bankStatementReference?: string;
|
|
1661
|
-
|
|
1662
|
-
/**
|
|
1663
|
-
* The billing address of the user. Required when handshake=true.
|
|
1664
|
-
*/
|
|
1665
|
-
billingAddress?: OrderUpdateResponse.BillingAddress;
|
|
1666
|
-
|
|
1667
|
-
/**
|
|
1668
|
-
* The merchant category code or
|
|
1669
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
1670
|
-
*/
|
|
1671
|
-
category?: string;
|
|
1672
|
-
|
|
1673
|
-
/**
|
|
1674
|
-
* @deprecated
|
|
1675
|
-
*/
|
|
1676
|
-
climateActionMode?: OrderUpdateResponse.ClimateActionMode;
|
|
1677
|
-
|
|
1678
|
-
/**
|
|
1679
|
-
* @deprecated
|
|
1680
|
-
*/
|
|
1681
|
-
co2Grams?: number;
|
|
1682
|
-
|
|
1683
|
-
/**
|
|
1684
|
-
* The unique identifier of the customer who placed the order.
|
|
1685
|
-
*/
|
|
1686
|
-
customerId?: string;
|
|
1687
|
-
|
|
1688
|
-
/**
|
|
1689
|
-
* The customer facing id. This id is displayed to the user during the checkout and
|
|
1690
|
-
* in the merchant dashboard.
|
|
1691
|
-
*/
|
|
1692
|
-
displayId?: string;
|
|
1693
|
-
|
|
1694
|
-
/**
|
|
1695
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
1696
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
1697
|
-
*/
|
|
1698
|
-
guest?: boolean;
|
|
1699
|
-
|
|
1700
|
-
/**
|
|
1701
|
-
* Only valid for sustainable incentive mode. The social / sustainable projects
|
|
1702
|
-
* available to the user during Checkout.
|
|
1703
|
-
*/
|
|
1704
|
-
impactOffsetProjects?: Array<string>;
|
|
1705
|
-
|
|
1706
|
-
/**
|
|
1707
|
-
* The incentive mode of the checkout session. For any use-case apart from
|
|
1708
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
1709
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
1710
|
-
* session will contain sustainable incentives for users.
|
|
1711
|
-
*/
|
|
1712
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
1713
|
-
|
|
1714
|
-
/**
|
|
1715
|
-
* The line items of the Checkout.
|
|
1716
|
-
*/
|
|
1717
|
-
lineItems?: Array<OrderUpdateResponse.LineItem>;
|
|
1718
|
-
|
|
1719
|
-
mandate?: OrderUpdateResponse.Mandate;
|
|
1720
|
-
|
|
1721
|
-
/**
|
|
1722
|
-
* The destination bank account where the money will be sent to.
|
|
1723
|
-
*/
|
|
1724
|
-
merchantFinancialAddress?: OrderUpdateResponse.MerchantFinancialAddress;
|
|
1725
|
-
|
|
1726
|
-
/**
|
|
1727
|
-
* Any data which will be stored and returned for this checkout session and
|
|
1728
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
1729
|
-
* more info.
|
|
1730
|
-
*/
|
|
1731
|
-
metadata?: Record<string, unknown>;
|
|
1732
|
-
|
|
1733
|
-
/**
|
|
1734
|
-
* Only valid for sustainable incentive mode. The social / sustainability project
|
|
1735
|
-
* chosen by the user during Checkout.
|
|
1736
|
-
*/
|
|
1737
|
-
offsetProject?: string;
|
|
1738
|
-
|
|
1739
|
-
/**
|
|
1740
|
-
* The source bank account where the money is send from.
|
|
1741
|
-
*/
|
|
1742
|
-
payerFinancialAddress?: OrderUpdateResponse.PayerFinancialAddress;
|
|
1743
|
-
|
|
1744
|
-
paymentMethodType?: 'sepa_debit' | 'customer_balance';
|
|
1745
|
-
|
|
1746
|
-
/**
|
|
1747
|
-
* The payment mode of the order. Can be either 'settlement' or 'direct'.
|
|
1748
|
-
*/
|
|
1749
|
-
paymentMode?: 'settlement' | 'direct';
|
|
1750
|
-
|
|
1751
|
-
/**
|
|
1752
|
-
* @deprecated Deprecated in favor of `status`. Do not use this field to trigger
|
|
1753
|
-
* actions in your system.
|
|
1754
|
-
*/
|
|
1755
|
-
paymentStatus?:
|
|
1756
|
-
| 'failed'
|
|
1757
|
-
| 'canceled'
|
|
1758
|
-
| 'processing'
|
|
1759
|
-
| 'requires_action'
|
|
1760
|
-
| 'succeeded'
|
|
1761
|
-
| 'in_refund'
|
|
1762
|
-
| 'refunded'
|
|
1763
|
-
| 'refund_failed'
|
|
1764
|
-
| 'partially_refunded'
|
|
1765
|
-
| 'not_settled'
|
|
1766
|
-
| 'disputed';
|
|
1767
|
-
|
|
1768
|
-
/**
|
|
1769
|
-
* The total amount in the currency of all successful refunds for this order
|
|
1770
|
-
*/
|
|
1771
|
-
refundAmount?: number;
|
|
1772
|
-
|
|
1773
|
-
/**
|
|
1774
|
-
* The list of refunds connected to this order.
|
|
1775
|
-
*/
|
|
1776
|
-
refunds?: Array<OrderUpdateResponse.Refund>;
|
|
1777
|
-
|
|
1778
|
-
/**
|
|
1779
|
-
* The shipping address of the user. This is only collected in express Checkouts.
|
|
1780
|
-
*/
|
|
1781
|
-
shippingAddress?: OrderUpdateResponse.ShippingAddress;
|
|
1782
|
-
|
|
1783
|
-
/**
|
|
1784
|
-
* The selected shipping method by the user. Can either be selected during an
|
|
1785
|
-
* express Checkout Session or passed during Checkout Session creation.
|
|
1786
|
-
*/
|
|
1787
|
-
shippingMethod?: OrderUpdateResponse.ShippingMethod;
|
|
1788
|
-
|
|
1789
|
-
/**
|
|
1790
|
-
* The logo of the shop provided as a URL.
|
|
1791
|
-
*/
|
|
1792
|
-
shopLogo?: string;
|
|
1793
|
-
|
|
1794
|
-
/**
|
|
1795
|
-
* The shopper object. Contains information collected from the user during the
|
|
1796
|
-
* Checkout.
|
|
1797
|
-
*/
|
|
1798
|
-
shopper?: OrderUpdateResponse.Shopper;
|
|
1799
|
-
|
|
1800
|
-
/**
|
|
1801
|
-
* @deprecated Deprecated in favor of `shopper.email`. The email of the user if
|
|
1802
|
-
* collected in the Checkout.
|
|
1803
|
-
*/
|
|
1804
|
-
shopperEmail?: string;
|
|
1805
|
-
|
|
1806
|
-
statusClassification?: OrderUpdateResponse.StatusClassification;
|
|
1807
|
-
|
|
1808
|
-
/**
|
|
1809
|
-
* List of status history items for the order, used for logging every update on
|
|
1810
|
-
* status.
|
|
1811
|
-
*/
|
|
1812
|
-
statusHistoryList?: Array<OrderUpdateResponse.StatusHistoryList>;
|
|
1813
|
-
|
|
1814
|
-
/**
|
|
1815
|
-
* The subaccount id of the order.
|
|
1816
|
-
*/
|
|
1817
|
-
subaccountId?: string;
|
|
1818
|
-
|
|
1819
|
-
/**
|
|
1820
|
-
* The legal name of the subaccount
|
|
1076
|
+
* The unique identifier of Ivy of the chosen bank to make the payment. Not there,
|
|
1077
|
+
* if no payment was made.
|
|
1821
1078
|
*/
|
|
1822
|
-
|
|
1079
|
+
bankId?: string;
|
|
1823
1080
|
|
|
1824
1081
|
/**
|
|
1825
|
-
* @deprecated
|
|
1082
|
+
* @deprecated The bank statement reference of the payment for the order. This is
|
|
1083
|
+
* the reference that will be visible on the bank statement.
|
|
1826
1084
|
*/
|
|
1827
|
-
|
|
1828
|
-
}
|
|
1085
|
+
bankStatementReference?: string;
|
|
1829
1086
|
|
|
1830
|
-
export namespace OrderUpdateResponse {
|
|
1831
1087
|
/**
|
|
1832
|
-
* The
|
|
1833
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1834
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1835
|
-
* as this is the format accepted by most banks.
|
|
1088
|
+
* The billing address of the customer.
|
|
1836
1089
|
*/
|
|
1837
|
-
|
|
1838
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
1839
|
-
|
|
1840
|
-
/**
|
|
1841
|
-
* The total amount to be paid.
|
|
1842
|
-
*/
|
|
1843
|
-
total: number;
|
|
1844
|
-
|
|
1845
|
-
/**
|
|
1846
|
-
* The shipping amount.
|
|
1847
|
-
*/
|
|
1848
|
-
shipping?: number;
|
|
1849
|
-
|
|
1850
|
-
/**
|
|
1851
|
-
* The subtotal amount, i.e. the total amount without VAT and shipping.
|
|
1852
|
-
*/
|
|
1853
|
-
subTotal?: number;
|
|
1854
|
-
|
|
1855
|
-
/**
|
|
1856
|
-
* The total net amount, i.e. the total amount without VAT. This value is rounded
|
|
1857
|
-
* to 2 decimal places for the actual transfer.
|
|
1858
|
-
*/
|
|
1859
|
-
totalNet?: number;
|
|
1860
|
-
|
|
1861
|
-
/**
|
|
1862
|
-
* The VAT amount.
|
|
1863
|
-
*/
|
|
1864
|
-
vat?: number;
|
|
1865
|
-
}
|
|
1090
|
+
billingAddress?: OrderRetrieveResponse.BillingAddress;
|
|
1866
1091
|
|
|
1867
1092
|
/**
|
|
1868
|
-
* The
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
/**
|
|
1874
|
-
* The country code in
|
|
1875
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1876
|
-
*/
|
|
1877
|
-
country:
|
|
1878
|
-
| 'AF'
|
|
1879
|
-
| 'AL'
|
|
1880
|
-
| 'DZ'
|
|
1881
|
-
| 'AS'
|
|
1882
|
-
| 'AD'
|
|
1883
|
-
| 'AO'
|
|
1884
|
-
| 'AI'
|
|
1885
|
-
| 'AQ'
|
|
1886
|
-
| 'AG'
|
|
1887
|
-
| 'AR'
|
|
1888
|
-
| 'AM'
|
|
1889
|
-
| 'AW'
|
|
1890
|
-
| 'AU'
|
|
1891
|
-
| 'AT'
|
|
1892
|
-
| 'AZ'
|
|
1893
|
-
| 'BS'
|
|
1894
|
-
| 'BH'
|
|
1895
|
-
| 'BD'
|
|
1896
|
-
| 'BB'
|
|
1897
|
-
| 'BY'
|
|
1898
|
-
| 'BE'
|
|
1899
|
-
| 'BZ'
|
|
1900
|
-
| 'BJ'
|
|
1901
|
-
| 'BM'
|
|
1902
|
-
| 'BT'
|
|
1903
|
-
| 'BO'
|
|
1904
|
-
| 'BA'
|
|
1905
|
-
| 'BW'
|
|
1906
|
-
| 'BV'
|
|
1907
|
-
| 'BR'
|
|
1908
|
-
| 'IO'
|
|
1909
|
-
| 'BN'
|
|
1910
|
-
| 'BG'
|
|
1911
|
-
| 'BF'
|
|
1912
|
-
| 'BI'
|
|
1913
|
-
| 'KH'
|
|
1914
|
-
| 'CM'
|
|
1915
|
-
| 'CA'
|
|
1916
|
-
| 'CV'
|
|
1917
|
-
| 'KY'
|
|
1918
|
-
| 'CF'
|
|
1919
|
-
| 'TD'
|
|
1920
|
-
| 'CL'
|
|
1921
|
-
| 'CN'
|
|
1922
|
-
| 'CX'
|
|
1923
|
-
| 'CC'
|
|
1924
|
-
| 'CO'
|
|
1925
|
-
| 'KM'
|
|
1926
|
-
| 'CG'
|
|
1927
|
-
| 'CD'
|
|
1928
|
-
| 'CK'
|
|
1929
|
-
| 'CR'
|
|
1930
|
-
| 'CI'
|
|
1931
|
-
| 'HR'
|
|
1932
|
-
| 'CU'
|
|
1933
|
-
| 'CY'
|
|
1934
|
-
| 'CZ'
|
|
1935
|
-
| 'DK'
|
|
1936
|
-
| 'DJ'
|
|
1937
|
-
| 'DM'
|
|
1938
|
-
| 'DO'
|
|
1939
|
-
| 'EC'
|
|
1940
|
-
| 'EG'
|
|
1941
|
-
| 'SV'
|
|
1942
|
-
| 'GQ'
|
|
1943
|
-
| 'ER'
|
|
1944
|
-
| 'EE'
|
|
1945
|
-
| 'ET'
|
|
1946
|
-
| 'FK'
|
|
1947
|
-
| 'FO'
|
|
1948
|
-
| 'FJ'
|
|
1949
|
-
| 'FI'
|
|
1950
|
-
| 'FR'
|
|
1951
|
-
| 'GF'
|
|
1952
|
-
| 'PF'
|
|
1953
|
-
| 'TF'
|
|
1954
|
-
| 'GA'
|
|
1955
|
-
| 'GM'
|
|
1956
|
-
| 'GE'
|
|
1957
|
-
| 'DE'
|
|
1958
|
-
| 'GH'
|
|
1959
|
-
| 'GI'
|
|
1960
|
-
| 'GR'
|
|
1961
|
-
| 'GL'
|
|
1962
|
-
| 'GD'
|
|
1963
|
-
| 'GP'
|
|
1964
|
-
| 'GU'
|
|
1965
|
-
| 'GT'
|
|
1966
|
-
| 'GN'
|
|
1967
|
-
| 'GW'
|
|
1968
|
-
| 'GY'
|
|
1969
|
-
| 'HT'
|
|
1970
|
-
| 'HM'
|
|
1971
|
-
| 'VA'
|
|
1972
|
-
| 'HN'
|
|
1973
|
-
| 'HK'
|
|
1974
|
-
| 'HU'
|
|
1975
|
-
| 'IS'
|
|
1976
|
-
| 'IN'
|
|
1977
|
-
| 'ID'
|
|
1978
|
-
| 'IR'
|
|
1979
|
-
| 'IQ'
|
|
1980
|
-
| 'IE'
|
|
1981
|
-
| 'IL'
|
|
1982
|
-
| 'IT'
|
|
1983
|
-
| 'JM'
|
|
1984
|
-
| 'JP'
|
|
1985
|
-
| 'JO'
|
|
1986
|
-
| 'KZ'
|
|
1987
|
-
| 'KE'
|
|
1988
|
-
| 'KI'
|
|
1989
|
-
| 'KP'
|
|
1990
|
-
| 'KR'
|
|
1991
|
-
| 'KW'
|
|
1992
|
-
| 'KG'
|
|
1993
|
-
| 'LA'
|
|
1994
|
-
| 'LV'
|
|
1995
|
-
| 'LB'
|
|
1996
|
-
| 'LS'
|
|
1997
|
-
| 'LR'
|
|
1998
|
-
| 'LY'
|
|
1999
|
-
| 'LI'
|
|
2000
|
-
| 'LT'
|
|
2001
|
-
| 'LU'
|
|
2002
|
-
| 'MO'
|
|
2003
|
-
| 'MG'
|
|
2004
|
-
| 'MW'
|
|
2005
|
-
| 'MY'
|
|
2006
|
-
| 'MV'
|
|
2007
|
-
| 'ML'
|
|
2008
|
-
| 'MT'
|
|
2009
|
-
| 'MH'
|
|
2010
|
-
| 'MQ'
|
|
2011
|
-
| 'MR'
|
|
2012
|
-
| 'MU'
|
|
2013
|
-
| 'YT'
|
|
2014
|
-
| 'MX'
|
|
2015
|
-
| 'FM'
|
|
2016
|
-
| 'MD'
|
|
2017
|
-
| 'MC'
|
|
2018
|
-
| 'MN'
|
|
2019
|
-
| 'MS'
|
|
2020
|
-
| 'MA'
|
|
2021
|
-
| 'MZ'
|
|
2022
|
-
| 'MM'
|
|
2023
|
-
| 'NA'
|
|
2024
|
-
| 'NR'
|
|
2025
|
-
| 'NP'
|
|
2026
|
-
| 'NL'
|
|
2027
|
-
| 'NC'
|
|
2028
|
-
| 'NZ'
|
|
2029
|
-
| 'NI'
|
|
2030
|
-
| 'NE'
|
|
2031
|
-
| 'NG'
|
|
2032
|
-
| 'NU'
|
|
2033
|
-
| 'NF'
|
|
2034
|
-
| 'MP'
|
|
2035
|
-
| 'MK'
|
|
2036
|
-
| 'NO'
|
|
2037
|
-
| 'OM'
|
|
2038
|
-
| 'PK'
|
|
2039
|
-
| 'PW'
|
|
2040
|
-
| 'PS'
|
|
2041
|
-
| 'PA'
|
|
2042
|
-
| 'PG'
|
|
2043
|
-
| 'PY'
|
|
2044
|
-
| 'PE'
|
|
2045
|
-
| 'PH'
|
|
2046
|
-
| 'PN'
|
|
2047
|
-
| 'PL'
|
|
2048
|
-
| 'PT'
|
|
2049
|
-
| 'PR'
|
|
2050
|
-
| 'QA'
|
|
2051
|
-
| 'RE'
|
|
2052
|
-
| 'RO'
|
|
2053
|
-
| 'RU'
|
|
2054
|
-
| 'RW'
|
|
2055
|
-
| 'SH'
|
|
2056
|
-
| 'KN'
|
|
2057
|
-
| 'LC'
|
|
2058
|
-
| 'PM'
|
|
2059
|
-
| 'VC'
|
|
2060
|
-
| 'WS'
|
|
2061
|
-
| 'SM'
|
|
2062
|
-
| 'ST'
|
|
2063
|
-
| 'SA'
|
|
2064
|
-
| 'SN'
|
|
2065
|
-
| 'SC'
|
|
2066
|
-
| 'SL'
|
|
2067
|
-
| 'SG'
|
|
2068
|
-
| 'SK'
|
|
2069
|
-
| 'SI'
|
|
2070
|
-
| 'SB'
|
|
2071
|
-
| 'SO'
|
|
2072
|
-
| 'ZA'
|
|
2073
|
-
| 'GS'
|
|
2074
|
-
| 'ES'
|
|
2075
|
-
| 'LK'
|
|
2076
|
-
| 'SD'
|
|
2077
|
-
| 'SR'
|
|
2078
|
-
| 'SJ'
|
|
2079
|
-
| 'SZ'
|
|
2080
|
-
| 'SE'
|
|
2081
|
-
| 'CH'
|
|
2082
|
-
| 'SY'
|
|
2083
|
-
| 'TW'
|
|
2084
|
-
| 'TJ'
|
|
2085
|
-
| 'TZ'
|
|
2086
|
-
| 'TH'
|
|
2087
|
-
| 'TL'
|
|
2088
|
-
| 'TG'
|
|
2089
|
-
| 'TK'
|
|
2090
|
-
| 'TO'
|
|
2091
|
-
| 'TT'
|
|
2092
|
-
| 'TN'
|
|
2093
|
-
| 'TR'
|
|
2094
|
-
| 'TM'
|
|
2095
|
-
| 'TC'
|
|
2096
|
-
| 'TV'
|
|
2097
|
-
| 'UG'
|
|
2098
|
-
| 'UA'
|
|
2099
|
-
| 'AE'
|
|
2100
|
-
| 'GB'
|
|
2101
|
-
| 'US'
|
|
2102
|
-
| 'UM'
|
|
2103
|
-
| 'UY'
|
|
2104
|
-
| 'UZ'
|
|
2105
|
-
| 'VU'
|
|
2106
|
-
| 'VE'
|
|
2107
|
-
| 'VN'
|
|
2108
|
-
| 'VG'
|
|
2109
|
-
| 'VI'
|
|
2110
|
-
| 'WF'
|
|
2111
|
-
| 'EH'
|
|
2112
|
-
| 'YE'
|
|
2113
|
-
| 'ZM'
|
|
2114
|
-
| 'ZW'
|
|
2115
|
-
| 'AX'
|
|
2116
|
-
| 'BQ'
|
|
2117
|
-
| 'CW'
|
|
2118
|
-
| 'GG'
|
|
2119
|
-
| 'IM'
|
|
2120
|
-
| 'JE'
|
|
2121
|
-
| 'ME'
|
|
2122
|
-
| 'BL'
|
|
2123
|
-
| 'MF'
|
|
2124
|
-
| 'RS'
|
|
2125
|
-
| 'SX'
|
|
2126
|
-
| 'SS'
|
|
2127
|
-
| 'XK';
|
|
2128
|
-
|
|
2129
|
-
line1: string;
|
|
2130
|
-
|
|
2131
|
-
zipCode: string;
|
|
2132
|
-
|
|
2133
|
-
firstName?: string;
|
|
2134
|
-
|
|
2135
|
-
lastName?: string;
|
|
2136
|
-
|
|
2137
|
-
line2?: string;
|
|
2138
|
-
|
|
2139
|
-
region?: string;
|
|
2140
|
-
}
|
|
2141
|
-
|
|
2142
|
-
/**
|
|
2143
|
-
* @deprecated
|
|
2144
|
-
*/
|
|
2145
|
-
export interface ClimateActionMode {
|
|
2146
|
-
amount: number;
|
|
2147
|
-
|
|
2148
|
-
type: 'transaction' | 'amount';
|
|
2149
|
-
}
|
|
2150
|
-
|
|
2151
|
-
export interface LineItem {
|
|
2152
|
-
/**
|
|
2153
|
-
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
2154
|
-
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
2155
|
-
*/
|
|
2156
|
-
amount: number;
|
|
2157
|
-
|
|
2158
|
-
/**
|
|
2159
|
-
* The name of the line item.
|
|
2160
|
-
*/
|
|
2161
|
-
name: string;
|
|
2162
|
-
|
|
2163
|
-
/**
|
|
2164
|
-
* The quantity of the line item.
|
|
2165
|
-
*/
|
|
2166
|
-
quantity: number;
|
|
2167
|
-
|
|
2168
|
-
/**
|
|
2169
|
-
* The net amount of a single item.
|
|
2170
|
-
*/
|
|
2171
|
-
singleNet: number;
|
|
2172
|
-
|
|
2173
|
-
/**
|
|
2174
|
-
* The VAT amount of a single item.
|
|
2175
|
-
*/
|
|
2176
|
-
singleVat: number;
|
|
2177
|
-
|
|
2178
|
-
/**
|
|
2179
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
2180
|
-
* the line item.
|
|
2181
|
-
*/
|
|
2182
|
-
category?: string;
|
|
2183
|
-
|
|
2184
|
-
/**
|
|
2185
|
-
* The
|
|
2186
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
2187
|
-
* of the line item.
|
|
2188
|
-
*/
|
|
2189
|
-
EAN?: string;
|
|
2190
|
-
|
|
2191
|
-
/**
|
|
2192
|
-
* The image of the line item as a URL.
|
|
2193
|
-
*/
|
|
2194
|
-
image?: string;
|
|
2195
|
-
|
|
2196
|
-
/**
|
|
2197
|
-
* The internal unique identifier of the line item.
|
|
2198
|
-
*/
|
|
2199
|
-
referenceId?: string;
|
|
2200
|
-
}
|
|
2201
|
-
|
|
2202
|
-
export interface Mandate {
|
|
2203
|
-
/**
|
|
2204
|
-
* The name of the account holder who signs the mandate.
|
|
2205
|
-
*/
|
|
2206
|
-
accountHolderName?: string;
|
|
2207
|
-
|
|
2208
|
-
/**
|
|
2209
|
-
* Additional information to display to the user during the mandate setup. This
|
|
2210
|
-
* information is not used to setup any recurrence on the mandate. It is only
|
|
2211
|
-
* displayed to the user during checkout.
|
|
2212
|
-
*/
|
|
2213
|
-
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
2214
|
-
|
|
2215
|
-
/**
|
|
2216
|
-
* Mandate creditor data
|
|
2217
|
-
*/
|
|
2218
|
-
creditor?: Mandate.Creditor;
|
|
2219
|
-
|
|
2220
|
-
/**
|
|
2221
|
-
* The reference of the mandate going to be setup
|
|
2222
|
-
*/
|
|
2223
|
-
reference?: string;
|
|
2224
|
-
|
|
2225
|
-
/**
|
|
2226
|
-
* The mandate referenceId. Set this to match incoming `mandate_setup_started`,
|
|
2227
|
-
* `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
|
|
2228
|
-
* mandate setup request.
|
|
2229
|
-
*/
|
|
2230
|
-
referenceId?: string;
|
|
2231
|
-
|
|
2232
|
-
/**
|
|
2233
|
-
* If true, a ready to use mandate will be set up after the payment flow.
|
|
2234
|
-
*/
|
|
2235
|
-
setup?: boolean;
|
|
2236
|
-
|
|
2237
|
-
/**
|
|
2238
|
-
* The email of the user who signs the mandate.
|
|
2239
|
-
*/
|
|
2240
|
-
userNotificationEmail?: string;
|
|
2241
|
-
}
|
|
2242
|
-
|
|
2243
|
-
export namespace Mandate {
|
|
2244
|
-
/**
|
|
2245
|
-
* Additional information to display to the user during the mandate setup. This
|
|
2246
|
-
* information is not used to setup any recurrence on the mandate. It is only
|
|
2247
|
-
* displayed to the user during checkout.
|
|
2248
|
-
*/
|
|
2249
|
-
export interface AdditionalDisplayInformation {
|
|
2250
|
-
/**
|
|
2251
|
-
* The intended cadence of charges used for displaying purpose only. On demand
|
|
2252
|
-
* would be used for unscheduled charges.
|
|
2253
|
-
*/
|
|
2254
|
-
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
2255
|
-
|
|
2256
|
-
price?: AdditionalDisplayInformation.Price;
|
|
2257
|
-
}
|
|
2258
|
-
|
|
2259
|
-
export namespace AdditionalDisplayInformation {
|
|
2260
|
-
export interface Price {
|
|
2261
|
-
/**
|
|
2262
|
-
* The amount displayed to the user as decimal e.g. 10.23 would be displayed as
|
|
2263
|
-
* 10.23 EUR.
|
|
2264
|
-
*/
|
|
2265
|
-
amount?: number;
|
|
2266
|
-
|
|
2267
|
-
currency?: 'EUR' | 'GBP' | 'PLN';
|
|
2268
|
-
}
|
|
2269
|
-
}
|
|
2270
|
-
|
|
2271
|
-
/**
|
|
2272
|
-
* Mandate creditor data
|
|
2273
|
-
*/
|
|
2274
|
-
export interface Creditor {
|
|
2275
|
-
id?: string;
|
|
2276
|
-
|
|
2277
|
-
name?: string;
|
|
2278
|
-
}
|
|
2279
|
-
}
|
|
2280
|
-
|
|
2281
|
-
/**
|
|
2282
|
-
* The destination bank account where the money will be sent to.
|
|
2283
|
-
*/
|
|
2284
|
-
export interface MerchantFinancialAddress {
|
|
2285
|
-
bankCode?: MerchantFinancialAddress.BankCode;
|
|
2286
|
-
|
|
2287
|
-
bban?: MerchantFinancialAddress.Bban;
|
|
2288
|
-
|
|
2289
|
-
iban?: MerchantFinancialAddress.Iban;
|
|
2290
|
-
|
|
2291
|
-
/**
|
|
2292
|
-
* The payment reference for the order. This is the reference that will be visible
|
|
2293
|
-
* on the bank statement.
|
|
2294
|
-
*/
|
|
2295
|
-
paymentReference?: string;
|
|
2296
|
-
|
|
2297
|
-
sortCode?: MerchantFinancialAddress.SortCode;
|
|
2298
|
-
|
|
2299
|
-
/**
|
|
2300
|
-
* The type of the financial address. The actual destination is determined by this
|
|
2301
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
2302
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
2303
|
-
* in the "iban" object.
|
|
2304
|
-
*
|
|
2305
|
-
* - iban: The IBAN of the account
|
|
2306
|
-
* - sort_code: The sort code of the account
|
|
2307
|
-
* - bank_code: The bank code of the account
|
|
2308
|
-
* - bban: The BBAN of the account
|
|
2309
|
-
*/
|
|
2310
|
-
type?: string;
|
|
2311
|
-
}
|
|
2312
|
-
|
|
2313
|
-
export namespace MerchantFinancialAddress {
|
|
2314
|
-
export interface BankCode {
|
|
2315
|
-
/**
|
|
2316
|
-
* The name of the account holder.
|
|
2317
|
-
*/
|
|
2318
|
-
accountHolderName: string;
|
|
2319
|
-
|
|
2320
|
-
accountNumber: string;
|
|
2321
|
-
|
|
2322
|
-
code: string;
|
|
2323
|
-
}
|
|
2324
|
-
|
|
2325
|
-
export interface Bban {
|
|
2326
|
-
/**
|
|
2327
|
-
* The name of the account holder.
|
|
2328
|
-
*/
|
|
2329
|
-
accountHolderName: string;
|
|
2330
|
-
|
|
2331
|
-
bban: string;
|
|
2332
|
-
|
|
2333
|
-
bic?: string;
|
|
2334
|
-
}
|
|
2335
|
-
|
|
2336
|
-
export interface Iban {
|
|
2337
|
-
/**
|
|
2338
|
-
* The name of the account holder.
|
|
2339
|
-
*/
|
|
2340
|
-
accountHolderName: string;
|
|
2341
|
-
|
|
2342
|
-
iban: string;
|
|
2343
|
-
|
|
2344
|
-
bic?: string;
|
|
2345
|
-
}
|
|
2346
|
-
|
|
2347
|
-
export interface SortCode {
|
|
2348
|
-
/**
|
|
2349
|
-
* The name of the account holder.
|
|
2350
|
-
*/
|
|
2351
|
-
accountHolderName: string;
|
|
2352
|
-
|
|
2353
|
-
accountNumber: string;
|
|
2354
|
-
|
|
2355
|
-
sortCode: string;
|
|
2356
|
-
}
|
|
2357
|
-
}
|
|
2358
|
-
|
|
2359
|
-
/**
|
|
2360
|
-
* The source bank account where the money is send from.
|
|
2361
|
-
*/
|
|
2362
|
-
export interface PayerFinancialAddress {
|
|
2363
|
-
/**
|
|
2364
|
-
* The type of the financial address. The actual destination is determined by this
|
|
2365
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
2366
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
2367
|
-
* in the "iban" object.
|
|
2368
|
-
*
|
|
2369
|
-
* - iban: The IBAN of the account
|
|
2370
|
-
* - sort_code: The sort code of the account
|
|
2371
|
-
* - bank_code: The bank code of the account
|
|
2372
|
-
* - bban: The BBAN of the account
|
|
2373
|
-
*/
|
|
2374
|
-
type: string;
|
|
2375
|
-
|
|
2376
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
2377
|
-
|
|
2378
|
-
bban?: PayerFinancialAddress.Bban;
|
|
2379
|
-
|
|
2380
|
-
iban?: PayerFinancialAddress.Iban;
|
|
2381
|
-
|
|
2382
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
2383
|
-
}
|
|
2384
|
-
|
|
2385
|
-
export namespace PayerFinancialAddress {
|
|
2386
|
-
export interface BankCode {
|
|
2387
|
-
accountNumber: string;
|
|
2388
|
-
|
|
2389
|
-
code: string;
|
|
2390
|
-
|
|
2391
|
-
/**
|
|
2392
|
-
* The name of the account holder.
|
|
2393
|
-
*/
|
|
2394
|
-
accountHolderName?: string;
|
|
2395
|
-
}
|
|
2396
|
-
|
|
2397
|
-
export interface Bban {
|
|
2398
|
-
bban: string;
|
|
2399
|
-
|
|
2400
|
-
/**
|
|
2401
|
-
* The name of the account holder.
|
|
2402
|
-
*/
|
|
2403
|
-
accountHolderName?: string;
|
|
2404
|
-
|
|
2405
|
-
bic?: string;
|
|
2406
|
-
}
|
|
2407
|
-
|
|
2408
|
-
export interface Iban {
|
|
2409
|
-
iban: string;
|
|
2410
|
-
|
|
2411
|
-
/**
|
|
2412
|
-
* The name of the account holder.
|
|
2413
|
-
*/
|
|
2414
|
-
accountHolderName?: string;
|
|
2415
|
-
|
|
2416
|
-
bic?: string;
|
|
2417
|
-
}
|
|
2418
|
-
|
|
2419
|
-
export interface SortCode {
|
|
2420
|
-
accountNumber: string;
|
|
2421
|
-
|
|
2422
|
-
sortCode: string;
|
|
2423
|
-
|
|
2424
|
-
/**
|
|
2425
|
-
* The name of the account holder.
|
|
2426
|
-
*/
|
|
2427
|
-
accountHolderName?: string;
|
|
2428
|
-
}
|
|
2429
|
-
}
|
|
2430
|
-
|
|
2431
|
-
/**
|
|
2432
|
-
* A Refund object. This corresponds to one Refund request.
|
|
2433
|
-
*/
|
|
2434
|
-
export interface Refund {
|
|
2435
|
-
id: string;
|
|
2436
|
-
|
|
2437
|
-
amount: number;
|
|
2438
|
-
|
|
2439
|
-
createdAt: string;
|
|
2440
|
-
|
|
2441
|
-
referenceId: string;
|
|
2442
|
-
|
|
2443
|
-
/**
|
|
2444
|
-
* The status of the refund. Always use the status of the order as your source of
|
|
2445
|
-
* truth to trigger actions in your dashboard.
|
|
2446
|
-
*/
|
|
2447
|
-
status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
|
|
2448
|
-
|
|
2449
|
-
updatedAt: string;
|
|
2450
|
-
|
|
2451
|
-
description?: string;
|
|
2452
|
-
}
|
|
2453
|
-
|
|
2454
|
-
/**
|
|
2455
|
-
* The shipping address of the user. This is only collected in express Checkouts.
|
|
2456
|
-
*/
|
|
2457
|
-
export interface ShippingAddress {
|
|
2458
|
-
city: string;
|
|
2459
|
-
|
|
2460
|
-
/**
|
|
2461
|
-
* The country code in
|
|
2462
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
2463
|
-
*/
|
|
2464
|
-
country:
|
|
2465
|
-
| 'AF'
|
|
2466
|
-
| 'AL'
|
|
2467
|
-
| 'DZ'
|
|
2468
|
-
| 'AS'
|
|
2469
|
-
| 'AD'
|
|
2470
|
-
| 'AO'
|
|
2471
|
-
| 'AI'
|
|
2472
|
-
| 'AQ'
|
|
2473
|
-
| 'AG'
|
|
2474
|
-
| 'AR'
|
|
2475
|
-
| 'AM'
|
|
2476
|
-
| 'AW'
|
|
2477
|
-
| 'AU'
|
|
2478
|
-
| 'AT'
|
|
2479
|
-
| 'AZ'
|
|
2480
|
-
| 'BS'
|
|
2481
|
-
| 'BH'
|
|
2482
|
-
| 'BD'
|
|
2483
|
-
| 'BB'
|
|
2484
|
-
| 'BY'
|
|
2485
|
-
| 'BE'
|
|
2486
|
-
| 'BZ'
|
|
2487
|
-
| 'BJ'
|
|
2488
|
-
| 'BM'
|
|
2489
|
-
| 'BT'
|
|
2490
|
-
| 'BO'
|
|
2491
|
-
| 'BA'
|
|
2492
|
-
| 'BW'
|
|
2493
|
-
| 'BV'
|
|
2494
|
-
| 'BR'
|
|
2495
|
-
| 'IO'
|
|
2496
|
-
| 'BN'
|
|
2497
|
-
| 'BG'
|
|
2498
|
-
| 'BF'
|
|
2499
|
-
| 'BI'
|
|
2500
|
-
| 'KH'
|
|
2501
|
-
| 'CM'
|
|
2502
|
-
| 'CA'
|
|
2503
|
-
| 'CV'
|
|
2504
|
-
| 'KY'
|
|
2505
|
-
| 'CF'
|
|
2506
|
-
| 'TD'
|
|
2507
|
-
| 'CL'
|
|
2508
|
-
| 'CN'
|
|
2509
|
-
| 'CX'
|
|
2510
|
-
| 'CC'
|
|
2511
|
-
| 'CO'
|
|
2512
|
-
| 'KM'
|
|
2513
|
-
| 'CG'
|
|
2514
|
-
| 'CD'
|
|
2515
|
-
| 'CK'
|
|
2516
|
-
| 'CR'
|
|
2517
|
-
| 'CI'
|
|
2518
|
-
| 'HR'
|
|
2519
|
-
| 'CU'
|
|
2520
|
-
| 'CY'
|
|
2521
|
-
| 'CZ'
|
|
2522
|
-
| 'DK'
|
|
2523
|
-
| 'DJ'
|
|
2524
|
-
| 'DM'
|
|
2525
|
-
| 'DO'
|
|
2526
|
-
| 'EC'
|
|
2527
|
-
| 'EG'
|
|
2528
|
-
| 'SV'
|
|
2529
|
-
| 'GQ'
|
|
2530
|
-
| 'ER'
|
|
2531
|
-
| 'EE'
|
|
2532
|
-
| 'ET'
|
|
2533
|
-
| 'FK'
|
|
2534
|
-
| 'FO'
|
|
2535
|
-
| 'FJ'
|
|
2536
|
-
| 'FI'
|
|
2537
|
-
| 'FR'
|
|
2538
|
-
| 'GF'
|
|
2539
|
-
| 'PF'
|
|
2540
|
-
| 'TF'
|
|
2541
|
-
| 'GA'
|
|
2542
|
-
| 'GM'
|
|
2543
|
-
| 'GE'
|
|
2544
|
-
| 'DE'
|
|
2545
|
-
| 'GH'
|
|
2546
|
-
| 'GI'
|
|
2547
|
-
| 'GR'
|
|
2548
|
-
| 'GL'
|
|
2549
|
-
| 'GD'
|
|
2550
|
-
| 'GP'
|
|
2551
|
-
| 'GU'
|
|
2552
|
-
| 'GT'
|
|
2553
|
-
| 'GN'
|
|
2554
|
-
| 'GW'
|
|
2555
|
-
| 'GY'
|
|
2556
|
-
| 'HT'
|
|
2557
|
-
| 'HM'
|
|
2558
|
-
| 'VA'
|
|
2559
|
-
| 'HN'
|
|
2560
|
-
| 'HK'
|
|
2561
|
-
| 'HU'
|
|
2562
|
-
| 'IS'
|
|
2563
|
-
| 'IN'
|
|
2564
|
-
| 'ID'
|
|
2565
|
-
| 'IR'
|
|
2566
|
-
| 'IQ'
|
|
2567
|
-
| 'IE'
|
|
2568
|
-
| 'IL'
|
|
2569
|
-
| 'IT'
|
|
2570
|
-
| 'JM'
|
|
2571
|
-
| 'JP'
|
|
2572
|
-
| 'JO'
|
|
2573
|
-
| 'KZ'
|
|
2574
|
-
| 'KE'
|
|
2575
|
-
| 'KI'
|
|
2576
|
-
| 'KP'
|
|
2577
|
-
| 'KR'
|
|
2578
|
-
| 'KW'
|
|
2579
|
-
| 'KG'
|
|
2580
|
-
| 'LA'
|
|
2581
|
-
| 'LV'
|
|
2582
|
-
| 'LB'
|
|
2583
|
-
| 'LS'
|
|
2584
|
-
| 'LR'
|
|
2585
|
-
| 'LY'
|
|
2586
|
-
| 'LI'
|
|
2587
|
-
| 'LT'
|
|
2588
|
-
| 'LU'
|
|
2589
|
-
| 'MO'
|
|
2590
|
-
| 'MG'
|
|
2591
|
-
| 'MW'
|
|
2592
|
-
| 'MY'
|
|
2593
|
-
| 'MV'
|
|
2594
|
-
| 'ML'
|
|
2595
|
-
| 'MT'
|
|
2596
|
-
| 'MH'
|
|
2597
|
-
| 'MQ'
|
|
2598
|
-
| 'MR'
|
|
2599
|
-
| 'MU'
|
|
2600
|
-
| 'YT'
|
|
2601
|
-
| 'MX'
|
|
2602
|
-
| 'FM'
|
|
2603
|
-
| 'MD'
|
|
2604
|
-
| 'MC'
|
|
2605
|
-
| 'MN'
|
|
2606
|
-
| 'MS'
|
|
2607
|
-
| 'MA'
|
|
2608
|
-
| 'MZ'
|
|
2609
|
-
| 'MM'
|
|
2610
|
-
| 'NA'
|
|
2611
|
-
| 'NR'
|
|
2612
|
-
| 'NP'
|
|
2613
|
-
| 'NL'
|
|
2614
|
-
| 'NC'
|
|
2615
|
-
| 'NZ'
|
|
2616
|
-
| 'NI'
|
|
2617
|
-
| 'NE'
|
|
2618
|
-
| 'NG'
|
|
2619
|
-
| 'NU'
|
|
2620
|
-
| 'NF'
|
|
2621
|
-
| 'MP'
|
|
2622
|
-
| 'MK'
|
|
2623
|
-
| 'NO'
|
|
2624
|
-
| 'OM'
|
|
2625
|
-
| 'PK'
|
|
2626
|
-
| 'PW'
|
|
2627
|
-
| 'PS'
|
|
2628
|
-
| 'PA'
|
|
2629
|
-
| 'PG'
|
|
2630
|
-
| 'PY'
|
|
2631
|
-
| 'PE'
|
|
2632
|
-
| 'PH'
|
|
2633
|
-
| 'PN'
|
|
2634
|
-
| 'PL'
|
|
2635
|
-
| 'PT'
|
|
2636
|
-
| 'PR'
|
|
2637
|
-
| 'QA'
|
|
2638
|
-
| 'RE'
|
|
2639
|
-
| 'RO'
|
|
2640
|
-
| 'RU'
|
|
2641
|
-
| 'RW'
|
|
2642
|
-
| 'SH'
|
|
2643
|
-
| 'KN'
|
|
2644
|
-
| 'LC'
|
|
2645
|
-
| 'PM'
|
|
2646
|
-
| 'VC'
|
|
2647
|
-
| 'WS'
|
|
2648
|
-
| 'SM'
|
|
2649
|
-
| 'ST'
|
|
2650
|
-
| 'SA'
|
|
2651
|
-
| 'SN'
|
|
2652
|
-
| 'SC'
|
|
2653
|
-
| 'SL'
|
|
2654
|
-
| 'SG'
|
|
2655
|
-
| 'SK'
|
|
2656
|
-
| 'SI'
|
|
2657
|
-
| 'SB'
|
|
2658
|
-
| 'SO'
|
|
2659
|
-
| 'ZA'
|
|
2660
|
-
| 'GS'
|
|
2661
|
-
| 'ES'
|
|
2662
|
-
| 'LK'
|
|
2663
|
-
| 'SD'
|
|
2664
|
-
| 'SR'
|
|
2665
|
-
| 'SJ'
|
|
2666
|
-
| 'SZ'
|
|
2667
|
-
| 'SE'
|
|
2668
|
-
| 'CH'
|
|
2669
|
-
| 'SY'
|
|
2670
|
-
| 'TW'
|
|
2671
|
-
| 'TJ'
|
|
2672
|
-
| 'TZ'
|
|
2673
|
-
| 'TH'
|
|
2674
|
-
| 'TL'
|
|
2675
|
-
| 'TG'
|
|
2676
|
-
| 'TK'
|
|
2677
|
-
| 'TO'
|
|
2678
|
-
| 'TT'
|
|
2679
|
-
| 'TN'
|
|
2680
|
-
| 'TR'
|
|
2681
|
-
| 'TM'
|
|
2682
|
-
| 'TC'
|
|
2683
|
-
| 'TV'
|
|
2684
|
-
| 'UG'
|
|
2685
|
-
| 'UA'
|
|
2686
|
-
| 'AE'
|
|
2687
|
-
| 'GB'
|
|
2688
|
-
| 'US'
|
|
2689
|
-
| 'UM'
|
|
2690
|
-
| 'UY'
|
|
2691
|
-
| 'UZ'
|
|
2692
|
-
| 'VU'
|
|
2693
|
-
| 'VE'
|
|
2694
|
-
| 'VN'
|
|
2695
|
-
| 'VG'
|
|
2696
|
-
| 'VI'
|
|
2697
|
-
| 'WF'
|
|
2698
|
-
| 'EH'
|
|
2699
|
-
| 'YE'
|
|
2700
|
-
| 'ZM'
|
|
2701
|
-
| 'ZW'
|
|
2702
|
-
| 'AX'
|
|
2703
|
-
| 'BQ'
|
|
2704
|
-
| 'CW'
|
|
2705
|
-
| 'GG'
|
|
2706
|
-
| 'IM'
|
|
2707
|
-
| 'JE'
|
|
2708
|
-
| 'ME'
|
|
2709
|
-
| 'BL'
|
|
2710
|
-
| 'MF'
|
|
2711
|
-
| 'RS'
|
|
2712
|
-
| 'SX'
|
|
2713
|
-
| 'SS'
|
|
2714
|
-
| 'XK';
|
|
1093
|
+
* The merchant category code or
|
|
1094
|
+
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
1095
|
+
*/
|
|
1096
|
+
category?: string;
|
|
2715
1097
|
|
|
2716
|
-
|
|
1098
|
+
/**
|
|
1099
|
+
* The unique identifier of the customer who placed the order.
|
|
1100
|
+
*/
|
|
1101
|
+
customerId?: string;
|
|
2717
1102
|
|
|
2718
|
-
|
|
1103
|
+
destination?: OrderRetrieveResponse.Destination;
|
|
2719
1104
|
|
|
2720
|
-
|
|
1105
|
+
/**
|
|
1106
|
+
* @deprecated Currently only visible in the merchant dashboard. This id used to be
|
|
1107
|
+
* displayed to the user during the checkout.
|
|
1108
|
+
*/
|
|
1109
|
+
displayId?: string;
|
|
2721
1110
|
|
|
2722
|
-
|
|
1111
|
+
/**
|
|
1112
|
+
* @deprecated The list of line items for the order.
|
|
1113
|
+
*/
|
|
1114
|
+
lineItems?: Array<OrderRetrieveResponse.LineItem>;
|
|
2723
1115
|
|
|
2724
|
-
|
|
1116
|
+
mandate?: OrderRetrieveResponse.Mandate;
|
|
2725
1117
|
|
|
2726
|
-
|
|
2727
|
-
|
|
1118
|
+
/**
|
|
1119
|
+
* @deprecated
|
|
1120
|
+
*/
|
|
1121
|
+
merchantFinancialAddress?: OrderRetrieveResponse.MerchantFinancialAddress;
|
|
2728
1122
|
|
|
2729
1123
|
/**
|
|
2730
|
-
*
|
|
2731
|
-
*
|
|
1124
|
+
* Any data which will be stored and returned for this checkout session and
|
|
1125
|
+
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
1126
|
+
* more info.
|
|
2732
1127
|
*/
|
|
2733
|
-
|
|
2734
|
-
/**
|
|
2735
|
-
* The customer-facing name of the shipping method.
|
|
2736
|
-
*/
|
|
2737
|
-
name: string;
|
|
1128
|
+
metadata?: Record<string, unknown>;
|
|
2738
1129
|
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
|
|
2742
|
-
|
|
1130
|
+
/**
|
|
1131
|
+
* The source bank account where the money is send from.
|
|
1132
|
+
*/
|
|
1133
|
+
payerFinancialAddress?: OrderRetrieveResponse.PayerFinancialAddress;
|
|
1134
|
+
|
|
1135
|
+
paymentMethodType?: 'sepa_debit' | 'customer_balance' | 'manual_bank_transfer';
|
|
1136
|
+
|
|
1137
|
+
/**
|
|
1138
|
+
* The payment mode of the order. Can be either 'settlement' or 'direct'.
|
|
1139
|
+
*/
|
|
1140
|
+
paymentMode?: 'settlement' | 'direct';
|
|
1141
|
+
|
|
1142
|
+
/**
|
|
1143
|
+
* @deprecated Deprecated in favor of `status`. Do not use this field to trigger
|
|
1144
|
+
* actions in your system.
|
|
1145
|
+
*/
|
|
1146
|
+
paymentStatus?:
|
|
1147
|
+
| 'failed'
|
|
1148
|
+
| 'canceled'
|
|
1149
|
+
| 'processing'
|
|
1150
|
+
| 'requires_action'
|
|
1151
|
+
| 'succeeded'
|
|
1152
|
+
| 'in_refund'
|
|
1153
|
+
| 'refunded'
|
|
1154
|
+
| 'refund_failed'
|
|
1155
|
+
| 'partially_refunded'
|
|
1156
|
+
| 'not_settled'
|
|
1157
|
+
| 'disputed';
|
|
1158
|
+
|
|
1159
|
+
/**
|
|
1160
|
+
* The total amount in the currency of all successful refunds for this order
|
|
1161
|
+
*/
|
|
1162
|
+
refundAmount?: number;
|
|
1163
|
+
|
|
1164
|
+
/**
|
|
1165
|
+
* The list of refunds connected to this order.
|
|
1166
|
+
*/
|
|
1167
|
+
refunds?: Array<OrderRetrieveResponse.Refund>;
|
|
1168
|
+
|
|
1169
|
+
/**
|
|
1170
|
+
* The shopper object. Contains information collected from the user during the
|
|
1171
|
+
* Checkout.
|
|
1172
|
+
*/
|
|
1173
|
+
shopper?: OrderRetrieveResponse.Shopper;
|
|
1174
|
+
|
|
1175
|
+
/**
|
|
1176
|
+
* @deprecated Deprecated in favor of `shopper.email`. The email of the user if
|
|
1177
|
+
* collected in the Checkout.
|
|
1178
|
+
*/
|
|
1179
|
+
shopperEmail?: string;
|
|
1180
|
+
|
|
1181
|
+
statusClassification?: OrderRetrieveResponse.StatusClassification;
|
|
1182
|
+
|
|
1183
|
+
/**
|
|
1184
|
+
* List of status history items for the order, used for logging every update on
|
|
1185
|
+
* status.
|
|
1186
|
+
*/
|
|
1187
|
+
statusHistoryList?: Array<OrderRetrieveResponse.StatusHistoryList>;
|
|
1188
|
+
|
|
1189
|
+
/**
|
|
1190
|
+
* The subaccount id of the order.
|
|
1191
|
+
*/
|
|
1192
|
+
subaccountId?: string;
|
|
1193
|
+
|
|
1194
|
+
/**
|
|
1195
|
+
* The legal name of the subaccount
|
|
1196
|
+
*/
|
|
1197
|
+
subaccountLegalName?: string;
|
|
1198
|
+
}
|
|
1199
|
+
|
|
1200
|
+
export namespace OrderRetrieveResponse {
|
|
1201
|
+
/**
|
|
1202
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
1203
|
+
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1204
|
+
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1205
|
+
* as this is the format accepted by most banks.
|
|
1206
|
+
*/
|
|
1207
|
+
export interface Price {
|
|
1208
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
2743
1209
|
|
|
2744
1210
|
/**
|
|
2745
|
-
* The
|
|
1211
|
+
* The total amount to be paid.
|
|
2746
1212
|
*/
|
|
2747
|
-
|
|
1213
|
+
total: number;
|
|
1214
|
+
|
|
1215
|
+
shipping?: number;
|
|
1216
|
+
|
|
1217
|
+
subTotal?: number;
|
|
1218
|
+
|
|
1219
|
+
totalNet?: number;
|
|
1220
|
+
|
|
1221
|
+
vat?: number;
|
|
1222
|
+
}
|
|
1223
|
+
|
|
1224
|
+
/**
|
|
1225
|
+
* The billing address of the customer.
|
|
1226
|
+
*/
|
|
1227
|
+
export interface BillingAddress {
|
|
1228
|
+
city: string;
|
|
2748
1229
|
|
|
2749
1230
|
/**
|
|
2750
|
-
* The
|
|
1231
|
+
* The country code in
|
|
1232
|
+
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
2751
1233
|
*/
|
|
2752
|
-
|
|
1234
|
+
country:
|
|
2753
1235
|
| 'AF'
|
|
2754
1236
|
| 'AL'
|
|
2755
1237
|
| 'DZ'
|
|
@@ -2999,74 +1481,413 @@ export namespace OrderUpdateResponse {
|
|
|
2999
1481
|
| 'RS'
|
|
3000
1482
|
| 'SX'
|
|
3001
1483
|
| 'SS'
|
|
3002
|
-
| 'XK'
|
|
3003
|
-
|
|
1484
|
+
| 'XK';
|
|
1485
|
+
|
|
1486
|
+
line1: string;
|
|
1487
|
+
|
|
1488
|
+
zipCode: string;
|
|
1489
|
+
|
|
1490
|
+
firstName?: string;
|
|
1491
|
+
|
|
1492
|
+
lastName?: string;
|
|
1493
|
+
|
|
1494
|
+
line2?: string;
|
|
1495
|
+
|
|
1496
|
+
region?: string;
|
|
1497
|
+
}
|
|
1498
|
+
|
|
1499
|
+
export interface Destination {
|
|
1500
|
+
/**
|
|
1501
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
1502
|
+
* to "iban", the "iban" object must be filled out.
|
|
1503
|
+
*/
|
|
1504
|
+
bankAccount: Destination.BankAccount;
|
|
1505
|
+
|
|
1506
|
+
/**
|
|
1507
|
+
* The bank statement reference of the payment for the order. This is the reference
|
|
1508
|
+
* that will be visible on the bank statement.
|
|
1509
|
+
*/
|
|
1510
|
+
bankStatementReference: string;
|
|
1511
|
+
}
|
|
1512
|
+
|
|
1513
|
+
export namespace Destination {
|
|
1514
|
+
/**
|
|
1515
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
1516
|
+
* to "iban", the "iban" object must be filled out.
|
|
1517
|
+
*/
|
|
1518
|
+
export interface BankAccount {
|
|
1519
|
+
/**
|
|
1520
|
+
* The type of the financial address. The actual destination is determined by this
|
|
1521
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
1522
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
1523
|
+
* in the "iban" object.
|
|
1524
|
+
*
|
|
1525
|
+
* - iban: The IBAN of the account
|
|
1526
|
+
* - sort_code: The sort code of the account
|
|
1527
|
+
* - bank_code: The bank code of the account
|
|
1528
|
+
* - bban: The BBAN of the account
|
|
1529
|
+
*/
|
|
1530
|
+
type: string;
|
|
1531
|
+
|
|
1532
|
+
bankCode?: BankAccount.BankCode;
|
|
1533
|
+
|
|
1534
|
+
bban?: BankAccount.Bban;
|
|
1535
|
+
|
|
1536
|
+
iban?: BankAccount.Iban;
|
|
1537
|
+
|
|
1538
|
+
sortCode?: BankAccount.SortCode;
|
|
1539
|
+
}
|
|
1540
|
+
|
|
1541
|
+
export namespace BankAccount {
|
|
1542
|
+
export interface BankCode {
|
|
1543
|
+
/**
|
|
1544
|
+
* The name of the account holder.
|
|
1545
|
+
*/
|
|
1546
|
+
accountHolderName: string;
|
|
1547
|
+
|
|
1548
|
+
accountNumber: string;
|
|
1549
|
+
|
|
1550
|
+
code: string;
|
|
1551
|
+
}
|
|
1552
|
+
|
|
1553
|
+
export interface Bban {
|
|
1554
|
+
/**
|
|
1555
|
+
* The name of the account holder.
|
|
1556
|
+
*/
|
|
1557
|
+
accountHolderName: string;
|
|
1558
|
+
|
|
1559
|
+
bban: string;
|
|
1560
|
+
|
|
1561
|
+
bic?: string;
|
|
1562
|
+
}
|
|
1563
|
+
|
|
1564
|
+
export interface Iban {
|
|
1565
|
+
/**
|
|
1566
|
+
* The name of the account holder.
|
|
1567
|
+
*/
|
|
1568
|
+
accountHolderName: string;
|
|
1569
|
+
|
|
1570
|
+
iban: string;
|
|
1571
|
+
|
|
1572
|
+
bic?: string;
|
|
1573
|
+
}
|
|
1574
|
+
|
|
1575
|
+
export interface SortCode {
|
|
1576
|
+
/**
|
|
1577
|
+
* The name of the account holder.
|
|
1578
|
+
*/
|
|
1579
|
+
accountHolderName: string;
|
|
1580
|
+
|
|
1581
|
+
accountNumber: string;
|
|
1582
|
+
|
|
1583
|
+
sortCode: string;
|
|
1584
|
+
}
|
|
1585
|
+
}
|
|
1586
|
+
}
|
|
1587
|
+
|
|
1588
|
+
export interface LineItem {
|
|
1589
|
+
/**
|
|
1590
|
+
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
1591
|
+
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
1592
|
+
*/
|
|
1593
|
+
amount: number;
|
|
1594
|
+
|
|
1595
|
+
/**
|
|
1596
|
+
* The name of the line item.
|
|
1597
|
+
*/
|
|
1598
|
+
name: string;
|
|
1599
|
+
|
|
1600
|
+
/**
|
|
1601
|
+
* The quantity of the line item.
|
|
1602
|
+
*/
|
|
1603
|
+
quantity: number;
|
|
1604
|
+
|
|
1605
|
+
/**
|
|
1606
|
+
* The net amount of a single item.
|
|
1607
|
+
*/
|
|
1608
|
+
singleNet: number;
|
|
1609
|
+
|
|
1610
|
+
/**
|
|
1611
|
+
* The VAT amount of a single item.
|
|
1612
|
+
*/
|
|
1613
|
+
singleVat: number;
|
|
1614
|
+
|
|
1615
|
+
/**
|
|
1616
|
+
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
1617
|
+
* the line item.
|
|
1618
|
+
*/
|
|
1619
|
+
category?: string;
|
|
1620
|
+
|
|
1621
|
+
/**
|
|
1622
|
+
* The
|
|
1623
|
+
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
1624
|
+
* of the line item.
|
|
1625
|
+
*/
|
|
1626
|
+
EAN?: string;
|
|
1627
|
+
|
|
1628
|
+
/**
|
|
1629
|
+
* The image of the line item as a URL.
|
|
1630
|
+
*/
|
|
1631
|
+
image?: string;
|
|
1632
|
+
|
|
1633
|
+
/**
|
|
1634
|
+
* The internal unique identifier of the line item.
|
|
1635
|
+
*/
|
|
1636
|
+
referenceId?: string;
|
|
1637
|
+
}
|
|
1638
|
+
|
|
1639
|
+
export interface Mandate {
|
|
1640
|
+
/**
|
|
1641
|
+
* The name of the account holder who signs the mandate.
|
|
1642
|
+
*/
|
|
1643
|
+
accountHolderName?: string;
|
|
1644
|
+
|
|
1645
|
+
/**
|
|
1646
|
+
* Additional information to display to the user during the mandate setup. This
|
|
1647
|
+
* information is not used to setup any recurrence on the mandate. It is only
|
|
1648
|
+
* displayed to the user during checkout.
|
|
1649
|
+
*/
|
|
1650
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
1651
|
+
|
|
1652
|
+
/**
|
|
1653
|
+
* Mandate creditor data
|
|
1654
|
+
*/
|
|
1655
|
+
creditor?: Mandate.Creditor;
|
|
3004
1656
|
|
|
3005
1657
|
/**
|
|
3006
|
-
* The
|
|
1658
|
+
* The reference of the mandate going to be setup
|
|
3007
1659
|
*/
|
|
3008
|
-
|
|
1660
|
+
reference?: string;
|
|
3009
1661
|
|
|
3010
1662
|
/**
|
|
3011
|
-
* The
|
|
1663
|
+
* The mandate referenceId. Set this to match incoming `mandate_setup_started`,
|
|
1664
|
+
* `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
|
|
1665
|
+
* mandate setup request.
|
|
3012
1666
|
*/
|
|
3013
|
-
|
|
1667
|
+
referenceId?: string;
|
|
1668
|
+
|
|
1669
|
+
/**
|
|
1670
|
+
* If true, a ready to use mandate will be set up after the payment flow.
|
|
1671
|
+
*/
|
|
1672
|
+
setup?: boolean;
|
|
1673
|
+
|
|
1674
|
+
/**
|
|
1675
|
+
* The email of the user who signs the mandate.
|
|
1676
|
+
*/
|
|
1677
|
+
userNotificationEmail?: string;
|
|
1678
|
+
}
|
|
1679
|
+
|
|
1680
|
+
export namespace Mandate {
|
|
1681
|
+
/**
|
|
1682
|
+
* Additional information to display to the user during the mandate setup. This
|
|
1683
|
+
* information is not used to setup any recurrence on the mandate. It is only
|
|
1684
|
+
* displayed to the user during checkout.
|
|
1685
|
+
*/
|
|
1686
|
+
export interface AdditionalDisplayInformation {
|
|
1687
|
+
/**
|
|
1688
|
+
* The intended cadence of charges used for displaying purpose only. On demand
|
|
1689
|
+
* would be used for unscheduled charges.
|
|
1690
|
+
*/
|
|
1691
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
1692
|
+
|
|
1693
|
+
price?: AdditionalDisplayInformation.Price;
|
|
1694
|
+
}
|
|
1695
|
+
|
|
1696
|
+
export namespace AdditionalDisplayInformation {
|
|
1697
|
+
export interface Price {
|
|
1698
|
+
/**
|
|
1699
|
+
* The amount displayed to the user as decimal e.g. 10.23 would be displayed as
|
|
1700
|
+
* 10.23 EUR.
|
|
1701
|
+
*/
|
|
1702
|
+
amount?: number;
|
|
1703
|
+
|
|
1704
|
+
currency?: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
1705
|
+
}
|
|
1706
|
+
}
|
|
3014
1707
|
|
|
3015
1708
|
/**
|
|
3016
|
-
*
|
|
1709
|
+
* Mandate creditor data
|
|
3017
1710
|
*/
|
|
3018
|
-
|
|
1711
|
+
export interface Creditor {
|
|
1712
|
+
id?: string;
|
|
1713
|
+
|
|
1714
|
+
name?: string;
|
|
1715
|
+
}
|
|
3019
1716
|
}
|
|
3020
1717
|
|
|
3021
|
-
|
|
1718
|
+
/**
|
|
1719
|
+
* @deprecated
|
|
1720
|
+
*/
|
|
1721
|
+
export interface MerchantFinancialAddress {
|
|
1722
|
+
bankCode?: MerchantFinancialAddress.BankCode;
|
|
1723
|
+
|
|
1724
|
+
bban?: MerchantFinancialAddress.Bban;
|
|
1725
|
+
|
|
1726
|
+
iban?: MerchantFinancialAddress.Iban;
|
|
1727
|
+
|
|
1728
|
+
/**
|
|
1729
|
+
* The payment reference for the order. This is the reference that will be visible
|
|
1730
|
+
* on the bank statement.
|
|
1731
|
+
*/
|
|
1732
|
+
paymentReference?: string;
|
|
1733
|
+
|
|
1734
|
+
sortCode?: MerchantFinancialAddress.SortCode;
|
|
1735
|
+
|
|
3022
1736
|
/**
|
|
3023
|
-
* The
|
|
1737
|
+
* The type of the financial address. The actual destination is determined by this
|
|
1738
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
1739
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
1740
|
+
* in the "iban" object.
|
|
1741
|
+
*
|
|
1742
|
+
* - iban: The IBAN of the account
|
|
1743
|
+
* - sort_code: The sort code of the account
|
|
1744
|
+
* - bank_code: The bank code of the account
|
|
1745
|
+
* - bban: The BBAN of the account
|
|
3024
1746
|
*/
|
|
3025
|
-
|
|
1747
|
+
type?: string;
|
|
1748
|
+
}
|
|
1749
|
+
|
|
1750
|
+
export namespace MerchantFinancialAddress {
|
|
1751
|
+
export interface BankCode {
|
|
3026
1752
|
/**
|
|
3027
|
-
* The
|
|
1753
|
+
* The name of the account holder.
|
|
3028
1754
|
*/
|
|
3029
|
-
|
|
1755
|
+
accountHolderName: string;
|
|
1756
|
+
|
|
1757
|
+
accountNumber: string;
|
|
1758
|
+
|
|
1759
|
+
code: string;
|
|
1760
|
+
}
|
|
3030
1761
|
|
|
1762
|
+
export interface Bban {
|
|
3031
1763
|
/**
|
|
3032
|
-
* The
|
|
1764
|
+
* The name of the account holder.
|
|
3033
1765
|
*/
|
|
3034
|
-
|
|
1766
|
+
accountHolderName: string;
|
|
1767
|
+
|
|
1768
|
+
bban: string;
|
|
1769
|
+
|
|
1770
|
+
bic?: string;
|
|
3035
1771
|
}
|
|
3036
1772
|
|
|
3037
|
-
export
|
|
1773
|
+
export interface Iban {
|
|
3038
1774
|
/**
|
|
3039
|
-
* The
|
|
1775
|
+
* The name of the account holder.
|
|
3040
1776
|
*/
|
|
3041
|
-
|
|
3042
|
-
/**
|
|
3043
|
-
* The unit of the time duration.
|
|
3044
|
-
*/
|
|
3045
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
1777
|
+
accountHolderName: string;
|
|
3046
1778
|
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
}
|
|
1779
|
+
iban: string;
|
|
1780
|
+
|
|
1781
|
+
bic?: string;
|
|
1782
|
+
}
|
|
3052
1783
|
|
|
1784
|
+
export interface SortCode {
|
|
3053
1785
|
/**
|
|
3054
|
-
* The
|
|
1786
|
+
* The name of the account holder.
|
|
3055
1787
|
*/
|
|
3056
|
-
|
|
3057
|
-
/**
|
|
3058
|
-
* The unit of the time duration.
|
|
3059
|
-
*/
|
|
3060
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
1788
|
+
accountHolderName: string;
|
|
3061
1789
|
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
|
|
3065
|
-
|
|
3066
|
-
|
|
1790
|
+
accountNumber: string;
|
|
1791
|
+
|
|
1792
|
+
sortCode: string;
|
|
1793
|
+
}
|
|
1794
|
+
}
|
|
1795
|
+
|
|
1796
|
+
/**
|
|
1797
|
+
* The source bank account where the money is send from.
|
|
1798
|
+
*/
|
|
1799
|
+
export interface PayerFinancialAddress {
|
|
1800
|
+
/**
|
|
1801
|
+
* The type of the financial address. The actual destination is determined by this
|
|
1802
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
1803
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
1804
|
+
* in the "iban" object.
|
|
1805
|
+
*
|
|
1806
|
+
* - iban: The IBAN of the account
|
|
1807
|
+
* - sort_code: The sort code of the account
|
|
1808
|
+
* - bank_code: The bank code of the account
|
|
1809
|
+
* - bban: The BBAN of the account
|
|
1810
|
+
*/
|
|
1811
|
+
type: string;
|
|
1812
|
+
|
|
1813
|
+
bankCode?: PayerFinancialAddress.BankCode;
|
|
1814
|
+
|
|
1815
|
+
bban?: PayerFinancialAddress.Bban;
|
|
1816
|
+
|
|
1817
|
+
iban?: PayerFinancialAddress.Iban;
|
|
1818
|
+
|
|
1819
|
+
sortCode?: PayerFinancialAddress.SortCode;
|
|
1820
|
+
}
|
|
1821
|
+
|
|
1822
|
+
export namespace PayerFinancialAddress {
|
|
1823
|
+
export interface BankCode {
|
|
1824
|
+
accountNumber: string;
|
|
1825
|
+
|
|
1826
|
+
code: string;
|
|
1827
|
+
|
|
1828
|
+
/**
|
|
1829
|
+
* The name of the account holder.
|
|
1830
|
+
*/
|
|
1831
|
+
accountHolderName?: string;
|
|
1832
|
+
}
|
|
1833
|
+
|
|
1834
|
+
export interface Bban {
|
|
1835
|
+
bban: string;
|
|
1836
|
+
|
|
1837
|
+
/**
|
|
1838
|
+
* The name of the account holder.
|
|
1839
|
+
*/
|
|
1840
|
+
accountHolderName?: string;
|
|
1841
|
+
|
|
1842
|
+
bic?: string;
|
|
1843
|
+
}
|
|
1844
|
+
|
|
1845
|
+
export interface Iban {
|
|
1846
|
+
iban: string;
|
|
1847
|
+
|
|
1848
|
+
/**
|
|
1849
|
+
* The name of the account holder.
|
|
1850
|
+
*/
|
|
1851
|
+
accountHolderName?: string;
|
|
1852
|
+
|
|
1853
|
+
bic?: string;
|
|
1854
|
+
}
|
|
1855
|
+
|
|
1856
|
+
export interface SortCode {
|
|
1857
|
+
accountNumber: string;
|
|
1858
|
+
|
|
1859
|
+
sortCode: string;
|
|
1860
|
+
|
|
1861
|
+
/**
|
|
1862
|
+
* The name of the account holder.
|
|
1863
|
+
*/
|
|
1864
|
+
accountHolderName?: string;
|
|
3067
1865
|
}
|
|
3068
1866
|
}
|
|
3069
1867
|
|
|
1868
|
+
/**
|
|
1869
|
+
* A Refund object. This corresponds to one Refund request.
|
|
1870
|
+
*/
|
|
1871
|
+
export interface Refund {
|
|
1872
|
+
id: string;
|
|
1873
|
+
|
|
1874
|
+
amount: number;
|
|
1875
|
+
|
|
1876
|
+
createdAt: string;
|
|
1877
|
+
|
|
1878
|
+
referenceId: string;
|
|
1879
|
+
|
|
1880
|
+
/**
|
|
1881
|
+
* The status of the refund. Always use the status of the order as your source of
|
|
1882
|
+
* truth to trigger actions in your dashboard.
|
|
1883
|
+
*/
|
|
1884
|
+
status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
|
|
1885
|
+
|
|
1886
|
+
updatedAt: string;
|
|
1887
|
+
|
|
1888
|
+
description?: string;
|
|
1889
|
+
}
|
|
1890
|
+
|
|
3070
1891
|
/**
|
|
3071
1892
|
* The shopper object. Contains information collected from the user during the
|
|
3072
1893
|
* Checkout.
|
|
@@ -3082,13 +1903,30 @@ export namespace OrderUpdateResponse {
|
|
|
3082
1903
|
* Populated with the primary payment initiation failure classsification if
|
|
3083
1904
|
* available.
|
|
3084
1905
|
*/
|
|
3085
|
-
primary
|
|
1906
|
+
primary: 'payment_authorisation_failed' | 'payment_execution_failed' | 'payment_abandoned';
|
|
3086
1907
|
|
|
3087
1908
|
/**
|
|
3088
1909
|
* Populated with the secondary payment initiation failure classsification if
|
|
3089
1910
|
* available.
|
|
3090
1911
|
*/
|
|
3091
|
-
secondary?:
|
|
1912
|
+
secondary?:
|
|
1913
|
+
| 'timeout'
|
|
1914
|
+
| 'wrong_credentials'
|
|
1915
|
+
| 'incorrect_2fa_response'
|
|
1916
|
+
| 'payment_rejected'
|
|
1917
|
+
| 'insufficient_funds'
|
|
1918
|
+
| 'cancelled'
|
|
1919
|
+
| 'connection_to_bank_failed'
|
|
1920
|
+
| 'international_transfer_blocked'
|
|
1921
|
+
| 'international_transfer_limit_exceeded'
|
|
1922
|
+
| 'user_blocked'
|
|
1923
|
+
| 'bank_error'
|
|
1924
|
+
| 'instant_transfers_not_enabled'
|
|
1925
|
+
| 'no_active_tan_methods_available'
|
|
1926
|
+
| 'account_limit_exceeded'
|
|
1927
|
+
| 'bank_under_maintenance'
|
|
1928
|
+
| 'pin_blocked'
|
|
1929
|
+
| 'payment_not_settled';
|
|
3092
1930
|
}
|
|
3093
1931
|
|
|
3094
1932
|
export interface StatusHistoryList {
|
|
@@ -3101,7 +1939,6 @@ export namespace OrderUpdateResponse {
|
|
|
3101
1939
|
| 'failed'
|
|
3102
1940
|
| 'canceled'
|
|
3103
1941
|
| 'processing'
|
|
3104
|
-
| 'in_handshake'
|
|
3105
1942
|
| 'waiting_for_payment'
|
|
3106
1943
|
| 'paid'
|
|
3107
1944
|
| 'in_refund'
|
|
@@ -3125,7 +1962,6 @@ export namespace OrderUpdateResponse {
|
|
|
3125
1962
|
| 'failed'
|
|
3126
1963
|
| 'canceled'
|
|
3127
1964
|
| 'processing'
|
|
3128
|
-
| 'in_handshake'
|
|
3129
1965
|
| 'waiting_for_payment'
|
|
3130
1966
|
| 'paid'
|
|
3131
1967
|
| 'in_refund'
|
|
@@ -3139,57 +1975,63 @@ export namespace OrderUpdateResponse {
|
|
|
3139
1975
|
}
|
|
3140
1976
|
}
|
|
3141
1977
|
|
|
3142
|
-
export interface
|
|
3143
|
-
|
|
3144
|
-
|
|
1978
|
+
export interface OrderCreateParams {
|
|
1979
|
+
/**
|
|
1980
|
+
* The total amount of the order
|
|
1981
|
+
*/
|
|
1982
|
+
amount: number;
|
|
3145
1983
|
|
|
3146
|
-
|
|
3147
|
-
|
|
1984
|
+
/**
|
|
1985
|
+
* The currency code of the order
|
|
1986
|
+
*/
|
|
1987
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
3148
1988
|
|
|
3149
1989
|
/**
|
|
3150
|
-
* The
|
|
3151
|
-
* orders in the Ivy Dashboard.
|
|
1990
|
+
* The merchant's unique reference ID for the order
|
|
3152
1991
|
*/
|
|
3153
|
-
|
|
1992
|
+
referenceId: string;
|
|
3154
1993
|
|
|
3155
1994
|
/**
|
|
3156
|
-
*
|
|
3157
|
-
* order. Needs to be unique per shop per order and can be up to 200 characters. We
|
|
3158
|
-
* recommend to use your internal order id here.
|
|
1995
|
+
* The customer of the merchant.
|
|
3159
1996
|
*/
|
|
3160
|
-
|
|
1997
|
+
customer?: OrderCreateParams.Email | OrderCreateParams.ID;
|
|
3161
1998
|
|
|
3162
1999
|
/**
|
|
3163
|
-
*
|
|
2000
|
+
* Optional expiration timestamp in seconds
|
|
3164
2001
|
*/
|
|
3165
|
-
|
|
2002
|
+
expiresAt?: string;
|
|
3166
2003
|
|
|
3167
2004
|
/**
|
|
3168
|
-
* The
|
|
3169
|
-
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
3170
|
-
* information.
|
|
2005
|
+
* The subaccount id of the merchant.
|
|
3171
2006
|
*/
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3183
|
-
|
|
3184
|
-
|
|
3185
|
-
|
|
2007
|
+
subaccountId?: string;
|
|
2008
|
+
}
|
|
2009
|
+
|
|
2010
|
+
export namespace OrderCreateParams {
|
|
2011
|
+
export interface Email {
|
|
2012
|
+
/**
|
|
2013
|
+
* The email of the customer.
|
|
2014
|
+
*/
|
|
2015
|
+
email: string;
|
|
2016
|
+
}
|
|
2017
|
+
|
|
2018
|
+
export interface ID {
|
|
2019
|
+
/**
|
|
2020
|
+
* The Ivy id of the customer.
|
|
2021
|
+
*/
|
|
2022
|
+
id: string;
|
|
2023
|
+
}
|
|
2024
|
+
}
|
|
2025
|
+
|
|
2026
|
+
export interface OrderRetrieveParams {
|
|
2027
|
+
id: string;
|
|
3186
2028
|
}
|
|
3187
2029
|
|
|
3188
2030
|
export declare namespace Orders {
|
|
3189
2031
|
export {
|
|
2032
|
+
type OrderCreateResponse as OrderCreateResponse,
|
|
3190
2033
|
type OrderRetrieveResponse as OrderRetrieveResponse,
|
|
3191
|
-
type
|
|
2034
|
+
type OrderCreateParams as OrderCreateParams,
|
|
3192
2035
|
type OrderRetrieveParams as OrderRetrieveParams,
|
|
3193
|
-
type OrderUpdateParams as OrderUpdateParams,
|
|
3194
2036
|
};
|
|
3195
2037
|
}
|