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