@getivy/node-sdk 0.1.0-alpha.9 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +326 -0
- package/README.md +16 -26
- package/_shims/index.d.ts +2 -0
- package/_shims/index.js +5 -1
- package/_shims/index.mjs +5 -1
- package/core.d.ts +19 -5
- package/core.d.ts.map +1 -1
- package/core.js +25 -15
- package/core.js.map +1 -1
- package/core.mjs +26 -16
- package/core.mjs.map +1 -1
- package/index.d.mts +30 -18
- package/index.d.ts +30 -18
- package/index.d.ts.map +1 -1
- package/index.js +21 -8
- package/index.js.map +1 -1
- package/index.mjs +21 -8
- package/index.mjs.map +1 -1
- package/package.json +11 -33
- package/resource.d.ts +1 -1
- package/resource.d.ts.map +1 -1
- package/resource.js.map +1 -1
- package/resource.mjs.map +1 -1
- package/resources/balance.d.ts +8 -5
- package/resources/balance.d.ts.map +1 -1
- package/resources/banks.d.ts +82 -67
- package/resources/banks.d.ts.map +1 -1
- package/resources/beneficiary-payouts.d.ts +61 -0
- package/resources/beneficiary-payouts.d.ts.map +1 -0
- package/resources/beneficiary-payouts.js +16 -0
- package/resources/beneficiary-payouts.js.map +1 -0
- package/resources/beneficiary-payouts.mjs +12 -0
- package/resources/beneficiary-payouts.mjs.map +1 -0
- package/resources/capabilities.d.ts +1 -10
- package/resources/capabilities.d.ts.map +1 -1
- package/resources/charges.d.ts +28 -19
- package/resources/charges.d.ts.map +1 -1
- package/resources/checkoutsession.d.ts +275 -1360
- package/resources/checkoutsession.d.ts.map +1 -1
- package/resources/customers.d.ts +140 -10
- package/resources/customers.d.ts.map +1 -1
- package/resources/customers.js +9 -2
- package/resources/customers.js.map +1 -1
- package/resources/customers.mjs +9 -2
- package/resources/customers.mjs.map +1 -1
- package/resources/deposits.d.ts +165 -0
- package/resources/deposits.d.ts.map +1 -0
- package/resources/deposits.js +15 -0
- package/resources/deposits.js.map +1 -0
- package/resources/deposits.mjs +11 -0
- package/resources/deposits.mjs.map +1 -0
- package/resources/fx.d.ts +90 -0
- package/resources/fx.d.ts.map +1 -0
- package/resources/fx.js +22 -0
- package/resources/fx.js.map +1 -0
- package/resources/fx.mjs +18 -0
- package/resources/fx.mjs.map +1 -0
- package/resources/index.d.ts +11 -8
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +11 -5
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +5 -2
- package/resources/index.mjs.map +1 -1
- package/resources/mandates.d.ts +55 -17
- package/resources/mandates.d.ts.map +1 -1
- package/resources/orders.d.ts +720 -743
- package/resources/orders.d.ts.map +1 -1
- package/resources/orders.js +13 -3
- package/resources/orders.js.map +1 -1
- package/resources/orders.mjs +13 -3
- package/resources/orders.mjs.map +1 -1
- package/resources/payouts.d.ts +219 -103
- package/resources/payouts.d.ts.map +1 -1
- package/resources/payouts.js +3 -4
- package/resources/payouts.js.map +1 -1
- package/resources/payouts.mjs +3 -4
- package/resources/payouts.mjs.map +1 -1
- package/resources/refunds.d.ts +53 -97
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +8 -12
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +8 -12
- package/resources/refunds.mjs.map +1 -1
- package/resources/returns.d.ts +104 -0
- package/resources/returns.d.ts.map +1 -0
- package/resources/returns.js +21 -0
- package/resources/returns.js.map +1 -0
- package/resources/returns.mjs +17 -0
- package/resources/returns.mjs.map +1 -0
- package/resources/subaccounts.d.ts +15 -5
- package/resources/subaccounts.d.ts.map +1 -1
- package/resources/subaccounts.js.map +1 -1
- package/resources/subaccounts.mjs.map +1 -1
- package/resources/transactions.d.ts +174 -0
- package/resources/transactions.d.ts.map +1 -0
- package/resources/transactions.js +15 -0
- package/resources/transactions.js.map +1 -0
- package/resources/transactions.mjs +11 -0
- package/resources/transactions.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 +44 -16
- package/src/index.ts +100 -63
- package/src/resource.ts +1 -1
- package/src/resources/balance.ts +8 -5
- package/src/resources/banks.ts +130 -67
- package/src/resources/beneficiary-payouts.ts +78 -0
- package/src/resources/capabilities.ts +1 -10
- package/src/resources/charges.ts +30 -21
- package/src/resources/checkoutsession.ts +1224 -3096
- package/src/resources/customers.ts +164 -9
- package/src/resources/deposits.ts +231 -0
- package/src/resources/fx.ts +119 -0
- package/src/resources/index.ts +31 -28
- package/src/resources/mandates.ts +79 -17
- package/src/resources/orders.ts +1449 -1075
- package/src/resources/payouts.ts +273 -103
- package/src/resources/refunds.ts +70 -111
- package/src/resources/returns.ts +140 -0
- package/src/resources/subaccounts.ts +26 -4
- package/src/resources/transactions.ts +234 -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/resources/reports.d.ts +0 -120
- package/resources/reports.d.ts.map +0 -1
- package/resources/reports.js +0 -31
- package/resources/reports.js.map +0 -1
- package/resources/reports.mjs +0 -27
- package/resources/reports.mjs.map +0 -1
- package/resources/webhooksubscription.d.ts +0 -155
- package/resources/webhooksubscription.d.ts.map +0 -1
- package/resources/webhooksubscription.js +0 -42
- package/resources/webhooksubscription.js.map +0 -1
- package/resources/webhooksubscription.mjs +0 -38
- package/resources/webhooksubscription.mjs.map +0 -1
- package/src/resources/reports.ts +0 -172
- package/src/resources/webhooksubscription.ts +0 -353
|
@@ -39,15 +39,37 @@ export class Checkoutsession extends APIResource {
|
|
|
39
39
|
}
|
|
40
40
|
|
|
41
41
|
export interface CheckoutsessionCreateResponse {
|
|
42
|
-
/**
|
|
43
|
-
* The unique identifier of the Checkout within Ivy.
|
|
44
|
-
*/
|
|
45
42
|
id: string;
|
|
46
43
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
44
|
+
appId: string;
|
|
45
|
+
|
|
46
|
+
created: number;
|
|
47
|
+
|
|
48
|
+
displayId: string;
|
|
49
|
+
|
|
50
|
+
errorCallbackUrl: string;
|
|
51
|
+
|
|
52
|
+
expiresAt: number;
|
|
53
|
+
|
|
54
|
+
lineItems: Array<CheckoutsessionCreateResponse.LineItem>;
|
|
55
|
+
|
|
56
|
+
merchant: CheckoutsessionCreateResponse.Merchant;
|
|
57
|
+
|
|
58
|
+
merchantAppId: string;
|
|
59
|
+
|
|
60
|
+
price: CheckoutsessionCreateResponse.Price;
|
|
61
|
+
|
|
62
|
+
redirectUrl: string;
|
|
63
|
+
|
|
64
|
+
referenceId: string;
|
|
65
|
+
|
|
66
|
+
status: 'open' | 'closed' | 'expired';
|
|
67
|
+
|
|
68
|
+
successCallbackUrl: string;
|
|
69
|
+
|
|
70
|
+
abortReason?: string;
|
|
71
|
+
|
|
72
|
+
availableMarkets?: Array<
|
|
51
73
|
| 'AF'
|
|
52
74
|
| 'AL'
|
|
53
75
|
| 'DZ'
|
|
@@ -300,143 +322,32 @@ export interface CheckoutsessionCreateResponse {
|
|
|
300
322
|
| 'XK'
|
|
301
323
|
>;
|
|
302
324
|
|
|
303
|
-
createdAt: string;
|
|
304
|
-
|
|
305
|
-
/**
|
|
306
|
-
* The customer facing id. This id is displayed to the user during the checkout and
|
|
307
|
-
* in the merchant dashboard.
|
|
308
|
-
*/
|
|
309
|
-
displayId: string;
|
|
310
|
-
|
|
311
|
-
/**
|
|
312
|
-
* Required if not set in the dashboard. Users will be redirected here after an
|
|
313
|
-
* unsuccessful Payment attempt.
|
|
314
|
-
*/
|
|
315
|
-
errorCallbackUrl: string;
|
|
316
|
-
|
|
317
|
-
merchant: CheckoutsessionCreateResponse.Merchant;
|
|
318
|
-
|
|
319
|
-
/**
|
|
320
|
-
* - `settlement`: The payment is initially settled into a virtual account. The
|
|
321
|
-
* funds are then disbursed in batches to the merchant. Refunds are instantly
|
|
322
|
-
* processed from the virtual account.
|
|
323
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
324
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
325
|
-
*/
|
|
326
|
-
paymentMode: 'settlement' | 'direct';
|
|
327
|
-
|
|
328
|
-
/**
|
|
329
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
330
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
331
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
332
|
-
* as this is the format accepted by most banks.
|
|
333
|
-
*/
|
|
334
|
-
price: CheckoutsessionCreateResponse.Price;
|
|
335
|
-
|
|
336
|
-
redirectUrl: string;
|
|
337
|
-
|
|
338
|
-
/**
|
|
339
|
-
* An internal reference id which will be stored with the checkout & corresponding
|
|
340
|
-
* order. Needs to be unique per shop per order and can be up to 200 characters. We
|
|
341
|
-
* recommend to use your internal order id here.
|
|
342
|
-
*/
|
|
343
|
-
referenceId: string;
|
|
344
|
-
|
|
345
|
-
status: 'open' | 'closed' | 'expired';
|
|
346
|
-
|
|
347
|
-
/**
|
|
348
|
-
* Required if not set in the dashboard. Users will be redirected here after a
|
|
349
|
-
* successful Payment attempt.
|
|
350
|
-
*/
|
|
351
|
-
successCallbackUrl: string;
|
|
352
|
-
|
|
353
|
-
updatedAt: string;
|
|
354
|
-
|
|
355
|
-
abortReason?: string;
|
|
356
|
-
|
|
357
|
-
appId?: string;
|
|
358
|
-
|
|
359
|
-
/**
|
|
360
|
-
* The billing address of the customer. Required when handshake=true.
|
|
361
|
-
*/
|
|
362
325
|
billingAddress?: CheckoutsessionCreateResponse.BillingAddress;
|
|
363
326
|
|
|
364
|
-
/**
|
|
365
|
-
* The merchant category code or
|
|
366
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
367
|
-
*/
|
|
368
327
|
category?: string;
|
|
369
328
|
|
|
370
|
-
/**
|
|
371
|
-
* Only applicable for express Checkouts. Complete Callback requests will be sent
|
|
372
|
-
* to this URL.
|
|
373
|
-
*/
|
|
374
329
|
completeCallbackUrl?: string;
|
|
375
330
|
|
|
376
|
-
|
|
377
|
-
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
378
|
-
* time of Checkout creation at Ivy.
|
|
379
|
-
*/
|
|
380
|
-
created?: number;
|
|
331
|
+
createdAt?: unknown;
|
|
381
332
|
|
|
382
333
|
customer?: CheckoutsessionCreateResponse.Customer;
|
|
383
334
|
|
|
384
|
-
/**
|
|
385
|
-
* False by default. If set to true, customers cannot modify the pre-selected bank
|
|
386
|
-
* from `prefill.bankId`.
|
|
387
|
-
*/
|
|
388
335
|
disableBankSelection?: boolean;
|
|
389
336
|
|
|
390
|
-
/**
|
|
391
|
-
* The Epoch time in seconds at which the Checkout Session will expire. It can be
|
|
392
|
-
* anywhere from 30 minutes to 24 hours after Checkout Session creation. By
|
|
393
|
-
* default, this value is 1 hour from creation.
|
|
394
|
-
*/
|
|
395
|
-
expiresAt?: number;
|
|
396
|
-
|
|
397
|
-
/**
|
|
398
|
-
* False by default. If set to true, the Checkout is displayed in express mode.
|
|
399
|
-
*/
|
|
400
337
|
express?: boolean;
|
|
401
338
|
|
|
402
|
-
/**
|
|
403
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
404
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
405
|
-
*/
|
|
406
339
|
guest?: boolean;
|
|
407
340
|
|
|
408
|
-
/**
|
|
409
|
-
* If true, the order must be confirmed through the merchant with an additional
|
|
410
|
-
* complete callback endpoint. Always true for express sessions.
|
|
411
|
-
*/
|
|
412
341
|
handshake?: boolean;
|
|
413
342
|
|
|
414
343
|
impactOffsetProjects?: Array<string>;
|
|
415
344
|
|
|
416
|
-
|
|
417
|
-
* The incentive mode of the checkout session. For any use-case apart from
|
|
418
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
419
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
420
|
-
* session will contain sustainable incentives for users.
|
|
421
|
-
*/
|
|
422
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
423
|
-
|
|
424
|
-
lineItems?: Array<CheckoutsessionCreateResponse.LineItem>;
|
|
345
|
+
incentiveMode?: string;
|
|
425
346
|
|
|
426
|
-
|
|
427
|
-
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
428
|
-
* given language. Users can change the language in the Checkout. If not provided,
|
|
429
|
-
* the language of the Checkout is determined by the browser's language.
|
|
430
|
-
*/
|
|
431
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
347
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
432
348
|
|
|
433
349
|
mandate?: CheckoutsessionCreateResponse.Mandate;
|
|
434
350
|
|
|
435
|
-
/**
|
|
436
|
-
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
437
|
-
* located. If provided, the Checkout will display the market's banks first. Not
|
|
438
|
-
* relevant if `prefill.bankId` is provided.
|
|
439
|
-
*/
|
|
440
351
|
market?:
|
|
441
352
|
| 'AF'
|
|
442
353
|
| 'AL'
|
|
@@ -689,61 +600,92 @@ export interface CheckoutsessionCreateResponse {
|
|
|
689
600
|
| 'SS'
|
|
690
601
|
| 'XK';
|
|
691
602
|
|
|
692
|
-
|
|
693
|
-
* @deprecated Use merchant.appId instead
|
|
694
|
-
*/
|
|
695
|
-
merchantAppId?: string;
|
|
696
|
-
|
|
697
|
-
/**
|
|
698
|
-
* Any data which will be stored and returned for this checkout session and
|
|
699
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
700
|
-
* more info.
|
|
701
|
-
*/
|
|
702
|
-
metadata?: Record<string, unknown>;
|
|
603
|
+
metadata?: { [key: string]: unknown };
|
|
703
604
|
|
|
704
605
|
offsetProject?: string;
|
|
705
606
|
|
|
706
|
-
|
|
607
|
+
paymentMode?: 'direct' | 'settlement';
|
|
608
|
+
|
|
609
|
+
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
707
610
|
|
|
708
|
-
/**
|
|
709
|
-
* The shop-plugin version.
|
|
710
|
-
*/
|
|
711
611
|
plugin?: string;
|
|
712
612
|
|
|
713
|
-
|
|
714
|
-
* Prefill known data to skip steps in the checkout.
|
|
715
|
-
*/
|
|
716
|
-
prefill?: CheckoutsessionCreateResponse.Prefill;
|
|
613
|
+
prefill?: unknown;
|
|
717
614
|
|
|
718
|
-
/**
|
|
719
|
-
* Only applicable for express Checkouts. Quote Callback requests will be sent to
|
|
720
|
-
* this URL.
|
|
721
|
-
*/
|
|
722
615
|
quoteCallbackUrl?: string;
|
|
723
616
|
|
|
724
|
-
/**
|
|
725
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
726
|
-
* input within the Ivy express Checkout.
|
|
727
|
-
*/
|
|
728
617
|
required?: CheckoutsessionCreateResponse.Required;
|
|
729
618
|
|
|
730
619
|
selectedShippingMethodId?: string;
|
|
731
620
|
|
|
732
621
|
shippingAddress?: CheckoutsessionCreateResponse.ShippingAddress;
|
|
733
622
|
|
|
734
|
-
shippingMethods?: Array<
|
|
623
|
+
shippingMethods?: Array<unknown>;
|
|
735
624
|
|
|
736
|
-
/**
|
|
737
|
-
* The logo of the shop provided as a URL.
|
|
738
|
-
*/
|
|
739
625
|
shopLogo?: string;
|
|
740
626
|
|
|
741
627
|
shopName?: string;
|
|
742
628
|
|
|
743
629
|
subaccountId?: string;
|
|
630
|
+
|
|
631
|
+
updatedAt?: unknown;
|
|
744
632
|
}
|
|
745
633
|
|
|
746
634
|
export namespace CheckoutsessionCreateResponse {
|
|
635
|
+
export interface LineItem {
|
|
636
|
+
/**
|
|
637
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
638
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
639
|
+
*/
|
|
640
|
+
amount: number;
|
|
641
|
+
|
|
642
|
+
/**
|
|
643
|
+
* Customer-facing name of the line item.
|
|
644
|
+
*/
|
|
645
|
+
name: string;
|
|
646
|
+
|
|
647
|
+
singleNet: number;
|
|
648
|
+
|
|
649
|
+
singleVat: number;
|
|
650
|
+
|
|
651
|
+
category?:
|
|
652
|
+
| '5045'
|
|
653
|
+
| '5065'
|
|
654
|
+
| '5094'
|
|
655
|
+
| '5192'
|
|
656
|
+
| '5193'
|
|
657
|
+
| '5499'
|
|
658
|
+
| '5655'
|
|
659
|
+
| '5691'
|
|
660
|
+
| '5712'
|
|
661
|
+
| '5722'
|
|
662
|
+
| '5812'
|
|
663
|
+
| '5814'
|
|
664
|
+
| '5912'
|
|
665
|
+
| '5977'
|
|
666
|
+
| '5999'
|
|
667
|
+
| '7629';
|
|
668
|
+
|
|
669
|
+
co2Grams?: number;
|
|
670
|
+
|
|
671
|
+
EAN?: string;
|
|
672
|
+
|
|
673
|
+
/**
|
|
674
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
675
|
+
*/
|
|
676
|
+
image?: string;
|
|
677
|
+
|
|
678
|
+
/**
|
|
679
|
+
* Quantity of this lineItem.
|
|
680
|
+
*/
|
|
681
|
+
quantity?: number;
|
|
682
|
+
|
|
683
|
+
/**
|
|
684
|
+
* An internal unique id stored to this line item.
|
|
685
|
+
*/
|
|
686
|
+
referenceId?: string;
|
|
687
|
+
}
|
|
688
|
+
|
|
747
689
|
export interface Merchant {
|
|
748
690
|
id: string;
|
|
749
691
|
|
|
@@ -758,10 +700,6 @@ export namespace CheckoutsessionCreateResponse {
|
|
|
758
700
|
export interface Address {
|
|
759
701
|
city: string;
|
|
760
702
|
|
|
761
|
-
/**
|
|
762
|
-
* The country code in
|
|
763
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
764
|
-
*/
|
|
765
703
|
country:
|
|
766
704
|
| 'AF'
|
|
767
705
|
| 'AL'
|
|
@@ -1014,32 +952,23 @@ export namespace CheckoutsessionCreateResponse {
|
|
|
1014
952
|
| 'SS'
|
|
1015
953
|
| 'XK';
|
|
1016
954
|
|
|
1017
|
-
|
|
955
|
+
firstName: string;
|
|
1018
956
|
|
|
1019
|
-
|
|
957
|
+
lastName: string;
|
|
1020
958
|
|
|
1021
|
-
|
|
959
|
+
line1: string;
|
|
1022
960
|
|
|
1023
|
-
|
|
961
|
+
line2: string;
|
|
1024
962
|
|
|
1025
|
-
|
|
963
|
+
region: string;
|
|
1026
964
|
|
|
1027
|
-
|
|
965
|
+
zipCode: string;
|
|
1028
966
|
}
|
|
1029
967
|
}
|
|
1030
968
|
|
|
1031
|
-
/**
|
|
1032
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
1033
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1034
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1035
|
-
* as this is the format accepted by most banks.
|
|
1036
|
-
*/
|
|
1037
969
|
export interface Price {
|
|
1038
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
970
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
1039
971
|
|
|
1040
|
-
/**
|
|
1041
|
-
* The total amount to be paid.
|
|
1042
|
-
*/
|
|
1043
972
|
total: number;
|
|
1044
973
|
|
|
1045
974
|
shipping?: number;
|
|
@@ -1051,16 +980,9 @@ export namespace CheckoutsessionCreateResponse {
|
|
|
1051
980
|
vat?: number;
|
|
1052
981
|
}
|
|
1053
982
|
|
|
1054
|
-
/**
|
|
1055
|
-
* The billing address of the customer. Required when handshake=true.
|
|
1056
|
-
*/
|
|
1057
983
|
export interface BillingAddress {
|
|
1058
984
|
city: string;
|
|
1059
985
|
|
|
1060
|
-
/**
|
|
1061
|
-
* The country code in
|
|
1062
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1063
|
-
*/
|
|
1064
986
|
country:
|
|
1065
987
|
| 'AF'
|
|
1066
988
|
| 'AL'
|
|
@@ -1313,207 +1235,58 @@ export namespace CheckoutsessionCreateResponse {
|
|
|
1313
1235
|
| 'SS'
|
|
1314
1236
|
| 'XK';
|
|
1315
1237
|
|
|
1316
|
-
|
|
1238
|
+
firstName: string;
|
|
1317
1239
|
|
|
1318
|
-
|
|
1240
|
+
lastName: string;
|
|
1319
1241
|
|
|
1320
|
-
|
|
1242
|
+
line1: string;
|
|
1321
1243
|
|
|
1322
|
-
|
|
1244
|
+
line2: string;
|
|
1323
1245
|
|
|
1324
|
-
|
|
1246
|
+
region: string;
|
|
1325
1247
|
|
|
1326
|
-
|
|
1248
|
+
zipCode: string;
|
|
1327
1249
|
}
|
|
1328
1250
|
|
|
1329
1251
|
export interface Customer {
|
|
1330
1252
|
id: string;
|
|
1331
1253
|
}
|
|
1332
1254
|
|
|
1333
|
-
/**
|
|
1334
|
-
* The line items of the Checkout.
|
|
1335
|
-
*/
|
|
1336
|
-
export interface LineItem {
|
|
1337
|
-
/**
|
|
1338
|
-
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
1339
|
-
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
1340
|
-
*/
|
|
1341
|
-
amount: number;
|
|
1342
|
-
|
|
1343
|
-
/**
|
|
1344
|
-
* The name of the line item.
|
|
1345
|
-
*/
|
|
1346
|
-
name: string;
|
|
1347
|
-
|
|
1348
|
-
/**
|
|
1349
|
-
* The quantity of the line item.
|
|
1350
|
-
*/
|
|
1351
|
-
quantity: number;
|
|
1352
|
-
|
|
1353
|
-
/**
|
|
1354
|
-
* The net amount of a single item.
|
|
1355
|
-
*/
|
|
1356
|
-
singleNet: number;
|
|
1357
|
-
|
|
1358
|
-
/**
|
|
1359
|
-
* The VAT amount of a single item.
|
|
1360
|
-
*/
|
|
1361
|
-
singleVat: number;
|
|
1362
|
-
|
|
1363
|
-
/**
|
|
1364
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
1365
|
-
* the line item.
|
|
1366
|
-
*/
|
|
1367
|
-
category?: string;
|
|
1368
|
-
|
|
1369
|
-
/**
|
|
1370
|
-
* The
|
|
1371
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
1372
|
-
* of the line item.
|
|
1373
|
-
*/
|
|
1374
|
-
EAN?: string;
|
|
1375
|
-
|
|
1376
|
-
/**
|
|
1377
|
-
* The image of the line item as a URL.
|
|
1378
|
-
*/
|
|
1379
|
-
image?: string;
|
|
1380
|
-
|
|
1381
|
-
/**
|
|
1382
|
-
* The internal unique identifier of the line item.
|
|
1383
|
-
*/
|
|
1384
|
-
referenceId?: string;
|
|
1385
|
-
}
|
|
1386
|
-
|
|
1387
1255
|
export interface Mandate {
|
|
1388
|
-
setup: boolean;
|
|
1389
|
-
|
|
1390
|
-
/**
|
|
1391
|
-
* The name of the account holder who signs the mandate
|
|
1392
|
-
*/
|
|
1393
1256
|
accountHolderName?: string;
|
|
1394
1257
|
|
|
1258
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
1259
|
+
|
|
1395
1260
|
referenceId?: string;
|
|
1396
1261
|
|
|
1262
|
+
setup?: boolean;
|
|
1263
|
+
|
|
1397
1264
|
userNotificationEmail?: string;
|
|
1398
1265
|
}
|
|
1399
1266
|
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
export interface Prefill {
|
|
1404
|
-
/**
|
|
1405
|
-
* The known bank id. Customers will skip the bank selection and go directly to the
|
|
1406
|
-
* bank's login. Required for financial address prefill.
|
|
1407
|
-
*/
|
|
1408
|
-
bankId?: string;
|
|
1409
|
-
|
|
1410
|
-
/**
|
|
1411
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
1412
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
1413
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
1414
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
1415
|
-
* out.
|
|
1416
|
-
*/
|
|
1417
|
-
payerFinancialAddress?: Prefill.PayerFinancialAddress;
|
|
1418
|
-
}
|
|
1267
|
+
export namespace Mandate {
|
|
1268
|
+
export interface AdditionalDisplayInformation {
|
|
1269
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
1419
1270
|
|
|
1420
|
-
|
|
1421
|
-
/**
|
|
1422
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
1423
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
1424
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
1425
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
1426
|
-
* out.
|
|
1427
|
-
*/
|
|
1428
|
-
export interface PayerFinancialAddress {
|
|
1429
|
-
/**
|
|
1430
|
-
* The type of the financial address. The actual destination is determined by this
|
|
1431
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
1432
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
1433
|
-
* in the "iban" object.
|
|
1434
|
-
*
|
|
1435
|
-
* - iban: The IBAN of the account
|
|
1436
|
-
* - sort_code: The sort code of the account
|
|
1437
|
-
* - bank_code: The bank code of the account
|
|
1438
|
-
* - bban: The BBAN of the account
|
|
1439
|
-
*/
|
|
1440
|
-
type: string;
|
|
1441
|
-
|
|
1442
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
1443
|
-
|
|
1444
|
-
bban?: PayerFinancialAddress.Bban;
|
|
1445
|
-
|
|
1446
|
-
iban?: PayerFinancialAddress.Iban;
|
|
1447
|
-
|
|
1448
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
1271
|
+
price?: AdditionalDisplayInformation.Price;
|
|
1449
1272
|
}
|
|
1450
1273
|
|
|
1451
|
-
export namespace
|
|
1452
|
-
export interface
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
code: string;
|
|
1456
|
-
|
|
1457
|
-
/**
|
|
1458
|
-
* The name of the account holder.
|
|
1459
|
-
*/
|
|
1460
|
-
accountHolderName?: string;
|
|
1461
|
-
}
|
|
1462
|
-
|
|
1463
|
-
export interface Bban {
|
|
1464
|
-
bban: string;
|
|
1465
|
-
|
|
1466
|
-
/**
|
|
1467
|
-
* The name of the account holder.
|
|
1468
|
-
*/
|
|
1469
|
-
accountHolderName?: string;
|
|
1470
|
-
|
|
1471
|
-
bic?: string;
|
|
1472
|
-
}
|
|
1473
|
-
|
|
1474
|
-
export interface Iban {
|
|
1475
|
-
iban: string;
|
|
1476
|
-
|
|
1477
|
-
/**
|
|
1478
|
-
* The name of the account holder.
|
|
1479
|
-
*/
|
|
1480
|
-
accountHolderName?: string;
|
|
1481
|
-
|
|
1482
|
-
bic?: string;
|
|
1483
|
-
}
|
|
1484
|
-
|
|
1485
|
-
export interface SortCode {
|
|
1486
|
-
accountNumber: string;
|
|
1487
|
-
|
|
1488
|
-
sortCode: string;
|
|
1274
|
+
export namespace AdditionalDisplayInformation {
|
|
1275
|
+
export interface Price {
|
|
1276
|
+
amount: number;
|
|
1489
1277
|
|
|
1490
|
-
|
|
1491
|
-
* The name of the account holder.
|
|
1492
|
-
*/
|
|
1493
|
-
accountHolderName?: string;
|
|
1278
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
1494
1279
|
}
|
|
1495
1280
|
}
|
|
1496
1281
|
}
|
|
1497
1282
|
|
|
1498
|
-
/**
|
|
1499
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
1500
|
-
* input within the Ivy express Checkout.
|
|
1501
|
-
*/
|
|
1502
1283
|
export interface Required {
|
|
1503
|
-
/**
|
|
1504
|
-
* If set to true, the phone number will be required input within the Ivy express
|
|
1505
|
-
* Checkout.
|
|
1506
|
-
*/
|
|
1507
1284
|
phone: boolean;
|
|
1508
1285
|
}
|
|
1509
1286
|
|
|
1510
1287
|
export interface ShippingAddress {
|
|
1511
1288
|
city: string;
|
|
1512
1289
|
|
|
1513
|
-
/**
|
|
1514
|
-
* The country code in
|
|
1515
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1516
|
-
*/
|
|
1517
1290
|
country:
|
|
1518
1291
|
| 'AF'
|
|
1519
1292
|
| 'AL'
|
|
@@ -1766,370 +1539,52 @@ export namespace CheckoutsessionCreateResponse {
|
|
|
1766
1539
|
| 'SS'
|
|
1767
1540
|
| 'XK';
|
|
1768
1541
|
|
|
1769
|
-
|
|
1542
|
+
firstName: string;
|
|
1770
1543
|
|
|
1771
|
-
|
|
1544
|
+
lastName: string;
|
|
1772
1545
|
|
|
1773
|
-
|
|
1546
|
+
line1: string;
|
|
1774
1547
|
|
|
1775
|
-
|
|
1548
|
+
line2: string;
|
|
1776
1549
|
|
|
1777
|
-
|
|
1550
|
+
region: string;
|
|
1778
1551
|
|
|
1779
|
-
|
|
1552
|
+
zipCode: string;
|
|
1780
1553
|
}
|
|
1554
|
+
}
|
|
1781
1555
|
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
*/
|
|
1785
|
-
export interface ShippingMethod {
|
|
1786
|
-
/**
|
|
1787
|
-
* The customer-facing name of the shipping method.
|
|
1788
|
-
*/
|
|
1789
|
-
name: string;
|
|
1556
|
+
export interface CheckoutsessionRetrieveResponse {
|
|
1557
|
+
id: string;
|
|
1790
1558
|
|
|
1791
|
-
|
|
1792
|
-
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
1793
|
-
*/
|
|
1794
|
-
price: number;
|
|
1559
|
+
appId: string;
|
|
1795
1560
|
|
|
1796
|
-
|
|
1797
|
-
* The unique identifier of the shipping method within Ivy.
|
|
1798
|
-
*/
|
|
1799
|
-
id?: string;
|
|
1561
|
+
created: number;
|
|
1800
1562
|
|
|
1801
|
-
|
|
1802
|
-
* The list of countries where the shipping method is available.
|
|
1803
|
-
*/
|
|
1804
|
-
countries?: Array<
|
|
1805
|
-
| 'AF'
|
|
1806
|
-
| 'AL'
|
|
1807
|
-
| 'DZ'
|
|
1808
|
-
| 'AS'
|
|
1809
|
-
| 'AD'
|
|
1810
|
-
| 'AO'
|
|
1811
|
-
| 'AI'
|
|
1812
|
-
| 'AQ'
|
|
1813
|
-
| 'AG'
|
|
1814
|
-
| 'AR'
|
|
1815
|
-
| 'AM'
|
|
1816
|
-
| 'AW'
|
|
1817
|
-
| 'AU'
|
|
1818
|
-
| 'AT'
|
|
1819
|
-
| 'AZ'
|
|
1820
|
-
| 'BS'
|
|
1821
|
-
| 'BH'
|
|
1822
|
-
| 'BD'
|
|
1823
|
-
| 'BB'
|
|
1824
|
-
| 'BY'
|
|
1825
|
-
| 'BE'
|
|
1826
|
-
| 'BZ'
|
|
1827
|
-
| 'BJ'
|
|
1828
|
-
| 'BM'
|
|
1829
|
-
| 'BT'
|
|
1830
|
-
| 'BO'
|
|
1831
|
-
| 'BA'
|
|
1832
|
-
| 'BW'
|
|
1833
|
-
| 'BV'
|
|
1834
|
-
| 'BR'
|
|
1835
|
-
| 'IO'
|
|
1836
|
-
| 'BN'
|
|
1837
|
-
| 'BG'
|
|
1838
|
-
| 'BF'
|
|
1839
|
-
| 'BI'
|
|
1840
|
-
| 'KH'
|
|
1841
|
-
| 'CM'
|
|
1842
|
-
| 'CA'
|
|
1843
|
-
| 'CV'
|
|
1844
|
-
| 'KY'
|
|
1845
|
-
| 'CF'
|
|
1846
|
-
| 'TD'
|
|
1847
|
-
| 'CL'
|
|
1848
|
-
| 'CN'
|
|
1849
|
-
| 'CX'
|
|
1850
|
-
| 'CC'
|
|
1851
|
-
| 'CO'
|
|
1852
|
-
| 'KM'
|
|
1853
|
-
| 'CG'
|
|
1854
|
-
| 'CD'
|
|
1855
|
-
| 'CK'
|
|
1856
|
-
| 'CR'
|
|
1857
|
-
| 'CI'
|
|
1858
|
-
| 'HR'
|
|
1859
|
-
| 'CU'
|
|
1860
|
-
| 'CY'
|
|
1861
|
-
| 'CZ'
|
|
1862
|
-
| 'DK'
|
|
1863
|
-
| 'DJ'
|
|
1864
|
-
| 'DM'
|
|
1865
|
-
| 'DO'
|
|
1866
|
-
| 'EC'
|
|
1867
|
-
| 'EG'
|
|
1868
|
-
| 'SV'
|
|
1869
|
-
| 'GQ'
|
|
1870
|
-
| 'ER'
|
|
1871
|
-
| 'EE'
|
|
1872
|
-
| 'ET'
|
|
1873
|
-
| 'FK'
|
|
1874
|
-
| 'FO'
|
|
1875
|
-
| 'FJ'
|
|
1876
|
-
| 'FI'
|
|
1877
|
-
| 'FR'
|
|
1878
|
-
| 'GF'
|
|
1879
|
-
| 'PF'
|
|
1880
|
-
| 'TF'
|
|
1881
|
-
| 'GA'
|
|
1882
|
-
| 'GM'
|
|
1883
|
-
| 'GE'
|
|
1884
|
-
| 'DE'
|
|
1885
|
-
| 'GH'
|
|
1886
|
-
| 'GI'
|
|
1887
|
-
| 'GR'
|
|
1888
|
-
| 'GL'
|
|
1889
|
-
| 'GD'
|
|
1890
|
-
| 'GP'
|
|
1891
|
-
| 'GU'
|
|
1892
|
-
| 'GT'
|
|
1893
|
-
| 'GN'
|
|
1894
|
-
| 'GW'
|
|
1895
|
-
| 'GY'
|
|
1896
|
-
| 'HT'
|
|
1897
|
-
| 'HM'
|
|
1898
|
-
| 'VA'
|
|
1899
|
-
| 'HN'
|
|
1900
|
-
| 'HK'
|
|
1901
|
-
| 'HU'
|
|
1902
|
-
| 'IS'
|
|
1903
|
-
| 'IN'
|
|
1904
|
-
| 'ID'
|
|
1905
|
-
| 'IR'
|
|
1906
|
-
| 'IQ'
|
|
1907
|
-
| 'IE'
|
|
1908
|
-
| 'IL'
|
|
1909
|
-
| 'IT'
|
|
1910
|
-
| 'JM'
|
|
1911
|
-
| 'JP'
|
|
1912
|
-
| 'JO'
|
|
1913
|
-
| 'KZ'
|
|
1914
|
-
| 'KE'
|
|
1915
|
-
| 'KI'
|
|
1916
|
-
| 'KP'
|
|
1917
|
-
| 'KR'
|
|
1918
|
-
| 'KW'
|
|
1919
|
-
| 'KG'
|
|
1920
|
-
| 'LA'
|
|
1921
|
-
| 'LV'
|
|
1922
|
-
| 'LB'
|
|
1923
|
-
| 'LS'
|
|
1924
|
-
| 'LR'
|
|
1925
|
-
| 'LY'
|
|
1926
|
-
| 'LI'
|
|
1927
|
-
| 'LT'
|
|
1928
|
-
| 'LU'
|
|
1929
|
-
| 'MO'
|
|
1930
|
-
| 'MG'
|
|
1931
|
-
| 'MW'
|
|
1932
|
-
| 'MY'
|
|
1933
|
-
| 'MV'
|
|
1934
|
-
| 'ML'
|
|
1935
|
-
| 'MT'
|
|
1936
|
-
| 'MH'
|
|
1937
|
-
| 'MQ'
|
|
1938
|
-
| 'MR'
|
|
1939
|
-
| 'MU'
|
|
1940
|
-
| 'YT'
|
|
1941
|
-
| 'MX'
|
|
1942
|
-
| 'FM'
|
|
1943
|
-
| 'MD'
|
|
1944
|
-
| 'MC'
|
|
1945
|
-
| 'MN'
|
|
1946
|
-
| 'MS'
|
|
1947
|
-
| 'MA'
|
|
1948
|
-
| 'MZ'
|
|
1949
|
-
| 'MM'
|
|
1950
|
-
| 'NA'
|
|
1951
|
-
| 'NR'
|
|
1952
|
-
| 'NP'
|
|
1953
|
-
| 'NL'
|
|
1954
|
-
| 'NC'
|
|
1955
|
-
| 'NZ'
|
|
1956
|
-
| 'NI'
|
|
1957
|
-
| 'NE'
|
|
1958
|
-
| 'NG'
|
|
1959
|
-
| 'NU'
|
|
1960
|
-
| 'NF'
|
|
1961
|
-
| 'MP'
|
|
1962
|
-
| 'MK'
|
|
1963
|
-
| 'NO'
|
|
1964
|
-
| 'OM'
|
|
1965
|
-
| 'PK'
|
|
1966
|
-
| 'PW'
|
|
1967
|
-
| 'PS'
|
|
1968
|
-
| 'PA'
|
|
1969
|
-
| 'PG'
|
|
1970
|
-
| 'PY'
|
|
1971
|
-
| 'PE'
|
|
1972
|
-
| 'PH'
|
|
1973
|
-
| 'PN'
|
|
1974
|
-
| 'PL'
|
|
1975
|
-
| 'PT'
|
|
1976
|
-
| 'PR'
|
|
1977
|
-
| 'QA'
|
|
1978
|
-
| 'RE'
|
|
1979
|
-
| 'RO'
|
|
1980
|
-
| 'RU'
|
|
1981
|
-
| 'RW'
|
|
1982
|
-
| 'SH'
|
|
1983
|
-
| 'KN'
|
|
1984
|
-
| 'LC'
|
|
1985
|
-
| 'PM'
|
|
1986
|
-
| 'VC'
|
|
1987
|
-
| 'WS'
|
|
1988
|
-
| 'SM'
|
|
1989
|
-
| 'ST'
|
|
1990
|
-
| 'SA'
|
|
1991
|
-
| 'SN'
|
|
1992
|
-
| 'SC'
|
|
1993
|
-
| 'SL'
|
|
1994
|
-
| 'SG'
|
|
1995
|
-
| 'SK'
|
|
1996
|
-
| 'SI'
|
|
1997
|
-
| 'SB'
|
|
1998
|
-
| 'SO'
|
|
1999
|
-
| 'ZA'
|
|
2000
|
-
| 'GS'
|
|
2001
|
-
| 'ES'
|
|
2002
|
-
| 'LK'
|
|
2003
|
-
| 'SD'
|
|
2004
|
-
| 'SR'
|
|
2005
|
-
| 'SJ'
|
|
2006
|
-
| 'SZ'
|
|
2007
|
-
| 'SE'
|
|
2008
|
-
| 'CH'
|
|
2009
|
-
| 'SY'
|
|
2010
|
-
| 'TW'
|
|
2011
|
-
| 'TJ'
|
|
2012
|
-
| 'TZ'
|
|
2013
|
-
| 'TH'
|
|
2014
|
-
| 'TL'
|
|
2015
|
-
| 'TG'
|
|
2016
|
-
| 'TK'
|
|
2017
|
-
| 'TO'
|
|
2018
|
-
| 'TT'
|
|
2019
|
-
| 'TN'
|
|
2020
|
-
| 'TR'
|
|
2021
|
-
| 'TM'
|
|
2022
|
-
| 'TC'
|
|
2023
|
-
| 'TV'
|
|
2024
|
-
| 'UG'
|
|
2025
|
-
| 'UA'
|
|
2026
|
-
| 'AE'
|
|
2027
|
-
| 'GB'
|
|
2028
|
-
| 'US'
|
|
2029
|
-
| 'UM'
|
|
2030
|
-
| 'UY'
|
|
2031
|
-
| 'UZ'
|
|
2032
|
-
| 'VU'
|
|
2033
|
-
| 'VE'
|
|
2034
|
-
| 'VN'
|
|
2035
|
-
| 'VG'
|
|
2036
|
-
| 'VI'
|
|
2037
|
-
| 'WF'
|
|
2038
|
-
| 'EH'
|
|
2039
|
-
| 'YE'
|
|
2040
|
-
| 'ZM'
|
|
2041
|
-
| 'ZW'
|
|
2042
|
-
| 'AX'
|
|
2043
|
-
| 'BQ'
|
|
2044
|
-
| 'CW'
|
|
2045
|
-
| 'GG'
|
|
2046
|
-
| 'IM'
|
|
2047
|
-
| 'JE'
|
|
2048
|
-
| 'ME'
|
|
2049
|
-
| 'BL'
|
|
2050
|
-
| 'MF'
|
|
2051
|
-
| 'RS'
|
|
2052
|
-
| 'SX'
|
|
2053
|
-
| 'SS'
|
|
2054
|
-
| 'XK'
|
|
2055
|
-
>;
|
|
1563
|
+
displayId: string;
|
|
2056
1564
|
|
|
2057
|
-
|
|
2058
|
-
* The delivery estimate of the shipping method.
|
|
2059
|
-
*/
|
|
2060
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
1565
|
+
errorCallbackUrl: string;
|
|
2061
1566
|
|
|
2062
|
-
|
|
2063
|
-
* The unique identifier within your system of the shipping method.
|
|
2064
|
-
*/
|
|
2065
|
-
reference?: string;
|
|
1567
|
+
expiresAt: number;
|
|
2066
1568
|
|
|
2067
|
-
|
|
2068
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
2069
|
-
*/
|
|
2070
|
-
timeFrame?: string;
|
|
2071
|
-
}
|
|
1569
|
+
lineItems: Array<CheckoutsessionRetrieveResponse.LineItem>;
|
|
2072
1570
|
|
|
2073
|
-
|
|
2074
|
-
/**
|
|
2075
|
-
* The delivery estimate of the shipping method.
|
|
2076
|
-
*/
|
|
2077
|
-
export interface DeliveryEstimate {
|
|
2078
|
-
/**
|
|
2079
|
-
* The maximum delivery time.
|
|
2080
|
-
*/
|
|
2081
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
2082
|
-
|
|
2083
|
-
/**
|
|
2084
|
-
* The minimum delivery time.
|
|
2085
|
-
*/
|
|
2086
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
2087
|
-
}
|
|
1571
|
+
merchant: CheckoutsessionRetrieveResponse.Merchant;
|
|
2088
1572
|
|
|
2089
|
-
|
|
2090
|
-
/**
|
|
2091
|
-
* The maximum delivery time.
|
|
2092
|
-
*/
|
|
2093
|
-
export interface Maximum {
|
|
2094
|
-
/**
|
|
2095
|
-
* The unit of the time duration.
|
|
2096
|
-
*/
|
|
2097
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
2098
|
-
|
|
2099
|
-
/**
|
|
2100
|
-
* The value of the time duration.
|
|
2101
|
-
*/
|
|
2102
|
-
value: number;
|
|
2103
|
-
}
|
|
1573
|
+
merchantAppId: string;
|
|
2104
1574
|
|
|
2105
|
-
|
|
2106
|
-
* The minimum delivery time.
|
|
2107
|
-
*/
|
|
2108
|
-
export interface Minimum {
|
|
2109
|
-
/**
|
|
2110
|
-
* The unit of the time duration.
|
|
2111
|
-
*/
|
|
2112
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
2113
|
-
|
|
2114
|
-
/**
|
|
2115
|
-
* The value of the time duration.
|
|
2116
|
-
*/
|
|
2117
|
-
value: number;
|
|
2118
|
-
}
|
|
2119
|
-
}
|
|
2120
|
-
}
|
|
2121
|
-
}
|
|
1575
|
+
price: CheckoutsessionRetrieveResponse.Price;
|
|
2122
1576
|
|
|
2123
|
-
|
|
2124
|
-
/**
|
|
2125
|
-
* The unique identifier of the Checkout within Ivy.
|
|
2126
|
-
*/
|
|
2127
|
-
id: string;
|
|
1577
|
+
redirectUrl: string;
|
|
2128
1578
|
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
1579
|
+
referenceId: string;
|
|
1580
|
+
|
|
1581
|
+
status: 'open' | 'closed' | 'expired';
|
|
1582
|
+
|
|
1583
|
+
successCallbackUrl: string;
|
|
1584
|
+
|
|
1585
|
+
abortReason?: string;
|
|
1586
|
+
|
|
1587
|
+
availableMarkets?: Array<
|
|
2133
1588
|
| 'AF'
|
|
2134
1589
|
| 'AL'
|
|
2135
1590
|
| 'DZ'
|
|
@@ -2382,143 +1837,32 @@ export interface CheckoutsessionRetrieveResponse {
|
|
|
2382
1837
|
| 'XK'
|
|
2383
1838
|
>;
|
|
2384
1839
|
|
|
2385
|
-
createdAt: string;
|
|
2386
|
-
|
|
2387
|
-
/**
|
|
2388
|
-
* The customer facing id. This id is displayed to the user during the checkout and
|
|
2389
|
-
* in the merchant dashboard.
|
|
2390
|
-
*/
|
|
2391
|
-
displayId: string;
|
|
2392
|
-
|
|
2393
|
-
/**
|
|
2394
|
-
* Required if not set in the dashboard. Users will be redirected here after an
|
|
2395
|
-
* unsuccessful Payment attempt.
|
|
2396
|
-
*/
|
|
2397
|
-
errorCallbackUrl: string;
|
|
2398
|
-
|
|
2399
|
-
merchant: CheckoutsessionRetrieveResponse.Merchant;
|
|
2400
|
-
|
|
2401
|
-
/**
|
|
2402
|
-
* - `settlement`: The payment is initially settled into a virtual account. The
|
|
2403
|
-
* funds are then disbursed in batches to the merchant. Refunds are instantly
|
|
2404
|
-
* processed from the virtual account.
|
|
2405
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
2406
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
2407
|
-
*/
|
|
2408
|
-
paymentMode: 'settlement' | 'direct';
|
|
2409
|
-
|
|
2410
|
-
/**
|
|
2411
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
2412
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
2413
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
2414
|
-
* as this is the format accepted by most banks.
|
|
2415
|
-
*/
|
|
2416
|
-
price: CheckoutsessionRetrieveResponse.Price;
|
|
2417
|
-
|
|
2418
|
-
redirectUrl: string;
|
|
2419
|
-
|
|
2420
|
-
/**
|
|
2421
|
-
* An internal reference id which will be stored with the checkout & corresponding
|
|
2422
|
-
* order. Needs to be unique per shop per order and can be up to 200 characters. We
|
|
2423
|
-
* recommend to use your internal order id here.
|
|
2424
|
-
*/
|
|
2425
|
-
referenceId: string;
|
|
2426
|
-
|
|
2427
|
-
status: 'open' | 'closed' | 'expired';
|
|
2428
|
-
|
|
2429
|
-
/**
|
|
2430
|
-
* Required if not set in the dashboard. Users will be redirected here after a
|
|
2431
|
-
* successful Payment attempt.
|
|
2432
|
-
*/
|
|
2433
|
-
successCallbackUrl: string;
|
|
2434
|
-
|
|
2435
|
-
updatedAt: string;
|
|
2436
|
-
|
|
2437
|
-
abortReason?: string;
|
|
2438
|
-
|
|
2439
|
-
appId?: string;
|
|
2440
|
-
|
|
2441
|
-
/**
|
|
2442
|
-
* The billing address of the customer. Required when handshake=true.
|
|
2443
|
-
*/
|
|
2444
1840
|
billingAddress?: CheckoutsessionRetrieveResponse.BillingAddress;
|
|
2445
1841
|
|
|
2446
|
-
/**
|
|
2447
|
-
* The merchant category code or
|
|
2448
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
2449
|
-
*/
|
|
2450
1842
|
category?: string;
|
|
2451
1843
|
|
|
2452
|
-
/**
|
|
2453
|
-
* Only applicable for express Checkouts. Complete Callback requests will be sent
|
|
2454
|
-
* to this URL.
|
|
2455
|
-
*/
|
|
2456
1844
|
completeCallbackUrl?: string;
|
|
2457
1845
|
|
|
2458
|
-
|
|
2459
|
-
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
2460
|
-
* time of Checkout creation at Ivy.
|
|
2461
|
-
*/
|
|
2462
|
-
created?: number;
|
|
1846
|
+
createdAt?: unknown;
|
|
2463
1847
|
|
|
2464
1848
|
customer?: CheckoutsessionRetrieveResponse.Customer;
|
|
2465
1849
|
|
|
2466
|
-
/**
|
|
2467
|
-
* False by default. If set to true, customers cannot modify the pre-selected bank
|
|
2468
|
-
* from `prefill.bankId`.
|
|
2469
|
-
*/
|
|
2470
1850
|
disableBankSelection?: boolean;
|
|
2471
1851
|
|
|
2472
|
-
/**
|
|
2473
|
-
* The Epoch time in seconds at which the Checkout Session will expire. It can be
|
|
2474
|
-
* anywhere from 30 minutes to 24 hours after Checkout Session creation. By
|
|
2475
|
-
* default, this value is 1 hour from creation.
|
|
2476
|
-
*/
|
|
2477
|
-
expiresAt?: number;
|
|
2478
|
-
|
|
2479
|
-
/**
|
|
2480
|
-
* False by default. If set to true, the Checkout is displayed in express mode.
|
|
2481
|
-
*/
|
|
2482
1852
|
express?: boolean;
|
|
2483
1853
|
|
|
2484
|
-
/**
|
|
2485
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
2486
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
2487
|
-
*/
|
|
2488
1854
|
guest?: boolean;
|
|
2489
1855
|
|
|
2490
|
-
/**
|
|
2491
|
-
* If true, the order must be confirmed through the merchant with an additional
|
|
2492
|
-
* complete callback endpoint. Always true for express sessions.
|
|
2493
|
-
*/
|
|
2494
1856
|
handshake?: boolean;
|
|
2495
1857
|
|
|
2496
1858
|
impactOffsetProjects?: Array<string>;
|
|
2497
1859
|
|
|
2498
|
-
|
|
2499
|
-
* The incentive mode of the checkout session. For any use-case apart from
|
|
2500
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
2501
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
2502
|
-
* session will contain sustainable incentives for users.
|
|
2503
|
-
*/
|
|
2504
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
2505
|
-
|
|
2506
|
-
lineItems?: Array<CheckoutsessionRetrieveResponse.LineItem>;
|
|
1860
|
+
incentiveMode?: string;
|
|
2507
1861
|
|
|
2508
|
-
|
|
2509
|
-
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
2510
|
-
* given language. Users can change the language in the Checkout. If not provided,
|
|
2511
|
-
* the language of the Checkout is determined by the browser's language.
|
|
2512
|
-
*/
|
|
2513
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
1862
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
2514
1863
|
|
|
2515
1864
|
mandate?: CheckoutsessionRetrieveResponse.Mandate;
|
|
2516
1865
|
|
|
2517
|
-
/**
|
|
2518
|
-
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
2519
|
-
* located. If provided, the Checkout will display the market's banks first. Not
|
|
2520
|
-
* relevant if `prefill.bankId` is provided.
|
|
2521
|
-
*/
|
|
2522
1866
|
market?:
|
|
2523
1867
|
| 'AF'
|
|
2524
1868
|
| 'AL'
|
|
@@ -2771,61 +2115,92 @@ export interface CheckoutsessionRetrieveResponse {
|
|
|
2771
2115
|
| 'SS'
|
|
2772
2116
|
| 'XK';
|
|
2773
2117
|
|
|
2774
|
-
|
|
2775
|
-
* @deprecated Use merchant.appId instead
|
|
2776
|
-
*/
|
|
2777
|
-
merchantAppId?: string;
|
|
2778
|
-
|
|
2779
|
-
/**
|
|
2780
|
-
* Any data which will be stored and returned for this checkout session and
|
|
2781
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
2782
|
-
* more info.
|
|
2783
|
-
*/
|
|
2784
|
-
metadata?: Record<string, unknown>;
|
|
2118
|
+
metadata?: { [key: string]: unknown };
|
|
2785
2119
|
|
|
2786
2120
|
offsetProject?: string;
|
|
2787
2121
|
|
|
2788
|
-
|
|
2122
|
+
paymentMode?: 'direct' | 'settlement';
|
|
2123
|
+
|
|
2124
|
+
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
2789
2125
|
|
|
2790
|
-
/**
|
|
2791
|
-
* The shop-plugin version.
|
|
2792
|
-
*/
|
|
2793
2126
|
plugin?: string;
|
|
2794
2127
|
|
|
2795
|
-
|
|
2796
|
-
* Prefill known data to skip steps in the checkout.
|
|
2797
|
-
*/
|
|
2798
|
-
prefill?: CheckoutsessionRetrieveResponse.Prefill;
|
|
2128
|
+
prefill?: unknown;
|
|
2799
2129
|
|
|
2800
|
-
/**
|
|
2801
|
-
* Only applicable for express Checkouts. Quote Callback requests will be sent to
|
|
2802
|
-
* this URL.
|
|
2803
|
-
*/
|
|
2804
2130
|
quoteCallbackUrl?: string;
|
|
2805
2131
|
|
|
2806
|
-
/**
|
|
2807
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
2808
|
-
* input within the Ivy express Checkout.
|
|
2809
|
-
*/
|
|
2810
2132
|
required?: CheckoutsessionRetrieveResponse.Required;
|
|
2811
2133
|
|
|
2812
2134
|
selectedShippingMethodId?: string;
|
|
2813
2135
|
|
|
2814
2136
|
shippingAddress?: CheckoutsessionRetrieveResponse.ShippingAddress;
|
|
2815
2137
|
|
|
2816
|
-
shippingMethods?: Array<
|
|
2138
|
+
shippingMethods?: Array<unknown>;
|
|
2817
2139
|
|
|
2818
|
-
/**
|
|
2819
|
-
* The logo of the shop provided as a URL.
|
|
2820
|
-
*/
|
|
2821
2140
|
shopLogo?: string;
|
|
2822
2141
|
|
|
2823
2142
|
shopName?: string;
|
|
2824
2143
|
|
|
2825
2144
|
subaccountId?: string;
|
|
2145
|
+
|
|
2146
|
+
updatedAt?: unknown;
|
|
2826
2147
|
}
|
|
2827
2148
|
|
|
2828
2149
|
export namespace CheckoutsessionRetrieveResponse {
|
|
2150
|
+
export interface LineItem {
|
|
2151
|
+
/**
|
|
2152
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
2153
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
2154
|
+
*/
|
|
2155
|
+
amount: number;
|
|
2156
|
+
|
|
2157
|
+
/**
|
|
2158
|
+
* Customer-facing name of the line item.
|
|
2159
|
+
*/
|
|
2160
|
+
name: string;
|
|
2161
|
+
|
|
2162
|
+
singleNet: number;
|
|
2163
|
+
|
|
2164
|
+
singleVat: number;
|
|
2165
|
+
|
|
2166
|
+
category?:
|
|
2167
|
+
| '5045'
|
|
2168
|
+
| '5065'
|
|
2169
|
+
| '5094'
|
|
2170
|
+
| '5192'
|
|
2171
|
+
| '5193'
|
|
2172
|
+
| '5499'
|
|
2173
|
+
| '5655'
|
|
2174
|
+
| '5691'
|
|
2175
|
+
| '5712'
|
|
2176
|
+
| '5722'
|
|
2177
|
+
| '5812'
|
|
2178
|
+
| '5814'
|
|
2179
|
+
| '5912'
|
|
2180
|
+
| '5977'
|
|
2181
|
+
| '5999'
|
|
2182
|
+
| '7629';
|
|
2183
|
+
|
|
2184
|
+
co2Grams?: number;
|
|
2185
|
+
|
|
2186
|
+
EAN?: string;
|
|
2187
|
+
|
|
2188
|
+
/**
|
|
2189
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
2190
|
+
*/
|
|
2191
|
+
image?: string;
|
|
2192
|
+
|
|
2193
|
+
/**
|
|
2194
|
+
* Quantity of this lineItem.
|
|
2195
|
+
*/
|
|
2196
|
+
quantity?: number;
|
|
2197
|
+
|
|
2198
|
+
/**
|
|
2199
|
+
* An internal unique id stored to this line item.
|
|
2200
|
+
*/
|
|
2201
|
+
referenceId?: string;
|
|
2202
|
+
}
|
|
2203
|
+
|
|
2829
2204
|
export interface Merchant {
|
|
2830
2205
|
id: string;
|
|
2831
2206
|
|
|
@@ -2840,10 +2215,6 @@ export namespace CheckoutsessionRetrieveResponse {
|
|
|
2840
2215
|
export interface Address {
|
|
2841
2216
|
city: string;
|
|
2842
2217
|
|
|
2843
|
-
/**
|
|
2844
|
-
* The country code in
|
|
2845
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
2846
|
-
*/
|
|
2847
2218
|
country:
|
|
2848
2219
|
| 'AF'
|
|
2849
2220
|
| 'AL'
|
|
@@ -3096,32 +2467,23 @@ export namespace CheckoutsessionRetrieveResponse {
|
|
|
3096
2467
|
| 'SS'
|
|
3097
2468
|
| 'XK';
|
|
3098
2469
|
|
|
3099
|
-
|
|
2470
|
+
firstName: string;
|
|
3100
2471
|
|
|
3101
|
-
|
|
2472
|
+
lastName: string;
|
|
3102
2473
|
|
|
3103
|
-
|
|
2474
|
+
line1: string;
|
|
3104
2475
|
|
|
3105
|
-
|
|
2476
|
+
line2: string;
|
|
3106
2477
|
|
|
3107
|
-
|
|
2478
|
+
region: string;
|
|
3108
2479
|
|
|
3109
|
-
|
|
2480
|
+
zipCode: string;
|
|
3110
2481
|
}
|
|
3111
2482
|
}
|
|
3112
2483
|
|
|
3113
|
-
/**
|
|
3114
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
3115
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
3116
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
3117
|
-
* as this is the format accepted by most banks.
|
|
3118
|
-
*/
|
|
3119
2484
|
export interface Price {
|
|
3120
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
2485
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
3121
2486
|
|
|
3122
|
-
/**
|
|
3123
|
-
* The total amount to be paid.
|
|
3124
|
-
*/
|
|
3125
2487
|
total: number;
|
|
3126
2488
|
|
|
3127
2489
|
shipping?: number;
|
|
@@ -3133,16 +2495,9 @@ export namespace CheckoutsessionRetrieveResponse {
|
|
|
3133
2495
|
vat?: number;
|
|
3134
2496
|
}
|
|
3135
2497
|
|
|
3136
|
-
/**
|
|
3137
|
-
* The billing address of the customer. Required when handshake=true.
|
|
3138
|
-
*/
|
|
3139
2498
|
export interface BillingAddress {
|
|
3140
2499
|
city: string;
|
|
3141
2500
|
|
|
3142
|
-
/**
|
|
3143
|
-
* The country code in
|
|
3144
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
3145
|
-
*/
|
|
3146
2501
|
country:
|
|
3147
2502
|
| 'AF'
|
|
3148
2503
|
| 'AL'
|
|
@@ -3395,207 +2750,58 @@ export namespace CheckoutsessionRetrieveResponse {
|
|
|
3395
2750
|
| 'SS'
|
|
3396
2751
|
| 'XK';
|
|
3397
2752
|
|
|
3398
|
-
|
|
2753
|
+
firstName: string;
|
|
3399
2754
|
|
|
3400
|
-
|
|
2755
|
+
lastName: string;
|
|
3401
2756
|
|
|
3402
|
-
|
|
2757
|
+
line1: string;
|
|
3403
2758
|
|
|
3404
|
-
|
|
2759
|
+
line2: string;
|
|
3405
2760
|
|
|
3406
|
-
|
|
2761
|
+
region: string;
|
|
3407
2762
|
|
|
3408
|
-
|
|
2763
|
+
zipCode: string;
|
|
3409
2764
|
}
|
|
3410
2765
|
|
|
3411
2766
|
export interface Customer {
|
|
3412
2767
|
id: string;
|
|
3413
2768
|
}
|
|
3414
2769
|
|
|
3415
|
-
/**
|
|
3416
|
-
* The line items of the Checkout.
|
|
3417
|
-
*/
|
|
3418
|
-
export interface LineItem {
|
|
3419
|
-
/**
|
|
3420
|
-
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
3421
|
-
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
3422
|
-
*/
|
|
3423
|
-
amount: number;
|
|
3424
|
-
|
|
3425
|
-
/**
|
|
3426
|
-
* The name of the line item.
|
|
3427
|
-
*/
|
|
3428
|
-
name: string;
|
|
3429
|
-
|
|
3430
|
-
/**
|
|
3431
|
-
* The quantity of the line item.
|
|
3432
|
-
*/
|
|
3433
|
-
quantity: number;
|
|
3434
|
-
|
|
3435
|
-
/**
|
|
3436
|
-
* The net amount of a single item.
|
|
3437
|
-
*/
|
|
3438
|
-
singleNet: number;
|
|
3439
|
-
|
|
3440
|
-
/**
|
|
3441
|
-
* The VAT amount of a single item.
|
|
3442
|
-
*/
|
|
3443
|
-
singleVat: number;
|
|
3444
|
-
|
|
3445
|
-
/**
|
|
3446
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
3447
|
-
* the line item.
|
|
3448
|
-
*/
|
|
3449
|
-
category?: string;
|
|
3450
|
-
|
|
3451
|
-
/**
|
|
3452
|
-
* The
|
|
3453
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
3454
|
-
* of the line item.
|
|
3455
|
-
*/
|
|
3456
|
-
EAN?: string;
|
|
3457
|
-
|
|
3458
|
-
/**
|
|
3459
|
-
* The image of the line item as a URL.
|
|
3460
|
-
*/
|
|
3461
|
-
image?: string;
|
|
3462
|
-
|
|
3463
|
-
/**
|
|
3464
|
-
* The internal unique identifier of the line item.
|
|
3465
|
-
*/
|
|
3466
|
-
referenceId?: string;
|
|
3467
|
-
}
|
|
3468
|
-
|
|
3469
2770
|
export interface Mandate {
|
|
3470
|
-
setup: boolean;
|
|
3471
|
-
|
|
3472
|
-
/**
|
|
3473
|
-
* The name of the account holder who signs the mandate
|
|
3474
|
-
*/
|
|
3475
2771
|
accountHolderName?: string;
|
|
3476
2772
|
|
|
2773
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
2774
|
+
|
|
3477
2775
|
referenceId?: string;
|
|
3478
2776
|
|
|
2777
|
+
setup?: boolean;
|
|
2778
|
+
|
|
3479
2779
|
userNotificationEmail?: string;
|
|
3480
2780
|
}
|
|
3481
2781
|
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
export interface Prefill {
|
|
3486
|
-
/**
|
|
3487
|
-
* The known bank id. Customers will skip the bank selection and go directly to the
|
|
3488
|
-
* bank's login. Required for financial address prefill.
|
|
3489
|
-
*/
|
|
3490
|
-
bankId?: string;
|
|
3491
|
-
|
|
3492
|
-
/**
|
|
3493
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
3494
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
3495
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
3496
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
3497
|
-
* out.
|
|
3498
|
-
*/
|
|
3499
|
-
payerFinancialAddress?: Prefill.PayerFinancialAddress;
|
|
3500
|
-
}
|
|
2782
|
+
export namespace Mandate {
|
|
2783
|
+
export interface AdditionalDisplayInformation {
|
|
2784
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
3501
2785
|
|
|
3502
|
-
|
|
3503
|
-
/**
|
|
3504
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
3505
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
3506
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
3507
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
3508
|
-
* out.
|
|
3509
|
-
*/
|
|
3510
|
-
export interface PayerFinancialAddress {
|
|
3511
|
-
/**
|
|
3512
|
-
* The type of the financial address. The actual destination is determined by this
|
|
3513
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
3514
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
3515
|
-
* in the "iban" object.
|
|
3516
|
-
*
|
|
3517
|
-
* - iban: The IBAN of the account
|
|
3518
|
-
* - sort_code: The sort code of the account
|
|
3519
|
-
* - bank_code: The bank code of the account
|
|
3520
|
-
* - bban: The BBAN of the account
|
|
3521
|
-
*/
|
|
3522
|
-
type: string;
|
|
3523
|
-
|
|
3524
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
3525
|
-
|
|
3526
|
-
bban?: PayerFinancialAddress.Bban;
|
|
3527
|
-
|
|
3528
|
-
iban?: PayerFinancialAddress.Iban;
|
|
3529
|
-
|
|
3530
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
2786
|
+
price?: AdditionalDisplayInformation.Price;
|
|
3531
2787
|
}
|
|
3532
2788
|
|
|
3533
|
-
export namespace
|
|
3534
|
-
export interface
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
code: string;
|
|
3538
|
-
|
|
3539
|
-
/**
|
|
3540
|
-
* The name of the account holder.
|
|
3541
|
-
*/
|
|
3542
|
-
accountHolderName?: string;
|
|
3543
|
-
}
|
|
3544
|
-
|
|
3545
|
-
export interface Bban {
|
|
3546
|
-
bban: string;
|
|
3547
|
-
|
|
3548
|
-
/**
|
|
3549
|
-
* The name of the account holder.
|
|
3550
|
-
*/
|
|
3551
|
-
accountHolderName?: string;
|
|
3552
|
-
|
|
3553
|
-
bic?: string;
|
|
3554
|
-
}
|
|
3555
|
-
|
|
3556
|
-
export interface Iban {
|
|
3557
|
-
iban: string;
|
|
3558
|
-
|
|
3559
|
-
/**
|
|
3560
|
-
* The name of the account holder.
|
|
3561
|
-
*/
|
|
3562
|
-
accountHolderName?: string;
|
|
3563
|
-
|
|
3564
|
-
bic?: string;
|
|
3565
|
-
}
|
|
3566
|
-
|
|
3567
|
-
export interface SortCode {
|
|
3568
|
-
accountNumber: string;
|
|
3569
|
-
|
|
3570
|
-
sortCode: string;
|
|
2789
|
+
export namespace AdditionalDisplayInformation {
|
|
2790
|
+
export interface Price {
|
|
2791
|
+
amount: number;
|
|
3571
2792
|
|
|
3572
|
-
|
|
3573
|
-
* The name of the account holder.
|
|
3574
|
-
*/
|
|
3575
|
-
accountHolderName?: string;
|
|
2793
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
3576
2794
|
}
|
|
3577
2795
|
}
|
|
3578
2796
|
}
|
|
3579
2797
|
|
|
3580
|
-
/**
|
|
3581
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
3582
|
-
* input within the Ivy express Checkout.
|
|
3583
|
-
*/
|
|
3584
2798
|
export interface Required {
|
|
3585
|
-
/**
|
|
3586
|
-
* If set to true, the phone number will be required input within the Ivy express
|
|
3587
|
-
* Checkout.
|
|
3588
|
-
*/
|
|
3589
2799
|
phone: boolean;
|
|
3590
2800
|
}
|
|
3591
2801
|
|
|
3592
2802
|
export interface ShippingAddress {
|
|
3593
2803
|
city: string;
|
|
3594
2804
|
|
|
3595
|
-
/**
|
|
3596
|
-
* The country code in
|
|
3597
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
3598
|
-
*/
|
|
3599
2805
|
country:
|
|
3600
2806
|
| 'AF'
|
|
3601
2807
|
| 'AL'
|
|
@@ -3848,370 +3054,52 @@ export namespace CheckoutsessionRetrieveResponse {
|
|
|
3848
3054
|
| 'SS'
|
|
3849
3055
|
| 'XK';
|
|
3850
3056
|
|
|
3851
|
-
|
|
3057
|
+
firstName: string;
|
|
3852
3058
|
|
|
3853
|
-
|
|
3059
|
+
lastName: string;
|
|
3854
3060
|
|
|
3855
|
-
|
|
3061
|
+
line1: string;
|
|
3856
3062
|
|
|
3857
|
-
|
|
3063
|
+
line2: string;
|
|
3858
3064
|
|
|
3859
|
-
|
|
3065
|
+
region: string;
|
|
3860
3066
|
|
|
3861
|
-
|
|
3067
|
+
zipCode: string;
|
|
3862
3068
|
}
|
|
3069
|
+
}
|
|
3863
3070
|
|
|
3864
|
-
|
|
3865
|
-
|
|
3866
|
-
*/
|
|
3867
|
-
export interface ShippingMethod {
|
|
3868
|
-
/**
|
|
3869
|
-
* The customer-facing name of the shipping method.
|
|
3870
|
-
*/
|
|
3871
|
-
name: string;
|
|
3071
|
+
export interface CheckoutsessionExpireResponse {
|
|
3072
|
+
id: string;
|
|
3872
3073
|
|
|
3873
|
-
|
|
3874
|
-
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
3875
|
-
*/
|
|
3876
|
-
price: number;
|
|
3074
|
+
appId: string;
|
|
3877
3075
|
|
|
3878
|
-
|
|
3879
|
-
* The unique identifier of the shipping method within Ivy.
|
|
3880
|
-
*/
|
|
3881
|
-
id?: string;
|
|
3076
|
+
created: number;
|
|
3882
3077
|
|
|
3883
|
-
|
|
3884
|
-
* The list of countries where the shipping method is available.
|
|
3885
|
-
*/
|
|
3886
|
-
countries?: Array<
|
|
3887
|
-
| 'AF'
|
|
3888
|
-
| 'AL'
|
|
3889
|
-
| 'DZ'
|
|
3890
|
-
| 'AS'
|
|
3891
|
-
| 'AD'
|
|
3892
|
-
| 'AO'
|
|
3893
|
-
| 'AI'
|
|
3894
|
-
| 'AQ'
|
|
3895
|
-
| 'AG'
|
|
3896
|
-
| 'AR'
|
|
3897
|
-
| 'AM'
|
|
3898
|
-
| 'AW'
|
|
3899
|
-
| 'AU'
|
|
3900
|
-
| 'AT'
|
|
3901
|
-
| 'AZ'
|
|
3902
|
-
| 'BS'
|
|
3903
|
-
| 'BH'
|
|
3904
|
-
| 'BD'
|
|
3905
|
-
| 'BB'
|
|
3906
|
-
| 'BY'
|
|
3907
|
-
| 'BE'
|
|
3908
|
-
| 'BZ'
|
|
3909
|
-
| 'BJ'
|
|
3910
|
-
| 'BM'
|
|
3911
|
-
| 'BT'
|
|
3912
|
-
| 'BO'
|
|
3913
|
-
| 'BA'
|
|
3914
|
-
| 'BW'
|
|
3915
|
-
| 'BV'
|
|
3916
|
-
| 'BR'
|
|
3917
|
-
| 'IO'
|
|
3918
|
-
| 'BN'
|
|
3919
|
-
| 'BG'
|
|
3920
|
-
| 'BF'
|
|
3921
|
-
| 'BI'
|
|
3922
|
-
| 'KH'
|
|
3923
|
-
| 'CM'
|
|
3924
|
-
| 'CA'
|
|
3925
|
-
| 'CV'
|
|
3926
|
-
| 'KY'
|
|
3927
|
-
| 'CF'
|
|
3928
|
-
| 'TD'
|
|
3929
|
-
| 'CL'
|
|
3930
|
-
| 'CN'
|
|
3931
|
-
| 'CX'
|
|
3932
|
-
| 'CC'
|
|
3933
|
-
| 'CO'
|
|
3934
|
-
| 'KM'
|
|
3935
|
-
| 'CG'
|
|
3936
|
-
| 'CD'
|
|
3937
|
-
| 'CK'
|
|
3938
|
-
| 'CR'
|
|
3939
|
-
| 'CI'
|
|
3940
|
-
| 'HR'
|
|
3941
|
-
| 'CU'
|
|
3942
|
-
| 'CY'
|
|
3943
|
-
| 'CZ'
|
|
3944
|
-
| 'DK'
|
|
3945
|
-
| 'DJ'
|
|
3946
|
-
| 'DM'
|
|
3947
|
-
| 'DO'
|
|
3948
|
-
| 'EC'
|
|
3949
|
-
| 'EG'
|
|
3950
|
-
| 'SV'
|
|
3951
|
-
| 'GQ'
|
|
3952
|
-
| 'ER'
|
|
3953
|
-
| 'EE'
|
|
3954
|
-
| 'ET'
|
|
3955
|
-
| 'FK'
|
|
3956
|
-
| 'FO'
|
|
3957
|
-
| 'FJ'
|
|
3958
|
-
| 'FI'
|
|
3959
|
-
| 'FR'
|
|
3960
|
-
| 'GF'
|
|
3961
|
-
| 'PF'
|
|
3962
|
-
| 'TF'
|
|
3963
|
-
| 'GA'
|
|
3964
|
-
| 'GM'
|
|
3965
|
-
| 'GE'
|
|
3966
|
-
| 'DE'
|
|
3967
|
-
| 'GH'
|
|
3968
|
-
| 'GI'
|
|
3969
|
-
| 'GR'
|
|
3970
|
-
| 'GL'
|
|
3971
|
-
| 'GD'
|
|
3972
|
-
| 'GP'
|
|
3973
|
-
| 'GU'
|
|
3974
|
-
| 'GT'
|
|
3975
|
-
| 'GN'
|
|
3976
|
-
| 'GW'
|
|
3977
|
-
| 'GY'
|
|
3978
|
-
| 'HT'
|
|
3979
|
-
| 'HM'
|
|
3980
|
-
| 'VA'
|
|
3981
|
-
| 'HN'
|
|
3982
|
-
| 'HK'
|
|
3983
|
-
| 'HU'
|
|
3984
|
-
| 'IS'
|
|
3985
|
-
| 'IN'
|
|
3986
|
-
| 'ID'
|
|
3987
|
-
| 'IR'
|
|
3988
|
-
| 'IQ'
|
|
3989
|
-
| 'IE'
|
|
3990
|
-
| 'IL'
|
|
3991
|
-
| 'IT'
|
|
3992
|
-
| 'JM'
|
|
3993
|
-
| 'JP'
|
|
3994
|
-
| 'JO'
|
|
3995
|
-
| 'KZ'
|
|
3996
|
-
| 'KE'
|
|
3997
|
-
| 'KI'
|
|
3998
|
-
| 'KP'
|
|
3999
|
-
| 'KR'
|
|
4000
|
-
| 'KW'
|
|
4001
|
-
| 'KG'
|
|
4002
|
-
| 'LA'
|
|
4003
|
-
| 'LV'
|
|
4004
|
-
| 'LB'
|
|
4005
|
-
| 'LS'
|
|
4006
|
-
| 'LR'
|
|
4007
|
-
| 'LY'
|
|
4008
|
-
| 'LI'
|
|
4009
|
-
| 'LT'
|
|
4010
|
-
| 'LU'
|
|
4011
|
-
| 'MO'
|
|
4012
|
-
| 'MG'
|
|
4013
|
-
| 'MW'
|
|
4014
|
-
| 'MY'
|
|
4015
|
-
| 'MV'
|
|
4016
|
-
| 'ML'
|
|
4017
|
-
| 'MT'
|
|
4018
|
-
| 'MH'
|
|
4019
|
-
| 'MQ'
|
|
4020
|
-
| 'MR'
|
|
4021
|
-
| 'MU'
|
|
4022
|
-
| 'YT'
|
|
4023
|
-
| 'MX'
|
|
4024
|
-
| 'FM'
|
|
4025
|
-
| 'MD'
|
|
4026
|
-
| 'MC'
|
|
4027
|
-
| 'MN'
|
|
4028
|
-
| 'MS'
|
|
4029
|
-
| 'MA'
|
|
4030
|
-
| 'MZ'
|
|
4031
|
-
| 'MM'
|
|
4032
|
-
| 'NA'
|
|
4033
|
-
| 'NR'
|
|
4034
|
-
| 'NP'
|
|
4035
|
-
| 'NL'
|
|
4036
|
-
| 'NC'
|
|
4037
|
-
| 'NZ'
|
|
4038
|
-
| 'NI'
|
|
4039
|
-
| 'NE'
|
|
4040
|
-
| 'NG'
|
|
4041
|
-
| 'NU'
|
|
4042
|
-
| 'NF'
|
|
4043
|
-
| 'MP'
|
|
4044
|
-
| 'MK'
|
|
4045
|
-
| 'NO'
|
|
4046
|
-
| 'OM'
|
|
4047
|
-
| 'PK'
|
|
4048
|
-
| 'PW'
|
|
4049
|
-
| 'PS'
|
|
4050
|
-
| 'PA'
|
|
4051
|
-
| 'PG'
|
|
4052
|
-
| 'PY'
|
|
4053
|
-
| 'PE'
|
|
4054
|
-
| 'PH'
|
|
4055
|
-
| 'PN'
|
|
4056
|
-
| 'PL'
|
|
4057
|
-
| 'PT'
|
|
4058
|
-
| 'PR'
|
|
4059
|
-
| 'QA'
|
|
4060
|
-
| 'RE'
|
|
4061
|
-
| 'RO'
|
|
4062
|
-
| 'RU'
|
|
4063
|
-
| 'RW'
|
|
4064
|
-
| 'SH'
|
|
4065
|
-
| 'KN'
|
|
4066
|
-
| 'LC'
|
|
4067
|
-
| 'PM'
|
|
4068
|
-
| 'VC'
|
|
4069
|
-
| 'WS'
|
|
4070
|
-
| 'SM'
|
|
4071
|
-
| 'ST'
|
|
4072
|
-
| 'SA'
|
|
4073
|
-
| 'SN'
|
|
4074
|
-
| 'SC'
|
|
4075
|
-
| 'SL'
|
|
4076
|
-
| 'SG'
|
|
4077
|
-
| 'SK'
|
|
4078
|
-
| 'SI'
|
|
4079
|
-
| 'SB'
|
|
4080
|
-
| 'SO'
|
|
4081
|
-
| 'ZA'
|
|
4082
|
-
| 'GS'
|
|
4083
|
-
| 'ES'
|
|
4084
|
-
| 'LK'
|
|
4085
|
-
| 'SD'
|
|
4086
|
-
| 'SR'
|
|
4087
|
-
| 'SJ'
|
|
4088
|
-
| 'SZ'
|
|
4089
|
-
| 'SE'
|
|
4090
|
-
| 'CH'
|
|
4091
|
-
| 'SY'
|
|
4092
|
-
| 'TW'
|
|
4093
|
-
| 'TJ'
|
|
4094
|
-
| 'TZ'
|
|
4095
|
-
| 'TH'
|
|
4096
|
-
| 'TL'
|
|
4097
|
-
| 'TG'
|
|
4098
|
-
| 'TK'
|
|
4099
|
-
| 'TO'
|
|
4100
|
-
| 'TT'
|
|
4101
|
-
| 'TN'
|
|
4102
|
-
| 'TR'
|
|
4103
|
-
| 'TM'
|
|
4104
|
-
| 'TC'
|
|
4105
|
-
| 'TV'
|
|
4106
|
-
| 'UG'
|
|
4107
|
-
| 'UA'
|
|
4108
|
-
| 'AE'
|
|
4109
|
-
| 'GB'
|
|
4110
|
-
| 'US'
|
|
4111
|
-
| 'UM'
|
|
4112
|
-
| 'UY'
|
|
4113
|
-
| 'UZ'
|
|
4114
|
-
| 'VU'
|
|
4115
|
-
| 'VE'
|
|
4116
|
-
| 'VN'
|
|
4117
|
-
| 'VG'
|
|
4118
|
-
| 'VI'
|
|
4119
|
-
| 'WF'
|
|
4120
|
-
| 'EH'
|
|
4121
|
-
| 'YE'
|
|
4122
|
-
| 'ZM'
|
|
4123
|
-
| 'ZW'
|
|
4124
|
-
| 'AX'
|
|
4125
|
-
| 'BQ'
|
|
4126
|
-
| 'CW'
|
|
4127
|
-
| 'GG'
|
|
4128
|
-
| 'IM'
|
|
4129
|
-
| 'JE'
|
|
4130
|
-
| 'ME'
|
|
4131
|
-
| 'BL'
|
|
4132
|
-
| 'MF'
|
|
4133
|
-
| 'RS'
|
|
4134
|
-
| 'SX'
|
|
4135
|
-
| 'SS'
|
|
4136
|
-
| 'XK'
|
|
4137
|
-
>;
|
|
3078
|
+
displayId: string;
|
|
4138
3079
|
|
|
4139
|
-
|
|
4140
|
-
* The delivery estimate of the shipping method.
|
|
4141
|
-
*/
|
|
4142
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
3080
|
+
errorCallbackUrl: string;
|
|
4143
3081
|
|
|
4144
|
-
|
|
4145
|
-
* The unique identifier within your system of the shipping method.
|
|
4146
|
-
*/
|
|
4147
|
-
reference?: string;
|
|
3082
|
+
expiresAt: number;
|
|
4148
3083
|
|
|
4149
|
-
|
|
4150
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
4151
|
-
*/
|
|
4152
|
-
timeFrame?: string;
|
|
4153
|
-
}
|
|
3084
|
+
lineItems: Array<CheckoutsessionExpireResponse.LineItem>;
|
|
4154
3085
|
|
|
4155
|
-
|
|
4156
|
-
/**
|
|
4157
|
-
* The delivery estimate of the shipping method.
|
|
4158
|
-
*/
|
|
4159
|
-
export interface DeliveryEstimate {
|
|
4160
|
-
/**
|
|
4161
|
-
* The maximum delivery time.
|
|
4162
|
-
*/
|
|
4163
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
4164
|
-
|
|
4165
|
-
/**
|
|
4166
|
-
* The minimum delivery time.
|
|
4167
|
-
*/
|
|
4168
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
4169
|
-
}
|
|
3086
|
+
merchant: CheckoutsessionExpireResponse.Merchant;
|
|
4170
3087
|
|
|
4171
|
-
|
|
4172
|
-
/**
|
|
4173
|
-
* The maximum delivery time.
|
|
4174
|
-
*/
|
|
4175
|
-
export interface Maximum {
|
|
4176
|
-
/**
|
|
4177
|
-
* The unit of the time duration.
|
|
4178
|
-
*/
|
|
4179
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
4180
|
-
|
|
4181
|
-
/**
|
|
4182
|
-
* The value of the time duration.
|
|
4183
|
-
*/
|
|
4184
|
-
value: number;
|
|
4185
|
-
}
|
|
3088
|
+
merchantAppId: string;
|
|
4186
3089
|
|
|
4187
|
-
|
|
4188
|
-
* The minimum delivery time.
|
|
4189
|
-
*/
|
|
4190
|
-
export interface Minimum {
|
|
4191
|
-
/**
|
|
4192
|
-
* The unit of the time duration.
|
|
4193
|
-
*/
|
|
4194
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
4195
|
-
|
|
4196
|
-
/**
|
|
4197
|
-
* The value of the time duration.
|
|
4198
|
-
*/
|
|
4199
|
-
value: number;
|
|
4200
|
-
}
|
|
4201
|
-
}
|
|
4202
|
-
}
|
|
4203
|
-
}
|
|
3090
|
+
price: CheckoutsessionExpireResponse.Price;
|
|
4204
3091
|
|
|
4205
|
-
|
|
4206
|
-
/**
|
|
4207
|
-
* The unique identifier of the Checkout within Ivy.
|
|
4208
|
-
*/
|
|
4209
|
-
id: string;
|
|
3092
|
+
redirectUrl: string;
|
|
4210
3093
|
|
|
4211
|
-
|
|
4212
|
-
|
|
4213
|
-
|
|
4214
|
-
|
|
3094
|
+
referenceId: string;
|
|
3095
|
+
|
|
3096
|
+
status: 'open' | 'closed' | 'expired';
|
|
3097
|
+
|
|
3098
|
+
successCallbackUrl: string;
|
|
3099
|
+
|
|
3100
|
+
abortReason?: string;
|
|
3101
|
+
|
|
3102
|
+
availableMarkets?: Array<
|
|
4215
3103
|
| 'AF'
|
|
4216
3104
|
| 'AL'
|
|
4217
3105
|
| 'DZ'
|
|
@@ -4242,1442 +3130,889 @@ export interface CheckoutsessionExpireResponse {
|
|
|
4242
3130
|
| 'BW'
|
|
4243
3131
|
| 'BV'
|
|
4244
3132
|
| 'BR'
|
|
4245
|
-
| 'IO'
|
|
4246
|
-
| 'BN'
|
|
4247
|
-
| 'BG'
|
|
4248
|
-
| 'BF'
|
|
4249
|
-
| 'BI'
|
|
4250
|
-
| 'KH'
|
|
4251
|
-
| 'CM'
|
|
4252
|
-
| 'CA'
|
|
4253
|
-
| 'CV'
|
|
4254
|
-
| 'KY'
|
|
4255
|
-
| 'CF'
|
|
4256
|
-
| 'TD'
|
|
4257
|
-
| 'CL'
|
|
4258
|
-
| 'CN'
|
|
4259
|
-
| 'CX'
|
|
4260
|
-
| 'CC'
|
|
4261
|
-
| 'CO'
|
|
4262
|
-
| 'KM'
|
|
4263
|
-
| 'CG'
|
|
4264
|
-
| 'CD'
|
|
4265
|
-
| 'CK'
|
|
4266
|
-
| 'CR'
|
|
4267
|
-
| 'CI'
|
|
4268
|
-
| 'HR'
|
|
4269
|
-
| 'CU'
|
|
4270
|
-
| 'CY'
|
|
4271
|
-
| 'CZ'
|
|
4272
|
-
| 'DK'
|
|
4273
|
-
| 'DJ'
|
|
4274
|
-
| 'DM'
|
|
4275
|
-
| 'DO'
|
|
4276
|
-
| 'EC'
|
|
4277
|
-
| 'EG'
|
|
4278
|
-
| 'SV'
|
|
4279
|
-
| 'GQ'
|
|
4280
|
-
| 'ER'
|
|
4281
|
-
| 'EE'
|
|
4282
|
-
| 'ET'
|
|
4283
|
-
| 'FK'
|
|
4284
|
-
| 'FO'
|
|
4285
|
-
| 'FJ'
|
|
4286
|
-
| 'FI'
|
|
4287
|
-
| 'FR'
|
|
4288
|
-
| 'GF'
|
|
4289
|
-
| 'PF'
|
|
4290
|
-
| 'TF'
|
|
4291
|
-
| 'GA'
|
|
4292
|
-
| 'GM'
|
|
4293
|
-
| 'GE'
|
|
4294
|
-
| 'DE'
|
|
4295
|
-
| 'GH'
|
|
4296
|
-
| 'GI'
|
|
4297
|
-
| 'GR'
|
|
4298
|
-
| 'GL'
|
|
4299
|
-
| 'GD'
|
|
4300
|
-
| 'GP'
|
|
4301
|
-
| 'GU'
|
|
4302
|
-
| 'GT'
|
|
4303
|
-
| 'GN'
|
|
4304
|
-
| 'GW'
|
|
4305
|
-
| 'GY'
|
|
4306
|
-
| 'HT'
|
|
4307
|
-
| 'HM'
|
|
4308
|
-
| 'VA'
|
|
4309
|
-
| 'HN'
|
|
4310
|
-
| 'HK'
|
|
4311
|
-
| 'HU'
|
|
4312
|
-
| 'IS'
|
|
4313
|
-
| 'IN'
|
|
4314
|
-
| 'ID'
|
|
4315
|
-
| 'IR'
|
|
4316
|
-
| 'IQ'
|
|
4317
|
-
| 'IE'
|
|
4318
|
-
| 'IL'
|
|
4319
|
-
| 'IT'
|
|
4320
|
-
| 'JM'
|
|
4321
|
-
| 'JP'
|
|
4322
|
-
| 'JO'
|
|
4323
|
-
| 'KZ'
|
|
4324
|
-
| 'KE'
|
|
4325
|
-
| 'KI'
|
|
4326
|
-
| 'KP'
|
|
4327
|
-
| 'KR'
|
|
4328
|
-
| 'KW'
|
|
4329
|
-
| 'KG'
|
|
4330
|
-
| 'LA'
|
|
4331
|
-
| 'LV'
|
|
4332
|
-
| 'LB'
|
|
4333
|
-
| 'LS'
|
|
4334
|
-
| 'LR'
|
|
4335
|
-
| 'LY'
|
|
4336
|
-
| 'LI'
|
|
4337
|
-
| 'LT'
|
|
4338
|
-
| 'LU'
|
|
4339
|
-
| 'MO'
|
|
4340
|
-
| 'MG'
|
|
4341
|
-
| 'MW'
|
|
4342
|
-
| 'MY'
|
|
4343
|
-
| 'MV'
|
|
4344
|
-
| 'ML'
|
|
4345
|
-
| 'MT'
|
|
4346
|
-
| 'MH'
|
|
4347
|
-
| 'MQ'
|
|
4348
|
-
| 'MR'
|
|
4349
|
-
| 'MU'
|
|
4350
|
-
| 'YT'
|
|
4351
|
-
| 'MX'
|
|
4352
|
-
| 'FM'
|
|
4353
|
-
| 'MD'
|
|
4354
|
-
| 'MC'
|
|
4355
|
-
| 'MN'
|
|
4356
|
-
| 'MS'
|
|
4357
|
-
| 'MA'
|
|
4358
|
-
| 'MZ'
|
|
4359
|
-
| 'MM'
|
|
4360
|
-
| 'NA'
|
|
4361
|
-
| 'NR'
|
|
4362
|
-
| 'NP'
|
|
4363
|
-
| 'NL'
|
|
4364
|
-
| 'NC'
|
|
4365
|
-
| 'NZ'
|
|
4366
|
-
| 'NI'
|
|
4367
|
-
| 'NE'
|
|
4368
|
-
| 'NG'
|
|
4369
|
-
| 'NU'
|
|
4370
|
-
| 'NF'
|
|
4371
|
-
| 'MP'
|
|
4372
|
-
| 'MK'
|
|
4373
|
-
| 'NO'
|
|
4374
|
-
| 'OM'
|
|
4375
|
-
| 'PK'
|
|
4376
|
-
| 'PW'
|
|
4377
|
-
| 'PS'
|
|
4378
|
-
| 'PA'
|
|
4379
|
-
| 'PG'
|
|
4380
|
-
| 'PY'
|
|
4381
|
-
| 'PE'
|
|
4382
|
-
| 'PH'
|
|
4383
|
-
| 'PN'
|
|
4384
|
-
| 'PL'
|
|
4385
|
-
| 'PT'
|
|
4386
|
-
| 'PR'
|
|
4387
|
-
| 'QA'
|
|
4388
|
-
| 'RE'
|
|
4389
|
-
| 'RO'
|
|
4390
|
-
| 'RU'
|
|
4391
|
-
| 'RW'
|
|
4392
|
-
| 'SH'
|
|
4393
|
-
| 'KN'
|
|
4394
|
-
| 'LC'
|
|
4395
|
-
| 'PM'
|
|
4396
|
-
| 'VC'
|
|
4397
|
-
| 'WS'
|
|
4398
|
-
| 'SM'
|
|
4399
|
-
| 'ST'
|
|
4400
|
-
| 'SA'
|
|
4401
|
-
| 'SN'
|
|
4402
|
-
| 'SC'
|
|
4403
|
-
| 'SL'
|
|
4404
|
-
| 'SG'
|
|
4405
|
-
| 'SK'
|
|
4406
|
-
| 'SI'
|
|
4407
|
-
| 'SB'
|
|
4408
|
-
| 'SO'
|
|
4409
|
-
| 'ZA'
|
|
4410
|
-
| 'GS'
|
|
4411
|
-
| 'ES'
|
|
4412
|
-
| 'LK'
|
|
4413
|
-
| 'SD'
|
|
4414
|
-
| 'SR'
|
|
4415
|
-
| 'SJ'
|
|
4416
|
-
| 'SZ'
|
|
4417
|
-
| 'SE'
|
|
4418
|
-
| 'CH'
|
|
4419
|
-
| 'SY'
|
|
4420
|
-
| 'TW'
|
|
4421
|
-
| 'TJ'
|
|
4422
|
-
| 'TZ'
|
|
4423
|
-
| 'TH'
|
|
4424
|
-
| 'TL'
|
|
4425
|
-
| 'TG'
|
|
4426
|
-
| 'TK'
|
|
4427
|
-
| 'TO'
|
|
4428
|
-
| 'TT'
|
|
4429
|
-
| 'TN'
|
|
4430
|
-
| 'TR'
|
|
4431
|
-
| 'TM'
|
|
4432
|
-
| 'TC'
|
|
4433
|
-
| 'TV'
|
|
4434
|
-
| 'UG'
|
|
4435
|
-
| 'UA'
|
|
4436
|
-
| 'AE'
|
|
4437
|
-
| 'GB'
|
|
4438
|
-
| 'US'
|
|
4439
|
-
| 'UM'
|
|
4440
|
-
| 'UY'
|
|
4441
|
-
| 'UZ'
|
|
4442
|
-
| 'VU'
|
|
4443
|
-
| 'VE'
|
|
4444
|
-
| 'VN'
|
|
4445
|
-
| 'VG'
|
|
4446
|
-
| 'VI'
|
|
4447
|
-
| 'WF'
|
|
4448
|
-
| 'EH'
|
|
4449
|
-
| 'YE'
|
|
4450
|
-
| 'ZM'
|
|
4451
|
-
| 'ZW'
|
|
4452
|
-
| 'AX'
|
|
4453
|
-
| 'BQ'
|
|
4454
|
-
| 'CW'
|
|
4455
|
-
| 'GG'
|
|
4456
|
-
| 'IM'
|
|
4457
|
-
| 'JE'
|
|
4458
|
-
| 'ME'
|
|
4459
|
-
| 'BL'
|
|
4460
|
-
| 'MF'
|
|
4461
|
-
| 'RS'
|
|
4462
|
-
| 'SX'
|
|
4463
|
-
| 'SS'
|
|
4464
|
-
| 'XK'
|
|
4465
|
-
>;
|
|
4466
|
-
|
|
4467
|
-
createdAt: string;
|
|
4468
|
-
|
|
4469
|
-
/**
|
|
4470
|
-
* The customer facing id. This id is displayed to the user during the checkout and
|
|
4471
|
-
* in the merchant dashboard.
|
|
4472
|
-
*/
|
|
4473
|
-
displayId: string;
|
|
4474
|
-
|
|
4475
|
-
/**
|
|
4476
|
-
* Required if not set in the dashboard. Users will be redirected here after an
|
|
4477
|
-
* unsuccessful Payment attempt.
|
|
4478
|
-
*/
|
|
4479
|
-
errorCallbackUrl: string;
|
|
4480
|
-
|
|
4481
|
-
merchant: CheckoutsessionExpireResponse.Merchant;
|
|
4482
|
-
|
|
4483
|
-
/**
|
|
4484
|
-
* - `settlement`: The payment is initially settled into a virtual account. The
|
|
4485
|
-
* funds are then disbursed in batches to the merchant. Refunds are instantly
|
|
4486
|
-
* processed from the virtual account.
|
|
4487
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
4488
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
4489
|
-
*/
|
|
4490
|
-
paymentMode: 'settlement' | 'direct';
|
|
4491
|
-
|
|
4492
|
-
/**
|
|
4493
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
4494
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
4495
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
4496
|
-
* as this is the format accepted by most banks.
|
|
4497
|
-
*/
|
|
4498
|
-
price: CheckoutsessionExpireResponse.Price;
|
|
4499
|
-
|
|
4500
|
-
redirectUrl: string;
|
|
4501
|
-
|
|
4502
|
-
/**
|
|
4503
|
-
* An internal reference id which will be stored with the checkout & corresponding
|
|
4504
|
-
* order. Needs to be unique per shop per order and can be up to 200 characters. We
|
|
4505
|
-
* recommend to use your internal order id here.
|
|
4506
|
-
*/
|
|
4507
|
-
referenceId: string;
|
|
4508
|
-
|
|
4509
|
-
status: 'open' | 'closed' | 'expired';
|
|
4510
|
-
|
|
4511
|
-
/**
|
|
4512
|
-
* Required if not set in the dashboard. Users will be redirected here after a
|
|
4513
|
-
* successful Payment attempt.
|
|
4514
|
-
*/
|
|
4515
|
-
successCallbackUrl: string;
|
|
4516
|
-
|
|
4517
|
-
updatedAt: string;
|
|
4518
|
-
|
|
4519
|
-
abortReason?: string;
|
|
4520
|
-
|
|
4521
|
-
appId?: string;
|
|
4522
|
-
|
|
4523
|
-
/**
|
|
4524
|
-
* The billing address of the customer. Required when handshake=true.
|
|
4525
|
-
*/
|
|
4526
|
-
billingAddress?: CheckoutsessionExpireResponse.BillingAddress;
|
|
4527
|
-
|
|
4528
|
-
/**
|
|
4529
|
-
* The merchant category code or
|
|
4530
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
4531
|
-
*/
|
|
4532
|
-
category?: string;
|
|
4533
|
-
|
|
4534
|
-
/**
|
|
4535
|
-
* Only applicable for express Checkouts. Complete Callback requests will be sent
|
|
4536
|
-
* to this URL.
|
|
4537
|
-
*/
|
|
4538
|
-
completeCallbackUrl?: string;
|
|
4539
|
-
|
|
4540
|
-
/**
|
|
4541
|
-
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
4542
|
-
* time of Checkout creation at Ivy.
|
|
4543
|
-
*/
|
|
4544
|
-
created?: number;
|
|
4545
|
-
|
|
4546
|
-
customer?: CheckoutsessionExpireResponse.Customer;
|
|
4547
|
-
|
|
4548
|
-
/**
|
|
4549
|
-
* False by default. If set to true, customers cannot modify the pre-selected bank
|
|
4550
|
-
* from `prefill.bankId`.
|
|
4551
|
-
*/
|
|
4552
|
-
disableBankSelection?: boolean;
|
|
4553
|
-
|
|
4554
|
-
/**
|
|
4555
|
-
* The Epoch time in seconds at which the Checkout Session will expire. It can be
|
|
4556
|
-
* anywhere from 30 minutes to 24 hours after Checkout Session creation. By
|
|
4557
|
-
* default, this value is 1 hour from creation.
|
|
4558
|
-
*/
|
|
4559
|
-
expiresAt?: number;
|
|
4560
|
-
|
|
4561
|
-
/**
|
|
4562
|
-
* False by default. If set to true, the Checkout is displayed in express mode.
|
|
4563
|
-
*/
|
|
4564
|
-
express?: boolean;
|
|
4565
|
-
|
|
4566
|
-
/**
|
|
4567
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
4568
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
4569
|
-
*/
|
|
4570
|
-
guest?: boolean;
|
|
4571
|
-
|
|
4572
|
-
/**
|
|
4573
|
-
* If true, the order must be confirmed through the merchant with an additional
|
|
4574
|
-
* complete callback endpoint. Always true for express sessions.
|
|
4575
|
-
*/
|
|
4576
|
-
handshake?: boolean;
|
|
4577
|
-
|
|
4578
|
-
impactOffsetProjects?: Array<string>;
|
|
4579
|
-
|
|
4580
|
-
/**
|
|
4581
|
-
* The incentive mode of the checkout session. For any use-case apart from
|
|
4582
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
4583
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
4584
|
-
* session will contain sustainable incentives for users.
|
|
4585
|
-
*/
|
|
4586
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
4587
|
-
|
|
4588
|
-
lineItems?: Array<CheckoutsessionExpireResponse.LineItem>;
|
|
4589
|
-
|
|
4590
|
-
/**
|
|
4591
|
-
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
4592
|
-
* given language. Users can change the language in the Checkout. If not provided,
|
|
4593
|
-
* the language of the Checkout is determined by the browser's language.
|
|
4594
|
-
*/
|
|
4595
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
4596
|
-
|
|
4597
|
-
mandate?: CheckoutsessionExpireResponse.Mandate;
|
|
4598
|
-
|
|
4599
|
-
/**
|
|
4600
|
-
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
4601
|
-
* located. If provided, the Checkout will display the market's banks first. Not
|
|
4602
|
-
* relevant if `prefill.bankId` is provided.
|
|
4603
|
-
*/
|
|
4604
|
-
market?:
|
|
4605
|
-
| 'AF'
|
|
4606
|
-
| 'AL'
|
|
4607
|
-
| 'DZ'
|
|
4608
|
-
| 'AS'
|
|
4609
|
-
| 'AD'
|
|
4610
|
-
| 'AO'
|
|
4611
|
-
| 'AI'
|
|
4612
|
-
| 'AQ'
|
|
4613
|
-
| 'AG'
|
|
4614
|
-
| 'AR'
|
|
4615
|
-
| 'AM'
|
|
4616
|
-
| 'AW'
|
|
4617
|
-
| 'AU'
|
|
4618
|
-
| 'AT'
|
|
4619
|
-
| 'AZ'
|
|
4620
|
-
| 'BS'
|
|
4621
|
-
| 'BH'
|
|
4622
|
-
| 'BD'
|
|
4623
|
-
| 'BB'
|
|
4624
|
-
| 'BY'
|
|
4625
|
-
| 'BE'
|
|
4626
|
-
| 'BZ'
|
|
4627
|
-
| 'BJ'
|
|
4628
|
-
| 'BM'
|
|
4629
|
-
| 'BT'
|
|
4630
|
-
| 'BO'
|
|
4631
|
-
| 'BA'
|
|
4632
|
-
| 'BW'
|
|
4633
|
-
| 'BV'
|
|
4634
|
-
| 'BR'
|
|
4635
|
-
| 'IO'
|
|
4636
|
-
| 'BN'
|
|
4637
|
-
| 'BG'
|
|
4638
|
-
| 'BF'
|
|
4639
|
-
| 'BI'
|
|
4640
|
-
| 'KH'
|
|
4641
|
-
| 'CM'
|
|
4642
|
-
| 'CA'
|
|
4643
|
-
| 'CV'
|
|
4644
|
-
| 'KY'
|
|
4645
|
-
| 'CF'
|
|
4646
|
-
| 'TD'
|
|
4647
|
-
| 'CL'
|
|
4648
|
-
| 'CN'
|
|
4649
|
-
| 'CX'
|
|
4650
|
-
| 'CC'
|
|
4651
|
-
| 'CO'
|
|
4652
|
-
| 'KM'
|
|
4653
|
-
| 'CG'
|
|
4654
|
-
| 'CD'
|
|
4655
|
-
| 'CK'
|
|
4656
|
-
| 'CR'
|
|
4657
|
-
| 'CI'
|
|
4658
|
-
| 'HR'
|
|
4659
|
-
| 'CU'
|
|
4660
|
-
| 'CY'
|
|
4661
|
-
| 'CZ'
|
|
4662
|
-
| 'DK'
|
|
4663
|
-
| 'DJ'
|
|
4664
|
-
| 'DM'
|
|
4665
|
-
| 'DO'
|
|
4666
|
-
| 'EC'
|
|
4667
|
-
| 'EG'
|
|
4668
|
-
| 'SV'
|
|
4669
|
-
| 'GQ'
|
|
4670
|
-
| 'ER'
|
|
4671
|
-
| 'EE'
|
|
4672
|
-
| 'ET'
|
|
4673
|
-
| 'FK'
|
|
4674
|
-
| 'FO'
|
|
4675
|
-
| 'FJ'
|
|
4676
|
-
| 'FI'
|
|
4677
|
-
| 'FR'
|
|
4678
|
-
| 'GF'
|
|
4679
|
-
| 'PF'
|
|
4680
|
-
| 'TF'
|
|
4681
|
-
| 'GA'
|
|
4682
|
-
| 'GM'
|
|
4683
|
-
| 'GE'
|
|
4684
|
-
| 'DE'
|
|
4685
|
-
| 'GH'
|
|
4686
|
-
| 'GI'
|
|
4687
|
-
| 'GR'
|
|
4688
|
-
| 'GL'
|
|
4689
|
-
| 'GD'
|
|
4690
|
-
| 'GP'
|
|
4691
|
-
| 'GU'
|
|
4692
|
-
| 'GT'
|
|
4693
|
-
| 'GN'
|
|
4694
|
-
| 'GW'
|
|
4695
|
-
| 'GY'
|
|
4696
|
-
| 'HT'
|
|
4697
|
-
| 'HM'
|
|
4698
|
-
| 'VA'
|
|
4699
|
-
| 'HN'
|
|
4700
|
-
| 'HK'
|
|
4701
|
-
| 'HU'
|
|
4702
|
-
| 'IS'
|
|
4703
|
-
| 'IN'
|
|
4704
|
-
| 'ID'
|
|
4705
|
-
| 'IR'
|
|
4706
|
-
| 'IQ'
|
|
4707
|
-
| 'IE'
|
|
4708
|
-
| 'IL'
|
|
4709
|
-
| 'IT'
|
|
4710
|
-
| 'JM'
|
|
4711
|
-
| 'JP'
|
|
4712
|
-
| 'JO'
|
|
4713
|
-
| 'KZ'
|
|
4714
|
-
| 'KE'
|
|
4715
|
-
| 'KI'
|
|
4716
|
-
| 'KP'
|
|
4717
|
-
| 'KR'
|
|
4718
|
-
| 'KW'
|
|
4719
|
-
| 'KG'
|
|
4720
|
-
| 'LA'
|
|
4721
|
-
| 'LV'
|
|
4722
|
-
| 'LB'
|
|
4723
|
-
| 'LS'
|
|
4724
|
-
| 'LR'
|
|
4725
|
-
| 'LY'
|
|
4726
|
-
| 'LI'
|
|
4727
|
-
| 'LT'
|
|
4728
|
-
| 'LU'
|
|
4729
|
-
| 'MO'
|
|
4730
|
-
| 'MG'
|
|
4731
|
-
| 'MW'
|
|
4732
|
-
| 'MY'
|
|
4733
|
-
| 'MV'
|
|
4734
|
-
| 'ML'
|
|
4735
|
-
| 'MT'
|
|
4736
|
-
| 'MH'
|
|
4737
|
-
| 'MQ'
|
|
4738
|
-
| 'MR'
|
|
4739
|
-
| 'MU'
|
|
4740
|
-
| 'YT'
|
|
4741
|
-
| 'MX'
|
|
4742
|
-
| 'FM'
|
|
4743
|
-
| 'MD'
|
|
4744
|
-
| 'MC'
|
|
4745
|
-
| 'MN'
|
|
4746
|
-
| 'MS'
|
|
4747
|
-
| 'MA'
|
|
4748
|
-
| 'MZ'
|
|
4749
|
-
| 'MM'
|
|
4750
|
-
| 'NA'
|
|
4751
|
-
| 'NR'
|
|
4752
|
-
| 'NP'
|
|
4753
|
-
| 'NL'
|
|
4754
|
-
| 'NC'
|
|
4755
|
-
| 'NZ'
|
|
4756
|
-
| 'NI'
|
|
4757
|
-
| 'NE'
|
|
4758
|
-
| 'NG'
|
|
4759
|
-
| 'NU'
|
|
4760
|
-
| 'NF'
|
|
4761
|
-
| 'MP'
|
|
4762
|
-
| 'MK'
|
|
4763
|
-
| 'NO'
|
|
4764
|
-
| 'OM'
|
|
4765
|
-
| 'PK'
|
|
4766
|
-
| 'PW'
|
|
4767
|
-
| 'PS'
|
|
4768
|
-
| 'PA'
|
|
4769
|
-
| 'PG'
|
|
4770
|
-
| 'PY'
|
|
4771
|
-
| 'PE'
|
|
4772
|
-
| 'PH'
|
|
4773
|
-
| 'PN'
|
|
4774
|
-
| 'PL'
|
|
4775
|
-
| 'PT'
|
|
4776
|
-
| 'PR'
|
|
4777
|
-
| 'QA'
|
|
4778
|
-
| 'RE'
|
|
4779
|
-
| 'RO'
|
|
4780
|
-
| 'RU'
|
|
4781
|
-
| 'RW'
|
|
4782
|
-
| 'SH'
|
|
4783
|
-
| 'KN'
|
|
4784
|
-
| 'LC'
|
|
4785
|
-
| 'PM'
|
|
4786
|
-
| 'VC'
|
|
4787
|
-
| 'WS'
|
|
4788
|
-
| 'SM'
|
|
4789
|
-
| 'ST'
|
|
4790
|
-
| 'SA'
|
|
4791
|
-
| 'SN'
|
|
4792
|
-
| 'SC'
|
|
4793
|
-
| 'SL'
|
|
4794
|
-
| 'SG'
|
|
4795
|
-
| 'SK'
|
|
4796
|
-
| 'SI'
|
|
4797
|
-
| 'SB'
|
|
4798
|
-
| 'SO'
|
|
4799
|
-
| 'ZA'
|
|
4800
|
-
| 'GS'
|
|
4801
|
-
| 'ES'
|
|
4802
|
-
| 'LK'
|
|
4803
|
-
| 'SD'
|
|
4804
|
-
| 'SR'
|
|
4805
|
-
| 'SJ'
|
|
4806
|
-
| 'SZ'
|
|
4807
|
-
| 'SE'
|
|
4808
|
-
| 'CH'
|
|
4809
|
-
| 'SY'
|
|
4810
|
-
| 'TW'
|
|
4811
|
-
| 'TJ'
|
|
4812
|
-
| 'TZ'
|
|
4813
|
-
| 'TH'
|
|
4814
|
-
| 'TL'
|
|
4815
|
-
| 'TG'
|
|
4816
|
-
| 'TK'
|
|
4817
|
-
| 'TO'
|
|
4818
|
-
| 'TT'
|
|
4819
|
-
| 'TN'
|
|
4820
|
-
| 'TR'
|
|
4821
|
-
| 'TM'
|
|
4822
|
-
| 'TC'
|
|
4823
|
-
| 'TV'
|
|
4824
|
-
| 'UG'
|
|
4825
|
-
| 'UA'
|
|
4826
|
-
| 'AE'
|
|
4827
|
-
| 'GB'
|
|
4828
|
-
| 'US'
|
|
4829
|
-
| 'UM'
|
|
4830
|
-
| 'UY'
|
|
4831
|
-
| 'UZ'
|
|
4832
|
-
| 'VU'
|
|
4833
|
-
| 'VE'
|
|
4834
|
-
| 'VN'
|
|
4835
|
-
| 'VG'
|
|
4836
|
-
| 'VI'
|
|
4837
|
-
| 'WF'
|
|
4838
|
-
| 'EH'
|
|
4839
|
-
| 'YE'
|
|
4840
|
-
| 'ZM'
|
|
4841
|
-
| 'ZW'
|
|
4842
|
-
| 'AX'
|
|
4843
|
-
| 'BQ'
|
|
4844
|
-
| 'CW'
|
|
4845
|
-
| 'GG'
|
|
4846
|
-
| 'IM'
|
|
4847
|
-
| 'JE'
|
|
4848
|
-
| 'ME'
|
|
4849
|
-
| 'BL'
|
|
4850
|
-
| 'MF'
|
|
4851
|
-
| 'RS'
|
|
4852
|
-
| 'SX'
|
|
4853
|
-
| 'SS'
|
|
4854
|
-
| 'XK';
|
|
4855
|
-
|
|
4856
|
-
/**
|
|
4857
|
-
* @deprecated Use merchant.appId instead
|
|
4858
|
-
*/
|
|
4859
|
-
merchantAppId?: string;
|
|
4860
|
-
|
|
4861
|
-
/**
|
|
4862
|
-
* Any data which will be stored and returned for this checkout session and
|
|
4863
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
4864
|
-
* more info.
|
|
4865
|
-
*/
|
|
4866
|
-
metadata?: Record<string, unknown>;
|
|
4867
|
-
|
|
4868
|
-
offsetProject?: string;
|
|
4869
|
-
|
|
4870
|
-
paymentSchemeSelection?: string;
|
|
4871
|
-
|
|
4872
|
-
/**
|
|
4873
|
-
* The shop-plugin version.
|
|
4874
|
-
*/
|
|
4875
|
-
plugin?: string;
|
|
4876
|
-
|
|
4877
|
-
/**
|
|
4878
|
-
* Prefill known data to skip steps in the checkout.
|
|
4879
|
-
*/
|
|
4880
|
-
prefill?: CheckoutsessionExpireResponse.Prefill;
|
|
4881
|
-
|
|
4882
|
-
/**
|
|
4883
|
-
* Only applicable for express Checkouts. Quote Callback requests will be sent to
|
|
4884
|
-
* this URL.
|
|
4885
|
-
*/
|
|
4886
|
-
quoteCallbackUrl?: string;
|
|
4887
|
-
|
|
4888
|
-
/**
|
|
4889
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
4890
|
-
* input within the Ivy express Checkout.
|
|
4891
|
-
*/
|
|
4892
|
-
required?: CheckoutsessionExpireResponse.Required;
|
|
4893
|
-
|
|
4894
|
-
selectedShippingMethodId?: string;
|
|
4895
|
-
|
|
4896
|
-
shippingAddress?: CheckoutsessionExpireResponse.ShippingAddress;
|
|
4897
|
-
|
|
4898
|
-
shippingMethods?: Array<CheckoutsessionExpireResponse.ShippingMethod>;
|
|
4899
|
-
|
|
4900
|
-
/**
|
|
4901
|
-
* The logo of the shop provided as a URL.
|
|
4902
|
-
*/
|
|
4903
|
-
shopLogo?: string;
|
|
4904
|
-
|
|
4905
|
-
shopName?: string;
|
|
4906
|
-
|
|
4907
|
-
subaccountId?: string;
|
|
4908
|
-
}
|
|
4909
|
-
|
|
4910
|
-
export namespace CheckoutsessionExpireResponse {
|
|
4911
|
-
export interface Merchant {
|
|
4912
|
-
id: string;
|
|
4913
|
-
|
|
4914
|
-
appId: string;
|
|
4915
|
-
|
|
4916
|
-
legalName: string;
|
|
4917
|
-
|
|
4918
|
-
address?: Merchant.Address;
|
|
4919
|
-
}
|
|
4920
|
-
|
|
4921
|
-
export namespace Merchant {
|
|
4922
|
-
export interface Address {
|
|
4923
|
-
city: string;
|
|
4924
|
-
|
|
4925
|
-
/**
|
|
4926
|
-
* The country code in
|
|
4927
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
4928
|
-
*/
|
|
4929
|
-
country:
|
|
4930
|
-
| 'AF'
|
|
4931
|
-
| 'AL'
|
|
4932
|
-
| 'DZ'
|
|
4933
|
-
| 'AS'
|
|
4934
|
-
| 'AD'
|
|
4935
|
-
| 'AO'
|
|
4936
|
-
| 'AI'
|
|
4937
|
-
| 'AQ'
|
|
4938
|
-
| 'AG'
|
|
4939
|
-
| 'AR'
|
|
4940
|
-
| 'AM'
|
|
4941
|
-
| 'AW'
|
|
4942
|
-
| 'AU'
|
|
4943
|
-
| 'AT'
|
|
4944
|
-
| 'AZ'
|
|
4945
|
-
| 'BS'
|
|
4946
|
-
| 'BH'
|
|
4947
|
-
| 'BD'
|
|
4948
|
-
| 'BB'
|
|
4949
|
-
| 'BY'
|
|
4950
|
-
| 'BE'
|
|
4951
|
-
| 'BZ'
|
|
4952
|
-
| 'BJ'
|
|
4953
|
-
| 'BM'
|
|
4954
|
-
| 'BT'
|
|
4955
|
-
| 'BO'
|
|
4956
|
-
| 'BA'
|
|
4957
|
-
| 'BW'
|
|
4958
|
-
| 'BV'
|
|
4959
|
-
| 'BR'
|
|
4960
|
-
| 'IO'
|
|
4961
|
-
| 'BN'
|
|
4962
|
-
| 'BG'
|
|
4963
|
-
| 'BF'
|
|
4964
|
-
| 'BI'
|
|
4965
|
-
| 'KH'
|
|
4966
|
-
| 'CM'
|
|
4967
|
-
| 'CA'
|
|
4968
|
-
| 'CV'
|
|
4969
|
-
| 'KY'
|
|
4970
|
-
| 'CF'
|
|
4971
|
-
| 'TD'
|
|
4972
|
-
| 'CL'
|
|
4973
|
-
| 'CN'
|
|
4974
|
-
| 'CX'
|
|
4975
|
-
| 'CC'
|
|
4976
|
-
| 'CO'
|
|
4977
|
-
| 'KM'
|
|
4978
|
-
| 'CG'
|
|
4979
|
-
| 'CD'
|
|
4980
|
-
| 'CK'
|
|
4981
|
-
| 'CR'
|
|
4982
|
-
| 'CI'
|
|
4983
|
-
| 'HR'
|
|
4984
|
-
| 'CU'
|
|
4985
|
-
| 'CY'
|
|
4986
|
-
| 'CZ'
|
|
4987
|
-
| 'DK'
|
|
4988
|
-
| 'DJ'
|
|
4989
|
-
| 'DM'
|
|
4990
|
-
| 'DO'
|
|
4991
|
-
| 'EC'
|
|
4992
|
-
| 'EG'
|
|
4993
|
-
| 'SV'
|
|
4994
|
-
| 'GQ'
|
|
4995
|
-
| 'ER'
|
|
4996
|
-
| 'EE'
|
|
4997
|
-
| 'ET'
|
|
4998
|
-
| 'FK'
|
|
4999
|
-
| 'FO'
|
|
5000
|
-
| 'FJ'
|
|
5001
|
-
| 'FI'
|
|
5002
|
-
| 'FR'
|
|
5003
|
-
| 'GF'
|
|
5004
|
-
| 'PF'
|
|
5005
|
-
| 'TF'
|
|
5006
|
-
| 'GA'
|
|
5007
|
-
| 'GM'
|
|
5008
|
-
| 'GE'
|
|
5009
|
-
| 'DE'
|
|
5010
|
-
| 'GH'
|
|
5011
|
-
| 'GI'
|
|
5012
|
-
| 'GR'
|
|
5013
|
-
| 'GL'
|
|
5014
|
-
| 'GD'
|
|
5015
|
-
| 'GP'
|
|
5016
|
-
| 'GU'
|
|
5017
|
-
| 'GT'
|
|
5018
|
-
| 'GN'
|
|
5019
|
-
| 'GW'
|
|
5020
|
-
| 'GY'
|
|
5021
|
-
| 'HT'
|
|
5022
|
-
| 'HM'
|
|
5023
|
-
| 'VA'
|
|
5024
|
-
| 'HN'
|
|
5025
|
-
| 'HK'
|
|
5026
|
-
| 'HU'
|
|
5027
|
-
| 'IS'
|
|
5028
|
-
| 'IN'
|
|
5029
|
-
| 'ID'
|
|
5030
|
-
| 'IR'
|
|
5031
|
-
| 'IQ'
|
|
5032
|
-
| 'IE'
|
|
5033
|
-
| 'IL'
|
|
5034
|
-
| 'IT'
|
|
5035
|
-
| 'JM'
|
|
5036
|
-
| 'JP'
|
|
5037
|
-
| 'JO'
|
|
5038
|
-
| 'KZ'
|
|
5039
|
-
| 'KE'
|
|
5040
|
-
| 'KI'
|
|
5041
|
-
| 'KP'
|
|
5042
|
-
| 'KR'
|
|
5043
|
-
| 'KW'
|
|
5044
|
-
| 'KG'
|
|
5045
|
-
| 'LA'
|
|
5046
|
-
| 'LV'
|
|
5047
|
-
| 'LB'
|
|
5048
|
-
| 'LS'
|
|
5049
|
-
| 'LR'
|
|
5050
|
-
| 'LY'
|
|
5051
|
-
| 'LI'
|
|
5052
|
-
| 'LT'
|
|
5053
|
-
| 'LU'
|
|
5054
|
-
| 'MO'
|
|
5055
|
-
| 'MG'
|
|
5056
|
-
| 'MW'
|
|
5057
|
-
| 'MY'
|
|
5058
|
-
| 'MV'
|
|
5059
|
-
| 'ML'
|
|
5060
|
-
| 'MT'
|
|
5061
|
-
| 'MH'
|
|
5062
|
-
| 'MQ'
|
|
5063
|
-
| 'MR'
|
|
5064
|
-
| 'MU'
|
|
5065
|
-
| 'YT'
|
|
5066
|
-
| 'MX'
|
|
5067
|
-
| 'FM'
|
|
5068
|
-
| 'MD'
|
|
5069
|
-
| 'MC'
|
|
5070
|
-
| 'MN'
|
|
5071
|
-
| 'MS'
|
|
5072
|
-
| 'MA'
|
|
5073
|
-
| 'MZ'
|
|
5074
|
-
| 'MM'
|
|
5075
|
-
| 'NA'
|
|
5076
|
-
| 'NR'
|
|
5077
|
-
| 'NP'
|
|
5078
|
-
| 'NL'
|
|
5079
|
-
| 'NC'
|
|
5080
|
-
| 'NZ'
|
|
5081
|
-
| 'NI'
|
|
5082
|
-
| 'NE'
|
|
5083
|
-
| 'NG'
|
|
5084
|
-
| 'NU'
|
|
5085
|
-
| 'NF'
|
|
5086
|
-
| 'MP'
|
|
5087
|
-
| 'MK'
|
|
5088
|
-
| 'NO'
|
|
5089
|
-
| 'OM'
|
|
5090
|
-
| 'PK'
|
|
5091
|
-
| 'PW'
|
|
5092
|
-
| 'PS'
|
|
5093
|
-
| 'PA'
|
|
5094
|
-
| 'PG'
|
|
5095
|
-
| 'PY'
|
|
5096
|
-
| 'PE'
|
|
5097
|
-
| 'PH'
|
|
5098
|
-
| 'PN'
|
|
5099
|
-
| 'PL'
|
|
5100
|
-
| 'PT'
|
|
5101
|
-
| 'PR'
|
|
5102
|
-
| 'QA'
|
|
5103
|
-
| 'RE'
|
|
5104
|
-
| 'RO'
|
|
5105
|
-
| 'RU'
|
|
5106
|
-
| 'RW'
|
|
5107
|
-
| 'SH'
|
|
5108
|
-
| 'KN'
|
|
5109
|
-
| 'LC'
|
|
5110
|
-
| 'PM'
|
|
5111
|
-
| 'VC'
|
|
5112
|
-
| 'WS'
|
|
5113
|
-
| 'SM'
|
|
5114
|
-
| 'ST'
|
|
5115
|
-
| 'SA'
|
|
5116
|
-
| 'SN'
|
|
5117
|
-
| 'SC'
|
|
5118
|
-
| 'SL'
|
|
5119
|
-
| 'SG'
|
|
5120
|
-
| 'SK'
|
|
5121
|
-
| 'SI'
|
|
5122
|
-
| 'SB'
|
|
5123
|
-
| 'SO'
|
|
5124
|
-
| 'ZA'
|
|
5125
|
-
| 'GS'
|
|
5126
|
-
| 'ES'
|
|
5127
|
-
| 'LK'
|
|
5128
|
-
| 'SD'
|
|
5129
|
-
| 'SR'
|
|
5130
|
-
| 'SJ'
|
|
5131
|
-
| 'SZ'
|
|
5132
|
-
| 'SE'
|
|
5133
|
-
| 'CH'
|
|
5134
|
-
| 'SY'
|
|
5135
|
-
| 'TW'
|
|
5136
|
-
| 'TJ'
|
|
5137
|
-
| 'TZ'
|
|
5138
|
-
| 'TH'
|
|
5139
|
-
| 'TL'
|
|
5140
|
-
| 'TG'
|
|
5141
|
-
| 'TK'
|
|
5142
|
-
| 'TO'
|
|
5143
|
-
| 'TT'
|
|
5144
|
-
| 'TN'
|
|
5145
|
-
| 'TR'
|
|
5146
|
-
| 'TM'
|
|
5147
|
-
| 'TC'
|
|
5148
|
-
| 'TV'
|
|
5149
|
-
| 'UG'
|
|
5150
|
-
| 'UA'
|
|
5151
|
-
| 'AE'
|
|
5152
|
-
| 'GB'
|
|
5153
|
-
| 'US'
|
|
5154
|
-
| 'UM'
|
|
5155
|
-
| 'UY'
|
|
5156
|
-
| 'UZ'
|
|
5157
|
-
| 'VU'
|
|
5158
|
-
| 'VE'
|
|
5159
|
-
| 'VN'
|
|
5160
|
-
| 'VG'
|
|
5161
|
-
| 'VI'
|
|
5162
|
-
| 'WF'
|
|
5163
|
-
| 'EH'
|
|
5164
|
-
| 'YE'
|
|
5165
|
-
| 'ZM'
|
|
5166
|
-
| 'ZW'
|
|
5167
|
-
| 'AX'
|
|
5168
|
-
| 'BQ'
|
|
5169
|
-
| 'CW'
|
|
5170
|
-
| 'GG'
|
|
5171
|
-
| 'IM'
|
|
5172
|
-
| 'JE'
|
|
5173
|
-
| 'ME'
|
|
5174
|
-
| 'BL'
|
|
5175
|
-
| 'MF'
|
|
5176
|
-
| 'RS'
|
|
5177
|
-
| 'SX'
|
|
5178
|
-
| 'SS'
|
|
5179
|
-
| 'XK';
|
|
3133
|
+
| 'IO'
|
|
3134
|
+
| 'BN'
|
|
3135
|
+
| 'BG'
|
|
3136
|
+
| 'BF'
|
|
3137
|
+
| 'BI'
|
|
3138
|
+
| 'KH'
|
|
3139
|
+
| 'CM'
|
|
3140
|
+
| 'CA'
|
|
3141
|
+
| 'CV'
|
|
3142
|
+
| 'KY'
|
|
3143
|
+
| 'CF'
|
|
3144
|
+
| 'TD'
|
|
3145
|
+
| 'CL'
|
|
3146
|
+
| 'CN'
|
|
3147
|
+
| 'CX'
|
|
3148
|
+
| 'CC'
|
|
3149
|
+
| 'CO'
|
|
3150
|
+
| 'KM'
|
|
3151
|
+
| 'CG'
|
|
3152
|
+
| 'CD'
|
|
3153
|
+
| 'CK'
|
|
3154
|
+
| 'CR'
|
|
3155
|
+
| 'CI'
|
|
3156
|
+
| 'HR'
|
|
3157
|
+
| 'CU'
|
|
3158
|
+
| 'CY'
|
|
3159
|
+
| 'CZ'
|
|
3160
|
+
| 'DK'
|
|
3161
|
+
| 'DJ'
|
|
3162
|
+
| 'DM'
|
|
3163
|
+
| 'DO'
|
|
3164
|
+
| 'EC'
|
|
3165
|
+
| 'EG'
|
|
3166
|
+
| 'SV'
|
|
3167
|
+
| 'GQ'
|
|
3168
|
+
| 'ER'
|
|
3169
|
+
| 'EE'
|
|
3170
|
+
| 'ET'
|
|
3171
|
+
| 'FK'
|
|
3172
|
+
| 'FO'
|
|
3173
|
+
| 'FJ'
|
|
3174
|
+
| 'FI'
|
|
3175
|
+
| 'FR'
|
|
3176
|
+
| 'GF'
|
|
3177
|
+
| 'PF'
|
|
3178
|
+
| 'TF'
|
|
3179
|
+
| 'GA'
|
|
3180
|
+
| 'GM'
|
|
3181
|
+
| 'GE'
|
|
3182
|
+
| 'DE'
|
|
3183
|
+
| 'GH'
|
|
3184
|
+
| 'GI'
|
|
3185
|
+
| 'GR'
|
|
3186
|
+
| 'GL'
|
|
3187
|
+
| 'GD'
|
|
3188
|
+
| 'GP'
|
|
3189
|
+
| 'GU'
|
|
3190
|
+
| 'GT'
|
|
3191
|
+
| 'GN'
|
|
3192
|
+
| 'GW'
|
|
3193
|
+
| 'GY'
|
|
3194
|
+
| 'HT'
|
|
3195
|
+
| 'HM'
|
|
3196
|
+
| 'VA'
|
|
3197
|
+
| 'HN'
|
|
3198
|
+
| 'HK'
|
|
3199
|
+
| 'HU'
|
|
3200
|
+
| 'IS'
|
|
3201
|
+
| 'IN'
|
|
3202
|
+
| 'ID'
|
|
3203
|
+
| 'IR'
|
|
3204
|
+
| 'IQ'
|
|
3205
|
+
| 'IE'
|
|
3206
|
+
| 'IL'
|
|
3207
|
+
| 'IT'
|
|
3208
|
+
| 'JM'
|
|
3209
|
+
| 'JP'
|
|
3210
|
+
| 'JO'
|
|
3211
|
+
| 'KZ'
|
|
3212
|
+
| 'KE'
|
|
3213
|
+
| 'KI'
|
|
3214
|
+
| 'KP'
|
|
3215
|
+
| 'KR'
|
|
3216
|
+
| 'KW'
|
|
3217
|
+
| 'KG'
|
|
3218
|
+
| 'LA'
|
|
3219
|
+
| 'LV'
|
|
3220
|
+
| 'LB'
|
|
3221
|
+
| 'LS'
|
|
3222
|
+
| 'LR'
|
|
3223
|
+
| 'LY'
|
|
3224
|
+
| 'LI'
|
|
3225
|
+
| 'LT'
|
|
3226
|
+
| 'LU'
|
|
3227
|
+
| 'MO'
|
|
3228
|
+
| 'MG'
|
|
3229
|
+
| 'MW'
|
|
3230
|
+
| 'MY'
|
|
3231
|
+
| 'MV'
|
|
3232
|
+
| 'ML'
|
|
3233
|
+
| 'MT'
|
|
3234
|
+
| 'MH'
|
|
3235
|
+
| 'MQ'
|
|
3236
|
+
| 'MR'
|
|
3237
|
+
| 'MU'
|
|
3238
|
+
| 'YT'
|
|
3239
|
+
| 'MX'
|
|
3240
|
+
| 'FM'
|
|
3241
|
+
| 'MD'
|
|
3242
|
+
| 'MC'
|
|
3243
|
+
| 'MN'
|
|
3244
|
+
| 'MS'
|
|
3245
|
+
| 'MA'
|
|
3246
|
+
| 'MZ'
|
|
3247
|
+
| 'MM'
|
|
3248
|
+
| 'NA'
|
|
3249
|
+
| 'NR'
|
|
3250
|
+
| 'NP'
|
|
3251
|
+
| 'NL'
|
|
3252
|
+
| 'NC'
|
|
3253
|
+
| 'NZ'
|
|
3254
|
+
| 'NI'
|
|
3255
|
+
| 'NE'
|
|
3256
|
+
| 'NG'
|
|
3257
|
+
| 'NU'
|
|
3258
|
+
| 'NF'
|
|
3259
|
+
| 'MP'
|
|
3260
|
+
| 'MK'
|
|
3261
|
+
| 'NO'
|
|
3262
|
+
| 'OM'
|
|
3263
|
+
| 'PK'
|
|
3264
|
+
| 'PW'
|
|
3265
|
+
| 'PS'
|
|
3266
|
+
| 'PA'
|
|
3267
|
+
| 'PG'
|
|
3268
|
+
| 'PY'
|
|
3269
|
+
| 'PE'
|
|
3270
|
+
| 'PH'
|
|
3271
|
+
| 'PN'
|
|
3272
|
+
| 'PL'
|
|
3273
|
+
| 'PT'
|
|
3274
|
+
| 'PR'
|
|
3275
|
+
| 'QA'
|
|
3276
|
+
| 'RE'
|
|
3277
|
+
| 'RO'
|
|
3278
|
+
| 'RU'
|
|
3279
|
+
| 'RW'
|
|
3280
|
+
| 'SH'
|
|
3281
|
+
| 'KN'
|
|
3282
|
+
| 'LC'
|
|
3283
|
+
| 'PM'
|
|
3284
|
+
| 'VC'
|
|
3285
|
+
| 'WS'
|
|
3286
|
+
| 'SM'
|
|
3287
|
+
| 'ST'
|
|
3288
|
+
| 'SA'
|
|
3289
|
+
| 'SN'
|
|
3290
|
+
| 'SC'
|
|
3291
|
+
| 'SL'
|
|
3292
|
+
| 'SG'
|
|
3293
|
+
| 'SK'
|
|
3294
|
+
| 'SI'
|
|
3295
|
+
| 'SB'
|
|
3296
|
+
| 'SO'
|
|
3297
|
+
| 'ZA'
|
|
3298
|
+
| 'GS'
|
|
3299
|
+
| 'ES'
|
|
3300
|
+
| 'LK'
|
|
3301
|
+
| 'SD'
|
|
3302
|
+
| 'SR'
|
|
3303
|
+
| 'SJ'
|
|
3304
|
+
| 'SZ'
|
|
3305
|
+
| 'SE'
|
|
3306
|
+
| 'CH'
|
|
3307
|
+
| 'SY'
|
|
3308
|
+
| 'TW'
|
|
3309
|
+
| 'TJ'
|
|
3310
|
+
| 'TZ'
|
|
3311
|
+
| 'TH'
|
|
3312
|
+
| 'TL'
|
|
3313
|
+
| 'TG'
|
|
3314
|
+
| 'TK'
|
|
3315
|
+
| 'TO'
|
|
3316
|
+
| 'TT'
|
|
3317
|
+
| 'TN'
|
|
3318
|
+
| 'TR'
|
|
3319
|
+
| 'TM'
|
|
3320
|
+
| 'TC'
|
|
3321
|
+
| 'TV'
|
|
3322
|
+
| 'UG'
|
|
3323
|
+
| 'UA'
|
|
3324
|
+
| 'AE'
|
|
3325
|
+
| 'GB'
|
|
3326
|
+
| 'US'
|
|
3327
|
+
| 'UM'
|
|
3328
|
+
| 'UY'
|
|
3329
|
+
| 'UZ'
|
|
3330
|
+
| 'VU'
|
|
3331
|
+
| 'VE'
|
|
3332
|
+
| 'VN'
|
|
3333
|
+
| 'VG'
|
|
3334
|
+
| 'VI'
|
|
3335
|
+
| 'WF'
|
|
3336
|
+
| 'EH'
|
|
3337
|
+
| 'YE'
|
|
3338
|
+
| 'ZM'
|
|
3339
|
+
| 'ZW'
|
|
3340
|
+
| 'AX'
|
|
3341
|
+
| 'BQ'
|
|
3342
|
+
| 'CW'
|
|
3343
|
+
| 'GG'
|
|
3344
|
+
| 'IM'
|
|
3345
|
+
| 'JE'
|
|
3346
|
+
| 'ME'
|
|
3347
|
+
| 'BL'
|
|
3348
|
+
| 'MF'
|
|
3349
|
+
| 'RS'
|
|
3350
|
+
| 'SX'
|
|
3351
|
+
| 'SS'
|
|
3352
|
+
| 'XK'
|
|
3353
|
+
>;
|
|
5180
3354
|
|
|
5181
|
-
|
|
3355
|
+
billingAddress?: CheckoutsessionExpireResponse.BillingAddress;
|
|
5182
3356
|
|
|
5183
|
-
|
|
3357
|
+
category?: string;
|
|
5184
3358
|
|
|
5185
|
-
|
|
3359
|
+
completeCallbackUrl?: string;
|
|
5186
3360
|
|
|
5187
|
-
|
|
3361
|
+
createdAt?: unknown;
|
|
5188
3362
|
|
|
5189
|
-
|
|
3363
|
+
customer?: CheckoutsessionExpireResponse.Customer;
|
|
5190
3364
|
|
|
5191
|
-
|
|
5192
|
-
|
|
5193
|
-
|
|
3365
|
+
disableBankSelection?: boolean;
|
|
3366
|
+
|
|
3367
|
+
express?: boolean;
|
|
3368
|
+
|
|
3369
|
+
guest?: boolean;
|
|
3370
|
+
|
|
3371
|
+
handshake?: boolean;
|
|
3372
|
+
|
|
3373
|
+
impactOffsetProjects?: Array<string>;
|
|
3374
|
+
|
|
3375
|
+
incentiveMode?: string;
|
|
3376
|
+
|
|
3377
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
3378
|
+
|
|
3379
|
+
mandate?: CheckoutsessionExpireResponse.Mandate;
|
|
3380
|
+
|
|
3381
|
+
market?:
|
|
3382
|
+
| 'AF'
|
|
3383
|
+
| 'AL'
|
|
3384
|
+
| 'DZ'
|
|
3385
|
+
| 'AS'
|
|
3386
|
+
| 'AD'
|
|
3387
|
+
| 'AO'
|
|
3388
|
+
| 'AI'
|
|
3389
|
+
| 'AQ'
|
|
3390
|
+
| 'AG'
|
|
3391
|
+
| 'AR'
|
|
3392
|
+
| 'AM'
|
|
3393
|
+
| 'AW'
|
|
3394
|
+
| 'AU'
|
|
3395
|
+
| 'AT'
|
|
3396
|
+
| 'AZ'
|
|
3397
|
+
| 'BS'
|
|
3398
|
+
| 'BH'
|
|
3399
|
+
| 'BD'
|
|
3400
|
+
| 'BB'
|
|
3401
|
+
| 'BY'
|
|
3402
|
+
| 'BE'
|
|
3403
|
+
| 'BZ'
|
|
3404
|
+
| 'BJ'
|
|
3405
|
+
| 'BM'
|
|
3406
|
+
| 'BT'
|
|
3407
|
+
| 'BO'
|
|
3408
|
+
| 'BA'
|
|
3409
|
+
| 'BW'
|
|
3410
|
+
| 'BV'
|
|
3411
|
+
| 'BR'
|
|
3412
|
+
| 'IO'
|
|
3413
|
+
| 'BN'
|
|
3414
|
+
| 'BG'
|
|
3415
|
+
| 'BF'
|
|
3416
|
+
| 'BI'
|
|
3417
|
+
| 'KH'
|
|
3418
|
+
| 'CM'
|
|
3419
|
+
| 'CA'
|
|
3420
|
+
| 'CV'
|
|
3421
|
+
| 'KY'
|
|
3422
|
+
| 'CF'
|
|
3423
|
+
| 'TD'
|
|
3424
|
+
| 'CL'
|
|
3425
|
+
| 'CN'
|
|
3426
|
+
| 'CX'
|
|
3427
|
+
| 'CC'
|
|
3428
|
+
| 'CO'
|
|
3429
|
+
| 'KM'
|
|
3430
|
+
| 'CG'
|
|
3431
|
+
| 'CD'
|
|
3432
|
+
| 'CK'
|
|
3433
|
+
| 'CR'
|
|
3434
|
+
| 'CI'
|
|
3435
|
+
| 'HR'
|
|
3436
|
+
| 'CU'
|
|
3437
|
+
| 'CY'
|
|
3438
|
+
| 'CZ'
|
|
3439
|
+
| 'DK'
|
|
3440
|
+
| 'DJ'
|
|
3441
|
+
| 'DM'
|
|
3442
|
+
| 'DO'
|
|
3443
|
+
| 'EC'
|
|
3444
|
+
| 'EG'
|
|
3445
|
+
| 'SV'
|
|
3446
|
+
| 'GQ'
|
|
3447
|
+
| 'ER'
|
|
3448
|
+
| 'EE'
|
|
3449
|
+
| 'ET'
|
|
3450
|
+
| 'FK'
|
|
3451
|
+
| 'FO'
|
|
3452
|
+
| 'FJ'
|
|
3453
|
+
| 'FI'
|
|
3454
|
+
| 'FR'
|
|
3455
|
+
| 'GF'
|
|
3456
|
+
| 'PF'
|
|
3457
|
+
| 'TF'
|
|
3458
|
+
| 'GA'
|
|
3459
|
+
| 'GM'
|
|
3460
|
+
| 'GE'
|
|
3461
|
+
| 'DE'
|
|
3462
|
+
| 'GH'
|
|
3463
|
+
| 'GI'
|
|
3464
|
+
| 'GR'
|
|
3465
|
+
| 'GL'
|
|
3466
|
+
| 'GD'
|
|
3467
|
+
| 'GP'
|
|
3468
|
+
| 'GU'
|
|
3469
|
+
| 'GT'
|
|
3470
|
+
| 'GN'
|
|
3471
|
+
| 'GW'
|
|
3472
|
+
| 'GY'
|
|
3473
|
+
| 'HT'
|
|
3474
|
+
| 'HM'
|
|
3475
|
+
| 'VA'
|
|
3476
|
+
| 'HN'
|
|
3477
|
+
| 'HK'
|
|
3478
|
+
| 'HU'
|
|
3479
|
+
| 'IS'
|
|
3480
|
+
| 'IN'
|
|
3481
|
+
| 'ID'
|
|
3482
|
+
| 'IR'
|
|
3483
|
+
| 'IQ'
|
|
3484
|
+
| 'IE'
|
|
3485
|
+
| 'IL'
|
|
3486
|
+
| 'IT'
|
|
3487
|
+
| 'JM'
|
|
3488
|
+
| 'JP'
|
|
3489
|
+
| 'JO'
|
|
3490
|
+
| 'KZ'
|
|
3491
|
+
| 'KE'
|
|
3492
|
+
| 'KI'
|
|
3493
|
+
| 'KP'
|
|
3494
|
+
| 'KR'
|
|
3495
|
+
| 'KW'
|
|
3496
|
+
| 'KG'
|
|
3497
|
+
| 'LA'
|
|
3498
|
+
| 'LV'
|
|
3499
|
+
| 'LB'
|
|
3500
|
+
| 'LS'
|
|
3501
|
+
| 'LR'
|
|
3502
|
+
| 'LY'
|
|
3503
|
+
| 'LI'
|
|
3504
|
+
| 'LT'
|
|
3505
|
+
| 'LU'
|
|
3506
|
+
| 'MO'
|
|
3507
|
+
| 'MG'
|
|
3508
|
+
| 'MW'
|
|
3509
|
+
| 'MY'
|
|
3510
|
+
| 'MV'
|
|
3511
|
+
| 'ML'
|
|
3512
|
+
| 'MT'
|
|
3513
|
+
| 'MH'
|
|
3514
|
+
| 'MQ'
|
|
3515
|
+
| 'MR'
|
|
3516
|
+
| 'MU'
|
|
3517
|
+
| 'YT'
|
|
3518
|
+
| 'MX'
|
|
3519
|
+
| 'FM'
|
|
3520
|
+
| 'MD'
|
|
3521
|
+
| 'MC'
|
|
3522
|
+
| 'MN'
|
|
3523
|
+
| 'MS'
|
|
3524
|
+
| 'MA'
|
|
3525
|
+
| 'MZ'
|
|
3526
|
+
| 'MM'
|
|
3527
|
+
| 'NA'
|
|
3528
|
+
| 'NR'
|
|
3529
|
+
| 'NP'
|
|
3530
|
+
| 'NL'
|
|
3531
|
+
| 'NC'
|
|
3532
|
+
| 'NZ'
|
|
3533
|
+
| 'NI'
|
|
3534
|
+
| 'NE'
|
|
3535
|
+
| 'NG'
|
|
3536
|
+
| 'NU'
|
|
3537
|
+
| 'NF'
|
|
3538
|
+
| 'MP'
|
|
3539
|
+
| 'MK'
|
|
3540
|
+
| 'NO'
|
|
3541
|
+
| 'OM'
|
|
3542
|
+
| 'PK'
|
|
3543
|
+
| 'PW'
|
|
3544
|
+
| 'PS'
|
|
3545
|
+
| 'PA'
|
|
3546
|
+
| 'PG'
|
|
3547
|
+
| 'PY'
|
|
3548
|
+
| 'PE'
|
|
3549
|
+
| 'PH'
|
|
3550
|
+
| 'PN'
|
|
3551
|
+
| 'PL'
|
|
3552
|
+
| 'PT'
|
|
3553
|
+
| 'PR'
|
|
3554
|
+
| 'QA'
|
|
3555
|
+
| 'RE'
|
|
3556
|
+
| 'RO'
|
|
3557
|
+
| 'RU'
|
|
3558
|
+
| 'RW'
|
|
3559
|
+
| 'SH'
|
|
3560
|
+
| 'KN'
|
|
3561
|
+
| 'LC'
|
|
3562
|
+
| 'PM'
|
|
3563
|
+
| 'VC'
|
|
3564
|
+
| 'WS'
|
|
3565
|
+
| 'SM'
|
|
3566
|
+
| 'ST'
|
|
3567
|
+
| 'SA'
|
|
3568
|
+
| 'SN'
|
|
3569
|
+
| 'SC'
|
|
3570
|
+
| 'SL'
|
|
3571
|
+
| 'SG'
|
|
3572
|
+
| 'SK'
|
|
3573
|
+
| 'SI'
|
|
3574
|
+
| 'SB'
|
|
3575
|
+
| 'SO'
|
|
3576
|
+
| 'ZA'
|
|
3577
|
+
| 'GS'
|
|
3578
|
+
| 'ES'
|
|
3579
|
+
| 'LK'
|
|
3580
|
+
| 'SD'
|
|
3581
|
+
| 'SR'
|
|
3582
|
+
| 'SJ'
|
|
3583
|
+
| 'SZ'
|
|
3584
|
+
| 'SE'
|
|
3585
|
+
| 'CH'
|
|
3586
|
+
| 'SY'
|
|
3587
|
+
| 'TW'
|
|
3588
|
+
| 'TJ'
|
|
3589
|
+
| 'TZ'
|
|
3590
|
+
| 'TH'
|
|
3591
|
+
| 'TL'
|
|
3592
|
+
| 'TG'
|
|
3593
|
+
| 'TK'
|
|
3594
|
+
| 'TO'
|
|
3595
|
+
| 'TT'
|
|
3596
|
+
| 'TN'
|
|
3597
|
+
| 'TR'
|
|
3598
|
+
| 'TM'
|
|
3599
|
+
| 'TC'
|
|
3600
|
+
| 'TV'
|
|
3601
|
+
| 'UG'
|
|
3602
|
+
| 'UA'
|
|
3603
|
+
| 'AE'
|
|
3604
|
+
| 'GB'
|
|
3605
|
+
| 'US'
|
|
3606
|
+
| 'UM'
|
|
3607
|
+
| 'UY'
|
|
3608
|
+
| 'UZ'
|
|
3609
|
+
| 'VU'
|
|
3610
|
+
| 'VE'
|
|
3611
|
+
| 'VN'
|
|
3612
|
+
| 'VG'
|
|
3613
|
+
| 'VI'
|
|
3614
|
+
| 'WF'
|
|
3615
|
+
| 'EH'
|
|
3616
|
+
| 'YE'
|
|
3617
|
+
| 'ZM'
|
|
3618
|
+
| 'ZW'
|
|
3619
|
+
| 'AX'
|
|
3620
|
+
| 'BQ'
|
|
3621
|
+
| 'CW'
|
|
3622
|
+
| 'GG'
|
|
3623
|
+
| 'IM'
|
|
3624
|
+
| 'JE'
|
|
3625
|
+
| 'ME'
|
|
3626
|
+
| 'BL'
|
|
3627
|
+
| 'MF'
|
|
3628
|
+
| 'RS'
|
|
3629
|
+
| 'SX'
|
|
3630
|
+
| 'SS'
|
|
3631
|
+
| 'XK';
|
|
5194
3632
|
|
|
5195
|
-
|
|
5196
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
5197
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
5198
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
5199
|
-
* as this is the format accepted by most banks.
|
|
5200
|
-
*/
|
|
5201
|
-
export interface Price {
|
|
5202
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
3633
|
+
metadata?: { [key: string]: unknown };
|
|
5203
3634
|
|
|
5204
|
-
|
|
5205
|
-
* The total amount to be paid.
|
|
5206
|
-
*/
|
|
5207
|
-
total: number;
|
|
3635
|
+
offsetProject?: string;
|
|
5208
3636
|
|
|
5209
|
-
|
|
3637
|
+
paymentMode?: 'direct' | 'settlement';
|
|
5210
3638
|
|
|
5211
|
-
|
|
3639
|
+
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
5212
3640
|
|
|
5213
|
-
|
|
3641
|
+
plugin?: string;
|
|
5214
3642
|
|
|
5215
|
-
|
|
5216
|
-
}
|
|
3643
|
+
prefill?: unknown;
|
|
5217
3644
|
|
|
5218
|
-
|
|
5219
|
-
* The billing address of the customer. Required when handshake=true.
|
|
5220
|
-
*/
|
|
5221
|
-
export interface BillingAddress {
|
|
5222
|
-
city: string;
|
|
3645
|
+
quoteCallbackUrl?: string;
|
|
5223
3646
|
|
|
5224
|
-
|
|
5225
|
-
* The country code in
|
|
5226
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
5227
|
-
*/
|
|
5228
|
-
country:
|
|
5229
|
-
| 'AF'
|
|
5230
|
-
| 'AL'
|
|
5231
|
-
| 'DZ'
|
|
5232
|
-
| 'AS'
|
|
5233
|
-
| 'AD'
|
|
5234
|
-
| 'AO'
|
|
5235
|
-
| 'AI'
|
|
5236
|
-
| 'AQ'
|
|
5237
|
-
| 'AG'
|
|
5238
|
-
| 'AR'
|
|
5239
|
-
| 'AM'
|
|
5240
|
-
| 'AW'
|
|
5241
|
-
| 'AU'
|
|
5242
|
-
| 'AT'
|
|
5243
|
-
| 'AZ'
|
|
5244
|
-
| 'BS'
|
|
5245
|
-
| 'BH'
|
|
5246
|
-
| 'BD'
|
|
5247
|
-
| 'BB'
|
|
5248
|
-
| 'BY'
|
|
5249
|
-
| 'BE'
|
|
5250
|
-
| 'BZ'
|
|
5251
|
-
| 'BJ'
|
|
5252
|
-
| 'BM'
|
|
5253
|
-
| 'BT'
|
|
5254
|
-
| 'BO'
|
|
5255
|
-
| 'BA'
|
|
5256
|
-
| 'BW'
|
|
5257
|
-
| 'BV'
|
|
5258
|
-
| 'BR'
|
|
5259
|
-
| 'IO'
|
|
5260
|
-
| 'BN'
|
|
5261
|
-
| 'BG'
|
|
5262
|
-
| 'BF'
|
|
5263
|
-
| 'BI'
|
|
5264
|
-
| 'KH'
|
|
5265
|
-
| 'CM'
|
|
5266
|
-
| 'CA'
|
|
5267
|
-
| 'CV'
|
|
5268
|
-
| 'KY'
|
|
5269
|
-
| 'CF'
|
|
5270
|
-
| 'TD'
|
|
5271
|
-
| 'CL'
|
|
5272
|
-
| 'CN'
|
|
5273
|
-
| 'CX'
|
|
5274
|
-
| 'CC'
|
|
5275
|
-
| 'CO'
|
|
5276
|
-
| 'KM'
|
|
5277
|
-
| 'CG'
|
|
5278
|
-
| 'CD'
|
|
5279
|
-
| 'CK'
|
|
5280
|
-
| 'CR'
|
|
5281
|
-
| 'CI'
|
|
5282
|
-
| 'HR'
|
|
5283
|
-
| 'CU'
|
|
5284
|
-
| 'CY'
|
|
5285
|
-
| 'CZ'
|
|
5286
|
-
| 'DK'
|
|
5287
|
-
| 'DJ'
|
|
5288
|
-
| 'DM'
|
|
5289
|
-
| 'DO'
|
|
5290
|
-
| 'EC'
|
|
5291
|
-
| 'EG'
|
|
5292
|
-
| 'SV'
|
|
5293
|
-
| 'GQ'
|
|
5294
|
-
| 'ER'
|
|
5295
|
-
| 'EE'
|
|
5296
|
-
| 'ET'
|
|
5297
|
-
| 'FK'
|
|
5298
|
-
| 'FO'
|
|
5299
|
-
| 'FJ'
|
|
5300
|
-
| 'FI'
|
|
5301
|
-
| 'FR'
|
|
5302
|
-
| 'GF'
|
|
5303
|
-
| 'PF'
|
|
5304
|
-
| 'TF'
|
|
5305
|
-
| 'GA'
|
|
5306
|
-
| 'GM'
|
|
5307
|
-
| 'GE'
|
|
5308
|
-
| 'DE'
|
|
5309
|
-
| 'GH'
|
|
5310
|
-
| 'GI'
|
|
5311
|
-
| 'GR'
|
|
5312
|
-
| 'GL'
|
|
5313
|
-
| 'GD'
|
|
5314
|
-
| 'GP'
|
|
5315
|
-
| 'GU'
|
|
5316
|
-
| 'GT'
|
|
5317
|
-
| 'GN'
|
|
5318
|
-
| 'GW'
|
|
5319
|
-
| 'GY'
|
|
5320
|
-
| 'HT'
|
|
5321
|
-
| 'HM'
|
|
5322
|
-
| 'VA'
|
|
5323
|
-
| 'HN'
|
|
5324
|
-
| 'HK'
|
|
5325
|
-
| 'HU'
|
|
5326
|
-
| 'IS'
|
|
5327
|
-
| 'IN'
|
|
5328
|
-
| 'ID'
|
|
5329
|
-
| 'IR'
|
|
5330
|
-
| 'IQ'
|
|
5331
|
-
| 'IE'
|
|
5332
|
-
| 'IL'
|
|
5333
|
-
| 'IT'
|
|
5334
|
-
| 'JM'
|
|
5335
|
-
| 'JP'
|
|
5336
|
-
| 'JO'
|
|
5337
|
-
| 'KZ'
|
|
5338
|
-
| 'KE'
|
|
5339
|
-
| 'KI'
|
|
5340
|
-
| 'KP'
|
|
5341
|
-
| 'KR'
|
|
5342
|
-
| 'KW'
|
|
5343
|
-
| 'KG'
|
|
5344
|
-
| 'LA'
|
|
5345
|
-
| 'LV'
|
|
5346
|
-
| 'LB'
|
|
5347
|
-
| 'LS'
|
|
5348
|
-
| 'LR'
|
|
5349
|
-
| 'LY'
|
|
5350
|
-
| 'LI'
|
|
5351
|
-
| 'LT'
|
|
5352
|
-
| 'LU'
|
|
5353
|
-
| 'MO'
|
|
5354
|
-
| 'MG'
|
|
5355
|
-
| 'MW'
|
|
5356
|
-
| 'MY'
|
|
5357
|
-
| 'MV'
|
|
5358
|
-
| 'ML'
|
|
5359
|
-
| 'MT'
|
|
5360
|
-
| 'MH'
|
|
5361
|
-
| 'MQ'
|
|
5362
|
-
| 'MR'
|
|
5363
|
-
| 'MU'
|
|
5364
|
-
| 'YT'
|
|
5365
|
-
| 'MX'
|
|
5366
|
-
| 'FM'
|
|
5367
|
-
| 'MD'
|
|
5368
|
-
| 'MC'
|
|
5369
|
-
| 'MN'
|
|
5370
|
-
| 'MS'
|
|
5371
|
-
| 'MA'
|
|
5372
|
-
| 'MZ'
|
|
5373
|
-
| 'MM'
|
|
5374
|
-
| 'NA'
|
|
5375
|
-
| 'NR'
|
|
5376
|
-
| 'NP'
|
|
5377
|
-
| 'NL'
|
|
5378
|
-
| 'NC'
|
|
5379
|
-
| 'NZ'
|
|
5380
|
-
| 'NI'
|
|
5381
|
-
| 'NE'
|
|
5382
|
-
| 'NG'
|
|
5383
|
-
| 'NU'
|
|
5384
|
-
| 'NF'
|
|
5385
|
-
| 'MP'
|
|
5386
|
-
| 'MK'
|
|
5387
|
-
| 'NO'
|
|
5388
|
-
| 'OM'
|
|
5389
|
-
| 'PK'
|
|
5390
|
-
| 'PW'
|
|
5391
|
-
| 'PS'
|
|
5392
|
-
| 'PA'
|
|
5393
|
-
| 'PG'
|
|
5394
|
-
| 'PY'
|
|
5395
|
-
| 'PE'
|
|
5396
|
-
| 'PH'
|
|
5397
|
-
| 'PN'
|
|
5398
|
-
| 'PL'
|
|
5399
|
-
| 'PT'
|
|
5400
|
-
| 'PR'
|
|
5401
|
-
| 'QA'
|
|
5402
|
-
| 'RE'
|
|
5403
|
-
| 'RO'
|
|
5404
|
-
| 'RU'
|
|
5405
|
-
| 'RW'
|
|
5406
|
-
| 'SH'
|
|
5407
|
-
| 'KN'
|
|
5408
|
-
| 'LC'
|
|
5409
|
-
| 'PM'
|
|
5410
|
-
| 'VC'
|
|
5411
|
-
| 'WS'
|
|
5412
|
-
| 'SM'
|
|
5413
|
-
| 'ST'
|
|
5414
|
-
| 'SA'
|
|
5415
|
-
| 'SN'
|
|
5416
|
-
| 'SC'
|
|
5417
|
-
| 'SL'
|
|
5418
|
-
| 'SG'
|
|
5419
|
-
| 'SK'
|
|
5420
|
-
| 'SI'
|
|
5421
|
-
| 'SB'
|
|
5422
|
-
| 'SO'
|
|
5423
|
-
| 'ZA'
|
|
5424
|
-
| 'GS'
|
|
5425
|
-
| 'ES'
|
|
5426
|
-
| 'LK'
|
|
5427
|
-
| 'SD'
|
|
5428
|
-
| 'SR'
|
|
5429
|
-
| 'SJ'
|
|
5430
|
-
| 'SZ'
|
|
5431
|
-
| 'SE'
|
|
5432
|
-
| 'CH'
|
|
5433
|
-
| 'SY'
|
|
5434
|
-
| 'TW'
|
|
5435
|
-
| 'TJ'
|
|
5436
|
-
| 'TZ'
|
|
5437
|
-
| 'TH'
|
|
5438
|
-
| 'TL'
|
|
5439
|
-
| 'TG'
|
|
5440
|
-
| 'TK'
|
|
5441
|
-
| 'TO'
|
|
5442
|
-
| 'TT'
|
|
5443
|
-
| 'TN'
|
|
5444
|
-
| 'TR'
|
|
5445
|
-
| 'TM'
|
|
5446
|
-
| 'TC'
|
|
5447
|
-
| 'TV'
|
|
5448
|
-
| 'UG'
|
|
5449
|
-
| 'UA'
|
|
5450
|
-
| 'AE'
|
|
5451
|
-
| 'GB'
|
|
5452
|
-
| 'US'
|
|
5453
|
-
| 'UM'
|
|
5454
|
-
| 'UY'
|
|
5455
|
-
| 'UZ'
|
|
5456
|
-
| 'VU'
|
|
5457
|
-
| 'VE'
|
|
5458
|
-
| 'VN'
|
|
5459
|
-
| 'VG'
|
|
5460
|
-
| 'VI'
|
|
5461
|
-
| 'WF'
|
|
5462
|
-
| 'EH'
|
|
5463
|
-
| 'YE'
|
|
5464
|
-
| 'ZM'
|
|
5465
|
-
| 'ZW'
|
|
5466
|
-
| 'AX'
|
|
5467
|
-
| 'BQ'
|
|
5468
|
-
| 'CW'
|
|
5469
|
-
| 'GG'
|
|
5470
|
-
| 'IM'
|
|
5471
|
-
| 'JE'
|
|
5472
|
-
| 'ME'
|
|
5473
|
-
| 'BL'
|
|
5474
|
-
| 'MF'
|
|
5475
|
-
| 'RS'
|
|
5476
|
-
| 'SX'
|
|
5477
|
-
| 'SS'
|
|
5478
|
-
| 'XK';
|
|
3647
|
+
required?: CheckoutsessionExpireResponse.Required;
|
|
5479
3648
|
|
|
5480
|
-
|
|
3649
|
+
selectedShippingMethodId?: string;
|
|
5481
3650
|
|
|
5482
|
-
|
|
3651
|
+
shippingAddress?: CheckoutsessionExpireResponse.ShippingAddress;
|
|
5483
3652
|
|
|
5484
|
-
|
|
3653
|
+
shippingMethods?: Array<unknown>;
|
|
5485
3654
|
|
|
5486
|
-
|
|
3655
|
+
shopLogo?: string;
|
|
5487
3656
|
|
|
5488
|
-
|
|
3657
|
+
shopName?: string;
|
|
5489
3658
|
|
|
5490
|
-
|
|
5491
|
-
}
|
|
3659
|
+
subaccountId?: string;
|
|
5492
3660
|
|
|
5493
|
-
|
|
5494
|
-
|
|
5495
|
-
}
|
|
3661
|
+
updatedAt?: unknown;
|
|
3662
|
+
}
|
|
5496
3663
|
|
|
5497
|
-
|
|
5498
|
-
* The line items of the Checkout.
|
|
5499
|
-
*/
|
|
3664
|
+
export namespace CheckoutsessionExpireResponse {
|
|
5500
3665
|
export interface LineItem {
|
|
5501
3666
|
/**
|
|
5502
|
-
*
|
|
5503
|
-
*
|
|
3667
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
3668
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
5504
3669
|
*/
|
|
5505
3670
|
amount: number;
|
|
5506
3671
|
|
|
5507
3672
|
/**
|
|
5508
|
-
*
|
|
3673
|
+
* Customer-facing name of the line item.
|
|
5509
3674
|
*/
|
|
5510
3675
|
name: string;
|
|
5511
3676
|
|
|
5512
|
-
/**
|
|
5513
|
-
* The quantity of the line item.
|
|
5514
|
-
*/
|
|
5515
|
-
quantity: number;
|
|
5516
|
-
|
|
5517
|
-
/**
|
|
5518
|
-
* The net amount of a single item.
|
|
5519
|
-
*/
|
|
5520
3677
|
singleNet: number;
|
|
5521
3678
|
|
|
5522
|
-
/**
|
|
5523
|
-
* The VAT amount of a single item.
|
|
5524
|
-
*/
|
|
5525
3679
|
singleVat: number;
|
|
5526
3680
|
|
|
5527
|
-
|
|
5528
|
-
|
|
5529
|
-
|
|
5530
|
-
|
|
5531
|
-
|
|
3681
|
+
category?:
|
|
3682
|
+
| '5045'
|
|
3683
|
+
| '5065'
|
|
3684
|
+
| '5094'
|
|
3685
|
+
| '5192'
|
|
3686
|
+
| '5193'
|
|
3687
|
+
| '5499'
|
|
3688
|
+
| '5655'
|
|
3689
|
+
| '5691'
|
|
3690
|
+
| '5712'
|
|
3691
|
+
| '5722'
|
|
3692
|
+
| '5812'
|
|
3693
|
+
| '5814'
|
|
3694
|
+
| '5912'
|
|
3695
|
+
| '5977'
|
|
3696
|
+
| '5999'
|
|
3697
|
+
| '7629';
|
|
3698
|
+
|
|
3699
|
+
co2Grams?: number;
|
|
5532
3700
|
|
|
5533
|
-
/**
|
|
5534
|
-
* The
|
|
5535
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
5536
|
-
* of the line item.
|
|
5537
|
-
*/
|
|
5538
3701
|
EAN?: string;
|
|
5539
3702
|
|
|
5540
3703
|
/**
|
|
5541
|
-
*
|
|
3704
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
5542
3705
|
*/
|
|
5543
3706
|
image?: string;
|
|
5544
3707
|
|
|
5545
3708
|
/**
|
|
5546
|
-
*
|
|
3709
|
+
* Quantity of this lineItem.
|
|
3710
|
+
*/
|
|
3711
|
+
quantity?: number;
|
|
3712
|
+
|
|
3713
|
+
/**
|
|
3714
|
+
* An internal unique id stored to this line item.
|
|
5547
3715
|
*/
|
|
5548
3716
|
referenceId?: string;
|
|
5549
3717
|
}
|
|
5550
3718
|
|
|
5551
|
-
export interface
|
|
5552
|
-
|
|
3719
|
+
export interface Merchant {
|
|
3720
|
+
id: string;
|
|
3721
|
+
|
|
3722
|
+
appId: string;
|
|
3723
|
+
|
|
3724
|
+
legalName: string;
|
|
3725
|
+
|
|
3726
|
+
address?: Merchant.Address;
|
|
3727
|
+
}
|
|
3728
|
+
|
|
3729
|
+
export namespace Merchant {
|
|
3730
|
+
export interface Address {
|
|
3731
|
+
city: string;
|
|
3732
|
+
|
|
3733
|
+
country:
|
|
3734
|
+
| 'AF'
|
|
3735
|
+
| 'AL'
|
|
3736
|
+
| 'DZ'
|
|
3737
|
+
| 'AS'
|
|
3738
|
+
| 'AD'
|
|
3739
|
+
| 'AO'
|
|
3740
|
+
| 'AI'
|
|
3741
|
+
| 'AQ'
|
|
3742
|
+
| 'AG'
|
|
3743
|
+
| 'AR'
|
|
3744
|
+
| 'AM'
|
|
3745
|
+
| 'AW'
|
|
3746
|
+
| 'AU'
|
|
3747
|
+
| 'AT'
|
|
3748
|
+
| 'AZ'
|
|
3749
|
+
| 'BS'
|
|
3750
|
+
| 'BH'
|
|
3751
|
+
| 'BD'
|
|
3752
|
+
| 'BB'
|
|
3753
|
+
| 'BY'
|
|
3754
|
+
| 'BE'
|
|
3755
|
+
| 'BZ'
|
|
3756
|
+
| 'BJ'
|
|
3757
|
+
| 'BM'
|
|
3758
|
+
| 'BT'
|
|
3759
|
+
| 'BO'
|
|
3760
|
+
| 'BA'
|
|
3761
|
+
| 'BW'
|
|
3762
|
+
| 'BV'
|
|
3763
|
+
| 'BR'
|
|
3764
|
+
| 'IO'
|
|
3765
|
+
| 'BN'
|
|
3766
|
+
| 'BG'
|
|
3767
|
+
| 'BF'
|
|
3768
|
+
| 'BI'
|
|
3769
|
+
| 'KH'
|
|
3770
|
+
| 'CM'
|
|
3771
|
+
| 'CA'
|
|
3772
|
+
| 'CV'
|
|
3773
|
+
| 'KY'
|
|
3774
|
+
| 'CF'
|
|
3775
|
+
| 'TD'
|
|
3776
|
+
| 'CL'
|
|
3777
|
+
| 'CN'
|
|
3778
|
+
| 'CX'
|
|
3779
|
+
| 'CC'
|
|
3780
|
+
| 'CO'
|
|
3781
|
+
| 'KM'
|
|
3782
|
+
| 'CG'
|
|
3783
|
+
| 'CD'
|
|
3784
|
+
| 'CK'
|
|
3785
|
+
| 'CR'
|
|
3786
|
+
| 'CI'
|
|
3787
|
+
| 'HR'
|
|
3788
|
+
| 'CU'
|
|
3789
|
+
| 'CY'
|
|
3790
|
+
| 'CZ'
|
|
3791
|
+
| 'DK'
|
|
3792
|
+
| 'DJ'
|
|
3793
|
+
| 'DM'
|
|
3794
|
+
| 'DO'
|
|
3795
|
+
| 'EC'
|
|
3796
|
+
| 'EG'
|
|
3797
|
+
| 'SV'
|
|
3798
|
+
| 'GQ'
|
|
3799
|
+
| 'ER'
|
|
3800
|
+
| 'EE'
|
|
3801
|
+
| 'ET'
|
|
3802
|
+
| 'FK'
|
|
3803
|
+
| 'FO'
|
|
3804
|
+
| 'FJ'
|
|
3805
|
+
| 'FI'
|
|
3806
|
+
| 'FR'
|
|
3807
|
+
| 'GF'
|
|
3808
|
+
| 'PF'
|
|
3809
|
+
| 'TF'
|
|
3810
|
+
| 'GA'
|
|
3811
|
+
| 'GM'
|
|
3812
|
+
| 'GE'
|
|
3813
|
+
| 'DE'
|
|
3814
|
+
| 'GH'
|
|
3815
|
+
| 'GI'
|
|
3816
|
+
| 'GR'
|
|
3817
|
+
| 'GL'
|
|
3818
|
+
| 'GD'
|
|
3819
|
+
| 'GP'
|
|
3820
|
+
| 'GU'
|
|
3821
|
+
| 'GT'
|
|
3822
|
+
| 'GN'
|
|
3823
|
+
| 'GW'
|
|
3824
|
+
| 'GY'
|
|
3825
|
+
| 'HT'
|
|
3826
|
+
| 'HM'
|
|
3827
|
+
| 'VA'
|
|
3828
|
+
| 'HN'
|
|
3829
|
+
| 'HK'
|
|
3830
|
+
| 'HU'
|
|
3831
|
+
| 'IS'
|
|
3832
|
+
| 'IN'
|
|
3833
|
+
| 'ID'
|
|
3834
|
+
| 'IR'
|
|
3835
|
+
| 'IQ'
|
|
3836
|
+
| 'IE'
|
|
3837
|
+
| 'IL'
|
|
3838
|
+
| 'IT'
|
|
3839
|
+
| 'JM'
|
|
3840
|
+
| 'JP'
|
|
3841
|
+
| 'JO'
|
|
3842
|
+
| 'KZ'
|
|
3843
|
+
| 'KE'
|
|
3844
|
+
| 'KI'
|
|
3845
|
+
| 'KP'
|
|
3846
|
+
| 'KR'
|
|
3847
|
+
| 'KW'
|
|
3848
|
+
| 'KG'
|
|
3849
|
+
| 'LA'
|
|
3850
|
+
| 'LV'
|
|
3851
|
+
| 'LB'
|
|
3852
|
+
| 'LS'
|
|
3853
|
+
| 'LR'
|
|
3854
|
+
| 'LY'
|
|
3855
|
+
| 'LI'
|
|
3856
|
+
| 'LT'
|
|
3857
|
+
| 'LU'
|
|
3858
|
+
| 'MO'
|
|
3859
|
+
| 'MG'
|
|
3860
|
+
| 'MW'
|
|
3861
|
+
| 'MY'
|
|
3862
|
+
| 'MV'
|
|
3863
|
+
| 'ML'
|
|
3864
|
+
| 'MT'
|
|
3865
|
+
| 'MH'
|
|
3866
|
+
| 'MQ'
|
|
3867
|
+
| 'MR'
|
|
3868
|
+
| 'MU'
|
|
3869
|
+
| 'YT'
|
|
3870
|
+
| 'MX'
|
|
3871
|
+
| 'FM'
|
|
3872
|
+
| 'MD'
|
|
3873
|
+
| 'MC'
|
|
3874
|
+
| 'MN'
|
|
3875
|
+
| 'MS'
|
|
3876
|
+
| 'MA'
|
|
3877
|
+
| 'MZ'
|
|
3878
|
+
| 'MM'
|
|
3879
|
+
| 'NA'
|
|
3880
|
+
| 'NR'
|
|
3881
|
+
| 'NP'
|
|
3882
|
+
| 'NL'
|
|
3883
|
+
| 'NC'
|
|
3884
|
+
| 'NZ'
|
|
3885
|
+
| 'NI'
|
|
3886
|
+
| 'NE'
|
|
3887
|
+
| 'NG'
|
|
3888
|
+
| 'NU'
|
|
3889
|
+
| 'NF'
|
|
3890
|
+
| 'MP'
|
|
3891
|
+
| 'MK'
|
|
3892
|
+
| 'NO'
|
|
3893
|
+
| 'OM'
|
|
3894
|
+
| 'PK'
|
|
3895
|
+
| 'PW'
|
|
3896
|
+
| 'PS'
|
|
3897
|
+
| 'PA'
|
|
3898
|
+
| 'PG'
|
|
3899
|
+
| 'PY'
|
|
3900
|
+
| 'PE'
|
|
3901
|
+
| 'PH'
|
|
3902
|
+
| 'PN'
|
|
3903
|
+
| 'PL'
|
|
3904
|
+
| 'PT'
|
|
3905
|
+
| 'PR'
|
|
3906
|
+
| 'QA'
|
|
3907
|
+
| 'RE'
|
|
3908
|
+
| 'RO'
|
|
3909
|
+
| 'RU'
|
|
3910
|
+
| 'RW'
|
|
3911
|
+
| 'SH'
|
|
3912
|
+
| 'KN'
|
|
3913
|
+
| 'LC'
|
|
3914
|
+
| 'PM'
|
|
3915
|
+
| 'VC'
|
|
3916
|
+
| 'WS'
|
|
3917
|
+
| 'SM'
|
|
3918
|
+
| 'ST'
|
|
3919
|
+
| 'SA'
|
|
3920
|
+
| 'SN'
|
|
3921
|
+
| 'SC'
|
|
3922
|
+
| 'SL'
|
|
3923
|
+
| 'SG'
|
|
3924
|
+
| 'SK'
|
|
3925
|
+
| 'SI'
|
|
3926
|
+
| 'SB'
|
|
3927
|
+
| 'SO'
|
|
3928
|
+
| 'ZA'
|
|
3929
|
+
| 'GS'
|
|
3930
|
+
| 'ES'
|
|
3931
|
+
| 'LK'
|
|
3932
|
+
| 'SD'
|
|
3933
|
+
| 'SR'
|
|
3934
|
+
| 'SJ'
|
|
3935
|
+
| 'SZ'
|
|
3936
|
+
| 'SE'
|
|
3937
|
+
| 'CH'
|
|
3938
|
+
| 'SY'
|
|
3939
|
+
| 'TW'
|
|
3940
|
+
| 'TJ'
|
|
3941
|
+
| 'TZ'
|
|
3942
|
+
| 'TH'
|
|
3943
|
+
| 'TL'
|
|
3944
|
+
| 'TG'
|
|
3945
|
+
| 'TK'
|
|
3946
|
+
| 'TO'
|
|
3947
|
+
| 'TT'
|
|
3948
|
+
| 'TN'
|
|
3949
|
+
| 'TR'
|
|
3950
|
+
| 'TM'
|
|
3951
|
+
| 'TC'
|
|
3952
|
+
| 'TV'
|
|
3953
|
+
| 'UG'
|
|
3954
|
+
| 'UA'
|
|
3955
|
+
| 'AE'
|
|
3956
|
+
| 'GB'
|
|
3957
|
+
| 'US'
|
|
3958
|
+
| 'UM'
|
|
3959
|
+
| 'UY'
|
|
3960
|
+
| 'UZ'
|
|
3961
|
+
| 'VU'
|
|
3962
|
+
| 'VE'
|
|
3963
|
+
| 'VN'
|
|
3964
|
+
| 'VG'
|
|
3965
|
+
| 'VI'
|
|
3966
|
+
| 'WF'
|
|
3967
|
+
| 'EH'
|
|
3968
|
+
| 'YE'
|
|
3969
|
+
| 'ZM'
|
|
3970
|
+
| 'ZW'
|
|
3971
|
+
| 'AX'
|
|
3972
|
+
| 'BQ'
|
|
3973
|
+
| 'CW'
|
|
3974
|
+
| 'GG'
|
|
3975
|
+
| 'IM'
|
|
3976
|
+
| 'JE'
|
|
3977
|
+
| 'ME'
|
|
3978
|
+
| 'BL'
|
|
3979
|
+
| 'MF'
|
|
3980
|
+
| 'RS'
|
|
3981
|
+
| 'SX'
|
|
3982
|
+
| 'SS'
|
|
3983
|
+
| 'XK';
|
|
5553
3984
|
|
|
5554
|
-
|
|
5555
|
-
* The name of the account holder who signs the mandate
|
|
5556
|
-
*/
|
|
5557
|
-
accountHolderName?: string;
|
|
3985
|
+
firstName: string;
|
|
5558
3986
|
|
|
5559
|
-
|
|
3987
|
+
lastName: string;
|
|
5560
3988
|
|
|
5561
|
-
|
|
5562
|
-
}
|
|
3989
|
+
line1: string;
|
|
5563
3990
|
|
|
5564
|
-
|
|
5565
|
-
* Prefill known data to skip steps in the checkout.
|
|
5566
|
-
*/
|
|
5567
|
-
export interface Prefill {
|
|
5568
|
-
/**
|
|
5569
|
-
* The known bank id. Customers will skip the bank selection and go directly to the
|
|
5570
|
-
* bank's login. Required for financial address prefill.
|
|
5571
|
-
*/
|
|
5572
|
-
bankId?: string;
|
|
3991
|
+
line2: string;
|
|
5573
3992
|
|
|
5574
|
-
|
|
5575
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
5576
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
5577
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
5578
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
5579
|
-
* out.
|
|
5580
|
-
*/
|
|
5581
|
-
payerFinancialAddress?: Prefill.PayerFinancialAddress;
|
|
5582
|
-
}
|
|
3993
|
+
region: string;
|
|
5583
3994
|
|
|
5584
|
-
|
|
5585
|
-
/**
|
|
5586
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
5587
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
5588
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
5589
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
5590
|
-
* out.
|
|
5591
|
-
*/
|
|
5592
|
-
export interface PayerFinancialAddress {
|
|
5593
|
-
/**
|
|
5594
|
-
* The type of the financial address. The actual destination is determined by this
|
|
5595
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
5596
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
5597
|
-
* in the "iban" object.
|
|
5598
|
-
*
|
|
5599
|
-
* - iban: The IBAN of the account
|
|
5600
|
-
* - sort_code: The sort code of the account
|
|
5601
|
-
* - bank_code: The bank code of the account
|
|
5602
|
-
* - bban: The BBAN of the account
|
|
5603
|
-
*/
|
|
5604
|
-
type: string;
|
|
5605
|
-
|
|
5606
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
5607
|
-
|
|
5608
|
-
bban?: PayerFinancialAddress.Bban;
|
|
5609
|
-
|
|
5610
|
-
iban?: PayerFinancialAddress.Iban;
|
|
5611
|
-
|
|
5612
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
3995
|
+
zipCode: string;
|
|
5613
3996
|
}
|
|
3997
|
+
}
|
|
5614
3998
|
|
|
5615
|
-
|
|
5616
|
-
|
|
5617
|
-
accountNumber: string;
|
|
5618
|
-
|
|
5619
|
-
code: string;
|
|
5620
|
-
|
|
5621
|
-
/**
|
|
5622
|
-
* The name of the account holder.
|
|
5623
|
-
*/
|
|
5624
|
-
accountHolderName?: string;
|
|
5625
|
-
}
|
|
5626
|
-
|
|
5627
|
-
export interface Bban {
|
|
5628
|
-
bban: string;
|
|
5629
|
-
|
|
5630
|
-
/**
|
|
5631
|
-
* The name of the account holder.
|
|
5632
|
-
*/
|
|
5633
|
-
accountHolderName?: string;
|
|
5634
|
-
|
|
5635
|
-
bic?: string;
|
|
5636
|
-
}
|
|
5637
|
-
|
|
5638
|
-
export interface Iban {
|
|
5639
|
-
iban: string;
|
|
5640
|
-
|
|
5641
|
-
/**
|
|
5642
|
-
* The name of the account holder.
|
|
5643
|
-
*/
|
|
5644
|
-
accountHolderName?: string;
|
|
3999
|
+
export interface Price {
|
|
4000
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
5645
4001
|
|
|
5646
|
-
|
|
5647
|
-
}
|
|
4002
|
+
total: number;
|
|
5648
4003
|
|
|
5649
|
-
|
|
5650
|
-
accountNumber: string;
|
|
4004
|
+
shipping?: number;
|
|
5651
4005
|
|
|
5652
|
-
|
|
4006
|
+
subTotal?: number;
|
|
5653
4007
|
|
|
5654
|
-
|
|
5655
|
-
* The name of the account holder.
|
|
5656
|
-
*/
|
|
5657
|
-
accountHolderName?: string;
|
|
5658
|
-
}
|
|
5659
|
-
}
|
|
5660
|
-
}
|
|
4008
|
+
totalNet?: number;
|
|
5661
4009
|
|
|
5662
|
-
|
|
5663
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
5664
|
-
* input within the Ivy express Checkout.
|
|
5665
|
-
*/
|
|
5666
|
-
export interface Required {
|
|
5667
|
-
/**
|
|
5668
|
-
* If set to true, the phone number will be required input within the Ivy express
|
|
5669
|
-
* Checkout.
|
|
5670
|
-
*/
|
|
5671
|
-
phone: boolean;
|
|
4010
|
+
vat?: number;
|
|
5672
4011
|
}
|
|
5673
4012
|
|
|
5674
|
-
export interface
|
|
4013
|
+
export interface BillingAddress {
|
|
5675
4014
|
city: string;
|
|
5676
4015
|
|
|
5677
|
-
/**
|
|
5678
|
-
* The country code in
|
|
5679
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
5680
|
-
*/
|
|
5681
4016
|
country:
|
|
5682
4017
|
| 'AF'
|
|
5683
4018
|
| 'AL'
|
|
@@ -5930,42 +4265,59 @@ export namespace CheckoutsessionExpireResponse {
|
|
|
5930
4265
|
| 'SS'
|
|
5931
4266
|
| 'XK';
|
|
5932
4267
|
|
|
4268
|
+
firstName: string;
|
|
4269
|
+
|
|
4270
|
+
lastName: string;
|
|
4271
|
+
|
|
5933
4272
|
line1: string;
|
|
5934
4273
|
|
|
4274
|
+
line2: string;
|
|
4275
|
+
|
|
4276
|
+
region: string;
|
|
4277
|
+
|
|
5935
4278
|
zipCode: string;
|
|
4279
|
+
}
|
|
5936
4280
|
|
|
5937
|
-
|
|
4281
|
+
export interface Customer {
|
|
4282
|
+
id: string;
|
|
4283
|
+
}
|
|
4284
|
+
|
|
4285
|
+
export interface Mandate {
|
|
4286
|
+
accountHolderName?: string;
|
|
5938
4287
|
|
|
5939
|
-
|
|
4288
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
4289
|
+
|
|
4290
|
+
referenceId?: string;
|
|
5940
4291
|
|
|
5941
|
-
|
|
4292
|
+
setup?: boolean;
|
|
5942
4293
|
|
|
5943
|
-
|
|
4294
|
+
userNotificationEmail?: string;
|
|
5944
4295
|
}
|
|
5945
4296
|
|
|
5946
|
-
|
|
5947
|
-
|
|
5948
|
-
|
|
5949
|
-
export interface ShippingMethod {
|
|
5950
|
-
/**
|
|
5951
|
-
* The customer-facing name of the shipping method.
|
|
5952
|
-
*/
|
|
5953
|
-
name: string;
|
|
4297
|
+
export namespace Mandate {
|
|
4298
|
+
export interface AdditionalDisplayInformation {
|
|
4299
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
5954
4300
|
|
|
5955
|
-
|
|
5956
|
-
|
|
5957
|
-
*/
|
|
5958
|
-
price: number;
|
|
4301
|
+
price?: AdditionalDisplayInformation.Price;
|
|
4302
|
+
}
|
|
5959
4303
|
|
|
5960
|
-
|
|
5961
|
-
|
|
5962
|
-
|
|
5963
|
-
id?: string;
|
|
4304
|
+
export namespace AdditionalDisplayInformation {
|
|
4305
|
+
export interface Price {
|
|
4306
|
+
amount: number;
|
|
5964
4307
|
|
|
5965
|
-
|
|
5966
|
-
|
|
5967
|
-
|
|
5968
|
-
|
|
4308
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
4309
|
+
}
|
|
4310
|
+
}
|
|
4311
|
+
}
|
|
4312
|
+
|
|
4313
|
+
export interface Required {
|
|
4314
|
+
phone: boolean;
|
|
4315
|
+
}
|
|
4316
|
+
|
|
4317
|
+
export interface ShippingAddress {
|
|
4318
|
+
city: string;
|
|
4319
|
+
|
|
4320
|
+
country:
|
|
5969
4321
|
| 'AF'
|
|
5970
4322
|
| 'AL'
|
|
5971
4323
|
| 'DZ'
|
|
@@ -6215,89 +4567,31 @@ export namespace CheckoutsessionExpireResponse {
|
|
|
6215
4567
|
| 'RS'
|
|
6216
4568
|
| 'SX'
|
|
6217
4569
|
| 'SS'
|
|
6218
|
-
| 'XK'
|
|
6219
|
-
>;
|
|
4570
|
+
| 'XK';
|
|
6220
4571
|
|
|
6221
|
-
|
|
6222
|
-
* The delivery estimate of the shipping method.
|
|
6223
|
-
*/
|
|
6224
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
4572
|
+
firstName: string;
|
|
6225
4573
|
|
|
6226
|
-
|
|
6227
|
-
* The unique identifier within your system of the shipping method.
|
|
6228
|
-
*/
|
|
6229
|
-
reference?: string;
|
|
4574
|
+
lastName: string;
|
|
6230
4575
|
|
|
6231
|
-
|
|
6232
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
6233
|
-
*/
|
|
6234
|
-
timeFrame?: string;
|
|
6235
|
-
}
|
|
4576
|
+
line1: string;
|
|
6236
4577
|
|
|
6237
|
-
|
|
6238
|
-
/**
|
|
6239
|
-
* The delivery estimate of the shipping method.
|
|
6240
|
-
*/
|
|
6241
|
-
export interface DeliveryEstimate {
|
|
6242
|
-
/**
|
|
6243
|
-
* The maximum delivery time.
|
|
6244
|
-
*/
|
|
6245
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
6246
|
-
|
|
6247
|
-
/**
|
|
6248
|
-
* The minimum delivery time.
|
|
6249
|
-
*/
|
|
6250
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
6251
|
-
}
|
|
4578
|
+
line2: string;
|
|
6252
4579
|
|
|
6253
|
-
|
|
6254
|
-
/**
|
|
6255
|
-
* The maximum delivery time.
|
|
6256
|
-
*/
|
|
6257
|
-
export interface Maximum {
|
|
6258
|
-
/**
|
|
6259
|
-
* The unit of the time duration.
|
|
6260
|
-
*/
|
|
6261
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
6262
|
-
|
|
6263
|
-
/**
|
|
6264
|
-
* The value of the time duration.
|
|
6265
|
-
*/
|
|
6266
|
-
value: number;
|
|
6267
|
-
}
|
|
4580
|
+
region: string;
|
|
6268
4581
|
|
|
6269
|
-
|
|
6270
|
-
* The minimum delivery time.
|
|
6271
|
-
*/
|
|
6272
|
-
export interface Minimum {
|
|
6273
|
-
/**
|
|
6274
|
-
* The unit of the time duration.
|
|
6275
|
-
*/
|
|
6276
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
6277
|
-
|
|
6278
|
-
/**
|
|
6279
|
-
* The value of the time duration.
|
|
6280
|
-
*/
|
|
6281
|
-
value: number;
|
|
6282
|
-
}
|
|
6283
|
-
}
|
|
4582
|
+
zipCode: string;
|
|
6284
4583
|
}
|
|
6285
4584
|
}
|
|
6286
4585
|
|
|
6287
4586
|
export interface CheckoutsessionCreateParams {
|
|
6288
4587
|
/**
|
|
6289
|
-
*
|
|
6290
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
6291
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
6292
|
-
* as this is the format accepted by most banks.
|
|
4588
|
+
* Price of the checkout session
|
|
6293
4589
|
*/
|
|
6294
4590
|
price: CheckoutsessionCreateParams.Price;
|
|
6295
4591
|
|
|
6296
4592
|
/**
|
|
6297
|
-
* An internal reference id which will be stored with the
|
|
6298
|
-
*
|
|
6299
|
-
* characters. We recommend to use your internal unique id for this customer's
|
|
6300
|
-
* payment process.
|
|
4593
|
+
* An internal reference id which will be stored with the order. Needs to be unique
|
|
4594
|
+
* per shop and can be up to 200 characters.
|
|
6301
4595
|
*/
|
|
6302
4596
|
referenceId: string;
|
|
6303
4597
|
|
|
@@ -6307,38 +4601,32 @@ export interface CheckoutsessionCreateParams {
|
|
|
6307
4601
|
billingAddress?: CheckoutsessionCreateParams.BillingAddress;
|
|
6308
4602
|
|
|
6309
4603
|
/**
|
|
6310
|
-
*
|
|
6311
|
-
* to this URL.
|
|
4604
|
+
* Complete Callback requests will be sent to this URL on default.
|
|
6312
4605
|
*/
|
|
6313
4606
|
completeCallbackUrl?: string;
|
|
6314
4607
|
|
|
6315
4608
|
/**
|
|
6316
4609
|
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
6317
|
-
* time of
|
|
4610
|
+
* time of api CheckoutSession creation at Ivy.
|
|
6318
4611
|
*/
|
|
6319
4612
|
created?: number;
|
|
6320
4613
|
|
|
6321
|
-
|
|
6322
|
-
* The customer of the merchant.
|
|
6323
|
-
*/
|
|
6324
|
-
customer?: CheckoutsessionCreateParams.Email | CheckoutsessionCreateParams.ID;
|
|
4614
|
+
customer?: CheckoutsessionCreateParams.Customer;
|
|
6325
4615
|
|
|
6326
4616
|
/**
|
|
6327
|
-
*
|
|
6328
|
-
*
|
|
4617
|
+
* Disable bank selection mode. If set to true, customers cannot modify the pre
|
|
4618
|
+
* selected bank.
|
|
6329
4619
|
*/
|
|
6330
4620
|
disableBankSelection?: boolean;
|
|
6331
4621
|
|
|
6332
4622
|
/**
|
|
6333
|
-
* The
|
|
6334
|
-
*
|
|
6335
|
-
* customer-friendly id.
|
|
4623
|
+
* The order id which will be displayed to the user and in the merchant dashboard.
|
|
4624
|
+
* At most 200 characters are allowed.
|
|
6336
4625
|
*/
|
|
6337
4626
|
displayId?: string;
|
|
6338
4627
|
|
|
6339
4628
|
/**
|
|
6340
|
-
*
|
|
6341
|
-
* unsuccessful payment attempt.
|
|
4629
|
+
* Users will be redirected here on default after an unsuccessful checkout.
|
|
6342
4630
|
*/
|
|
6343
4631
|
errorCallbackUrl?: string;
|
|
6344
4632
|
|
|
@@ -6350,33 +4638,22 @@ export interface CheckoutsessionCreateParams {
|
|
|
6350
4638
|
expiresAt?: number;
|
|
6351
4639
|
|
|
6352
4640
|
/**
|
|
6353
|
-
*
|
|
6354
|
-
* checkout session.
|
|
4641
|
+
* Sets the checkout to a express version
|
|
6355
4642
|
*/
|
|
6356
4643
|
express?: boolean;
|
|
6357
4644
|
|
|
6358
4645
|
/**
|
|
6359
|
-
*
|
|
4646
|
+
* All line items of this checkout session. At least one line item required
|
|
6360
4647
|
*/
|
|
6361
4648
|
lineItems?: Array<CheckoutsessionCreateParams.LineItem>;
|
|
6362
4649
|
|
|
6363
|
-
|
|
6364
|
-
* The locale of the customer, i.e. the language of the checkout. Customers can
|
|
6365
|
-
* change the language in the checkout. If not provided, the language of the
|
|
6366
|
-
* checkout is determined by the browser's language.
|
|
6367
|
-
*/
|
|
6368
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
4650
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
6369
4651
|
|
|
6370
|
-
/**
|
|
6371
|
-
* The mandate setup for the payment. Relevant for
|
|
6372
|
-
* [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
|
|
6373
|
-
*/
|
|
6374
4652
|
mandate?: CheckoutsessionCreateParams.Mandate;
|
|
6375
4653
|
|
|
6376
4654
|
/**
|
|
6377
|
-
*
|
|
6378
|
-
*
|
|
6379
|
-
* `prefill.bankId` is provided.
|
|
4655
|
+
* The market of the checkoutSession. Will show the market banks connected with
|
|
4656
|
+
* this market
|
|
6380
4657
|
*/
|
|
6381
4658
|
market?:
|
|
6382
4659
|
| 'AF'
|
|
@@ -6632,75 +4909,47 @@ export interface CheckoutsessionCreateParams {
|
|
|
6632
4909
|
|
|
6633
4910
|
/**
|
|
6634
4911
|
* Any data which will be stored and returned for this checkout session and
|
|
6635
|
-
* corresponding order
|
|
6636
|
-
* more info.
|
|
4912
|
+
* corresponding order
|
|
6637
4913
|
*/
|
|
6638
|
-
metadata?:
|
|
4914
|
+
metadata?: { [key: string]: unknown };
|
|
6639
4915
|
|
|
6640
4916
|
/**
|
|
6641
|
-
*
|
|
6642
|
-
*
|
|
6643
|
-
* processed from the virtual account.
|
|
6644
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
6645
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
4917
|
+
* The mode in which the payment should be processed. If direct is used, you need
|
|
4918
|
+
* to provide a settlementDestination
|
|
6646
4919
|
*/
|
|
6647
|
-
paymentMode?: '
|
|
4920
|
+
paymentMode?: 'direct' | 'settlement';
|
|
6648
4921
|
|
|
6649
|
-
/**
|
|
6650
|
-
* The scheme selection for the payment. `instant_only` enforces instant payments,
|
|
6651
|
-
* meaning no banks that do not support it can be selected. `instant_preferred`
|
|
6652
|
-
* means that the payment is done via instant rails, if supported by the bank. It
|
|
6653
|
-
* will use standard rails, if not supported by the bank. Standard means that only
|
|
6654
|
-
* cost-free, but potentially slower bank rails are used for the transfer. Defaults
|
|
6655
|
-
* to value set on merchant dashboard if not provided.
|
|
6656
|
-
*/
|
|
6657
4922
|
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
6658
4923
|
|
|
6659
4924
|
/**
|
|
6660
|
-
*
|
|
4925
|
+
* The values specified here will be pre-filled in the Ivy Checkout.
|
|
6661
4926
|
*/
|
|
6662
4927
|
prefill?: CheckoutsessionCreateParams.Prefill;
|
|
6663
4928
|
|
|
6664
4929
|
/**
|
|
6665
|
-
*
|
|
6666
|
-
* this URL.
|
|
4930
|
+
* Quote Callback requests will be sent to this URL on default.
|
|
6667
4931
|
*/
|
|
6668
4932
|
quoteCallbackUrl?: string;
|
|
6669
4933
|
|
|
6670
|
-
/**
|
|
6671
|
-
* The settlement destination of the payment. If not provided, the financial
|
|
6672
|
-
* address of the merchant's direct payout destination will be used with a randomly
|
|
6673
|
-
* generated payment reference.
|
|
6674
|
-
*/
|
|
6675
4934
|
settlementDestination?: CheckoutsessionCreateParams.SettlementDestination;
|
|
6676
4935
|
|
|
6677
|
-
/**
|
|
6678
|
-
* Usually relevant for PSPs. Create a subaccount for each underlying storefront or
|
|
6679
|
-
* merchant which processes payments with your Ivy account. You can create new
|
|
6680
|
-
* subaccounts [here](https://docs.getivy.de/reference/merchantsubaccountcreate-1)
|
|
6681
|
-
*/
|
|
6682
4936
|
subaccountId?: string;
|
|
6683
4937
|
|
|
6684
4938
|
/**
|
|
6685
|
-
*
|
|
6686
|
-
* successful payment attempt.
|
|
4939
|
+
* Users will be redirected here on default after a successful checkout.
|
|
6687
4940
|
*/
|
|
6688
4941
|
successCallbackUrl?: string;
|
|
4942
|
+
|
|
4943
|
+
themeVariant?: 'light' | 'dark';
|
|
6689
4944
|
}
|
|
6690
4945
|
|
|
6691
4946
|
export namespace CheckoutsessionCreateParams {
|
|
6692
4947
|
/**
|
|
6693
|
-
*
|
|
6694
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
6695
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
6696
|
-
* as this is the format accepted by most banks.
|
|
4948
|
+
* Price of the checkout session
|
|
6697
4949
|
*/
|
|
6698
4950
|
export interface Price {
|
|
6699
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
4951
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
6700
4952
|
|
|
6701
|
-
/**
|
|
6702
|
-
* The total amount to be paid.
|
|
6703
|
-
*/
|
|
6704
4953
|
total: number;
|
|
6705
4954
|
|
|
6706
4955
|
shipping?: number;
|
|
@@ -6718,10 +4967,6 @@ export namespace CheckoutsessionCreateParams {
|
|
|
6718
4967
|
export interface BillingAddress {
|
|
6719
4968
|
city: string;
|
|
6720
4969
|
|
|
6721
|
-
/**
|
|
6722
|
-
* The country code in
|
|
6723
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
6724
|
-
*/
|
|
6725
4970
|
country:
|
|
6726
4971
|
| 'AF'
|
|
6727
4972
|
| 'AL'
|
|
@@ -6974,237 +5219,125 @@ export namespace CheckoutsessionCreateParams {
|
|
|
6974
5219
|
| 'SS'
|
|
6975
5220
|
| 'XK';
|
|
6976
5221
|
|
|
6977
|
-
|
|
5222
|
+
firstName: string;
|
|
6978
5223
|
|
|
6979
|
-
|
|
5224
|
+
lastName: string;
|
|
6980
5225
|
|
|
6981
|
-
|
|
5226
|
+
line1: string;
|
|
6982
5227
|
|
|
6983
|
-
|
|
5228
|
+
line2: string;
|
|
6984
5229
|
|
|
6985
|
-
|
|
5230
|
+
region: string;
|
|
6986
5231
|
|
|
6987
|
-
|
|
5232
|
+
zipCode: string;
|
|
6988
5233
|
}
|
|
6989
5234
|
|
|
6990
|
-
export interface
|
|
6991
|
-
|
|
6992
|
-
* The email of the customer.
|
|
6993
|
-
*/
|
|
6994
|
-
email: string;
|
|
6995
|
-
}
|
|
5235
|
+
export interface Customer {
|
|
5236
|
+
id?: string;
|
|
6996
5237
|
|
|
6997
|
-
|
|
6998
|
-
/**
|
|
6999
|
-
* The Ivy id of the customer.
|
|
7000
|
-
*/
|
|
7001
|
-
id: string;
|
|
5238
|
+
email?: string;
|
|
7002
5239
|
}
|
|
7003
5240
|
|
|
7004
5241
|
export interface LineItem {
|
|
7005
5242
|
/**
|
|
7006
|
-
*
|
|
7007
|
-
*
|
|
5243
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
5244
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
7008
5245
|
*/
|
|
7009
5246
|
amount: number;
|
|
7010
5247
|
|
|
7011
5248
|
/**
|
|
7012
|
-
*
|
|
5249
|
+
* Customer-facing name of the line item.
|
|
7013
5250
|
*/
|
|
7014
5251
|
name: string;
|
|
7015
5252
|
|
|
7016
|
-
/**
|
|
7017
|
-
* The quantity of the line item.
|
|
7018
|
-
*/
|
|
7019
|
-
quantity: number;
|
|
7020
|
-
|
|
7021
|
-
/**
|
|
7022
|
-
* The net amount of a single item.
|
|
7023
|
-
*/
|
|
7024
5253
|
singleNet: number;
|
|
7025
5254
|
|
|
7026
|
-
/**
|
|
7027
|
-
* The VAT amount of a single item.
|
|
7028
|
-
*/
|
|
7029
5255
|
singleVat: number;
|
|
7030
5256
|
|
|
7031
|
-
|
|
7032
|
-
|
|
7033
|
-
|
|
7034
|
-
|
|
7035
|
-
|
|
5257
|
+
category?:
|
|
5258
|
+
| '5045'
|
|
5259
|
+
| '5065'
|
|
5260
|
+
| '5094'
|
|
5261
|
+
| '5192'
|
|
5262
|
+
| '5193'
|
|
5263
|
+
| '5499'
|
|
5264
|
+
| '5655'
|
|
5265
|
+
| '5691'
|
|
5266
|
+
| '5712'
|
|
5267
|
+
| '5722'
|
|
5268
|
+
| '5812'
|
|
5269
|
+
| '5814'
|
|
5270
|
+
| '5912'
|
|
5271
|
+
| '5977'
|
|
5272
|
+
| '5999'
|
|
5273
|
+
| '7629';
|
|
7036
5274
|
|
|
7037
|
-
/**
|
|
7038
|
-
* The
|
|
7039
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
7040
|
-
* of the line item.
|
|
7041
|
-
*/
|
|
7042
5275
|
EAN?: string;
|
|
7043
5276
|
|
|
7044
5277
|
/**
|
|
7045
|
-
*
|
|
5278
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
7046
5279
|
*/
|
|
7047
5280
|
image?: string;
|
|
7048
5281
|
|
|
7049
5282
|
/**
|
|
7050
|
-
*
|
|
5283
|
+
* Quantity of this lineItem.
|
|
5284
|
+
*/
|
|
5285
|
+
quantity?: number;
|
|
5286
|
+
|
|
5287
|
+
/**
|
|
5288
|
+
* An internal unique id stored to this line item.
|
|
7051
5289
|
*/
|
|
7052
5290
|
referenceId?: string;
|
|
7053
5291
|
}
|
|
7054
5292
|
|
|
7055
|
-
/**
|
|
7056
|
-
* The mandate setup for the payment. Relevant for
|
|
7057
|
-
* [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
|
|
7058
|
-
*/
|
|
7059
5293
|
export interface Mandate {
|
|
7060
|
-
setup: boolean;
|
|
7061
|
-
|
|
7062
|
-
/**
|
|
7063
|
-
* The name of the account holder who signs the mandate
|
|
7064
|
-
*/
|
|
7065
5294
|
accountHolderName?: string;
|
|
7066
5295
|
|
|
5296
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
5297
|
+
|
|
7067
5298
|
referenceId?: string;
|
|
7068
5299
|
|
|
5300
|
+
setup?: boolean;
|
|
5301
|
+
|
|
7069
5302
|
userNotificationEmail?: string;
|
|
7070
5303
|
}
|
|
7071
5304
|
|
|
7072
|
-
|
|
7073
|
-
|
|
7074
|
-
|
|
7075
|
-
export interface Prefill {
|
|
7076
|
-
/**
|
|
7077
|
-
* The known bank id. Customers will skip the bank selection and go directly to the
|
|
7078
|
-
* bank's login. Required for financial address prefill.
|
|
7079
|
-
*/
|
|
7080
|
-
bankId?: string;
|
|
7081
|
-
|
|
7082
|
-
/**
|
|
7083
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
7084
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
7085
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
7086
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
7087
|
-
* out.
|
|
7088
|
-
*/
|
|
7089
|
-
payerFinancialAddress?: Prefill.PayerFinancialAddress;
|
|
7090
|
-
}
|
|
5305
|
+
export namespace Mandate {
|
|
5306
|
+
export interface AdditionalDisplayInformation {
|
|
5307
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
7091
5308
|
|
|
7092
|
-
|
|
7093
|
-
/**
|
|
7094
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
7095
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
7096
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
7097
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
7098
|
-
* out.
|
|
7099
|
-
*/
|
|
7100
|
-
export interface PayerFinancialAddress {
|
|
7101
|
-
/**
|
|
7102
|
-
* The type of the financial address. The actual destination is determined by this
|
|
7103
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
7104
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
7105
|
-
* in the "iban" object.
|
|
7106
|
-
*
|
|
7107
|
-
* - iban: The IBAN of the account
|
|
7108
|
-
* - sort_code: The sort code of the account
|
|
7109
|
-
* - bank_code: The bank code of the account
|
|
7110
|
-
* - bban: The BBAN of the account
|
|
7111
|
-
*/
|
|
7112
|
-
type: string;
|
|
7113
|
-
|
|
7114
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
7115
|
-
|
|
7116
|
-
bban?: PayerFinancialAddress.Bban;
|
|
7117
|
-
|
|
7118
|
-
iban?: PayerFinancialAddress.Iban;
|
|
7119
|
-
|
|
7120
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
5309
|
+
price?: AdditionalDisplayInformation.Price;
|
|
7121
5310
|
}
|
|
7122
5311
|
|
|
7123
|
-
export namespace
|
|
7124
|
-
export interface
|
|
7125
|
-
|
|
7126
|
-
|
|
7127
|
-
code: string;
|
|
7128
|
-
|
|
7129
|
-
/**
|
|
7130
|
-
* The name of the account holder.
|
|
7131
|
-
*/
|
|
7132
|
-
accountHolderName?: string;
|
|
7133
|
-
}
|
|
7134
|
-
|
|
7135
|
-
export interface Bban {
|
|
7136
|
-
bban: string;
|
|
7137
|
-
|
|
7138
|
-
/**
|
|
7139
|
-
* The name of the account holder.
|
|
7140
|
-
*/
|
|
7141
|
-
accountHolderName?: string;
|
|
7142
|
-
|
|
7143
|
-
bic?: string;
|
|
7144
|
-
}
|
|
7145
|
-
|
|
7146
|
-
export interface Iban {
|
|
7147
|
-
iban: string;
|
|
7148
|
-
|
|
7149
|
-
/**
|
|
7150
|
-
* The name of the account holder.
|
|
7151
|
-
*/
|
|
7152
|
-
accountHolderName?: string;
|
|
7153
|
-
|
|
7154
|
-
bic?: string;
|
|
7155
|
-
}
|
|
7156
|
-
|
|
7157
|
-
export interface SortCode {
|
|
7158
|
-
accountNumber: string;
|
|
7159
|
-
|
|
7160
|
-
sortCode: string;
|
|
5312
|
+
export namespace AdditionalDisplayInformation {
|
|
5313
|
+
export interface Price {
|
|
5314
|
+
amount: number;
|
|
7161
5315
|
|
|
7162
|
-
|
|
7163
|
-
* The name of the account holder.
|
|
7164
|
-
*/
|
|
7165
|
-
accountHolderName?: string;
|
|
5316
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
7166
5317
|
}
|
|
7167
5318
|
}
|
|
7168
5319
|
}
|
|
7169
5320
|
|
|
7170
5321
|
/**
|
|
7171
|
-
* The
|
|
7172
|
-
* address of the merchant's direct payout destination will be used with a randomly
|
|
7173
|
-
* generated payment reference.
|
|
5322
|
+
* The values specified here will be pre-filled in the Ivy Checkout.
|
|
7174
5323
|
*/
|
|
7175
|
-
export interface
|
|
5324
|
+
export interface Prefill {
|
|
7176
5325
|
/**
|
|
7177
|
-
*
|
|
7178
|
-
*
|
|
7179
|
-
* characters, otherwise 35.
|
|
5326
|
+
* Retrieve a valid bankId with the POST /banks/search endpoint. When presented in
|
|
5327
|
+
* this field, the customer will skip the bank selection in the Ivy Checkout.
|
|
7180
5328
|
*/
|
|
5329
|
+
bankId?: string;
|
|
5330
|
+
}
|
|
5331
|
+
|
|
5332
|
+
export interface SettlementDestination {
|
|
7181
5333
|
reference: string;
|
|
7182
5334
|
|
|
7183
|
-
/**
|
|
7184
|
-
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
7185
|
-
* to "iban", the "iban" object must be filled out.
|
|
7186
|
-
*/
|
|
7187
5335
|
financialAddress?: SettlementDestination.FinancialAddress;
|
|
7188
5336
|
}
|
|
7189
5337
|
|
|
7190
5338
|
export namespace SettlementDestination {
|
|
7191
|
-
/**
|
|
7192
|
-
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
7193
|
-
* to "iban", the "iban" object must be filled out.
|
|
7194
|
-
*/
|
|
7195
5339
|
export interface FinancialAddress {
|
|
7196
|
-
|
|
7197
|
-
* The type of the financial address. The actual destination is determined by this
|
|
7198
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
7199
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
7200
|
-
* in the "iban" object.
|
|
7201
|
-
*
|
|
7202
|
-
* - iban: The IBAN of the account
|
|
7203
|
-
* - sort_code: The sort code of the account
|
|
7204
|
-
* - bank_code: The bank code of the account
|
|
7205
|
-
* - bban: The BBAN of the account
|
|
7206
|
-
*/
|
|
7207
|
-
type: string;
|
|
5340
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
7208
5341
|
|
|
7209
5342
|
bankCode?: FinancialAddress.BankCode;
|
|
7210
5343
|
|
|
@@ -7217,9 +5350,6 @@ export namespace CheckoutsessionCreateParams {
|
|
|
7217
5350
|
|
|
7218
5351
|
export namespace FinancialAddress {
|
|
7219
5352
|
export interface BankCode {
|
|
7220
|
-
/**
|
|
7221
|
-
* The name of the account holder.
|
|
7222
|
-
*/
|
|
7223
5353
|
accountHolderName: string;
|
|
7224
5354
|
|
|
7225
5355
|
accountNumber: string;
|
|
@@ -7228,9 +5358,6 @@ export namespace CheckoutsessionCreateParams {
|
|
|
7228
5358
|
}
|
|
7229
5359
|
|
|
7230
5360
|
export interface Bban {
|
|
7231
|
-
/**
|
|
7232
|
-
* The name of the account holder.
|
|
7233
|
-
*/
|
|
7234
5361
|
accountHolderName: string;
|
|
7235
5362
|
|
|
7236
5363
|
bban: string;
|
|
@@ -7239,9 +5366,6 @@ export namespace CheckoutsessionCreateParams {
|
|
|
7239
5366
|
}
|
|
7240
5367
|
|
|
7241
5368
|
export interface Iban {
|
|
7242
|
-
/**
|
|
7243
|
-
* The name of the account holder.
|
|
7244
|
-
*/
|
|
7245
5369
|
accountHolderName: string;
|
|
7246
5370
|
|
|
7247
5371
|
iban: string;
|
|
@@ -7250,9 +5374,6 @@ export namespace CheckoutsessionCreateParams {
|
|
|
7250
5374
|
}
|
|
7251
5375
|
|
|
7252
5376
|
export interface SortCode {
|
|
7253
|
-
/**
|
|
7254
|
-
* The name of the account holder.
|
|
7255
|
-
*/
|
|
7256
5377
|
accountHolderName: string;
|
|
7257
5378
|
|
|
7258
5379
|
accountNumber: string;
|
|
@@ -7264,10 +5385,17 @@ export namespace CheckoutsessionCreateParams {
|
|
|
7264
5385
|
}
|
|
7265
5386
|
|
|
7266
5387
|
export interface CheckoutsessionRetrieveParams {
|
|
5388
|
+
/**
|
|
5389
|
+
* The checkout session id to retrieve details for
|
|
5390
|
+
*/
|
|
7267
5391
|
id: string;
|
|
7268
5392
|
}
|
|
7269
5393
|
|
|
7270
5394
|
export interface CheckoutsessionExpireParams {
|
|
5395
|
+
/**
|
|
5396
|
+
* The checkout session id to expire. By expiring a Checkout Session, users will
|
|
5397
|
+
* not be able to access this Checkout Session anymore.
|
|
5398
|
+
*/
|
|
7271
5399
|
id: string;
|
|
7272
5400
|
}
|
|
7273
5401
|
|