@getivy/node-sdk 0.1.0-alpha.9 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +334 -0
- package/README.md +16 -26
- package/_shims/index.d.ts +2 -0
- package/_shims/index.js +5 -1
- package/_shims/index.mjs +5 -1
- package/core.d.ts +19 -5
- package/core.d.ts.map +1 -1
- package/core.js +25 -15
- package/core.js.map +1 -1
- package/core.mjs +26 -16
- package/core.mjs.map +1 -1
- package/index.d.mts +36 -18
- package/index.d.ts +36 -18
- package/index.d.ts.map +1 -1
- package/index.js +27 -8
- package/index.js.map +1 -1
- package/index.mjs +27 -8
- package/index.mjs.map +1 -1
- package/package.json +11 -33
- package/resource.d.ts +1 -1
- package/resource.d.ts.map +1 -1
- package/resource.js.map +1 -1
- package/resource.mjs.map +1 -1
- package/resources/balance.d.ts +8 -5
- package/resources/balance.d.ts.map +1 -1
- package/resources/banks.d.ts +82 -67
- package/resources/banks.d.ts.map +1 -1
- package/resources/beneficiary-payouts.d.ts +61 -0
- package/resources/beneficiary-payouts.d.ts.map +1 -0
- package/resources/beneficiary-payouts.js +16 -0
- package/resources/beneficiary-payouts.js.map +1 -0
- package/resources/beneficiary-payouts.mjs +12 -0
- package/resources/beneficiary-payouts.mjs.map +1 -0
- package/resources/capabilities.d.ts +1 -10
- package/resources/capabilities.d.ts.map +1 -1
- package/resources/charges.d.ts +28 -19
- package/resources/charges.d.ts.map +1 -1
- package/resources/checkoutsession.d.ts +275 -1360
- package/resources/checkoutsession.d.ts.map +1 -1
- package/resources/customers.d.ts +140 -10
- package/resources/customers.d.ts.map +1 -1
- package/resources/customers.js +9 -2
- package/resources/customers.js.map +1 -1
- package/resources/customers.mjs +9 -2
- package/resources/customers.mjs.map +1 -1
- package/resources/data/accounts.d.ts +83 -0
- package/resources/data/accounts.d.ts.map +1 -0
- package/resources/data/accounts.js +15 -0
- package/resources/data/accounts.js.map +1 -0
- package/resources/data/accounts.mjs +11 -0
- package/resources/data/accounts.mjs.map +1 -0
- package/resources/data/balances.d.ts +48 -0
- package/resources/data/balances.d.ts.map +1 -0
- package/resources/data/balances.js +15 -0
- package/resources/data/balances.js.map +1 -0
- package/resources/data/balances.mjs +11 -0
- package/resources/data/balances.mjs.map +1 -0
- package/resources/data/consent.d.ts +80 -0
- package/resources/data/consent.d.ts.map +1 -0
- package/resources/data/consent.js +21 -0
- package/resources/data/consent.js.map +1 -0
- package/resources/data/consent.mjs +17 -0
- package/resources/data/consent.mjs.map +1 -0
- package/resources/data/data.d.ts +26 -0
- package/resources/data/data.d.ts.map +1 -0
- package/resources/data/data.js +55 -0
- package/resources/data/data.js.map +1 -0
- package/resources/data/data.mjs +28 -0
- package/resources/data/data.mjs.map +1 -0
- package/resources/data/index.d.ts +7 -0
- package/resources/data/index.d.ts.map +1 -0
- package/resources/data/index.js +17 -0
- package/resources/data/index.js.map +1 -0
- package/resources/data/index.mjs +8 -0
- package/resources/data/index.mjs.map +1 -0
- package/resources/data/session.d.ts +258 -0
- package/resources/data/session.d.ts.map +1 -0
- package/resources/data/session.js +21 -0
- package/resources/data/session.js.map +1 -0
- package/resources/data/session.mjs +17 -0
- package/resources/data/session.mjs.map +1 -0
- package/resources/data/transactions.d.ts +175 -0
- package/resources/data/transactions.d.ts.map +1 -0
- package/resources/data/transactions.js +16 -0
- package/resources/data/transactions.js.map +1 -0
- package/resources/data/transactions.mjs +12 -0
- package/resources/data/transactions.mjs.map +1 -0
- package/resources/data.d.ts +2 -0
- package/resources/data.d.ts.map +1 -0
- package/resources/data.js +19 -0
- package/resources/data.js.map +1 -0
- package/resources/data.mjs +3 -0
- package/resources/data.mjs.map +1 -0
- package/resources/deposits.d.ts +165 -0
- package/resources/deposits.d.ts.map +1 -0
- package/resources/deposits.js +15 -0
- package/resources/deposits.js.map +1 -0
- package/resources/deposits.mjs +11 -0
- package/resources/deposits.mjs.map +1 -0
- package/resources/fx.d.ts +90 -0
- package/resources/fx.d.ts.map +1 -0
- package/resources/fx.js +22 -0
- package/resources/fx.js.map +1 -0
- package/resources/fx.mjs +18 -0
- package/resources/fx.mjs.map +1 -0
- package/resources/index.d.ts +13 -8
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +15 -5
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +7 -2
- package/resources/index.mjs.map +1 -1
- package/resources/mandates.d.ts +55 -17
- package/resources/mandates.d.ts.map +1 -1
- package/resources/orders.d.ts +720 -743
- package/resources/orders.d.ts.map +1 -1
- package/resources/orders.js +13 -3
- package/resources/orders.js.map +1 -1
- package/resources/orders.mjs +13 -3
- package/resources/orders.mjs.map +1 -1
- package/resources/payouts.d.ts +219 -103
- package/resources/payouts.d.ts.map +1 -1
- package/resources/payouts.js +3 -4
- package/resources/payouts.js.map +1 -1
- package/resources/payouts.mjs +3 -4
- package/resources/payouts.mjs.map +1 -1
- package/resources/refunds.d.ts +53 -97
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +8 -12
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +8 -12
- package/resources/refunds.mjs.map +1 -1
- package/resources/returns.d.ts +104 -0
- package/resources/returns.d.ts.map +1 -0
- package/resources/returns.js +21 -0
- package/resources/returns.js.map +1 -0
- package/resources/returns.mjs +17 -0
- package/resources/returns.mjs.map +1 -0
- package/resources/subaccounts.d.ts +15 -5
- package/resources/subaccounts.d.ts.map +1 -1
- package/resources/subaccounts.js.map +1 -1
- package/resources/subaccounts.mjs.map +1 -1
- package/resources/transactions.d.ts +174 -0
- package/resources/transactions.d.ts.map +1 -0
- package/resources/transactions.js +15 -0
- package/resources/transactions.js.map +1 -0
- package/resources/transactions.mjs +11 -0
- package/resources/transactions.mjs.map +1 -0
- package/resources/webhook/index.d.ts +3 -0
- package/resources/webhook/index.d.ts.map +1 -0
- package/resources/webhook/index.js +9 -0
- package/resources/webhook/index.js.map +1 -0
- package/resources/webhook/index.mjs +4 -0
- package/resources/webhook/index.mjs.map +1 -0
- package/resources/webhook/subscription.d.ts +152 -0
- package/resources/webhook/subscription.d.ts.map +1 -0
- package/resources/{webhooksubscription.js → webhook/subscription.js} +6 -6
- package/resources/webhook/subscription.js.map +1 -0
- package/resources/{webhooksubscription.mjs → webhook/subscription.mjs} +4 -4
- package/resources/webhook/subscription.mjs.map +1 -0
- package/resources/webhook/webhook.d.ts +28 -0
- package/resources/webhook/webhook.d.ts.map +1 -0
- package/resources/webhook/webhook.js +45 -0
- package/resources/webhook/webhook.js.map +1 -0
- package/resources/webhook/webhook.mjs +18 -0
- package/resources/webhook/webhook.mjs.map +1 -0
- package/resources/webhook.d.ts +2 -0
- package/resources/webhook.d.ts.map +1 -0
- package/resources/webhook.js +19 -0
- package/resources/webhook.js.map +1 -0
- package/resources/webhook.mjs +3 -0
- package/resources/webhook.mjs.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +18 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/_shims/index.d.ts +2 -0
- package/src/_shims/index.js +5 -1
- package/src/_shims/index.mjs +5 -1
- package/src/core.ts +44 -16
- package/src/index.ts +111 -60
- package/src/resource.ts +1 -1
- package/src/resources/balance.ts +8 -5
- package/src/resources/banks.ts +130 -67
- package/src/resources/beneficiary-payouts.ts +78 -0
- package/src/resources/capabilities.ts +1 -10
- package/src/resources/charges.ts +30 -21
- package/src/resources/checkoutsession.ts +1224 -3096
- package/src/resources/customers.ts +164 -9
- package/src/resources/data/accounts.ts +113 -0
- package/src/resources/data/balances.ts +60 -0
- package/src/resources/data/consent.ts +110 -0
- package/src/resources/data/data.ts +75 -0
- package/src/resources/data/index.ts +20 -0
- package/src/resources/data/session.ts +1317 -0
- package/src/resources/data/transactions.ts +235 -0
- package/src/resources/data.ts +3 -0
- package/src/resources/deposits.ts +231 -0
- package/src/resources/fx.ts +119 -0
- package/src/resources/index.ts +33 -28
- package/src/resources/mandates.ts +79 -17
- package/src/resources/orders.ts +1449 -1075
- package/src/resources/payouts.ts +273 -103
- package/src/resources/refunds.ts +70 -111
- package/src/resources/returns.ts +140 -0
- package/src/resources/subaccounts.ts +26 -4
- package/src/resources/transactions.ts +234 -0
- package/src/resources/webhook/index.ts +16 -0
- package/src/resources/{webhooksubscription.ts → webhook/subscription.ts} +164 -112
- package/src/resources/webhook/webhook.ts +69 -0
- package/src/resources/webhook.ts +3 -0
- package/src/resources.ts +1 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/resources/reports.d.ts +0 -120
- package/resources/reports.d.ts.map +0 -1
- package/resources/reports.js +0 -31
- package/resources/reports.js.map +0 -1
- package/resources/reports.mjs +0 -27
- package/resources/reports.mjs.map +0 -1
- package/resources/webhooksubscription.d.ts +0 -155
- package/resources/webhooksubscription.d.ts.map +0 -1
- package/resources/webhooksubscription.js.map +0 -1
- package/resources/webhooksubscription.mjs.map +0 -1
- package/src/resources/reports.ts +0 -172
|
@@ -18,165 +18,83 @@ 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
|
-
* The customer facing id. This id is displayed to the user during the checkout and
|
|
32
|
-
* in the merchant dashboard.
|
|
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. Required when handshake=true.
|
|
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
46
|
impactOffsetProjects?: Array<string>;
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
121
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
122
|
-
* session will contain sustainable incentives for users.
|
|
123
|
-
*/
|
|
124
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
125
|
-
lineItems?: Array<CheckoutsessionCreateResponse.LineItem>;
|
|
126
|
-
/**
|
|
127
|
-
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
128
|
-
* given language. Users can change the language in the Checkout. If not provided,
|
|
129
|
-
* the language of the Checkout is determined by the browser's language.
|
|
130
|
-
*/
|
|
131
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
47
|
+
incentiveMode?: string;
|
|
48
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
132
49
|
mandate?: CheckoutsessionCreateResponse.Mandate;
|
|
133
|
-
/**
|
|
134
|
-
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
135
|
-
* located. If provided, the Checkout will display the market's banks first. Not
|
|
136
|
-
* relevant if `prefill.bankId` is provided.
|
|
137
|
-
*/
|
|
138
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';
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
merchantAppId?: string;
|
|
143
|
-
/**
|
|
144
|
-
* Any data which will be stored and returned for this checkout session and
|
|
145
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
146
|
-
* more info.
|
|
147
|
-
*/
|
|
148
|
-
metadata?: Record<string, unknown>;
|
|
51
|
+
metadata?: {
|
|
52
|
+
[key: string]: unknown;
|
|
53
|
+
};
|
|
149
54
|
offsetProject?: string;
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
* The shop-plugin version.
|
|
153
|
-
*/
|
|
55
|
+
paymentMode?: 'direct' | 'settlement';
|
|
56
|
+
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
154
57
|
plugin?: string;
|
|
155
|
-
|
|
156
|
-
* Prefill known data to skip steps in the checkout.
|
|
157
|
-
*/
|
|
158
|
-
prefill?: CheckoutsessionCreateResponse.Prefill;
|
|
159
|
-
/**
|
|
160
|
-
* Only applicable for express Checkouts. Quote Callback requests will be sent to
|
|
161
|
-
* this URL.
|
|
162
|
-
*/
|
|
58
|
+
prefill?: unknown;
|
|
163
59
|
quoteCallbackUrl?: string;
|
|
164
|
-
/**
|
|
165
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
166
|
-
* input within the Ivy express Checkout.
|
|
167
|
-
*/
|
|
168
60
|
required?: CheckoutsessionCreateResponse.Required;
|
|
169
61
|
selectedShippingMethodId?: string;
|
|
170
62
|
shippingAddress?: CheckoutsessionCreateResponse.ShippingAddress;
|
|
171
|
-
shippingMethods?: Array<
|
|
172
|
-
/**
|
|
173
|
-
* The logo of the shop provided as a URL.
|
|
174
|
-
*/
|
|
63
|
+
shippingMethods?: Array<unknown>;
|
|
175
64
|
shopLogo?: string;
|
|
176
65
|
shopName?: string;
|
|
177
66
|
subaccountId?: string;
|
|
67
|
+
updatedAt?: unknown;
|
|
178
68
|
}
|
|
179
69
|
export declare namespace CheckoutsessionCreateResponse {
|
|
70
|
+
interface LineItem {
|
|
71
|
+
/**
|
|
72
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
73
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
74
|
+
*/
|
|
75
|
+
amount: number;
|
|
76
|
+
/**
|
|
77
|
+
* Customer-facing name of the line item.
|
|
78
|
+
*/
|
|
79
|
+
name: string;
|
|
80
|
+
singleNet: number;
|
|
81
|
+
singleVat: number;
|
|
82
|
+
category?: '5045' | '5065' | '5094' | '5192' | '5193' | '5499' | '5655' | '5691' | '5712' | '5722' | '5812' | '5814' | '5912' | '5977' | '5999' | '7629';
|
|
83
|
+
co2Grams?: number;
|
|
84
|
+
EAN?: string;
|
|
85
|
+
/**
|
|
86
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
87
|
+
*/
|
|
88
|
+
image?: string;
|
|
89
|
+
/**
|
|
90
|
+
* Quantity of this lineItem.
|
|
91
|
+
*/
|
|
92
|
+
quantity?: number;
|
|
93
|
+
/**
|
|
94
|
+
* An internal unique id stored to this line item.
|
|
95
|
+
*/
|
|
96
|
+
referenceId?: string;
|
|
97
|
+
}
|
|
180
98
|
interface Merchant {
|
|
181
99
|
id: string;
|
|
182
100
|
appId: string;
|
|
@@ -186,451 +104,147 @@ export declare namespace CheckoutsessionCreateResponse {
|
|
|
186
104
|
namespace Merchant {
|
|
187
105
|
interface Address {
|
|
188
106
|
city: string;
|
|
189
|
-
/**
|
|
190
|
-
* The country code in
|
|
191
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
192
|
-
*/
|
|
193
107
|
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';
|
|
108
|
+
firstName: string;
|
|
109
|
+
lastName: string;
|
|
194
110
|
line1: string;
|
|
111
|
+
line2: string;
|
|
112
|
+
region: string;
|
|
195
113
|
zipCode: string;
|
|
196
|
-
firstName?: string;
|
|
197
|
-
lastName?: string;
|
|
198
|
-
line2?: string;
|
|
199
|
-
region?: string;
|
|
200
114
|
}
|
|
201
115
|
}
|
|
202
|
-
/**
|
|
203
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
204
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
205
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
206
|
-
* as this is the format accepted by most banks.
|
|
207
|
-
*/
|
|
208
116
|
interface Price {
|
|
209
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
210
|
-
/**
|
|
211
|
-
* The total amount to be paid.
|
|
212
|
-
*/
|
|
117
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
213
118
|
total: number;
|
|
214
119
|
shipping?: number;
|
|
215
120
|
subTotal?: number;
|
|
216
121
|
totalNet?: number;
|
|
217
122
|
vat?: number;
|
|
218
123
|
}
|
|
219
|
-
/**
|
|
220
|
-
* The billing address of the customer. Required when handshake=true.
|
|
221
|
-
*/
|
|
222
124
|
interface BillingAddress {
|
|
223
125
|
city: string;
|
|
224
|
-
/**
|
|
225
|
-
* The country code in
|
|
226
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
227
|
-
*/
|
|
228
126
|
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';
|
|
127
|
+
firstName: string;
|
|
128
|
+
lastName: string;
|
|
229
129
|
line1: string;
|
|
130
|
+
line2: string;
|
|
131
|
+
region: string;
|
|
230
132
|
zipCode: string;
|
|
231
|
-
firstName?: string;
|
|
232
|
-
lastName?: string;
|
|
233
|
-
line2?: string;
|
|
234
|
-
region?: string;
|
|
235
133
|
}
|
|
236
134
|
interface Customer {
|
|
237
135
|
id: string;
|
|
238
136
|
}
|
|
239
|
-
/**
|
|
240
|
-
* The line items of the Checkout.
|
|
241
|
-
*/
|
|
242
|
-
interface LineItem {
|
|
243
|
-
/**
|
|
244
|
-
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
245
|
-
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
246
|
-
*/
|
|
247
|
-
amount: number;
|
|
248
|
-
/**
|
|
249
|
-
* The name of the line item.
|
|
250
|
-
*/
|
|
251
|
-
name: string;
|
|
252
|
-
/**
|
|
253
|
-
* The quantity of the line item.
|
|
254
|
-
*/
|
|
255
|
-
quantity: number;
|
|
256
|
-
/**
|
|
257
|
-
* The net amount of a single item.
|
|
258
|
-
*/
|
|
259
|
-
singleNet: number;
|
|
260
|
-
/**
|
|
261
|
-
* The VAT amount of a single item.
|
|
262
|
-
*/
|
|
263
|
-
singleVat: number;
|
|
264
|
-
/**
|
|
265
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
266
|
-
* the line item.
|
|
267
|
-
*/
|
|
268
|
-
category?: string;
|
|
269
|
-
/**
|
|
270
|
-
* The
|
|
271
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
272
|
-
* of the line item.
|
|
273
|
-
*/
|
|
274
|
-
EAN?: string;
|
|
275
|
-
/**
|
|
276
|
-
* The image of the line item as a URL.
|
|
277
|
-
*/
|
|
278
|
-
image?: string;
|
|
279
|
-
/**
|
|
280
|
-
* The internal unique identifier of the line item.
|
|
281
|
-
*/
|
|
282
|
-
referenceId?: string;
|
|
283
|
-
}
|
|
284
137
|
interface Mandate {
|
|
285
|
-
setup: boolean;
|
|
286
|
-
/**
|
|
287
|
-
* The name of the account holder who signs the mandate
|
|
288
|
-
*/
|
|
289
138
|
accountHolderName?: string;
|
|
139
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
290
140
|
referenceId?: string;
|
|
141
|
+
setup?: boolean;
|
|
291
142
|
userNotificationEmail?: string;
|
|
292
143
|
}
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
/**
|
|
298
|
-
* The known bank id. Customers will skip the bank selection and go directly to the
|
|
299
|
-
* bank's login. Required for financial address prefill.
|
|
300
|
-
*/
|
|
301
|
-
bankId?: string;
|
|
302
|
-
/**
|
|
303
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
304
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
305
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
306
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
307
|
-
* out.
|
|
308
|
-
*/
|
|
309
|
-
payerFinancialAddress?: Prefill.PayerFinancialAddress;
|
|
310
|
-
}
|
|
311
|
-
namespace Prefill {
|
|
312
|
-
/**
|
|
313
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
314
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
315
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
316
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
317
|
-
* out.
|
|
318
|
-
*/
|
|
319
|
-
interface PayerFinancialAddress {
|
|
320
|
-
/**
|
|
321
|
-
* The type of the financial address. The actual destination is determined by this
|
|
322
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
323
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
324
|
-
* in the "iban" object.
|
|
325
|
-
*
|
|
326
|
-
* - iban: The IBAN of the account
|
|
327
|
-
* - sort_code: The sort code of the account
|
|
328
|
-
* - bank_code: The bank code of the account
|
|
329
|
-
* - bban: The BBAN of the account
|
|
330
|
-
*/
|
|
331
|
-
type: string;
|
|
332
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
333
|
-
bban?: PayerFinancialAddress.Bban;
|
|
334
|
-
iban?: PayerFinancialAddress.Iban;
|
|
335
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
144
|
+
namespace Mandate {
|
|
145
|
+
interface AdditionalDisplayInformation {
|
|
146
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
147
|
+
price?: AdditionalDisplayInformation.Price;
|
|
336
148
|
}
|
|
337
|
-
namespace
|
|
338
|
-
interface
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
/**
|
|
342
|
-
* The name of the account holder.
|
|
343
|
-
*/
|
|
344
|
-
accountHolderName?: string;
|
|
345
|
-
}
|
|
346
|
-
interface Bban {
|
|
347
|
-
bban: string;
|
|
348
|
-
/**
|
|
349
|
-
* The name of the account holder.
|
|
350
|
-
*/
|
|
351
|
-
accountHolderName?: string;
|
|
352
|
-
bic?: string;
|
|
353
|
-
}
|
|
354
|
-
interface Iban {
|
|
355
|
-
iban: string;
|
|
356
|
-
/**
|
|
357
|
-
* The name of the account holder.
|
|
358
|
-
*/
|
|
359
|
-
accountHolderName?: string;
|
|
360
|
-
bic?: string;
|
|
361
|
-
}
|
|
362
|
-
interface SortCode {
|
|
363
|
-
accountNumber: string;
|
|
364
|
-
sortCode: string;
|
|
365
|
-
/**
|
|
366
|
-
* The name of the account holder.
|
|
367
|
-
*/
|
|
368
|
-
accountHolderName?: string;
|
|
149
|
+
namespace AdditionalDisplayInformation {
|
|
150
|
+
interface Price {
|
|
151
|
+
amount: number;
|
|
152
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
369
153
|
}
|
|
370
154
|
}
|
|
371
155
|
}
|
|
372
|
-
/**
|
|
373
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
374
|
-
* input within the Ivy express Checkout.
|
|
375
|
-
*/
|
|
376
156
|
interface Required {
|
|
377
|
-
/**
|
|
378
|
-
* If set to true, the phone number will be required input within the Ivy express
|
|
379
|
-
* Checkout.
|
|
380
|
-
*/
|
|
381
157
|
phone: boolean;
|
|
382
158
|
}
|
|
383
159
|
interface ShippingAddress {
|
|
384
160
|
city: string;
|
|
385
|
-
/**
|
|
386
|
-
* The country code in
|
|
387
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
388
|
-
*/
|
|
389
161
|
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';
|
|
162
|
+
firstName: string;
|
|
163
|
+
lastName: string;
|
|
390
164
|
line1: string;
|
|
165
|
+
line2: string;
|
|
166
|
+
region: string;
|
|
391
167
|
zipCode: string;
|
|
392
|
-
firstName?: string;
|
|
393
|
-
lastName?: string;
|
|
394
|
-
line2?: string;
|
|
395
|
-
region?: string;
|
|
396
|
-
}
|
|
397
|
-
/**
|
|
398
|
-
* The shipping methods of the Checkout.
|
|
399
|
-
*/
|
|
400
|
-
interface ShippingMethod {
|
|
401
|
-
/**
|
|
402
|
-
* The customer-facing name of the shipping method.
|
|
403
|
-
*/
|
|
404
|
-
name: string;
|
|
405
|
-
/**
|
|
406
|
-
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
407
|
-
*/
|
|
408
|
-
price: number;
|
|
409
|
-
/**
|
|
410
|
-
* The unique identifier of the shipping method within Ivy.
|
|
411
|
-
*/
|
|
412
|
-
id?: string;
|
|
413
|
-
/**
|
|
414
|
-
* The list of countries where the shipping method is available.
|
|
415
|
-
*/
|
|
416
|
-
countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
|
|
417
|
-
/**
|
|
418
|
-
* The delivery estimate of the shipping method.
|
|
419
|
-
*/
|
|
420
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
421
|
-
/**
|
|
422
|
-
* The unique identifier within your system of the shipping method.
|
|
423
|
-
*/
|
|
424
|
-
reference?: string;
|
|
425
|
-
/**
|
|
426
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
427
|
-
*/
|
|
428
|
-
timeFrame?: string;
|
|
429
|
-
}
|
|
430
|
-
namespace ShippingMethod {
|
|
431
|
-
/**
|
|
432
|
-
* The delivery estimate of the shipping method.
|
|
433
|
-
*/
|
|
434
|
-
interface DeliveryEstimate {
|
|
435
|
-
/**
|
|
436
|
-
* The maximum delivery time.
|
|
437
|
-
*/
|
|
438
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
439
|
-
/**
|
|
440
|
-
* The minimum delivery time.
|
|
441
|
-
*/
|
|
442
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
443
|
-
}
|
|
444
|
-
namespace DeliveryEstimate {
|
|
445
|
-
/**
|
|
446
|
-
* The maximum delivery time.
|
|
447
|
-
*/
|
|
448
|
-
interface Maximum {
|
|
449
|
-
/**
|
|
450
|
-
* The unit of the time duration.
|
|
451
|
-
*/
|
|
452
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
453
|
-
/**
|
|
454
|
-
* The value of the time duration.
|
|
455
|
-
*/
|
|
456
|
-
value: number;
|
|
457
|
-
}
|
|
458
|
-
/**
|
|
459
|
-
* The minimum delivery time.
|
|
460
|
-
*/
|
|
461
|
-
interface Minimum {
|
|
462
|
-
/**
|
|
463
|
-
* The unit of the time duration.
|
|
464
|
-
*/
|
|
465
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
466
|
-
/**
|
|
467
|
-
* The value of the time duration.
|
|
468
|
-
*/
|
|
469
|
-
value: number;
|
|
470
|
-
}
|
|
471
|
-
}
|
|
472
168
|
}
|
|
473
169
|
}
|
|
474
170
|
export interface CheckoutsessionRetrieveResponse {
|
|
475
|
-
/**
|
|
476
|
-
* The unique identifier of the Checkout within Ivy.
|
|
477
|
-
*/
|
|
478
171
|
id: string;
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
*/
|
|
482
|
-
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'>;
|
|
483
|
-
createdAt: string;
|
|
484
|
-
/**
|
|
485
|
-
* The customer facing id. This id is displayed to the user during the checkout and
|
|
486
|
-
* in the merchant dashboard.
|
|
487
|
-
*/
|
|
172
|
+
appId: string;
|
|
173
|
+
created: number;
|
|
488
174
|
displayId: string;
|
|
489
|
-
/**
|
|
490
|
-
* Required if not set in the dashboard. Users will be redirected here after an
|
|
491
|
-
* unsuccessful Payment attempt.
|
|
492
|
-
*/
|
|
493
175
|
errorCallbackUrl: string;
|
|
176
|
+
expiresAt: number;
|
|
177
|
+
lineItems: Array<CheckoutsessionRetrieveResponse.LineItem>;
|
|
494
178
|
merchant: CheckoutsessionRetrieveResponse.Merchant;
|
|
495
|
-
|
|
496
|
-
* - `settlement`: The payment is initially settled into a virtual account. The
|
|
497
|
-
* funds are then disbursed in batches to the merchant. Refunds are instantly
|
|
498
|
-
* processed from the virtual account.
|
|
499
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
500
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
501
|
-
*/
|
|
502
|
-
paymentMode: 'settlement' | 'direct';
|
|
503
|
-
/**
|
|
504
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
505
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
506
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
507
|
-
* as this is the format accepted by most banks.
|
|
508
|
-
*/
|
|
179
|
+
merchantAppId: string;
|
|
509
180
|
price: CheckoutsessionRetrieveResponse.Price;
|
|
510
181
|
redirectUrl: string;
|
|
511
|
-
/**
|
|
512
|
-
* An internal reference id which will be stored with the checkout & corresponding
|
|
513
|
-
* order. Needs to be unique per shop per order and can be up to 200 characters. We
|
|
514
|
-
* recommend to use your internal order id here.
|
|
515
|
-
*/
|
|
516
182
|
referenceId: string;
|
|
517
183
|
status: 'open' | 'closed' | 'expired';
|
|
518
|
-
/**
|
|
519
|
-
* Required if not set in the dashboard. Users will be redirected here after a
|
|
520
|
-
* successful Payment attempt.
|
|
521
|
-
*/
|
|
522
184
|
successCallbackUrl: string;
|
|
523
|
-
updatedAt: string;
|
|
524
185
|
abortReason?: string;
|
|
525
|
-
|
|
526
|
-
/**
|
|
527
|
-
* The billing address of the customer. Required when handshake=true.
|
|
528
|
-
*/
|
|
186
|
+
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'>;
|
|
529
187
|
billingAddress?: CheckoutsessionRetrieveResponse.BillingAddress;
|
|
530
|
-
/**
|
|
531
|
-
* The merchant category code or
|
|
532
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
533
|
-
*/
|
|
534
188
|
category?: string;
|
|
535
|
-
/**
|
|
536
|
-
* Only applicable for express Checkouts. Complete Callback requests will be sent
|
|
537
|
-
* to this URL.
|
|
538
|
-
*/
|
|
539
189
|
completeCallbackUrl?: string;
|
|
540
|
-
|
|
541
|
-
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
542
|
-
* time of Checkout creation at Ivy.
|
|
543
|
-
*/
|
|
544
|
-
created?: number;
|
|
190
|
+
createdAt?: unknown;
|
|
545
191
|
customer?: CheckoutsessionRetrieveResponse.Customer;
|
|
546
|
-
/**
|
|
547
|
-
* False by default. If set to true, customers cannot modify the pre-selected bank
|
|
548
|
-
* from `prefill.bankId`.
|
|
549
|
-
*/
|
|
550
192
|
disableBankSelection?: boolean;
|
|
551
|
-
/**
|
|
552
|
-
* The Epoch time in seconds at which the Checkout Session will expire. It can be
|
|
553
|
-
* anywhere from 30 minutes to 24 hours after Checkout Session creation. By
|
|
554
|
-
* default, this value is 1 hour from creation.
|
|
555
|
-
*/
|
|
556
|
-
expiresAt?: number;
|
|
557
|
-
/**
|
|
558
|
-
* False by default. If set to true, the Checkout is displayed in express mode.
|
|
559
|
-
*/
|
|
560
193
|
express?: boolean;
|
|
561
|
-
/**
|
|
562
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
563
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
564
|
-
*/
|
|
565
194
|
guest?: boolean;
|
|
566
|
-
/**
|
|
567
|
-
* If true, the order must be confirmed through the merchant with an additional
|
|
568
|
-
* complete callback endpoint. Always true for express sessions.
|
|
569
|
-
*/
|
|
570
195
|
handshake?: boolean;
|
|
571
196
|
impactOffsetProjects?: Array<string>;
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
575
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
576
|
-
* session will contain sustainable incentives for users.
|
|
577
|
-
*/
|
|
578
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
579
|
-
lineItems?: Array<CheckoutsessionRetrieveResponse.LineItem>;
|
|
580
|
-
/**
|
|
581
|
-
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
582
|
-
* given language. Users can change the language in the Checkout. If not provided,
|
|
583
|
-
* the language of the Checkout is determined by the browser's language.
|
|
584
|
-
*/
|
|
585
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
197
|
+
incentiveMode?: string;
|
|
198
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
586
199
|
mandate?: CheckoutsessionRetrieveResponse.Mandate;
|
|
587
|
-
/**
|
|
588
|
-
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
589
|
-
* located. If provided, the Checkout will display the market's banks first. Not
|
|
590
|
-
* relevant if `prefill.bankId` is provided.
|
|
591
|
-
*/
|
|
592
200
|
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';
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
merchantAppId?: string;
|
|
597
|
-
/**
|
|
598
|
-
* Any data which will be stored and returned for this checkout session and
|
|
599
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
600
|
-
* more info.
|
|
601
|
-
*/
|
|
602
|
-
metadata?: Record<string, unknown>;
|
|
201
|
+
metadata?: {
|
|
202
|
+
[key: string]: unknown;
|
|
203
|
+
};
|
|
603
204
|
offsetProject?: string;
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
* The shop-plugin version.
|
|
607
|
-
*/
|
|
205
|
+
paymentMode?: 'direct' | 'settlement';
|
|
206
|
+
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
608
207
|
plugin?: string;
|
|
609
|
-
|
|
610
|
-
* Prefill known data to skip steps in the checkout.
|
|
611
|
-
*/
|
|
612
|
-
prefill?: CheckoutsessionRetrieveResponse.Prefill;
|
|
613
|
-
/**
|
|
614
|
-
* Only applicable for express Checkouts. Quote Callback requests will be sent to
|
|
615
|
-
* this URL.
|
|
616
|
-
*/
|
|
208
|
+
prefill?: unknown;
|
|
617
209
|
quoteCallbackUrl?: string;
|
|
618
|
-
/**
|
|
619
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
620
|
-
* input within the Ivy express Checkout.
|
|
621
|
-
*/
|
|
622
210
|
required?: CheckoutsessionRetrieveResponse.Required;
|
|
623
211
|
selectedShippingMethodId?: string;
|
|
624
212
|
shippingAddress?: CheckoutsessionRetrieveResponse.ShippingAddress;
|
|
625
|
-
shippingMethods?: Array<
|
|
626
|
-
/**
|
|
627
|
-
* The logo of the shop provided as a URL.
|
|
628
|
-
*/
|
|
213
|
+
shippingMethods?: Array<unknown>;
|
|
629
214
|
shopLogo?: string;
|
|
630
215
|
shopName?: string;
|
|
631
216
|
subaccountId?: string;
|
|
217
|
+
updatedAt?: unknown;
|
|
632
218
|
}
|
|
633
219
|
export declare namespace CheckoutsessionRetrieveResponse {
|
|
220
|
+
interface LineItem {
|
|
221
|
+
/**
|
|
222
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
223
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
224
|
+
*/
|
|
225
|
+
amount: number;
|
|
226
|
+
/**
|
|
227
|
+
* Customer-facing name of the line item.
|
|
228
|
+
*/
|
|
229
|
+
name: string;
|
|
230
|
+
singleNet: number;
|
|
231
|
+
singleVat: number;
|
|
232
|
+
category?: '5045' | '5065' | '5094' | '5192' | '5193' | '5499' | '5655' | '5691' | '5712' | '5722' | '5812' | '5814' | '5912' | '5977' | '5999' | '7629';
|
|
233
|
+
co2Grams?: number;
|
|
234
|
+
EAN?: string;
|
|
235
|
+
/**
|
|
236
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
237
|
+
*/
|
|
238
|
+
image?: string;
|
|
239
|
+
/**
|
|
240
|
+
* Quantity of this lineItem.
|
|
241
|
+
*/
|
|
242
|
+
quantity?: number;
|
|
243
|
+
/**
|
|
244
|
+
* An internal unique id stored to this line item.
|
|
245
|
+
*/
|
|
246
|
+
referenceId?: string;
|
|
247
|
+
}
|
|
634
248
|
interface Merchant {
|
|
635
249
|
id: string;
|
|
636
250
|
appId: string;
|
|
@@ -640,451 +254,147 @@ export declare namespace CheckoutsessionRetrieveResponse {
|
|
|
640
254
|
namespace Merchant {
|
|
641
255
|
interface Address {
|
|
642
256
|
city: string;
|
|
643
|
-
/**
|
|
644
|
-
* The country code in
|
|
645
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
646
|
-
*/
|
|
647
257
|
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';
|
|
258
|
+
firstName: string;
|
|
259
|
+
lastName: string;
|
|
648
260
|
line1: string;
|
|
261
|
+
line2: string;
|
|
262
|
+
region: string;
|
|
649
263
|
zipCode: string;
|
|
650
|
-
firstName?: string;
|
|
651
|
-
lastName?: string;
|
|
652
|
-
line2?: string;
|
|
653
|
-
region?: string;
|
|
654
264
|
}
|
|
655
265
|
}
|
|
656
|
-
/**
|
|
657
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
658
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
659
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
660
|
-
* as this is the format accepted by most banks.
|
|
661
|
-
*/
|
|
662
266
|
interface Price {
|
|
663
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
664
|
-
/**
|
|
665
|
-
* The total amount to be paid.
|
|
666
|
-
*/
|
|
267
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
667
268
|
total: number;
|
|
668
269
|
shipping?: number;
|
|
669
270
|
subTotal?: number;
|
|
670
271
|
totalNet?: number;
|
|
671
272
|
vat?: number;
|
|
672
273
|
}
|
|
673
|
-
/**
|
|
674
|
-
* The billing address of the customer. Required when handshake=true.
|
|
675
|
-
*/
|
|
676
274
|
interface BillingAddress {
|
|
677
275
|
city: string;
|
|
678
|
-
/**
|
|
679
|
-
* The country code in
|
|
680
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
681
|
-
*/
|
|
682
276
|
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';
|
|
277
|
+
firstName: string;
|
|
278
|
+
lastName: string;
|
|
683
279
|
line1: string;
|
|
280
|
+
line2: string;
|
|
281
|
+
region: string;
|
|
684
282
|
zipCode: string;
|
|
685
|
-
firstName?: string;
|
|
686
|
-
lastName?: string;
|
|
687
|
-
line2?: string;
|
|
688
|
-
region?: string;
|
|
689
283
|
}
|
|
690
284
|
interface Customer {
|
|
691
285
|
id: string;
|
|
692
286
|
}
|
|
693
|
-
/**
|
|
694
|
-
* The line items of the Checkout.
|
|
695
|
-
*/
|
|
696
|
-
interface LineItem {
|
|
697
|
-
/**
|
|
698
|
-
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
699
|
-
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
700
|
-
*/
|
|
701
|
-
amount: number;
|
|
702
|
-
/**
|
|
703
|
-
* The name of the line item.
|
|
704
|
-
*/
|
|
705
|
-
name: string;
|
|
706
|
-
/**
|
|
707
|
-
* The quantity of the line item.
|
|
708
|
-
*/
|
|
709
|
-
quantity: number;
|
|
710
|
-
/**
|
|
711
|
-
* The net amount of a single item.
|
|
712
|
-
*/
|
|
713
|
-
singleNet: number;
|
|
714
|
-
/**
|
|
715
|
-
* The VAT amount of a single item.
|
|
716
|
-
*/
|
|
717
|
-
singleVat: number;
|
|
718
|
-
/**
|
|
719
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
720
|
-
* the line item.
|
|
721
|
-
*/
|
|
722
|
-
category?: string;
|
|
723
|
-
/**
|
|
724
|
-
* The
|
|
725
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
726
|
-
* of the line item.
|
|
727
|
-
*/
|
|
728
|
-
EAN?: string;
|
|
729
|
-
/**
|
|
730
|
-
* The image of the line item as a URL.
|
|
731
|
-
*/
|
|
732
|
-
image?: string;
|
|
733
|
-
/**
|
|
734
|
-
* The internal unique identifier of the line item.
|
|
735
|
-
*/
|
|
736
|
-
referenceId?: string;
|
|
737
|
-
}
|
|
738
287
|
interface Mandate {
|
|
739
|
-
setup: boolean;
|
|
740
|
-
/**
|
|
741
|
-
* The name of the account holder who signs the mandate
|
|
742
|
-
*/
|
|
743
288
|
accountHolderName?: string;
|
|
289
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
744
290
|
referenceId?: string;
|
|
291
|
+
setup?: boolean;
|
|
745
292
|
userNotificationEmail?: string;
|
|
746
293
|
}
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
/**
|
|
752
|
-
* The known bank id. Customers will skip the bank selection and go directly to the
|
|
753
|
-
* bank's login. Required for financial address prefill.
|
|
754
|
-
*/
|
|
755
|
-
bankId?: string;
|
|
756
|
-
/**
|
|
757
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
758
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
759
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
760
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
761
|
-
* out.
|
|
762
|
-
*/
|
|
763
|
-
payerFinancialAddress?: Prefill.PayerFinancialAddress;
|
|
764
|
-
}
|
|
765
|
-
namespace Prefill {
|
|
766
|
-
/**
|
|
767
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
768
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
769
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
770
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
771
|
-
* out.
|
|
772
|
-
*/
|
|
773
|
-
interface PayerFinancialAddress {
|
|
774
|
-
/**
|
|
775
|
-
* The type of the financial address. The actual destination is determined by this
|
|
776
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
777
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
778
|
-
* in the "iban" object.
|
|
779
|
-
*
|
|
780
|
-
* - iban: The IBAN of the account
|
|
781
|
-
* - sort_code: The sort code of the account
|
|
782
|
-
* - bank_code: The bank code of the account
|
|
783
|
-
* - bban: The BBAN of the account
|
|
784
|
-
*/
|
|
785
|
-
type: string;
|
|
786
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
787
|
-
bban?: PayerFinancialAddress.Bban;
|
|
788
|
-
iban?: PayerFinancialAddress.Iban;
|
|
789
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
294
|
+
namespace Mandate {
|
|
295
|
+
interface AdditionalDisplayInformation {
|
|
296
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
297
|
+
price?: AdditionalDisplayInformation.Price;
|
|
790
298
|
}
|
|
791
|
-
namespace
|
|
792
|
-
interface
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
/**
|
|
796
|
-
* The name of the account holder.
|
|
797
|
-
*/
|
|
798
|
-
accountHolderName?: string;
|
|
799
|
-
}
|
|
800
|
-
interface Bban {
|
|
801
|
-
bban: string;
|
|
802
|
-
/**
|
|
803
|
-
* The name of the account holder.
|
|
804
|
-
*/
|
|
805
|
-
accountHolderName?: string;
|
|
806
|
-
bic?: string;
|
|
807
|
-
}
|
|
808
|
-
interface Iban {
|
|
809
|
-
iban: string;
|
|
810
|
-
/**
|
|
811
|
-
* The name of the account holder.
|
|
812
|
-
*/
|
|
813
|
-
accountHolderName?: string;
|
|
814
|
-
bic?: string;
|
|
815
|
-
}
|
|
816
|
-
interface SortCode {
|
|
817
|
-
accountNumber: string;
|
|
818
|
-
sortCode: string;
|
|
819
|
-
/**
|
|
820
|
-
* The name of the account holder.
|
|
821
|
-
*/
|
|
822
|
-
accountHolderName?: string;
|
|
299
|
+
namespace AdditionalDisplayInformation {
|
|
300
|
+
interface Price {
|
|
301
|
+
amount: number;
|
|
302
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
823
303
|
}
|
|
824
304
|
}
|
|
825
305
|
}
|
|
826
|
-
/**
|
|
827
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
828
|
-
* input within the Ivy express Checkout.
|
|
829
|
-
*/
|
|
830
306
|
interface Required {
|
|
831
|
-
/**
|
|
832
|
-
* If set to true, the phone number will be required input within the Ivy express
|
|
833
|
-
* Checkout.
|
|
834
|
-
*/
|
|
835
307
|
phone: boolean;
|
|
836
308
|
}
|
|
837
309
|
interface ShippingAddress {
|
|
838
310
|
city: string;
|
|
839
|
-
/**
|
|
840
|
-
* The country code in
|
|
841
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
842
|
-
*/
|
|
843
311
|
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';
|
|
312
|
+
firstName: string;
|
|
313
|
+
lastName: string;
|
|
844
314
|
line1: string;
|
|
315
|
+
line2: string;
|
|
316
|
+
region: string;
|
|
845
317
|
zipCode: string;
|
|
846
|
-
firstName?: string;
|
|
847
|
-
lastName?: string;
|
|
848
|
-
line2?: string;
|
|
849
|
-
region?: string;
|
|
850
|
-
}
|
|
851
|
-
/**
|
|
852
|
-
* The shipping methods of the Checkout.
|
|
853
|
-
*/
|
|
854
|
-
interface ShippingMethod {
|
|
855
|
-
/**
|
|
856
|
-
* The customer-facing name of the shipping method.
|
|
857
|
-
*/
|
|
858
|
-
name: string;
|
|
859
|
-
/**
|
|
860
|
-
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
861
|
-
*/
|
|
862
|
-
price: number;
|
|
863
|
-
/**
|
|
864
|
-
* The unique identifier of the shipping method within Ivy.
|
|
865
|
-
*/
|
|
866
|
-
id?: string;
|
|
867
|
-
/**
|
|
868
|
-
* The list of countries where the shipping method is available.
|
|
869
|
-
*/
|
|
870
|
-
countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
|
|
871
|
-
/**
|
|
872
|
-
* The delivery estimate of the shipping method.
|
|
873
|
-
*/
|
|
874
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
875
|
-
/**
|
|
876
|
-
* The unique identifier within your system of the shipping method.
|
|
877
|
-
*/
|
|
878
|
-
reference?: string;
|
|
879
|
-
/**
|
|
880
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
881
|
-
*/
|
|
882
|
-
timeFrame?: string;
|
|
883
|
-
}
|
|
884
|
-
namespace ShippingMethod {
|
|
885
|
-
/**
|
|
886
|
-
* The delivery estimate of the shipping method.
|
|
887
|
-
*/
|
|
888
|
-
interface DeliveryEstimate {
|
|
889
|
-
/**
|
|
890
|
-
* The maximum delivery time.
|
|
891
|
-
*/
|
|
892
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
893
|
-
/**
|
|
894
|
-
* The minimum delivery time.
|
|
895
|
-
*/
|
|
896
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
897
|
-
}
|
|
898
|
-
namespace DeliveryEstimate {
|
|
899
|
-
/**
|
|
900
|
-
* The maximum delivery time.
|
|
901
|
-
*/
|
|
902
|
-
interface Maximum {
|
|
903
|
-
/**
|
|
904
|
-
* The unit of the time duration.
|
|
905
|
-
*/
|
|
906
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
907
|
-
/**
|
|
908
|
-
* The value of the time duration.
|
|
909
|
-
*/
|
|
910
|
-
value: number;
|
|
911
|
-
}
|
|
912
|
-
/**
|
|
913
|
-
* The minimum delivery time.
|
|
914
|
-
*/
|
|
915
|
-
interface Minimum {
|
|
916
|
-
/**
|
|
917
|
-
* The unit of the time duration.
|
|
918
|
-
*/
|
|
919
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
920
|
-
/**
|
|
921
|
-
* The value of the time duration.
|
|
922
|
-
*/
|
|
923
|
-
value: number;
|
|
924
|
-
}
|
|
925
|
-
}
|
|
926
318
|
}
|
|
927
319
|
}
|
|
928
320
|
export interface CheckoutsessionExpireResponse {
|
|
929
|
-
/**
|
|
930
|
-
* The unique identifier of the Checkout within Ivy.
|
|
931
|
-
*/
|
|
932
321
|
id: string;
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
*/
|
|
936
|
-
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'>;
|
|
937
|
-
createdAt: string;
|
|
938
|
-
/**
|
|
939
|
-
* The customer facing id. This id is displayed to the user during the checkout and
|
|
940
|
-
* in the merchant dashboard.
|
|
941
|
-
*/
|
|
322
|
+
appId: string;
|
|
323
|
+
created: number;
|
|
942
324
|
displayId: string;
|
|
943
|
-
/**
|
|
944
|
-
* Required if not set in the dashboard. Users will be redirected here after an
|
|
945
|
-
* unsuccessful Payment attempt.
|
|
946
|
-
*/
|
|
947
325
|
errorCallbackUrl: string;
|
|
326
|
+
expiresAt: number;
|
|
327
|
+
lineItems: Array<CheckoutsessionExpireResponse.LineItem>;
|
|
948
328
|
merchant: CheckoutsessionExpireResponse.Merchant;
|
|
949
|
-
|
|
950
|
-
* - `settlement`: The payment is initially settled into a virtual account. The
|
|
951
|
-
* funds are then disbursed in batches to the merchant. Refunds are instantly
|
|
952
|
-
* processed from the virtual account.
|
|
953
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
954
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
955
|
-
*/
|
|
956
|
-
paymentMode: 'settlement' | 'direct';
|
|
957
|
-
/**
|
|
958
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
959
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
960
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
961
|
-
* as this is the format accepted by most banks.
|
|
962
|
-
*/
|
|
329
|
+
merchantAppId: string;
|
|
963
330
|
price: CheckoutsessionExpireResponse.Price;
|
|
964
331
|
redirectUrl: string;
|
|
965
|
-
/**
|
|
966
|
-
* An internal reference id which will be stored with the checkout & corresponding
|
|
967
|
-
* order. Needs to be unique per shop per order and can be up to 200 characters. We
|
|
968
|
-
* recommend to use your internal order id here.
|
|
969
|
-
*/
|
|
970
332
|
referenceId: string;
|
|
971
333
|
status: 'open' | 'closed' | 'expired';
|
|
972
|
-
/**
|
|
973
|
-
* Required if not set in the dashboard. Users will be redirected here after a
|
|
974
|
-
* successful Payment attempt.
|
|
975
|
-
*/
|
|
976
334
|
successCallbackUrl: string;
|
|
977
|
-
updatedAt: string;
|
|
978
335
|
abortReason?: string;
|
|
979
|
-
|
|
980
|
-
/**
|
|
981
|
-
* The billing address of the customer. Required when handshake=true.
|
|
982
|
-
*/
|
|
336
|
+
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'>;
|
|
983
337
|
billingAddress?: CheckoutsessionExpireResponse.BillingAddress;
|
|
984
|
-
/**
|
|
985
|
-
* The merchant category code or
|
|
986
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
987
|
-
*/
|
|
988
338
|
category?: string;
|
|
989
|
-
/**
|
|
990
|
-
* Only applicable for express Checkouts. Complete Callback requests will be sent
|
|
991
|
-
* to this URL.
|
|
992
|
-
*/
|
|
993
339
|
completeCallbackUrl?: string;
|
|
994
|
-
|
|
995
|
-
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
996
|
-
* time of Checkout creation at Ivy.
|
|
997
|
-
*/
|
|
998
|
-
created?: number;
|
|
340
|
+
createdAt?: unknown;
|
|
999
341
|
customer?: CheckoutsessionExpireResponse.Customer;
|
|
1000
|
-
/**
|
|
1001
|
-
* False by default. If set to true, customers cannot modify the pre-selected bank
|
|
1002
|
-
* from `prefill.bankId`.
|
|
1003
|
-
*/
|
|
1004
342
|
disableBankSelection?: boolean;
|
|
1005
|
-
/**
|
|
1006
|
-
* The Epoch time in seconds at which the Checkout Session will expire. It can be
|
|
1007
|
-
* anywhere from 30 minutes to 24 hours after Checkout Session creation. By
|
|
1008
|
-
* default, this value is 1 hour from creation.
|
|
1009
|
-
*/
|
|
1010
|
-
expiresAt?: number;
|
|
1011
|
-
/**
|
|
1012
|
-
* False by default. If set to true, the Checkout is displayed in express mode.
|
|
1013
|
-
*/
|
|
1014
343
|
express?: boolean;
|
|
1015
|
-
/**
|
|
1016
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
1017
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
1018
|
-
*/
|
|
1019
344
|
guest?: boolean;
|
|
1020
|
-
/**
|
|
1021
|
-
* If true, the order must be confirmed through the merchant with an additional
|
|
1022
|
-
* complete callback endpoint. Always true for express sessions.
|
|
1023
|
-
*/
|
|
1024
345
|
handshake?: boolean;
|
|
1025
346
|
impactOffsetProjects?: Array<string>;
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
1029
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
1030
|
-
* session will contain sustainable incentives for users.
|
|
1031
|
-
*/
|
|
1032
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
1033
|
-
lineItems?: Array<CheckoutsessionExpireResponse.LineItem>;
|
|
1034
|
-
/**
|
|
1035
|
-
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
1036
|
-
* given language. Users can change the language in the Checkout. If not provided,
|
|
1037
|
-
* the language of the Checkout is determined by the browser's language.
|
|
1038
|
-
*/
|
|
1039
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
347
|
+
incentiveMode?: string;
|
|
348
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
1040
349
|
mandate?: CheckoutsessionExpireResponse.Mandate;
|
|
1041
|
-
/**
|
|
1042
|
-
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
1043
|
-
* located. If provided, the Checkout will display the market's banks first. Not
|
|
1044
|
-
* relevant if `prefill.bankId` is provided.
|
|
1045
|
-
*/
|
|
1046
350
|
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';
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
merchantAppId?: string;
|
|
1051
|
-
/**
|
|
1052
|
-
* Any data which will be stored and returned for this checkout session and
|
|
1053
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
1054
|
-
* more info.
|
|
1055
|
-
*/
|
|
1056
|
-
metadata?: Record<string, unknown>;
|
|
351
|
+
metadata?: {
|
|
352
|
+
[key: string]: unknown;
|
|
353
|
+
};
|
|
1057
354
|
offsetProject?: string;
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
* The shop-plugin version.
|
|
1061
|
-
*/
|
|
355
|
+
paymentMode?: 'direct' | 'settlement';
|
|
356
|
+
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
1062
357
|
plugin?: string;
|
|
1063
|
-
|
|
1064
|
-
* Prefill known data to skip steps in the checkout.
|
|
1065
|
-
*/
|
|
1066
|
-
prefill?: CheckoutsessionExpireResponse.Prefill;
|
|
1067
|
-
/**
|
|
1068
|
-
* Only applicable for express Checkouts. Quote Callback requests will be sent to
|
|
1069
|
-
* this URL.
|
|
1070
|
-
*/
|
|
358
|
+
prefill?: unknown;
|
|
1071
359
|
quoteCallbackUrl?: string;
|
|
1072
|
-
/**
|
|
1073
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
1074
|
-
* input within the Ivy express Checkout.
|
|
1075
|
-
*/
|
|
1076
360
|
required?: CheckoutsessionExpireResponse.Required;
|
|
1077
361
|
selectedShippingMethodId?: string;
|
|
1078
362
|
shippingAddress?: CheckoutsessionExpireResponse.ShippingAddress;
|
|
1079
|
-
shippingMethods?: Array<
|
|
1080
|
-
/**
|
|
1081
|
-
* The logo of the shop provided as a URL.
|
|
1082
|
-
*/
|
|
363
|
+
shippingMethods?: Array<unknown>;
|
|
1083
364
|
shopLogo?: string;
|
|
1084
365
|
shopName?: string;
|
|
1085
366
|
subaccountId?: string;
|
|
367
|
+
updatedAt?: unknown;
|
|
1086
368
|
}
|
|
1087
369
|
export declare namespace CheckoutsessionExpireResponse {
|
|
370
|
+
interface LineItem {
|
|
371
|
+
/**
|
|
372
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
373
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
374
|
+
*/
|
|
375
|
+
amount: number;
|
|
376
|
+
/**
|
|
377
|
+
* Customer-facing name of the line item.
|
|
378
|
+
*/
|
|
379
|
+
name: string;
|
|
380
|
+
singleNet: number;
|
|
381
|
+
singleVat: number;
|
|
382
|
+
category?: '5045' | '5065' | '5094' | '5192' | '5193' | '5499' | '5655' | '5691' | '5712' | '5722' | '5812' | '5814' | '5912' | '5977' | '5999' | '7629';
|
|
383
|
+
co2Grams?: number;
|
|
384
|
+
EAN?: string;
|
|
385
|
+
/**
|
|
386
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
387
|
+
*/
|
|
388
|
+
image?: string;
|
|
389
|
+
/**
|
|
390
|
+
* Quantity of this lineItem.
|
|
391
|
+
*/
|
|
392
|
+
quantity?: number;
|
|
393
|
+
/**
|
|
394
|
+
* An internal unique id stored to this line item.
|
|
395
|
+
*/
|
|
396
|
+
referenceId?: string;
|
|
397
|
+
}
|
|
1088
398
|
interface Merchant {
|
|
1089
399
|
id: string;
|
|
1090
400
|
appId: string;
|
|
@@ -1094,304 +404,77 @@ export declare namespace CheckoutsessionExpireResponse {
|
|
|
1094
404
|
namespace Merchant {
|
|
1095
405
|
interface Address {
|
|
1096
406
|
city: string;
|
|
1097
|
-
/**
|
|
1098
|
-
* The country code in
|
|
1099
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1100
|
-
*/
|
|
1101
407
|
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';
|
|
408
|
+
firstName: string;
|
|
409
|
+
lastName: string;
|
|
1102
410
|
line1: string;
|
|
411
|
+
line2: string;
|
|
412
|
+
region: string;
|
|
1103
413
|
zipCode: string;
|
|
1104
|
-
firstName?: string;
|
|
1105
|
-
lastName?: string;
|
|
1106
|
-
line2?: string;
|
|
1107
|
-
region?: string;
|
|
1108
414
|
}
|
|
1109
415
|
}
|
|
1110
|
-
/**
|
|
1111
|
-
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
1112
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1113
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1114
|
-
* as this is the format accepted by most banks.
|
|
1115
|
-
*/
|
|
1116
416
|
interface Price {
|
|
1117
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
1118
|
-
/**
|
|
1119
|
-
* The total amount to be paid.
|
|
1120
|
-
*/
|
|
417
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
1121
418
|
total: number;
|
|
1122
419
|
shipping?: number;
|
|
1123
420
|
subTotal?: number;
|
|
1124
421
|
totalNet?: number;
|
|
1125
422
|
vat?: number;
|
|
1126
423
|
}
|
|
1127
|
-
/**
|
|
1128
|
-
* The billing address of the customer. Required when handshake=true.
|
|
1129
|
-
*/
|
|
1130
424
|
interface BillingAddress {
|
|
1131
425
|
city: string;
|
|
1132
|
-
/**
|
|
1133
|
-
* The country code in
|
|
1134
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1135
|
-
*/
|
|
1136
426
|
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';
|
|
427
|
+
firstName: string;
|
|
428
|
+
lastName: string;
|
|
1137
429
|
line1: string;
|
|
430
|
+
line2: string;
|
|
431
|
+
region: string;
|
|
1138
432
|
zipCode: string;
|
|
1139
|
-
firstName?: string;
|
|
1140
|
-
lastName?: string;
|
|
1141
|
-
line2?: string;
|
|
1142
|
-
region?: string;
|
|
1143
433
|
}
|
|
1144
434
|
interface Customer {
|
|
1145
435
|
id: string;
|
|
1146
436
|
}
|
|
1147
|
-
/**
|
|
1148
|
-
* The line items of the Checkout.
|
|
1149
|
-
*/
|
|
1150
|
-
interface LineItem {
|
|
1151
|
-
/**
|
|
1152
|
-
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
1153
|
-
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
1154
|
-
*/
|
|
1155
|
-
amount: number;
|
|
1156
|
-
/**
|
|
1157
|
-
* The name of the line item.
|
|
1158
|
-
*/
|
|
1159
|
-
name: string;
|
|
1160
|
-
/**
|
|
1161
|
-
* The quantity of the line item.
|
|
1162
|
-
*/
|
|
1163
|
-
quantity: number;
|
|
1164
|
-
/**
|
|
1165
|
-
* The net amount of a single item.
|
|
1166
|
-
*/
|
|
1167
|
-
singleNet: number;
|
|
1168
|
-
/**
|
|
1169
|
-
* The VAT amount of a single item.
|
|
1170
|
-
*/
|
|
1171
|
-
singleVat: number;
|
|
1172
|
-
/**
|
|
1173
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
1174
|
-
* the line item.
|
|
1175
|
-
*/
|
|
1176
|
-
category?: string;
|
|
1177
|
-
/**
|
|
1178
|
-
* The
|
|
1179
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
1180
|
-
* of the line item.
|
|
1181
|
-
*/
|
|
1182
|
-
EAN?: string;
|
|
1183
|
-
/**
|
|
1184
|
-
* The image of the line item as a URL.
|
|
1185
|
-
*/
|
|
1186
|
-
image?: string;
|
|
1187
|
-
/**
|
|
1188
|
-
* The internal unique identifier of the line item.
|
|
1189
|
-
*/
|
|
1190
|
-
referenceId?: string;
|
|
1191
|
-
}
|
|
1192
437
|
interface Mandate {
|
|
1193
|
-
setup: boolean;
|
|
1194
|
-
/**
|
|
1195
|
-
* The name of the account holder who signs the mandate
|
|
1196
|
-
*/
|
|
1197
438
|
accountHolderName?: string;
|
|
439
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
1198
440
|
referenceId?: string;
|
|
441
|
+
setup?: boolean;
|
|
1199
442
|
userNotificationEmail?: string;
|
|
1200
443
|
}
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
/**
|
|
1206
|
-
* The known bank id. Customers will skip the bank selection and go directly to the
|
|
1207
|
-
* bank's login. Required for financial address prefill.
|
|
1208
|
-
*/
|
|
1209
|
-
bankId?: string;
|
|
1210
|
-
/**
|
|
1211
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
1212
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
1213
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
1214
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
1215
|
-
* out.
|
|
1216
|
-
*/
|
|
1217
|
-
payerFinancialAddress?: Prefill.PayerFinancialAddress;
|
|
1218
|
-
}
|
|
1219
|
-
namespace Prefill {
|
|
1220
|
-
/**
|
|
1221
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
1222
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
1223
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
1224
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
1225
|
-
* out.
|
|
1226
|
-
*/
|
|
1227
|
-
interface PayerFinancialAddress {
|
|
1228
|
-
/**
|
|
1229
|
-
* The type of the financial address. The actual destination is determined by this
|
|
1230
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
1231
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
1232
|
-
* in the "iban" object.
|
|
1233
|
-
*
|
|
1234
|
-
* - iban: The IBAN of the account
|
|
1235
|
-
* - sort_code: The sort code of the account
|
|
1236
|
-
* - bank_code: The bank code of the account
|
|
1237
|
-
* - bban: The BBAN of the account
|
|
1238
|
-
*/
|
|
1239
|
-
type: string;
|
|
1240
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
1241
|
-
bban?: PayerFinancialAddress.Bban;
|
|
1242
|
-
iban?: PayerFinancialAddress.Iban;
|
|
1243
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
444
|
+
namespace Mandate {
|
|
445
|
+
interface AdditionalDisplayInformation {
|
|
446
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
447
|
+
price?: AdditionalDisplayInformation.Price;
|
|
1244
448
|
}
|
|
1245
|
-
namespace
|
|
1246
|
-
interface
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
/**
|
|
1250
|
-
* The name of the account holder.
|
|
1251
|
-
*/
|
|
1252
|
-
accountHolderName?: string;
|
|
1253
|
-
}
|
|
1254
|
-
interface Bban {
|
|
1255
|
-
bban: string;
|
|
1256
|
-
/**
|
|
1257
|
-
* The name of the account holder.
|
|
1258
|
-
*/
|
|
1259
|
-
accountHolderName?: string;
|
|
1260
|
-
bic?: string;
|
|
1261
|
-
}
|
|
1262
|
-
interface Iban {
|
|
1263
|
-
iban: string;
|
|
1264
|
-
/**
|
|
1265
|
-
* The name of the account holder.
|
|
1266
|
-
*/
|
|
1267
|
-
accountHolderName?: string;
|
|
1268
|
-
bic?: string;
|
|
1269
|
-
}
|
|
1270
|
-
interface SortCode {
|
|
1271
|
-
accountNumber: string;
|
|
1272
|
-
sortCode: string;
|
|
1273
|
-
/**
|
|
1274
|
-
* The name of the account holder.
|
|
1275
|
-
*/
|
|
1276
|
-
accountHolderName?: string;
|
|
449
|
+
namespace AdditionalDisplayInformation {
|
|
450
|
+
interface Price {
|
|
451
|
+
amount: number;
|
|
452
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
1277
453
|
}
|
|
1278
454
|
}
|
|
1279
455
|
}
|
|
1280
|
-
/**
|
|
1281
|
-
* Only applicable for express Checkout Sessions. The given fields will be required
|
|
1282
|
-
* input within the Ivy express Checkout.
|
|
1283
|
-
*/
|
|
1284
456
|
interface Required {
|
|
1285
|
-
/**
|
|
1286
|
-
* If set to true, the phone number will be required input within the Ivy express
|
|
1287
|
-
* Checkout.
|
|
1288
|
-
*/
|
|
1289
457
|
phone: boolean;
|
|
1290
458
|
}
|
|
1291
459
|
interface ShippingAddress {
|
|
1292
460
|
city: string;
|
|
1293
|
-
/**
|
|
1294
|
-
* The country code in
|
|
1295
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1296
|
-
*/
|
|
1297
461
|
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';
|
|
462
|
+
firstName: string;
|
|
463
|
+
lastName: string;
|
|
1298
464
|
line1: string;
|
|
465
|
+
line2: string;
|
|
466
|
+
region: string;
|
|
1299
467
|
zipCode: string;
|
|
1300
|
-
firstName?: string;
|
|
1301
|
-
lastName?: string;
|
|
1302
|
-
line2?: string;
|
|
1303
|
-
region?: string;
|
|
1304
|
-
}
|
|
1305
|
-
/**
|
|
1306
|
-
* The shipping methods of the Checkout.
|
|
1307
|
-
*/
|
|
1308
|
-
interface ShippingMethod {
|
|
1309
|
-
/**
|
|
1310
|
-
* The customer-facing name of the shipping method.
|
|
1311
|
-
*/
|
|
1312
|
-
name: string;
|
|
1313
|
-
/**
|
|
1314
|
-
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
1315
|
-
*/
|
|
1316
|
-
price: number;
|
|
1317
|
-
/**
|
|
1318
|
-
* The unique identifier of the shipping method within Ivy.
|
|
1319
|
-
*/
|
|
1320
|
-
id?: string;
|
|
1321
|
-
/**
|
|
1322
|
-
* The list of countries where the shipping method is available.
|
|
1323
|
-
*/
|
|
1324
|
-
countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
|
|
1325
|
-
/**
|
|
1326
|
-
* The delivery estimate of the shipping method.
|
|
1327
|
-
*/
|
|
1328
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
1329
|
-
/**
|
|
1330
|
-
* The unique identifier within your system of the shipping method.
|
|
1331
|
-
*/
|
|
1332
|
-
reference?: string;
|
|
1333
|
-
/**
|
|
1334
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
1335
|
-
*/
|
|
1336
|
-
timeFrame?: string;
|
|
1337
|
-
}
|
|
1338
|
-
namespace ShippingMethod {
|
|
1339
|
-
/**
|
|
1340
|
-
* The delivery estimate of the shipping method.
|
|
1341
|
-
*/
|
|
1342
|
-
interface DeliveryEstimate {
|
|
1343
|
-
/**
|
|
1344
|
-
* The maximum delivery time.
|
|
1345
|
-
*/
|
|
1346
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
1347
|
-
/**
|
|
1348
|
-
* The minimum delivery time.
|
|
1349
|
-
*/
|
|
1350
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
1351
|
-
}
|
|
1352
|
-
namespace DeliveryEstimate {
|
|
1353
|
-
/**
|
|
1354
|
-
* The maximum delivery time.
|
|
1355
|
-
*/
|
|
1356
|
-
interface Maximum {
|
|
1357
|
-
/**
|
|
1358
|
-
* The unit of the time duration.
|
|
1359
|
-
*/
|
|
1360
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
1361
|
-
/**
|
|
1362
|
-
* The value of the time duration.
|
|
1363
|
-
*/
|
|
1364
|
-
value: number;
|
|
1365
|
-
}
|
|
1366
|
-
/**
|
|
1367
|
-
* The minimum delivery time.
|
|
1368
|
-
*/
|
|
1369
|
-
interface Minimum {
|
|
1370
|
-
/**
|
|
1371
|
-
* The unit of the time duration.
|
|
1372
|
-
*/
|
|
1373
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
1374
|
-
/**
|
|
1375
|
-
* The value of the time duration.
|
|
1376
|
-
*/
|
|
1377
|
-
value: number;
|
|
1378
|
-
}
|
|
1379
|
-
}
|
|
1380
468
|
}
|
|
1381
469
|
}
|
|
1382
470
|
export interface CheckoutsessionCreateParams {
|
|
1383
471
|
/**
|
|
1384
|
-
*
|
|
1385
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1386
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1387
|
-
* as this is the format accepted by most banks.
|
|
472
|
+
* Price of the checkout session
|
|
1388
473
|
*/
|
|
1389
474
|
price: CheckoutsessionCreateParams.Price;
|
|
1390
475
|
/**
|
|
1391
|
-
* An internal reference id which will be stored with the
|
|
1392
|
-
*
|
|
1393
|
-
* characters. We recommend to use your internal unique id for this customer's
|
|
1394
|
-
* payment process.
|
|
476
|
+
* An internal reference id which will be stored with the order. Needs to be unique
|
|
477
|
+
* per shop and can be up to 200 characters.
|
|
1395
478
|
*/
|
|
1396
479
|
referenceId: string;
|
|
1397
480
|
/**
|
|
@@ -1399,33 +482,27 @@ export interface CheckoutsessionCreateParams {
|
|
|
1399
482
|
*/
|
|
1400
483
|
billingAddress?: CheckoutsessionCreateParams.BillingAddress;
|
|
1401
484
|
/**
|
|
1402
|
-
*
|
|
1403
|
-
* to this URL.
|
|
485
|
+
* Complete Callback requests will be sent to this URL on default.
|
|
1404
486
|
*/
|
|
1405
487
|
completeCallbackUrl?: string;
|
|
1406
488
|
/**
|
|
1407
489
|
* The Epoch time in seconds at which the Checkout Session was created. By default,
|
|
1408
|
-
* time of
|
|
490
|
+
* time of api CheckoutSession creation at Ivy.
|
|
1409
491
|
*/
|
|
1410
492
|
created?: number;
|
|
493
|
+
customer?: CheckoutsessionCreateParams.Customer;
|
|
1411
494
|
/**
|
|
1412
|
-
*
|
|
1413
|
-
|
|
1414
|
-
customer?: CheckoutsessionCreateParams.Email | CheckoutsessionCreateParams.ID;
|
|
1415
|
-
/**
|
|
1416
|
-
* False by default. If set to true, customers cannot choose another bank than the
|
|
1417
|
-
* pre-selected one.
|
|
495
|
+
* Disable bank selection mode. If set to true, customers cannot modify the pre
|
|
496
|
+
* selected bank.
|
|
1418
497
|
*/
|
|
1419
498
|
disableBankSelection?: boolean;
|
|
1420
499
|
/**
|
|
1421
|
-
* The
|
|
1422
|
-
*
|
|
1423
|
-
* customer-friendly id.
|
|
500
|
+
* The order id which will be displayed to the user and in the merchant dashboard.
|
|
501
|
+
* At most 200 characters are allowed.
|
|
1424
502
|
*/
|
|
1425
503
|
displayId?: string;
|
|
1426
504
|
/**
|
|
1427
|
-
*
|
|
1428
|
-
* unsuccessful payment attempt.
|
|
505
|
+
* Users will be redirected here on default after an unsuccessful checkout.
|
|
1429
506
|
*/
|
|
1430
507
|
errorCallbackUrl?: string;
|
|
1431
508
|
/**
|
|
@@ -1435,93 +512,55 @@ export interface CheckoutsessionCreateParams {
|
|
|
1435
512
|
*/
|
|
1436
513
|
expiresAt?: number;
|
|
1437
514
|
/**
|
|
1438
|
-
*
|
|
1439
|
-
* checkout session.
|
|
515
|
+
* Sets the checkout to a express version
|
|
1440
516
|
*/
|
|
1441
517
|
express?: boolean;
|
|
1442
518
|
/**
|
|
1443
|
-
*
|
|
519
|
+
* All line items of this checkout session. At least one line item required
|
|
1444
520
|
*/
|
|
1445
521
|
lineItems?: Array<CheckoutsessionCreateParams.LineItem>;
|
|
1446
|
-
|
|
1447
|
-
* The locale of the customer, i.e. the language of the checkout. Customers can
|
|
1448
|
-
* change the language in the checkout. If not provided, the language of the
|
|
1449
|
-
* checkout is determined by the browser's language.
|
|
1450
|
-
*/
|
|
1451
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
1452
|
-
/**
|
|
1453
|
-
* The mandate setup for the payment. Relevant for
|
|
1454
|
-
* [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
|
|
1455
|
-
*/
|
|
522
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
1456
523
|
mandate?: CheckoutsessionCreateParams.Mandate;
|
|
1457
524
|
/**
|
|
1458
|
-
*
|
|
1459
|
-
*
|
|
1460
|
-
* `prefill.bankId` is provided.
|
|
525
|
+
* The market of the checkoutSession. Will show the market banks connected with
|
|
526
|
+
* this market
|
|
1461
527
|
*/
|
|
1462
528
|
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';
|
|
1463
529
|
/**
|
|
1464
530
|
* Any data which will be stored and returned for this checkout session and
|
|
1465
|
-
* corresponding order
|
|
1466
|
-
* more info.
|
|
1467
|
-
*/
|
|
1468
|
-
metadata?: Array<Record<string, unknown>>;
|
|
1469
|
-
/**
|
|
1470
|
-
* - `settlement`: The payment is initially settled into a virtual account. The
|
|
1471
|
-
* funds are then disbursed in batches to the merchant. Refunds are instantly
|
|
1472
|
-
* processed from the virtual account.
|
|
1473
|
-
* - `direct`: The payment will be settled to the specified `settlementDestination`
|
|
1474
|
-
* account. `settlementDestination` is required if `paymentMode` is `direct`.
|
|
531
|
+
* corresponding order
|
|
1475
532
|
*/
|
|
1476
|
-
|
|
533
|
+
metadata?: {
|
|
534
|
+
[key: string]: unknown;
|
|
535
|
+
};
|
|
1477
536
|
/**
|
|
1478
|
-
* The
|
|
1479
|
-
*
|
|
1480
|
-
* means that the payment is done via instant rails, if supported by the bank. It
|
|
1481
|
-
* will use standard rails, if not supported by the bank. Standard means that only
|
|
1482
|
-
* cost-free, but potentially slower bank rails are used for the transfer. Defaults
|
|
1483
|
-
* to value set on merchant dashboard if not provided.
|
|
537
|
+
* The mode in which the payment should be processed. If direct is used, you need
|
|
538
|
+
* to provide a settlementDestination
|
|
1484
539
|
*/
|
|
540
|
+
paymentMode?: 'direct' | 'settlement';
|
|
1485
541
|
paymentSchemeSelection?: 'instant_preferred' | 'standard' | 'instant_only';
|
|
1486
542
|
/**
|
|
1487
|
-
*
|
|
543
|
+
* The values specified here will be pre-filled in the Ivy Checkout.
|
|
1488
544
|
*/
|
|
1489
545
|
prefill?: CheckoutsessionCreateParams.Prefill;
|
|
1490
546
|
/**
|
|
1491
|
-
*
|
|
1492
|
-
* this URL.
|
|
547
|
+
* Quote Callback requests will be sent to this URL on default.
|
|
1493
548
|
*/
|
|
1494
549
|
quoteCallbackUrl?: string;
|
|
1495
|
-
/**
|
|
1496
|
-
* The settlement destination of the payment. If not provided, the financial
|
|
1497
|
-
* address of the merchant's direct payout destination will be used with a randomly
|
|
1498
|
-
* generated payment reference.
|
|
1499
|
-
*/
|
|
1500
550
|
settlementDestination?: CheckoutsessionCreateParams.SettlementDestination;
|
|
1501
|
-
/**
|
|
1502
|
-
* Usually relevant for PSPs. Create a subaccount for each underlying storefront or
|
|
1503
|
-
* merchant which processes payments with your Ivy account. You can create new
|
|
1504
|
-
* subaccounts [here](https://docs.getivy.de/reference/merchantsubaccountcreate-1)
|
|
1505
|
-
*/
|
|
1506
551
|
subaccountId?: string;
|
|
1507
552
|
/**
|
|
1508
|
-
*
|
|
1509
|
-
* successful payment attempt.
|
|
553
|
+
* Users will be redirected here on default after a successful checkout.
|
|
1510
554
|
*/
|
|
1511
555
|
successCallbackUrl?: string;
|
|
556
|
+
themeVariant?: 'light' | 'dark';
|
|
1512
557
|
}
|
|
1513
558
|
export declare namespace CheckoutsessionCreateParams {
|
|
1514
559
|
/**
|
|
1515
|
-
*
|
|
1516
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1517
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1518
|
-
* as this is the format accepted by most banks.
|
|
560
|
+
* Price of the checkout session
|
|
1519
561
|
*/
|
|
1520
562
|
interface Price {
|
|
1521
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
1522
|
-
/**
|
|
1523
|
-
* The total amount to be paid.
|
|
1524
|
-
*/
|
|
563
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
1525
564
|
total: number;
|
|
1526
565
|
shipping?: number;
|
|
1527
566
|
subTotal?: number;
|
|
@@ -1533,200 +572,81 @@ export declare namespace CheckoutsessionCreateParams {
|
|
|
1533
572
|
*/
|
|
1534
573
|
interface BillingAddress {
|
|
1535
574
|
city: string;
|
|
1536
|
-
/**
|
|
1537
|
-
* The country code in
|
|
1538
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1539
|
-
*/
|
|
1540
575
|
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';
|
|
576
|
+
firstName: string;
|
|
577
|
+
lastName: string;
|
|
1541
578
|
line1: string;
|
|
579
|
+
line2: string;
|
|
580
|
+
region: string;
|
|
1542
581
|
zipCode: string;
|
|
1543
|
-
firstName?: string;
|
|
1544
|
-
lastName?: string;
|
|
1545
|
-
line2?: string;
|
|
1546
|
-
region?: string;
|
|
1547
582
|
}
|
|
1548
|
-
interface
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
*/
|
|
1552
|
-
email: string;
|
|
1553
|
-
}
|
|
1554
|
-
interface ID {
|
|
1555
|
-
/**
|
|
1556
|
-
* The Ivy id of the customer.
|
|
1557
|
-
*/
|
|
1558
|
-
id: string;
|
|
583
|
+
interface Customer {
|
|
584
|
+
id?: string;
|
|
585
|
+
email?: string;
|
|
1559
586
|
}
|
|
1560
587
|
interface LineItem {
|
|
1561
588
|
/**
|
|
1562
|
-
*
|
|
1563
|
-
*
|
|
589
|
+
* Accumulated cost in decimals. For example, for a lineItem with total price 3.00
|
|
590
|
+
* and quantity 4, amount would be equal to 12.00.
|
|
1564
591
|
*/
|
|
1565
592
|
amount: number;
|
|
1566
593
|
/**
|
|
1567
|
-
*
|
|
594
|
+
* Customer-facing name of the line item.
|
|
1568
595
|
*/
|
|
1569
596
|
name: string;
|
|
1570
|
-
/**
|
|
1571
|
-
* The quantity of the line item.
|
|
1572
|
-
*/
|
|
1573
|
-
quantity: number;
|
|
1574
|
-
/**
|
|
1575
|
-
* The net amount of a single item.
|
|
1576
|
-
*/
|
|
1577
597
|
singleNet: number;
|
|
1578
|
-
/**
|
|
1579
|
-
* The VAT amount of a single item.
|
|
1580
|
-
*/
|
|
1581
598
|
singleVat: number;
|
|
1582
|
-
|
|
1583
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
1584
|
-
* the line item.
|
|
1585
|
-
*/
|
|
1586
|
-
category?: string;
|
|
1587
|
-
/**
|
|
1588
|
-
* The
|
|
1589
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
1590
|
-
* of the line item.
|
|
1591
|
-
*/
|
|
599
|
+
category?: '5045' | '5065' | '5094' | '5192' | '5193' | '5499' | '5655' | '5691' | '5712' | '5722' | '5812' | '5814' | '5912' | '5977' | '5999' | '7629';
|
|
1592
600
|
EAN?: string;
|
|
1593
601
|
/**
|
|
1594
|
-
*
|
|
602
|
+
* An image of the line item. Valid URLs are accepted only.
|
|
1595
603
|
*/
|
|
1596
604
|
image?: string;
|
|
1597
605
|
/**
|
|
1598
|
-
*
|
|
606
|
+
* Quantity of this lineItem.
|
|
607
|
+
*/
|
|
608
|
+
quantity?: number;
|
|
609
|
+
/**
|
|
610
|
+
* An internal unique id stored to this line item.
|
|
1599
611
|
*/
|
|
1600
612
|
referenceId?: string;
|
|
1601
613
|
}
|
|
1602
|
-
/**
|
|
1603
|
-
* The mandate setup for the payment. Relevant for
|
|
1604
|
-
* [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
|
|
1605
|
-
*/
|
|
1606
614
|
interface Mandate {
|
|
1607
|
-
setup: boolean;
|
|
1608
|
-
/**
|
|
1609
|
-
* The name of the account holder who signs the mandate
|
|
1610
|
-
*/
|
|
1611
615
|
accountHolderName?: string;
|
|
616
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
1612
617
|
referenceId?: string;
|
|
618
|
+
setup?: boolean;
|
|
1613
619
|
userNotificationEmail?: string;
|
|
1614
620
|
}
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
/**
|
|
1620
|
-
* The known bank id. Customers will skip the bank selection and go directly to the
|
|
1621
|
-
* bank's login. Required for financial address prefill.
|
|
1622
|
-
*/
|
|
1623
|
-
bankId?: string;
|
|
1624
|
-
/**
|
|
1625
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
1626
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
1627
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
1628
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
1629
|
-
* out.
|
|
1630
|
-
*/
|
|
1631
|
-
payerFinancialAddress?: Prefill.PayerFinancialAddress;
|
|
1632
|
-
}
|
|
1633
|
-
namespace Prefill {
|
|
1634
|
-
/**
|
|
1635
|
-
* Prefill the customer's financial address to skip bank selection and enforce the
|
|
1636
|
-
* customer to pay from this specific bank account. Use IBAN for SEPA EUR payments
|
|
1637
|
-
* and Sort Code for UK GBP payments. The validation logic is based on the "type"
|
|
1638
|
-
* field. For example, if "type" is set to "iban", the "iban" object must be filled
|
|
1639
|
-
* out.
|
|
1640
|
-
*/
|
|
1641
|
-
interface PayerFinancialAddress {
|
|
1642
|
-
/**
|
|
1643
|
-
* The type of the financial address. The actual destination is determined by this
|
|
1644
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
1645
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
1646
|
-
* in the "iban" object.
|
|
1647
|
-
*
|
|
1648
|
-
* - iban: The IBAN of the account
|
|
1649
|
-
* - sort_code: The sort code of the account
|
|
1650
|
-
* - bank_code: The bank code of the account
|
|
1651
|
-
* - bban: The BBAN of the account
|
|
1652
|
-
*/
|
|
1653
|
-
type: string;
|
|
1654
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
1655
|
-
bban?: PayerFinancialAddress.Bban;
|
|
1656
|
-
iban?: PayerFinancialAddress.Iban;
|
|
1657
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
621
|
+
namespace Mandate {
|
|
622
|
+
interface AdditionalDisplayInformation {
|
|
623
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
624
|
+
price?: AdditionalDisplayInformation.Price;
|
|
1658
625
|
}
|
|
1659
|
-
namespace
|
|
1660
|
-
interface
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
/**
|
|
1664
|
-
* The name of the account holder.
|
|
1665
|
-
*/
|
|
1666
|
-
accountHolderName?: string;
|
|
1667
|
-
}
|
|
1668
|
-
interface Bban {
|
|
1669
|
-
bban: string;
|
|
1670
|
-
/**
|
|
1671
|
-
* The name of the account holder.
|
|
1672
|
-
*/
|
|
1673
|
-
accountHolderName?: string;
|
|
1674
|
-
bic?: string;
|
|
1675
|
-
}
|
|
1676
|
-
interface Iban {
|
|
1677
|
-
iban: string;
|
|
1678
|
-
/**
|
|
1679
|
-
* The name of the account holder.
|
|
1680
|
-
*/
|
|
1681
|
-
accountHolderName?: string;
|
|
1682
|
-
bic?: string;
|
|
1683
|
-
}
|
|
1684
|
-
interface SortCode {
|
|
1685
|
-
accountNumber: string;
|
|
1686
|
-
sortCode: string;
|
|
1687
|
-
/**
|
|
1688
|
-
* The name of the account holder.
|
|
1689
|
-
*/
|
|
1690
|
-
accountHolderName?: string;
|
|
626
|
+
namespace AdditionalDisplayInformation {
|
|
627
|
+
interface Price {
|
|
628
|
+
amount: number;
|
|
629
|
+
currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
|
|
1691
630
|
}
|
|
1692
631
|
}
|
|
1693
632
|
}
|
|
1694
633
|
/**
|
|
1695
|
-
* The
|
|
1696
|
-
* address of the merchant's direct payout destination will be used with a randomly
|
|
1697
|
-
* generated payment reference.
|
|
634
|
+
* The values specified here will be pre-filled in the Ivy Checkout.
|
|
1698
635
|
*/
|
|
1699
|
-
interface
|
|
636
|
+
interface Prefill {
|
|
1700
637
|
/**
|
|
1701
|
-
*
|
|
1702
|
-
*
|
|
1703
|
-
* characters, otherwise 35.
|
|
638
|
+
* Retrieve a valid bankId with the POST /banks/search endpoint. When presented in
|
|
639
|
+
* this field, the customer will skip the bank selection in the Ivy Checkout.
|
|
1704
640
|
*/
|
|
641
|
+
bankId?: string;
|
|
642
|
+
}
|
|
643
|
+
interface SettlementDestination {
|
|
1705
644
|
reference: string;
|
|
1706
|
-
/**
|
|
1707
|
-
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
1708
|
-
* to "iban", the "iban" object must be filled out.
|
|
1709
|
-
*/
|
|
1710
645
|
financialAddress?: SettlementDestination.FinancialAddress;
|
|
1711
646
|
}
|
|
1712
647
|
namespace SettlementDestination {
|
|
1713
|
-
/**
|
|
1714
|
-
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
1715
|
-
* to "iban", the "iban" object must be filled out.
|
|
1716
|
-
*/
|
|
1717
648
|
interface FinancialAddress {
|
|
1718
|
-
|
|
1719
|
-
* The type of the financial address. The actual destination is determined by this
|
|
1720
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
1721
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
1722
|
-
* in the "iban" object.
|
|
1723
|
-
*
|
|
1724
|
-
* - iban: The IBAN of the account
|
|
1725
|
-
* - sort_code: The sort code of the account
|
|
1726
|
-
* - bank_code: The bank code of the account
|
|
1727
|
-
* - bban: The BBAN of the account
|
|
1728
|
-
*/
|
|
1729
|
-
type: string;
|
|
649
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
1730
650
|
bankCode?: FinancialAddress.BankCode;
|
|
1731
651
|
bban?: FinancialAddress.Bban;
|
|
1732
652
|
iban?: FinancialAddress.Iban;
|
|
@@ -1734,33 +654,21 @@ export declare namespace CheckoutsessionCreateParams {
|
|
|
1734
654
|
}
|
|
1735
655
|
namespace FinancialAddress {
|
|
1736
656
|
interface BankCode {
|
|
1737
|
-
/**
|
|
1738
|
-
* The name of the account holder.
|
|
1739
|
-
*/
|
|
1740
657
|
accountHolderName: string;
|
|
1741
658
|
accountNumber: string;
|
|
1742
659
|
code: string;
|
|
1743
660
|
}
|
|
1744
661
|
interface Bban {
|
|
1745
|
-
/**
|
|
1746
|
-
* The name of the account holder.
|
|
1747
|
-
*/
|
|
1748
662
|
accountHolderName: string;
|
|
1749
663
|
bban: string;
|
|
1750
664
|
bic?: string;
|
|
1751
665
|
}
|
|
1752
666
|
interface Iban {
|
|
1753
|
-
/**
|
|
1754
|
-
* The name of the account holder.
|
|
1755
|
-
*/
|
|
1756
667
|
accountHolderName: string;
|
|
1757
668
|
iban: string;
|
|
1758
669
|
bic?: string;
|
|
1759
670
|
}
|
|
1760
671
|
interface SortCode {
|
|
1761
|
-
/**
|
|
1762
|
-
* The name of the account holder.
|
|
1763
|
-
*/
|
|
1764
672
|
accountHolderName: string;
|
|
1765
673
|
accountNumber: string;
|
|
1766
674
|
sortCode: string;
|
|
@@ -1769,9 +677,16 @@ export declare namespace CheckoutsessionCreateParams {
|
|
|
1769
677
|
}
|
|
1770
678
|
}
|
|
1771
679
|
export interface CheckoutsessionRetrieveParams {
|
|
680
|
+
/**
|
|
681
|
+
* The checkout session id to retrieve details for
|
|
682
|
+
*/
|
|
1772
683
|
id: string;
|
|
1773
684
|
}
|
|
1774
685
|
export interface CheckoutsessionExpireParams {
|
|
686
|
+
/**
|
|
687
|
+
* The checkout session id to expire. By expiring a Checkout Session, users will
|
|
688
|
+
* not be able to access this Checkout Session anymore.
|
|
689
|
+
*/
|
|
1775
690
|
id: string;
|
|
1776
691
|
}
|
|
1777
692
|
export declare namespace Checkoutsession {
|