@getivy/node-sdk 0.1.0-alpha.32 → 0.1.0-alpha.33
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 +8 -0
- package/index.d.mts +14 -14
- package/index.d.ts +14 -14
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/index.mjs +1 -1
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/balance.d.ts +6 -3
- package/resources/balance.d.ts.map +1 -1
- package/resources/banks.d.ts +38 -59
- package/resources/banks.d.ts.map +1 -1
- package/resources/capabilities.d.ts +1 -10
- package/resources/capabilities.d.ts.map +1 -1
- package/resources/charges.d.ts +30 -21
- package/resources/charges.d.ts.map +1 -1
- package/resources/checkoutsession.d.ts +311 -803
- package/resources/checkoutsession.d.ts.map +1 -1
- package/resources/customers.d.ts +9 -12
- package/resources/customers.d.ts.map +1 -1
- package/resources/data/accounts.d.ts +0 -100
- package/resources/data/accounts.d.ts.map +1 -1
- package/resources/data/accounts.js +0 -6
- package/resources/data/accounts.js.map +1 -1
- package/resources/data/accounts.mjs +0 -6
- package/resources/data/accounts.mjs.map +1 -1
- package/resources/data/balances.d.ts +0 -41
- package/resources/data/balances.d.ts.map +1 -1
- package/resources/data/balances.js +0 -6
- package/resources/data/balances.js.map +1 -1
- package/resources/data/balances.mjs +0 -6
- package/resources/data/balances.mjs.map +1 -1
- package/resources/data/consent.d.ts +0 -76
- package/resources/data/consent.d.ts.map +1 -1
- package/resources/data/consent.js +0 -12
- package/resources/data/consent.js.map +1 -1
- package/resources/data/consent.mjs +0 -12
- package/resources/data/consent.mjs.map +1 -1
- package/resources/data/data.d.ts +10 -10
- package/resources/data/data.d.ts.map +1 -1
- package/resources/data/data.js.map +1 -1
- package/resources/data/data.mjs +2 -2
- package/resources/data/data.mjs.map +1 -1
- package/resources/data/index.d.ts +5 -5
- package/resources/data/index.d.ts.map +1 -1
- package/resources/data/index.js.map +1 -1
- package/resources/data/index.mjs +2 -2
- package/resources/data/index.mjs.map +1 -1
- package/resources/data/session.d.ts +0 -230
- package/resources/data/session.d.ts.map +1 -1
- package/resources/data/session.js +0 -12
- package/resources/data/session.js.map +1 -1
- package/resources/data/session.mjs +0 -12
- package/resources/data/session.mjs.map +1 -1
- package/resources/data/transactions.d.ts +0 -50
- package/resources/data/transactions.d.ts.map +1 -1
- package/resources/data/transactions.js +0 -7
- package/resources/data/transactions.js.map +1 -1
- package/resources/data/transactions.mjs +0 -7
- package/resources/data/transactions.mjs.map +1 -1
- package/resources/index.d.ts +7 -7
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/mandates.d.ts +55 -17
- package/resources/mandates.d.ts.map +1 -1
- package/resources/mandates.js.map +1 -1
- package/resources/mandates.mjs.map +1 -1
- package/resources/orders.d.ts +242 -524
- package/resources/orders.d.ts.map +1 -1
- package/resources/payouts.d.ts +146 -70
- package/resources/payouts.d.ts.map +1 -1
- package/resources/payouts.js.map +1 -1
- package/resources/payouts.mjs.map +1 -1
- package/resources/refunds.d.ts +16 -92
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +4 -4
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +4 -4
- package/resources/refunds.mjs.map +1 -1
- package/resources/reports.d.ts +4 -78
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +5 -1
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +5 -1
- package/resources/reports.mjs.map +1 -1
- package/resources/subaccounts.d.ts +19 -7
- package/resources/subaccounts.d.ts.map +1 -1
- package/resources/subaccounts.js.map +1 -1
- package/resources/subaccounts.mjs.map +1 -1
- package/resources/webhooksubscription.d.ts +0 -151
- package/resources/webhooksubscription.d.ts.map +1 -1
- package/resources/webhooksubscription.js +0 -33
- package/resources/webhooksubscription.js.map +1 -1
- package/resources/webhooksubscription.mjs +0 -33
- package/resources/webhooksubscription.mjs.map +1 -1
- package/src/index.ts +22 -38
- package/src/resources/balance.ts +6 -3
- package/src/resources/banks.ts +41 -59
- package/src/resources/capabilities.ts +1 -10
- package/src/resources/charges.ts +32 -23
- package/src/resources/checkoutsession.ts +1395 -999
- package/src/resources/customers.ts +9 -12
- package/src/resources/data/accounts.ts +1 -130
- package/src/resources/data/balances.ts +1 -53
- package/src/resources/data/consent.ts +1 -106
- package/src/resources/data/data.ts +10 -46
- package/src/resources/data/index.ts +5 -17
- package/src/resources/data/session.ts +1 -1295
- package/src/resources/data/transactions.ts +1 -67
- package/src/resources/index.ts +9 -19
- package/src/resources/mandates.ts +82 -17
- package/src/resources/orders.ts +1149 -805
- package/src/resources/payouts.ts +239 -70
- package/src/resources/refunds.ts +33 -94
- package/src/resources/reports.ts +8 -98
- package/src/resources/subaccounts.ts +36 -7
- package/src/resources/webhooksubscription.ts +1 -349
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -18,152 +18,81 @@ export declare class Checkoutsession extends APIResource {
|
|
|
18
18
|
expire(body: CheckoutsessionExpireParams, options?: Core.RequestOptions): Core.APIPromise<CheckoutsessionExpireResponse>;
|
|
19
19
|
}
|
|
20
20
|
export interface CheckoutsessionCreateResponse {
|
|
21
|
-
/**
|
|
22
|
-
* The unique identifier of the Checkout within Ivy.
|
|
23
|
-
*/
|
|
24
21
|
id: string;
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
*/
|
|
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'>;
|
|
29
|
-
createdAt: string;
|
|
30
|
-
/**
|
|
31
|
-
* @deprecated Currently only visible in the merchant dashboard. This id used to be
|
|
32
|
-
* displayed to the user during the checkout.
|
|
33
|
-
*/
|
|
22
|
+
appId: string;
|
|
23
|
+
created: number;
|
|
34
24
|
displayId: string;
|
|
35
|
-
/**
|
|
36
|
-
* Required if not set in the dashboard. Users will be redirected here after an
|
|
37
|
-
* unsuccessful Payment attempt.
|
|
38
|
-
*/
|
|
39
25
|
errorCallbackUrl: string;
|
|
26
|
+
expiresAt: number;
|
|
27
|
+
lineItems: Array<CheckoutsessionCreateResponse.LineItem>;
|
|
40
28
|
merchant: CheckoutsessionCreateResponse.Merchant;
|
|
41
|
-
|
|
42
|
-
* - `settlement`: The payment is initially settled into a virtual account. The
|
|
43
|
-
* funds are then disbursed in batches to the merchant. Refunds are instantly
|
|
44
|
-
* processed from the virtual account.
|
|
45
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
46
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
47
|
-
*/
|
|
48
|
-
paymentMode: 'settlement' | 'direct';
|
|
49
|
-
/**
|
|
50
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
51
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
52
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
53
|
-
* as this is the format accepted by most banks.
|
|
54
|
-
*/
|
|
29
|
+
merchantAppId: string;
|
|
55
30
|
price: CheckoutsessionCreateResponse.Price;
|
|
56
31
|
redirectUrl: string;
|
|
57
|
-
/**
|
|
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.
|
|
61
|
-
*/
|
|
62
32
|
referenceId: string;
|
|
63
33
|
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
34
|
successCallbackUrl: string;
|
|
69
|
-
updatedAt: string;
|
|
70
35
|
abortReason?: string;
|
|
71
|
-
|
|
72
|
-
/**
|
|
73
|
-
* The billing address of the customer.
|
|
74
|
-
*/
|
|
36
|
+
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'>;
|
|
75
37
|
billingAddress?: CheckoutsessionCreateResponse.BillingAddress;
|
|
76
|
-
/**
|
|
77
|
-
* The merchant category code or
|
|
78
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
79
|
-
*/
|
|
80
38
|
category?: string;
|
|
81
|
-
/**
|
|
82
|
-
* Only applicable for express Checkouts. Complete Callback requests will be sent
|
|
83
|
-
* to this URL.
|
|
84
|
-
*/
|
|
85
39
|
completeCallbackUrl?: string;
|
|
86
|
-
|
|
87
|
-
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
88
|
-
* time of Checkout creation at Ivy.
|
|
89
|
-
*/
|
|
90
|
-
created?: number;
|
|
40
|
+
createdAt?: unknown;
|
|
91
41
|
customer?: CheckoutsessionCreateResponse.Customer;
|
|
92
|
-
/**
|
|
93
|
-
* False by default. If set to true, customers cannot modify the pre-selected bank
|
|
94
|
-
* from `prefill.bankId`.
|
|
95
|
-
*/
|
|
96
42
|
disableBankSelection?: boolean;
|
|
97
|
-
/**
|
|
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.
|
|
101
|
-
*/
|
|
102
|
-
expiresAt?: number;
|
|
103
|
-
/**
|
|
104
|
-
* False by default. If set to true, the Checkout is displayed in express mode.
|
|
105
|
-
*/
|
|
106
43
|
express?: boolean;
|
|
107
|
-
/**
|
|
108
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
109
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
110
|
-
*/
|
|
111
44
|
guest?: boolean;
|
|
112
|
-
/**
|
|
113
|
-
* If true, the order must be confirmed through the merchant with an additional
|
|
114
|
-
* complete callback endpoint. Always true for express sessions.
|
|
115
|
-
*/
|
|
116
45
|
handshake?: boolean;
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
*/
|
|
120
|
-
lineItems?: Array<CheckoutsessionCreateResponse.LineItem>;
|
|
121
|
-
/**
|
|
122
|
-
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
123
|
-
* given language. Users can change the language in the Checkout. If not provided,
|
|
124
|
-
* the language of the Checkout is determined by the browser's language.
|
|
125
|
-
*/
|
|
46
|
+
impactOffsetProjects?: Array<string>;
|
|
47
|
+
incentiveMode?: string;
|
|
126
48
|
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
127
49
|
mandate?: CheckoutsessionCreateResponse.Mandate;
|
|
128
|
-
/**
|
|
129
|
-
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
130
|
-
* located. If provided, the Checkout will display the market's banks first. Not
|
|
131
|
-
* relevant if `prefill.bankId` is provided.
|
|
132
|
-
*/
|
|
133
50
|
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;
|
|
138
|
-
/**
|
|
139
|
-
* Any data which will be stored and returned for this checkout session and
|
|
140
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
141
|
-
* more info.
|
|
142
|
-
*/
|
|
143
51
|
metadata?: Record<string, unknown>;
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
prefill?:
|
|
149
|
-
/**
|
|
150
|
-
* Only applicable for express Checkouts. Quote Callback requests will be sent to
|
|
151
|
-
* this URL.
|
|
152
|
-
*/
|
|
52
|
+
offsetProject?: string;
|
|
53
|
+
paymentMode?: 'direct' | 'settlement';
|
|
54
|
+
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
55
|
+
plugin?: string;
|
|
56
|
+
prefill?: unknown;
|
|
153
57
|
quoteCallbackUrl?: string;
|
|
154
|
-
/**
|
|
155
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
156
|
-
* input within the Ivy express Checkout.
|
|
157
|
-
*/
|
|
158
58
|
required?: CheckoutsessionCreateResponse.Required;
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
59
|
+
selectedShippingMethodId?: string;
|
|
60
|
+
shippingAddress?: CheckoutsessionCreateResponse.ShippingAddress;
|
|
61
|
+
shippingMethods?: Array<unknown>;
|
|
162
62
|
shopLogo?: string;
|
|
163
63
|
shopName?: string;
|
|
164
64
|
subaccountId?: string;
|
|
65
|
+
updatedAt?: unknown;
|
|
165
66
|
}
|
|
166
67
|
export declare namespace CheckoutsessionCreateResponse {
|
|
68
|
+
interface LineItem {
|
|
69
|
+
/**
|
|
70
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
71
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
72
|
+
*/
|
|
73
|
+
amount: number;
|
|
74
|
+
/**
|
|
75
|
+
* Customer-facing name of the line item.
|
|
76
|
+
*/
|
|
77
|
+
name: string;
|
|
78
|
+
singleNet: number;
|
|
79
|
+
singleVat: number;
|
|
80
|
+
category?: '5045' | '5065' | '5094' | '5192' | '5193' | '5499' | '5655' | '5691' | '5712' | '5722' | '5812' | '5814' | '5912' | '5977' | '5999' | '7629';
|
|
81
|
+
co2Grams?: number;
|
|
82
|
+
EAN?: string;
|
|
83
|
+
/**
|
|
84
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
85
|
+
*/
|
|
86
|
+
image?: string;
|
|
87
|
+
/**
|
|
88
|
+
* Quantity of this lineItem.
|
|
89
|
+
*/
|
|
90
|
+
quantity?: number;
|
|
91
|
+
/**
|
|
92
|
+
* An internal unique id stored to this line item.
|
|
93
|
+
*/
|
|
94
|
+
referenceId?: string;
|
|
95
|
+
}
|
|
167
96
|
interface Merchant {
|
|
168
97
|
id: string;
|
|
169
98
|
appId: string;
|
|
@@ -173,276 +102,145 @@ export declare namespace CheckoutsessionCreateResponse {
|
|
|
173
102
|
namespace Merchant {
|
|
174
103
|
interface Address {
|
|
175
104
|
city: string;
|
|
176
|
-
/**
|
|
177
|
-
* The country code in
|
|
178
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
179
|
-
*/
|
|
180
105
|
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';
|
|
106
|
+
firstName: string;
|
|
107
|
+
lastName: string;
|
|
181
108
|
line1: string;
|
|
109
|
+
line2: string;
|
|
110
|
+
region: string;
|
|
182
111
|
zipCode: string;
|
|
183
|
-
firstName?: string;
|
|
184
|
-
lastName?: string;
|
|
185
|
-
line2?: string;
|
|
186
|
-
region?: string;
|
|
187
112
|
}
|
|
188
113
|
}
|
|
189
|
-
/**
|
|
190
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
191
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
192
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
193
|
-
* as this is the format accepted by most banks.
|
|
194
|
-
*/
|
|
195
114
|
interface Price {
|
|
196
115
|
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
197
|
-
/**
|
|
198
|
-
* The total amount to be paid.
|
|
199
|
-
*/
|
|
200
116
|
total: number;
|
|
201
117
|
shipping?: number;
|
|
202
118
|
subTotal?: number;
|
|
203
119
|
totalNet?: number;
|
|
204
120
|
vat?: number;
|
|
205
121
|
}
|
|
206
|
-
/**
|
|
207
|
-
* The billing address of the customer.
|
|
208
|
-
*/
|
|
209
122
|
interface BillingAddress {
|
|
210
123
|
city: string;
|
|
211
|
-
/**
|
|
212
|
-
* The country code in
|
|
213
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
214
|
-
*/
|
|
215
124
|
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';
|
|
125
|
+
firstName: string;
|
|
126
|
+
lastName: string;
|
|
216
127
|
line1: string;
|
|
128
|
+
line2: string;
|
|
129
|
+
region: string;
|
|
217
130
|
zipCode: string;
|
|
218
|
-
firstName?: string;
|
|
219
|
-
lastName?: string;
|
|
220
|
-
line2?: string;
|
|
221
|
-
region?: string;
|
|
222
131
|
}
|
|
223
132
|
interface Customer {
|
|
224
133
|
id: string;
|
|
225
134
|
}
|
|
226
|
-
interface LineItem {
|
|
227
|
-
/**
|
|
228
|
-
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
229
|
-
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
230
|
-
*/
|
|
231
|
-
amount: number;
|
|
232
|
-
/**
|
|
233
|
-
* The name of the line item.
|
|
234
|
-
*/
|
|
235
|
-
name: string;
|
|
236
|
-
/**
|
|
237
|
-
* The quantity of the line item.
|
|
238
|
-
*/
|
|
239
|
-
quantity: number;
|
|
240
|
-
/**
|
|
241
|
-
* The net amount of a single item.
|
|
242
|
-
*/
|
|
243
|
-
singleNet: number;
|
|
244
|
-
/**
|
|
245
|
-
* The VAT amount of a single item.
|
|
246
|
-
*/
|
|
247
|
-
singleVat: number;
|
|
248
|
-
/**
|
|
249
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
250
|
-
* the line item.
|
|
251
|
-
*/
|
|
252
|
-
category?: string;
|
|
253
|
-
/**
|
|
254
|
-
* The
|
|
255
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
256
|
-
* of the line item.
|
|
257
|
-
*/
|
|
258
|
-
EAN?: string;
|
|
259
|
-
/**
|
|
260
|
-
* The image of the line item as a URL.
|
|
261
|
-
*/
|
|
262
|
-
image?: string;
|
|
263
|
-
/**
|
|
264
|
-
* The internal unique identifier of the line item.
|
|
265
|
-
*/
|
|
266
|
-
referenceId?: string;
|
|
267
|
-
}
|
|
268
135
|
interface Mandate {
|
|
269
|
-
setup: boolean;
|
|
270
|
-
/**
|
|
271
|
-
* The name of the account holder who signs the mandate
|
|
272
|
-
*/
|
|
273
136
|
accountHolderName?: string;
|
|
137
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
274
138
|
referenceId?: string;
|
|
139
|
+
setup?: boolean;
|
|
275
140
|
userNotificationEmail?: string;
|
|
276
141
|
}
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
142
|
+
namespace Mandate {
|
|
143
|
+
interface AdditionalDisplayInformation {
|
|
144
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
145
|
+
price?: AdditionalDisplayInformation.Price;
|
|
146
|
+
}
|
|
147
|
+
namespace AdditionalDisplayInformation {
|
|
148
|
+
interface Price {
|
|
149
|
+
amount: number;
|
|
150
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
151
|
+
}
|
|
152
|
+
}
|
|
286
153
|
}
|
|
287
|
-
/**
|
|
288
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
289
|
-
* input within the Ivy express Checkout.
|
|
290
|
-
*/
|
|
291
154
|
interface Required {
|
|
292
|
-
/**
|
|
293
|
-
* If set to true, the phone number will be required input within the Ivy express
|
|
294
|
-
* Checkout.
|
|
295
|
-
*/
|
|
296
155
|
phone: boolean;
|
|
297
156
|
}
|
|
157
|
+
interface ShippingAddress {
|
|
158
|
+
city: string;
|
|
159
|
+
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';
|
|
160
|
+
firstName: string;
|
|
161
|
+
lastName: string;
|
|
162
|
+
line1: string;
|
|
163
|
+
line2: string;
|
|
164
|
+
region: string;
|
|
165
|
+
zipCode: string;
|
|
166
|
+
}
|
|
298
167
|
}
|
|
299
168
|
export interface CheckoutsessionRetrieveResponse {
|
|
300
|
-
/**
|
|
301
|
-
* The unique identifier of the Checkout within Ivy.
|
|
302
|
-
*/
|
|
303
169
|
id: string;
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
*/
|
|
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'>;
|
|
308
|
-
createdAt: string;
|
|
309
|
-
/**
|
|
310
|
-
* @deprecated Currently only visible in the merchant dashboard. This id used to be
|
|
311
|
-
* displayed to the user during the checkout.
|
|
312
|
-
*/
|
|
170
|
+
appId: string;
|
|
171
|
+
created: number;
|
|
313
172
|
displayId: string;
|
|
314
|
-
/**
|
|
315
|
-
* Required if not set in the dashboard. Users will be redirected here after an
|
|
316
|
-
* unsuccessful Payment attempt.
|
|
317
|
-
*/
|
|
318
173
|
errorCallbackUrl: string;
|
|
174
|
+
expiresAt: number;
|
|
175
|
+
lineItems: Array<CheckoutsessionRetrieveResponse.LineItem>;
|
|
319
176
|
merchant: CheckoutsessionRetrieveResponse.Merchant;
|
|
320
|
-
|
|
321
|
-
* - `settlement`: The payment is initially settled into a virtual account. The
|
|
322
|
-
* funds are then disbursed in batches to the merchant. Refunds are instantly
|
|
323
|
-
* processed from the virtual account.
|
|
324
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
325
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
326
|
-
*/
|
|
327
|
-
paymentMode: 'settlement' | 'direct';
|
|
328
|
-
/**
|
|
329
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
330
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
331
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
332
|
-
* as this is the format accepted by most banks.
|
|
333
|
-
*/
|
|
177
|
+
merchantAppId: string;
|
|
334
178
|
price: CheckoutsessionRetrieveResponse.Price;
|
|
335
179
|
redirectUrl: string;
|
|
336
|
-
/**
|
|
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.
|
|
340
|
-
*/
|
|
341
180
|
referenceId: string;
|
|
342
181
|
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
182
|
successCallbackUrl: string;
|
|
348
|
-
updatedAt: string;
|
|
349
183
|
abortReason?: string;
|
|
350
|
-
|
|
351
|
-
/**
|
|
352
|
-
* The billing address of the customer.
|
|
353
|
-
*/
|
|
184
|
+
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'>;
|
|
354
185
|
billingAddress?: CheckoutsessionRetrieveResponse.BillingAddress;
|
|
355
|
-
/**
|
|
356
|
-
* The merchant category code or
|
|
357
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
358
|
-
*/
|
|
359
186
|
category?: string;
|
|
360
|
-
/**
|
|
361
|
-
* Only applicable for express Checkouts. Complete Callback requests will be sent
|
|
362
|
-
* to this URL.
|
|
363
|
-
*/
|
|
364
187
|
completeCallbackUrl?: string;
|
|
365
|
-
|
|
366
|
-
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
367
|
-
* time of Checkout creation at Ivy.
|
|
368
|
-
*/
|
|
369
|
-
created?: number;
|
|
188
|
+
createdAt?: unknown;
|
|
370
189
|
customer?: CheckoutsessionRetrieveResponse.Customer;
|
|
371
|
-
/**
|
|
372
|
-
* False by default. If set to true, customers cannot modify the pre-selected bank
|
|
373
|
-
* from `prefill.bankId`.
|
|
374
|
-
*/
|
|
375
190
|
disableBankSelection?: boolean;
|
|
376
|
-
/**
|
|
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.
|
|
380
|
-
*/
|
|
381
|
-
expiresAt?: number;
|
|
382
|
-
/**
|
|
383
|
-
* False by default. If set to true, the Checkout is displayed in express mode.
|
|
384
|
-
*/
|
|
385
191
|
express?: boolean;
|
|
386
|
-
/**
|
|
387
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
388
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
389
|
-
*/
|
|
390
192
|
guest?: boolean;
|
|
391
|
-
/**
|
|
392
|
-
* If true, the order must be confirmed through the merchant with an additional
|
|
393
|
-
* complete callback endpoint. Always true for express sessions.
|
|
394
|
-
*/
|
|
395
193
|
handshake?: boolean;
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
*/
|
|
399
|
-
lineItems?: Array<CheckoutsessionRetrieveResponse.LineItem>;
|
|
400
|
-
/**
|
|
401
|
-
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
402
|
-
* given language. Users can change the language in the Checkout. If not provided,
|
|
403
|
-
* the language of the Checkout is determined by the browser's language.
|
|
404
|
-
*/
|
|
194
|
+
impactOffsetProjects?: Array<string>;
|
|
195
|
+
incentiveMode?: string;
|
|
405
196
|
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
406
197
|
mandate?: CheckoutsessionRetrieveResponse.Mandate;
|
|
407
|
-
/**
|
|
408
|
-
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
409
|
-
* located. If provided, the Checkout will display the market's banks first. Not
|
|
410
|
-
* relevant if `prefill.bankId` is provided.
|
|
411
|
-
*/
|
|
412
198
|
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;
|
|
417
|
-
/**
|
|
418
|
-
* Any data which will be stored and returned for this checkout session and
|
|
419
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
420
|
-
* more info.
|
|
421
|
-
*/
|
|
422
199
|
metadata?: Record<string, unknown>;
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
prefill?:
|
|
428
|
-
/**
|
|
429
|
-
* Only applicable for express Checkouts. Quote Callback requests will be sent to
|
|
430
|
-
* this URL.
|
|
431
|
-
*/
|
|
200
|
+
offsetProject?: string;
|
|
201
|
+
paymentMode?: 'direct' | 'settlement';
|
|
202
|
+
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
203
|
+
plugin?: string;
|
|
204
|
+
prefill?: unknown;
|
|
432
205
|
quoteCallbackUrl?: string;
|
|
433
|
-
/**
|
|
434
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
435
|
-
* input within the Ivy express Checkout.
|
|
436
|
-
*/
|
|
437
206
|
required?: CheckoutsessionRetrieveResponse.Required;
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
207
|
+
selectedShippingMethodId?: string;
|
|
208
|
+
shippingAddress?: CheckoutsessionRetrieveResponse.ShippingAddress;
|
|
209
|
+
shippingMethods?: Array<unknown>;
|
|
441
210
|
shopLogo?: string;
|
|
442
211
|
shopName?: string;
|
|
443
212
|
subaccountId?: string;
|
|
213
|
+
updatedAt?: unknown;
|
|
444
214
|
}
|
|
445
215
|
export declare namespace CheckoutsessionRetrieveResponse {
|
|
216
|
+
interface LineItem {
|
|
217
|
+
/**
|
|
218
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
219
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
220
|
+
*/
|
|
221
|
+
amount: number;
|
|
222
|
+
/**
|
|
223
|
+
* Customer-facing name of the line item.
|
|
224
|
+
*/
|
|
225
|
+
name: string;
|
|
226
|
+
singleNet: number;
|
|
227
|
+
singleVat: number;
|
|
228
|
+
category?: '5045' | '5065' | '5094' | '5192' | '5193' | '5499' | '5655' | '5691' | '5712' | '5722' | '5812' | '5814' | '5912' | '5977' | '5999' | '7629';
|
|
229
|
+
co2Grams?: number;
|
|
230
|
+
EAN?: string;
|
|
231
|
+
/**
|
|
232
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
233
|
+
*/
|
|
234
|
+
image?: string;
|
|
235
|
+
/**
|
|
236
|
+
* Quantity of this lineItem.
|
|
237
|
+
*/
|
|
238
|
+
quantity?: number;
|
|
239
|
+
/**
|
|
240
|
+
* An internal unique id stored to this line item.
|
|
241
|
+
*/
|
|
242
|
+
referenceId?: string;
|
|
243
|
+
}
|
|
446
244
|
interface Merchant {
|
|
447
245
|
id: string;
|
|
448
246
|
appId: string;
|
|
@@ -452,276 +250,145 @@ export declare namespace CheckoutsessionRetrieveResponse {
|
|
|
452
250
|
namespace Merchant {
|
|
453
251
|
interface Address {
|
|
454
252
|
city: string;
|
|
455
|
-
/**
|
|
456
|
-
* The country code in
|
|
457
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
458
|
-
*/
|
|
459
253
|
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';
|
|
254
|
+
firstName: string;
|
|
255
|
+
lastName: string;
|
|
460
256
|
line1: string;
|
|
257
|
+
line2: string;
|
|
258
|
+
region: string;
|
|
461
259
|
zipCode: string;
|
|
462
|
-
firstName?: string;
|
|
463
|
-
lastName?: string;
|
|
464
|
-
line2?: string;
|
|
465
|
-
region?: string;
|
|
466
260
|
}
|
|
467
261
|
}
|
|
468
|
-
/**
|
|
469
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
470
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
471
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
472
|
-
* as this is the format accepted by most banks.
|
|
473
|
-
*/
|
|
474
262
|
interface Price {
|
|
475
263
|
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
476
|
-
/**
|
|
477
|
-
* The total amount to be paid.
|
|
478
|
-
*/
|
|
479
264
|
total: number;
|
|
480
265
|
shipping?: number;
|
|
481
266
|
subTotal?: number;
|
|
482
267
|
totalNet?: number;
|
|
483
268
|
vat?: number;
|
|
484
269
|
}
|
|
485
|
-
/**
|
|
486
|
-
* The billing address of the customer.
|
|
487
|
-
*/
|
|
488
270
|
interface BillingAddress {
|
|
489
271
|
city: string;
|
|
490
|
-
/**
|
|
491
|
-
* The country code in
|
|
492
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
493
|
-
*/
|
|
494
272
|
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';
|
|
273
|
+
firstName: string;
|
|
274
|
+
lastName: string;
|
|
495
275
|
line1: string;
|
|
276
|
+
line2: string;
|
|
277
|
+
region: string;
|
|
496
278
|
zipCode: string;
|
|
497
|
-
firstName?: string;
|
|
498
|
-
lastName?: string;
|
|
499
|
-
line2?: string;
|
|
500
|
-
region?: string;
|
|
501
279
|
}
|
|
502
280
|
interface Customer {
|
|
503
281
|
id: string;
|
|
504
282
|
}
|
|
505
|
-
interface LineItem {
|
|
506
|
-
/**
|
|
507
|
-
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
508
|
-
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
509
|
-
*/
|
|
510
|
-
amount: number;
|
|
511
|
-
/**
|
|
512
|
-
* The name of the line item.
|
|
513
|
-
*/
|
|
514
|
-
name: string;
|
|
515
|
-
/**
|
|
516
|
-
* The quantity of the line item.
|
|
517
|
-
*/
|
|
518
|
-
quantity: number;
|
|
519
|
-
/**
|
|
520
|
-
* The net amount of a single item.
|
|
521
|
-
*/
|
|
522
|
-
singleNet: number;
|
|
523
|
-
/**
|
|
524
|
-
* The VAT amount of a single item.
|
|
525
|
-
*/
|
|
526
|
-
singleVat: number;
|
|
527
|
-
/**
|
|
528
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
529
|
-
* the line item.
|
|
530
|
-
*/
|
|
531
|
-
category?: string;
|
|
532
|
-
/**
|
|
533
|
-
* The
|
|
534
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
535
|
-
* of the line item.
|
|
536
|
-
*/
|
|
537
|
-
EAN?: string;
|
|
538
|
-
/**
|
|
539
|
-
* The image of the line item as a URL.
|
|
540
|
-
*/
|
|
541
|
-
image?: string;
|
|
542
|
-
/**
|
|
543
|
-
* The internal unique identifier of the line item.
|
|
544
|
-
*/
|
|
545
|
-
referenceId?: string;
|
|
546
|
-
}
|
|
547
283
|
interface Mandate {
|
|
548
|
-
setup: boolean;
|
|
549
|
-
/**
|
|
550
|
-
* The name of the account holder who signs the mandate
|
|
551
|
-
*/
|
|
552
284
|
accountHolderName?: string;
|
|
285
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
553
286
|
referenceId?: string;
|
|
287
|
+
setup?: boolean;
|
|
554
288
|
userNotificationEmail?: string;
|
|
555
289
|
}
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
290
|
+
namespace Mandate {
|
|
291
|
+
interface AdditionalDisplayInformation {
|
|
292
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
293
|
+
price?: AdditionalDisplayInformation.Price;
|
|
294
|
+
}
|
|
295
|
+
namespace AdditionalDisplayInformation {
|
|
296
|
+
interface Price {
|
|
297
|
+
amount: number;
|
|
298
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
299
|
+
}
|
|
300
|
+
}
|
|
565
301
|
}
|
|
566
|
-
/**
|
|
567
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
568
|
-
* input within the Ivy express Checkout.
|
|
569
|
-
*/
|
|
570
302
|
interface Required {
|
|
571
|
-
/**
|
|
572
|
-
* If set to true, the phone number will be required input within the Ivy express
|
|
573
|
-
* Checkout.
|
|
574
|
-
*/
|
|
575
303
|
phone: boolean;
|
|
576
304
|
}
|
|
305
|
+
interface ShippingAddress {
|
|
306
|
+
city: string;
|
|
307
|
+
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';
|
|
308
|
+
firstName: string;
|
|
309
|
+
lastName: string;
|
|
310
|
+
line1: string;
|
|
311
|
+
line2: string;
|
|
312
|
+
region: string;
|
|
313
|
+
zipCode: string;
|
|
314
|
+
}
|
|
577
315
|
}
|
|
578
316
|
export interface CheckoutsessionExpireResponse {
|
|
579
|
-
/**
|
|
580
|
-
* The unique identifier of the Checkout within Ivy.
|
|
581
|
-
*/
|
|
582
317
|
id: string;
|
|
583
|
-
|
|
584
|
-
|
|
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
|
-
*/
|
|
318
|
+
appId: string;
|
|
319
|
+
created: number;
|
|
592
320
|
displayId: string;
|
|
593
|
-
/**
|
|
594
|
-
* Required if not set in the dashboard. Users will be redirected here after an
|
|
595
|
-
* unsuccessful Payment attempt.
|
|
596
|
-
*/
|
|
597
321
|
errorCallbackUrl: string;
|
|
322
|
+
expiresAt: number;
|
|
323
|
+
lineItems: Array<CheckoutsessionExpireResponse.LineItem>;
|
|
598
324
|
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
|
-
*/
|
|
325
|
+
merchantAppId: string;
|
|
613
326
|
price: CheckoutsessionExpireResponse.Price;
|
|
614
327
|
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
328
|
referenceId: string;
|
|
621
329
|
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
330
|
successCallbackUrl: string;
|
|
627
|
-
updatedAt: string;
|
|
628
331
|
abortReason?: string;
|
|
629
|
-
|
|
630
|
-
/**
|
|
631
|
-
* The billing address of the customer.
|
|
632
|
-
*/
|
|
332
|
+
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'>;
|
|
633
333
|
billingAddress?: CheckoutsessionExpireResponse.BillingAddress;
|
|
634
|
-
/**
|
|
635
|
-
* The merchant category code or
|
|
636
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
637
|
-
*/
|
|
638
334
|
category?: string;
|
|
639
|
-
/**
|
|
640
|
-
* Only applicable for express Checkouts. Complete Callback requests will be sent
|
|
641
|
-
* to this URL.
|
|
642
|
-
*/
|
|
643
335
|
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;
|
|
336
|
+
createdAt?: unknown;
|
|
649
337
|
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
338
|
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
339
|
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
340
|
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
341
|
handshake?: boolean;
|
|
675
|
-
|
|
676
|
-
|
|
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
|
-
*/
|
|
342
|
+
impactOffsetProjects?: Array<string>;
|
|
343
|
+
incentiveMode?: string;
|
|
684
344
|
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
685
345
|
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
346
|
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
347
|
metadata?: Record<string, unknown>;
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
prefill?:
|
|
707
|
-
/**
|
|
708
|
-
* Only applicable for express Checkouts. Quote Callback requests will be sent to
|
|
709
|
-
* this URL.
|
|
710
|
-
*/
|
|
348
|
+
offsetProject?: string;
|
|
349
|
+
paymentMode?: 'direct' | 'settlement';
|
|
350
|
+
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
351
|
+
plugin?: string;
|
|
352
|
+
prefill?: unknown;
|
|
711
353
|
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
354
|
required?: CheckoutsessionExpireResponse.Required;
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
355
|
+
selectedShippingMethodId?: string;
|
|
356
|
+
shippingAddress?: CheckoutsessionExpireResponse.ShippingAddress;
|
|
357
|
+
shippingMethods?: Array<unknown>;
|
|
720
358
|
shopLogo?: string;
|
|
721
359
|
shopName?: string;
|
|
722
360
|
subaccountId?: string;
|
|
361
|
+
updatedAt?: unknown;
|
|
723
362
|
}
|
|
724
363
|
export declare namespace CheckoutsessionExpireResponse {
|
|
364
|
+
interface LineItem {
|
|
365
|
+
/**
|
|
366
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
367
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
368
|
+
*/
|
|
369
|
+
amount: number;
|
|
370
|
+
/**
|
|
371
|
+
* Customer-facing name of the line item.
|
|
372
|
+
*/
|
|
373
|
+
name: string;
|
|
374
|
+
singleNet: number;
|
|
375
|
+
singleVat: number;
|
|
376
|
+
category?: '5045' | '5065' | '5094' | '5192' | '5193' | '5499' | '5655' | '5691' | '5712' | '5722' | '5812' | '5814' | '5912' | '5977' | '5999' | '7629';
|
|
377
|
+
co2Grams?: number;
|
|
378
|
+
EAN?: string;
|
|
379
|
+
/**
|
|
380
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
381
|
+
*/
|
|
382
|
+
image?: string;
|
|
383
|
+
/**
|
|
384
|
+
* Quantity of this lineItem.
|
|
385
|
+
*/
|
|
386
|
+
quantity?: number;
|
|
387
|
+
/**
|
|
388
|
+
* An internal unique id stored to this line item.
|
|
389
|
+
*/
|
|
390
|
+
referenceId?: string;
|
|
391
|
+
}
|
|
725
392
|
interface Merchant {
|
|
726
393
|
id: string;
|
|
727
394
|
appId: string;
|
|
@@ -731,142 +398,77 @@ export declare namespace CheckoutsessionExpireResponse {
|
|
|
731
398
|
namespace Merchant {
|
|
732
399
|
interface Address {
|
|
733
400
|
city: string;
|
|
734
|
-
/**
|
|
735
|
-
* The country code in
|
|
736
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
737
|
-
*/
|
|
738
401
|
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';
|
|
402
|
+
firstName: string;
|
|
403
|
+
lastName: string;
|
|
739
404
|
line1: string;
|
|
405
|
+
line2: string;
|
|
406
|
+
region: string;
|
|
740
407
|
zipCode: string;
|
|
741
|
-
firstName?: string;
|
|
742
|
-
lastName?: string;
|
|
743
|
-
line2?: string;
|
|
744
|
-
region?: string;
|
|
745
408
|
}
|
|
746
409
|
}
|
|
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
410
|
interface Price {
|
|
754
411
|
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
755
|
-
/**
|
|
756
|
-
* The total amount to be paid.
|
|
757
|
-
*/
|
|
758
412
|
total: number;
|
|
759
413
|
shipping?: number;
|
|
760
414
|
subTotal?: number;
|
|
761
415
|
totalNet?: number;
|
|
762
416
|
vat?: number;
|
|
763
417
|
}
|
|
764
|
-
/**
|
|
765
|
-
* The billing address of the customer.
|
|
766
|
-
*/
|
|
767
418
|
interface BillingAddress {
|
|
768
419
|
city: string;
|
|
769
|
-
/**
|
|
770
|
-
* The country code in
|
|
771
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
772
|
-
*/
|
|
773
420
|
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';
|
|
421
|
+
firstName: string;
|
|
422
|
+
lastName: string;
|
|
774
423
|
line1: string;
|
|
424
|
+
line2: string;
|
|
425
|
+
region: string;
|
|
775
426
|
zipCode: string;
|
|
776
|
-
firstName?: string;
|
|
777
|
-
lastName?: string;
|
|
778
|
-
line2?: string;
|
|
779
|
-
region?: string;
|
|
780
427
|
}
|
|
781
428
|
interface Customer {
|
|
782
429
|
id: string;
|
|
783
430
|
}
|
|
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;
|
|
790
|
-
/**
|
|
791
|
-
* The name of the line item.
|
|
792
|
-
*/
|
|
793
|
-
name: string;
|
|
794
|
-
/**
|
|
795
|
-
* The quantity of the line item.
|
|
796
|
-
*/
|
|
797
|
-
quantity: number;
|
|
798
|
-
/**
|
|
799
|
-
* The net amount of a single item.
|
|
800
|
-
*/
|
|
801
|
-
singleNet: number;
|
|
802
|
-
/**
|
|
803
|
-
* The VAT amount of a single item.
|
|
804
|
-
*/
|
|
805
|
-
singleVat: number;
|
|
806
|
-
/**
|
|
807
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
808
|
-
* the line item.
|
|
809
|
-
*/
|
|
810
|
-
category?: string;
|
|
811
|
-
/**
|
|
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.
|
|
815
|
-
*/
|
|
816
|
-
EAN?: string;
|
|
817
|
-
/**
|
|
818
|
-
* The image of the line item as a URL.
|
|
819
|
-
*/
|
|
820
|
-
image?: string;
|
|
821
|
-
/**
|
|
822
|
-
* The internal unique identifier of the line item.
|
|
823
|
-
*/
|
|
824
|
-
referenceId?: string;
|
|
825
|
-
}
|
|
826
431
|
interface Mandate {
|
|
827
|
-
setup: boolean;
|
|
828
|
-
/**
|
|
829
|
-
* The name of the account holder who signs the mandate
|
|
830
|
-
*/
|
|
831
432
|
accountHolderName?: string;
|
|
433
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
832
434
|
referenceId?: string;
|
|
435
|
+
setup?: boolean;
|
|
833
436
|
userNotificationEmail?: string;
|
|
834
437
|
}
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
438
|
+
namespace Mandate {
|
|
439
|
+
interface AdditionalDisplayInformation {
|
|
440
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
441
|
+
price?: AdditionalDisplayInformation.Price;
|
|
442
|
+
}
|
|
443
|
+
namespace AdditionalDisplayInformation {
|
|
444
|
+
interface Price {
|
|
445
|
+
amount: number;
|
|
446
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
447
|
+
}
|
|
448
|
+
}
|
|
844
449
|
}
|
|
845
|
-
/**
|
|
846
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
847
|
-
* input within the Ivy express Checkout.
|
|
848
|
-
*/
|
|
849
450
|
interface Required {
|
|
850
|
-
/**
|
|
851
|
-
* If set to true, the phone number will be required input within the Ivy express
|
|
852
|
-
* Checkout.
|
|
853
|
-
*/
|
|
854
451
|
phone: boolean;
|
|
855
452
|
}
|
|
453
|
+
interface ShippingAddress {
|
|
454
|
+
city: string;
|
|
455
|
+
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';
|
|
456
|
+
firstName: string;
|
|
457
|
+
lastName: string;
|
|
458
|
+
line1: string;
|
|
459
|
+
line2: string;
|
|
460
|
+
region: string;
|
|
461
|
+
zipCode: string;
|
|
462
|
+
}
|
|
856
463
|
}
|
|
857
464
|
export interface CheckoutsessionCreateParams {
|
|
858
465
|
/**
|
|
859
|
-
*
|
|
860
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
861
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
862
|
-
* as this is the format accepted by most banks.
|
|
466
|
+
* Price of the checkout session
|
|
863
467
|
*/
|
|
864
468
|
price: CheckoutsessionCreateParams.Price;
|
|
865
469
|
/**
|
|
866
|
-
* An internal reference id which will be stored with the
|
|
867
|
-
*
|
|
868
|
-
* characters. We recommend to use your internal unique id for this customer's
|
|
869
|
-
* payment process.
|
|
470
|
+
* An internal reference id which will be stored with the order. Needs to be unique
|
|
471
|
+
* per shop and can be up to 200 characters.
|
|
870
472
|
*/
|
|
871
473
|
referenceId: string;
|
|
872
474
|
/**
|
|
@@ -874,133 +476,83 @@ export interface CheckoutsessionCreateParams {
|
|
|
874
476
|
*/
|
|
875
477
|
billingAddress?: CheckoutsessionCreateParams.BillingAddress;
|
|
876
478
|
/**
|
|
877
|
-
*
|
|
878
|
-
* will be sent to this URL.
|
|
479
|
+
* Complete Callback requests will be sent to this URL on default.
|
|
879
480
|
*/
|
|
880
481
|
completeCallbackUrl?: string;
|
|
881
482
|
/**
|
|
882
|
-
*
|
|
883
|
-
*
|
|
483
|
+
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
484
|
+
* time of api CheckoutSession creation at Ivy.
|
|
884
485
|
*/
|
|
885
486
|
created?: number;
|
|
487
|
+
customer?: CheckoutsessionCreateParams.Customer;
|
|
886
488
|
/**
|
|
887
|
-
*
|
|
888
|
-
|
|
889
|
-
customer?: CheckoutsessionCreateParams.Email | CheckoutsessionCreateParams.ID;
|
|
890
|
-
/**
|
|
891
|
-
* False by default. If set to true, customers cannot choose another bank than the
|
|
892
|
-
* pre-selected one.
|
|
489
|
+
* Disable bank selection mode. If set to true, customers cannot modify the pre
|
|
490
|
+
* selected bank.
|
|
893
491
|
*/
|
|
894
492
|
disableBankSelection?: boolean;
|
|
895
493
|
/**
|
|
896
|
-
*
|
|
897
|
-
*
|
|
494
|
+
* The order id which will be displayed to the user and in the merchant dashboard.
|
|
495
|
+
* At most 200 characters are allowed.
|
|
898
496
|
*/
|
|
899
497
|
displayId?: string;
|
|
900
498
|
/**
|
|
901
|
-
*
|
|
902
|
-
* unsuccessful payment attempt.
|
|
499
|
+
* Users will be redirected here on default after an unsuccessful checkout.
|
|
903
500
|
*/
|
|
904
501
|
errorCallbackUrl?: string;
|
|
905
502
|
/**
|
|
906
503
|
* The Epoch time in seconds at which the Checkout Session will expire. It can be
|
|
907
|
-
* anywhere from
|
|
908
|
-
* this value is 1 hour from creation.
|
|
504
|
+
* anywhere from 30 minutes to 24 hours after Checkout Session creation. By
|
|
505
|
+
* default, this value is 1 hour from creation.
|
|
909
506
|
*/
|
|
910
507
|
expiresAt?: number;
|
|
911
508
|
/**
|
|
912
|
-
*
|
|
913
|
-
* an express checkout session.
|
|
509
|
+
* Sets the checkout to a express version
|
|
914
510
|
*/
|
|
915
511
|
express?: boolean;
|
|
916
512
|
/**
|
|
917
|
-
*
|
|
513
|
+
* All line items of this checkout session. At least one line item required
|
|
918
514
|
*/
|
|
919
515
|
lineItems?: Array<CheckoutsessionCreateParams.LineItem>;
|
|
920
|
-
/**
|
|
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.
|
|
924
|
-
*/
|
|
925
516
|
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
926
|
-
/**
|
|
927
|
-
* The mandate setup for the payment. Relevant for
|
|
928
|
-
* [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
|
|
929
|
-
*/
|
|
930
517
|
mandate?: CheckoutsessionCreateParams.Mandate;
|
|
931
518
|
/**
|
|
932
|
-
*
|
|
933
|
-
*
|
|
934
|
-
* `prefill.bankId` is provided.
|
|
519
|
+
* The market of the checkoutSession. Will show the market banks connected with
|
|
520
|
+
* this market
|
|
935
521
|
*/
|
|
936
522
|
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';
|
|
937
523
|
/**
|
|
938
524
|
* Any data which will be stored and returned for this checkout session and
|
|
939
|
-
* corresponding order
|
|
940
|
-
* more info.
|
|
525
|
+
* corresponding order
|
|
941
526
|
*/
|
|
942
|
-
metadata?:
|
|
943
|
-
/**
|
|
944
|
-
* - `settlement`: The payment is initially settled into a virtual account. The
|
|
945
|
-
* funds are then disbursed in batches to the merchant. Refunds are instantly
|
|
946
|
-
* processed from the virtual account.
|
|
947
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
948
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
949
|
-
*/
|
|
950
|
-
paymentMode?: 'settlement' | 'direct';
|
|
527
|
+
metadata?: Record<string, unknown>;
|
|
951
528
|
/**
|
|
952
|
-
* The
|
|
953
|
-
*
|
|
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.
|
|
529
|
+
* The mode in which the payment should be processed. If direct is used, you need
|
|
530
|
+
* to provide a settlementDestination
|
|
958
531
|
*/
|
|
532
|
+
paymentMode?: 'direct' | 'settlement';
|
|
959
533
|
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
960
534
|
/**
|
|
961
|
-
*
|
|
535
|
+
* The values specified here will be pre-filled in the Ivy Checkout.
|
|
962
536
|
*/
|
|
963
537
|
prefill?: CheckoutsessionCreateParams.Prefill;
|
|
964
538
|
/**
|
|
965
|
-
*
|
|
966
|
-
* be sent to this URL.
|
|
539
|
+
* Quote Callback requests will be sent to this URL on default.
|
|
967
540
|
*/
|
|
968
541
|
quoteCallbackUrl?: string;
|
|
969
|
-
/**
|
|
970
|
-
* The settlement destination of the payment. If not provided, the financial
|
|
971
|
-
* address of the merchant's direct payout destination will be used with a randomly
|
|
972
|
-
* generated payment reference.
|
|
973
|
-
*/
|
|
974
542
|
settlementDestination?: CheckoutsessionCreateParams.SettlementDestination;
|
|
975
|
-
/**
|
|
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)
|
|
979
|
-
*/
|
|
980
543
|
subaccountId?: string;
|
|
981
544
|
/**
|
|
982
|
-
*
|
|
983
|
-
* successful payment attempt.
|
|
545
|
+
* Users will be redirected here on default after a successful checkout.
|
|
984
546
|
*/
|
|
985
547
|
successCallbackUrl?: string;
|
|
986
|
-
/**
|
|
987
|
-
* The theme variant which will be used in checkout. If not provided, the default
|
|
988
|
-
* light theme will be used.
|
|
989
|
-
*/
|
|
990
548
|
themeVariant?: 'light' | 'dark';
|
|
991
549
|
}
|
|
992
550
|
export declare namespace CheckoutsessionCreateParams {
|
|
993
551
|
/**
|
|
994
|
-
*
|
|
995
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
996
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
997
|
-
* as this is the format accepted by most banks.
|
|
552
|
+
* Price of the checkout session
|
|
998
553
|
*/
|
|
999
554
|
interface Price {
|
|
1000
555
|
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
1001
|
-
/**
|
|
1002
|
-
* The total amount to be paid.
|
|
1003
|
-
*/
|
|
1004
556
|
total: number;
|
|
1005
557
|
shipping?: number;
|
|
1006
558
|
subTotal?: number;
|
|
@@ -1012,165 +564,114 @@ export declare namespace CheckoutsessionCreateParams {
|
|
|
1012
564
|
*/
|
|
1013
565
|
interface BillingAddress {
|
|
1014
566
|
city: string;
|
|
1015
|
-
/**
|
|
1016
|
-
* The country code in
|
|
1017
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1018
|
-
*/
|
|
1019
567
|
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';
|
|
568
|
+
firstName: string;
|
|
569
|
+
lastName: string;
|
|
1020
570
|
line1: string;
|
|
571
|
+
line2: string;
|
|
572
|
+
region: string;
|
|
1021
573
|
zipCode: string;
|
|
1022
|
-
firstName?: string;
|
|
1023
|
-
lastName?: string;
|
|
1024
|
-
line2?: string;
|
|
1025
|
-
region?: string;
|
|
1026
574
|
}
|
|
1027
|
-
interface
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
*/
|
|
1031
|
-
email: string;
|
|
1032
|
-
}
|
|
1033
|
-
interface ID {
|
|
1034
|
-
/**
|
|
1035
|
-
* The Ivy id of the customer.
|
|
1036
|
-
*/
|
|
1037
|
-
id: string;
|
|
575
|
+
interface Customer {
|
|
576
|
+
id?: string;
|
|
577
|
+
email?: string;
|
|
1038
578
|
}
|
|
1039
579
|
interface LineItem {
|
|
1040
580
|
/**
|
|
1041
|
-
*
|
|
1042
|
-
*
|
|
581
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
582
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
1043
583
|
*/
|
|
1044
584
|
amount: number;
|
|
1045
585
|
/**
|
|
1046
|
-
*
|
|
586
|
+
* Customer-facing name of the line item.
|
|
1047
587
|
*/
|
|
1048
588
|
name: string;
|
|
1049
|
-
/**
|
|
1050
|
-
* The quantity of the line item.
|
|
1051
|
-
*/
|
|
1052
|
-
quantity: number;
|
|
1053
|
-
/**
|
|
1054
|
-
* The net amount of a single item.
|
|
1055
|
-
*/
|
|
1056
589
|
singleNet: number;
|
|
1057
|
-
/**
|
|
1058
|
-
* The VAT amount of a single item.
|
|
1059
|
-
*/
|
|
1060
590
|
singleVat: number;
|
|
1061
|
-
|
|
1062
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
1063
|
-
* the line item.
|
|
1064
|
-
*/
|
|
1065
|
-
category?: string;
|
|
1066
|
-
/**
|
|
1067
|
-
* The
|
|
1068
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
1069
|
-
* of the line item.
|
|
1070
|
-
*/
|
|
591
|
+
category?: '5045' | '5065' | '5094' | '5192' | '5193' | '5499' | '5655' | '5691' | '5712' | '5722' | '5812' | '5814' | '5912' | '5977' | '5999' | '7629';
|
|
1071
592
|
EAN?: string;
|
|
1072
593
|
/**
|
|
1073
|
-
*
|
|
594
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
1074
595
|
*/
|
|
1075
596
|
image?: string;
|
|
1076
597
|
/**
|
|
1077
|
-
*
|
|
598
|
+
* Quantity of this lineItem.
|
|
599
|
+
*/
|
|
600
|
+
quantity?: number;
|
|
601
|
+
/**
|
|
602
|
+
* An internal unique id stored to this line item.
|
|
1078
603
|
*/
|
|
1079
604
|
referenceId?: string;
|
|
1080
605
|
}
|
|
1081
|
-
/**
|
|
1082
|
-
* The mandate setup for the payment. Relevant for
|
|
1083
|
-
* [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
|
|
1084
|
-
*/
|
|
1085
606
|
interface Mandate {
|
|
1086
|
-
setup: boolean;
|
|
1087
|
-
/**
|
|
1088
|
-
* The name of the account holder who signs the mandate
|
|
1089
|
-
*/
|
|
1090
607
|
accountHolderName?: string;
|
|
608
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
1091
609
|
referenceId?: string;
|
|
610
|
+
setup?: boolean;
|
|
1092
611
|
userNotificationEmail?: string;
|
|
1093
612
|
}
|
|
613
|
+
namespace Mandate {
|
|
614
|
+
interface AdditionalDisplayInformation {
|
|
615
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
616
|
+
price?: AdditionalDisplayInformation.Price;
|
|
617
|
+
}
|
|
618
|
+
namespace AdditionalDisplayInformation {
|
|
619
|
+
interface Price {
|
|
620
|
+
amount: number;
|
|
621
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
622
|
+
}
|
|
623
|
+
}
|
|
624
|
+
}
|
|
1094
625
|
/**
|
|
1095
|
-
*
|
|
626
|
+
* The values specified here will be pre-filled in the Ivy Checkout.
|
|
1096
627
|
*/
|
|
1097
628
|
interface Prefill {
|
|
1098
629
|
/**
|
|
1099
|
-
*
|
|
1100
|
-
* bank
|
|
630
|
+
* Retrieve a valid bankId with the POST /banks/search endpoint. When presented in
|
|
631
|
+
* this field, the customer will skip the bank selection in the Ivy Checkout.
|
|
1101
632
|
*/
|
|
1102
633
|
bankId?: string;
|
|
1103
634
|
}
|
|
1104
|
-
/**
|
|
1105
|
-
* The settlement destination of the payment. If not provided, the financial
|
|
1106
|
-
* address of the merchant's direct payout destination will be used with a randomly
|
|
1107
|
-
* generated payment reference.
|
|
1108
|
-
*/
|
|
1109
635
|
interface SettlementDestination {
|
|
1110
|
-
/**
|
|
1111
|
-
* The payment reference of the payment. This will be displayed in the receiving
|
|
1112
|
-
* bank account statement. For GBP payments the reference can be up to 18
|
|
1113
|
-
* characters, otherwise 35.
|
|
1114
|
-
*/
|
|
1115
636
|
reference: string;
|
|
1116
|
-
/**
|
|
1117
|
-
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
1118
|
-
* to "iban", the "iban" object must be filled out.
|
|
1119
|
-
*/
|
|
1120
637
|
financialAddress?: SettlementDestination.FinancialAddress;
|
|
1121
638
|
}
|
|
1122
639
|
namespace SettlementDestination {
|
|
1123
|
-
/**
|
|
1124
|
-
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
1125
|
-
* to "iban", the "iban" object must be filled out.
|
|
1126
|
-
*/
|
|
1127
640
|
interface FinancialAddress {
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
1131
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
1132
|
-
* in the "iban" object.
|
|
1133
|
-
*
|
|
1134
|
-
* - iban: The IBAN of the account
|
|
1135
|
-
* - sort_code: The sort code of the account
|
|
1136
|
-
* - bank_code: The bank code of the account
|
|
1137
|
-
* - bban: The BBAN of the account
|
|
1138
|
-
*/
|
|
1139
|
-
type: string;
|
|
641
|
+
psuData: FinancialAddress.PsuData | null;
|
|
642
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
1140
643
|
bankCode?: FinancialAddress.BankCode;
|
|
1141
644
|
bban?: FinancialAddress.Bban;
|
|
1142
645
|
iban?: FinancialAddress.Iban;
|
|
646
|
+
paymentReference?: string;
|
|
1143
647
|
sortCode?: FinancialAddress.SortCode;
|
|
1144
648
|
}
|
|
1145
649
|
namespace FinancialAddress {
|
|
650
|
+
interface PsuData {
|
|
651
|
+
branchNumber?: string;
|
|
652
|
+
clientId?: string;
|
|
653
|
+
ipAddress?: string;
|
|
654
|
+
oib?: string;
|
|
655
|
+
psuId?: string;
|
|
656
|
+
ssn?: string;
|
|
657
|
+
username?: string;
|
|
658
|
+
}
|
|
1146
659
|
interface BankCode {
|
|
1147
|
-
/**
|
|
1148
|
-
* The name of the account holder.
|
|
1149
|
-
*/
|
|
1150
660
|
accountHolderName: string;
|
|
1151
661
|
accountNumber: string;
|
|
1152
662
|
code: string;
|
|
1153
663
|
}
|
|
1154
664
|
interface Bban {
|
|
1155
|
-
/**
|
|
1156
|
-
* The name of the account holder.
|
|
1157
|
-
*/
|
|
1158
665
|
accountHolderName: string;
|
|
1159
666
|
bban: string;
|
|
1160
667
|
bic?: string;
|
|
1161
668
|
}
|
|
1162
669
|
interface Iban {
|
|
1163
|
-
/**
|
|
1164
|
-
* The name of the account holder.
|
|
1165
|
-
*/
|
|
1166
670
|
accountHolderName: string;
|
|
1167
671
|
iban: string;
|
|
1168
672
|
bic?: string;
|
|
1169
673
|
}
|
|
1170
674
|
interface SortCode {
|
|
1171
|
-
/**
|
|
1172
|
-
* The name of the account holder.
|
|
1173
|
-
*/
|
|
1174
675
|
accountHolderName: string;
|
|
1175
676
|
accountNumber: string;
|
|
1176
677
|
sortCode: string;
|
|
@@ -1179,9 +680,16 @@ export declare namespace CheckoutsessionCreateParams {
|
|
|
1179
680
|
}
|
|
1180
681
|
}
|
|
1181
682
|
export interface CheckoutsessionRetrieveParams {
|
|
683
|
+
/**
|
|
684
|
+
* The checkout session id to retrieve details for
|
|
685
|
+
*/
|
|
1182
686
|
id: string;
|
|
1183
687
|
}
|
|
1184
688
|
export interface CheckoutsessionExpireParams {
|
|
689
|
+
/**
|
|
690
|
+
* The checkout session id to expire. By expiring a Checkout Session, users will
|
|
691
|
+
* not be able to access this Checkout Session anymore.
|
|
692
|
+
*/
|
|
1185
693
|
id: string;
|
|
1186
694
|
}
|
|
1187
695
|
export declare namespace Checkoutsession {
|