@getivy/node-sdk 0.1.0-alpha.20 → 0.1.0-alpha.22
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 +24 -0
- package/index.d.mts +4 -4
- package/index.d.ts +4 -4
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/index.mjs +1 -1
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/customers.d.ts +96 -3
- 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/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/orders.d.ts +1411 -18
- package/resources/orders.d.ts.map +1 -1
- package/resources/orders.js +18 -0
- package/resources/orders.js.map +1 -1
- package/resources/orders.mjs +18 -0
- package/resources/orders.mjs.map +1 -1
- package/src/index.ts +17 -1
- package/src/resources/customers.ts +115 -2
- package/src/resources/index.ts +11 -1
- package/src/resources/orders.ts +3375 -17
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/src/resources/orders.ts
CHANGED
|
@@ -4,6 +4,17 @@ import { APIResource } from '../resource';
|
|
|
4
4
|
import * as Core from '../core';
|
|
5
5
|
|
|
6
6
|
export class Orders extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Create a new order. By creating a new order, you will create a new settlement
|
|
9
|
+
* destination which you can use to settle expected incoming payments efficiently.
|
|
10
|
+
* After creating the order, Ivy provides you with a destination for the expected
|
|
11
|
+
* incoming payment. As soon as a payment with the same details arrives, Ivy will
|
|
12
|
+
* update the status of the order.
|
|
13
|
+
*/
|
|
14
|
+
create(body: OrderCreateParams, options?: Core.RequestOptions): Core.APIPromise<OrderCreateResponse> {
|
|
15
|
+
return this._client.post('/api/service/order/create', { body, ...options });
|
|
16
|
+
}
|
|
17
|
+
|
|
7
18
|
/**
|
|
8
19
|
* Retrieve details of an order. You can retrieve the order by passing either the
|
|
9
20
|
* internal Ivy order id or the `referenceId` you specified when creating a
|
|
@@ -12,9 +23,18 @@ export class Orders extends APIResource {
|
|
|
12
23
|
retrieve(body: OrderRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<OrderRetrieveResponse> {
|
|
13
24
|
return this._client.post('/api/service/order/details', { body, ...options });
|
|
14
25
|
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Expire an order. This will set the order to status `canceled` immediately. All
|
|
29
|
+
* transactions which arrive afterwards for this order will be returned
|
|
30
|
+
* automatically.
|
|
31
|
+
*/
|
|
32
|
+
expire(body: OrderExpireParams, options?: Core.RequestOptions): Core.APIPromise<OrderExpireResponse> {
|
|
33
|
+
return this._client.post('/api/service/order/expire', { body, ...options });
|
|
34
|
+
}
|
|
15
35
|
}
|
|
16
36
|
|
|
17
|
-
export interface
|
|
37
|
+
export interface OrderCreateResponse {
|
|
18
38
|
/**
|
|
19
39
|
* The Ivy unique identifier for the order.
|
|
20
40
|
*/
|
|
@@ -52,7 +72,7 @@ export interface OrderRetrieveResponse {
|
|
|
52
72
|
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
53
73
|
* as this is the format accepted by most banks.
|
|
54
74
|
*/
|
|
55
|
-
price:
|
|
75
|
+
price: OrderCreateResponse.Price;
|
|
56
76
|
|
|
57
77
|
/**
|
|
58
78
|
* An internal reference id which will be stored with the checkout & corresponding
|
|
@@ -101,7 +121,7 @@ export interface OrderRetrieveResponse {
|
|
|
101
121
|
/**
|
|
102
122
|
* The billing address of the user. Required when handshake=true.
|
|
103
123
|
*/
|
|
104
|
-
billingAddress?:
|
|
124
|
+
billingAddress?: OrderCreateResponse.BillingAddress;
|
|
105
125
|
|
|
106
126
|
/**
|
|
107
127
|
* The merchant category code or
|
|
@@ -112,7 +132,7 @@ export interface OrderRetrieveResponse {
|
|
|
112
132
|
/**
|
|
113
133
|
* @deprecated
|
|
114
134
|
*/
|
|
115
|
-
climateActionMode?:
|
|
135
|
+
climateActionMode?: OrderCreateResponse.ClimateActionMode;
|
|
116
136
|
|
|
117
137
|
/**
|
|
118
138
|
* @deprecated
|
|
@@ -124,7 +144,7 @@ export interface OrderRetrieveResponse {
|
|
|
124
144
|
*/
|
|
125
145
|
customerId?: string;
|
|
126
146
|
|
|
127
|
-
destination?:
|
|
147
|
+
destination?: OrderCreateResponse.Destination;
|
|
128
148
|
|
|
129
149
|
/**
|
|
130
150
|
* The customer facing id. This id is displayed to the user during the checkout and
|
|
@@ -155,14 +175,14 @@ export interface OrderRetrieveResponse {
|
|
|
155
175
|
/**
|
|
156
176
|
* The line items of the Checkout.
|
|
157
177
|
*/
|
|
158
|
-
lineItems?: Array<
|
|
178
|
+
lineItems?: Array<OrderCreateResponse.LineItem>;
|
|
159
179
|
|
|
160
|
-
mandate?:
|
|
180
|
+
mandate?: OrderCreateResponse.Mandate;
|
|
161
181
|
|
|
162
182
|
/**
|
|
163
183
|
* @deprecated
|
|
164
184
|
*/
|
|
165
|
-
merchantFinancialAddress?:
|
|
185
|
+
merchantFinancialAddress?: OrderCreateResponse.MerchantFinancialAddress;
|
|
166
186
|
|
|
167
187
|
/**
|
|
168
188
|
* Any data which will be stored and returned for this checkout session and
|
|
@@ -180,7 +200,7 @@ export interface OrderRetrieveResponse {
|
|
|
180
200
|
/**
|
|
181
201
|
* The source bank account where the money is send from.
|
|
182
202
|
*/
|
|
183
|
-
payerFinancialAddress?:
|
|
203
|
+
payerFinancialAddress?: OrderCreateResponse.PayerFinancialAddress;
|
|
184
204
|
|
|
185
205
|
paymentMethodType?: 'sepa_debit' | 'customer_balance' | 'manual_bank_transfer';
|
|
186
206
|
|
|
@@ -215,18 +235,18 @@ export interface OrderRetrieveResponse {
|
|
|
215
235
|
/**
|
|
216
236
|
* The list of refunds connected to this order.
|
|
217
237
|
*/
|
|
218
|
-
refunds?: Array<
|
|
238
|
+
refunds?: Array<OrderCreateResponse.Refund>;
|
|
219
239
|
|
|
220
240
|
/**
|
|
221
241
|
* The shipping address of the user. This is only collected in express Checkouts.
|
|
222
242
|
*/
|
|
223
|
-
shippingAddress?:
|
|
243
|
+
shippingAddress?: OrderCreateResponse.ShippingAddress;
|
|
224
244
|
|
|
225
245
|
/**
|
|
226
246
|
* The selected shipping method by the user. Can either be selected during an
|
|
227
247
|
* express Checkout Session or passed during Checkout Session creation.
|
|
228
248
|
*/
|
|
229
|
-
shippingMethod?:
|
|
249
|
+
shippingMethod?: OrderCreateResponse.ShippingMethod;
|
|
230
250
|
|
|
231
251
|
/**
|
|
232
252
|
* The logo of the shop provided as a URL.
|
|
@@ -237,7 +257,7 @@ export interface OrderRetrieveResponse {
|
|
|
237
257
|
* The shopper object. Contains information collected from the user during the
|
|
238
258
|
* Checkout.
|
|
239
259
|
*/
|
|
240
|
-
shopper?:
|
|
260
|
+
shopper?: OrderCreateResponse.Shopper;
|
|
241
261
|
|
|
242
262
|
/**
|
|
243
263
|
* @deprecated Deprecated in favor of `shopper.email`. The email of the user if
|
|
@@ -245,13 +265,13 @@ export interface OrderRetrieveResponse {
|
|
|
245
265
|
*/
|
|
246
266
|
shopperEmail?: string;
|
|
247
267
|
|
|
248
|
-
statusClassification?:
|
|
268
|
+
statusClassification?: OrderCreateResponse.StatusClassification;
|
|
249
269
|
|
|
250
270
|
/**
|
|
251
271
|
* List of status history items for the order, used for logging every update on
|
|
252
272
|
* status.
|
|
253
273
|
*/
|
|
254
|
-
statusHistoryList?: Array<
|
|
274
|
+
statusHistoryList?: Array<OrderCreateResponse.StatusHistoryList>;
|
|
255
275
|
|
|
256
276
|
/**
|
|
257
277
|
* The subaccount id of the order.
|
|
@@ -269,7 +289,7 @@ export interface OrderRetrieveResponse {
|
|
|
269
289
|
trees?: number;
|
|
270
290
|
}
|
|
271
291
|
|
|
272
|
-
export namespace
|
|
292
|
+
export namespace OrderCreateResponse {
|
|
273
293
|
/**
|
|
274
294
|
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
275
295
|
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
@@ -1655,13 +1675,3351 @@ export namespace OrderRetrieveResponse {
|
|
|
1655
1675
|
}
|
|
1656
1676
|
}
|
|
1657
1677
|
|
|
1658
|
-
export interface
|
|
1678
|
+
export interface OrderRetrieveResponse {
|
|
1679
|
+
/**
|
|
1680
|
+
* The Ivy unique identifier for the order.
|
|
1681
|
+
*/
|
|
1682
|
+
id: string;
|
|
1683
|
+
|
|
1684
|
+
/**
|
|
1685
|
+
* @deprecated The unique identifier for the merchantApp which initiated the order
|
|
1686
|
+
* / payment attempt.
|
|
1687
|
+
*/
|
|
1688
|
+
appId: string;
|
|
1689
|
+
|
|
1690
|
+
/**
|
|
1691
|
+
* The Ivy fee for the payment.
|
|
1692
|
+
*/
|
|
1693
|
+
applicationFeeAmount: number;
|
|
1694
|
+
|
|
1695
|
+
createdAt: string;
|
|
1696
|
+
|
|
1697
|
+
instantPaymentScheme: boolean;
|
|
1698
|
+
|
|
1699
|
+
/**
|
|
1700
|
+
* @deprecated Deprecated in favor of `appId`.
|
|
1701
|
+
*/
|
|
1702
|
+
merchantAppId: string;
|
|
1703
|
+
|
|
1704
|
+
/**
|
|
1705
|
+
* The unique identifier for the merchant which initiated the order / payment
|
|
1706
|
+
* attempt.
|
|
1707
|
+
*/
|
|
1708
|
+
merchantId: string;
|
|
1709
|
+
|
|
1710
|
+
/**
|
|
1711
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
1712
|
+
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1713
|
+
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1714
|
+
* as this is the format accepted by most banks.
|
|
1715
|
+
*/
|
|
1716
|
+
price: OrderRetrieveResponse.Price;
|
|
1717
|
+
|
|
1718
|
+
/**
|
|
1719
|
+
* An internal reference id which will be stored with the checkout & corresponding
|
|
1720
|
+
* order. Needs to be unique per shop per order and can be up to 200 characters.
|
|
1721
|
+
*/
|
|
1722
|
+
referenceId: string;
|
|
1723
|
+
|
|
1724
|
+
/**
|
|
1725
|
+
* The name of the merchant which initiated the order.
|
|
1726
|
+
*/
|
|
1727
|
+
shopName: string;
|
|
1728
|
+
|
|
1729
|
+
/**
|
|
1730
|
+
* The order status. This status symbolises the state of the user's payment
|
|
1731
|
+
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
1732
|
+
* information.
|
|
1733
|
+
*/
|
|
1734
|
+
status:
|
|
1735
|
+
| 'failed'
|
|
1736
|
+
| 'canceled'
|
|
1737
|
+
| 'processing'
|
|
1738
|
+
| 'waiting_for_payment'
|
|
1739
|
+
| 'paid'
|
|
1740
|
+
| 'in_refund'
|
|
1741
|
+
| 'refunded'
|
|
1742
|
+
| 'refund_failed'
|
|
1743
|
+
| 'partially_refunded'
|
|
1744
|
+
| 'in_dispute'
|
|
1745
|
+
| 'disputed'
|
|
1746
|
+
| 'refused';
|
|
1747
|
+
|
|
1748
|
+
updatedAt: string;
|
|
1749
|
+
|
|
1750
|
+
/**
|
|
1751
|
+
* The unique identifier of Ivy of the chosen bank to make the payment. Not there,
|
|
1752
|
+
* if no payment was made.
|
|
1753
|
+
*/
|
|
1754
|
+
bankId?: string;
|
|
1755
|
+
|
|
1756
|
+
/**
|
|
1757
|
+
* @deprecated The bank statement reference of the payment for the order. This is
|
|
1758
|
+
* the reference that will be visible on the bank statement.
|
|
1759
|
+
*/
|
|
1760
|
+
bankStatementReference?: string;
|
|
1761
|
+
|
|
1762
|
+
/**
|
|
1763
|
+
* The billing address of the user. Required when handshake=true.
|
|
1764
|
+
*/
|
|
1765
|
+
billingAddress?: OrderRetrieveResponse.BillingAddress;
|
|
1766
|
+
|
|
1767
|
+
/**
|
|
1768
|
+
* The merchant category code or
|
|
1769
|
+
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
1770
|
+
*/
|
|
1771
|
+
category?: string;
|
|
1772
|
+
|
|
1773
|
+
/**
|
|
1774
|
+
* @deprecated
|
|
1775
|
+
*/
|
|
1776
|
+
climateActionMode?: OrderRetrieveResponse.ClimateActionMode;
|
|
1777
|
+
|
|
1778
|
+
/**
|
|
1779
|
+
* @deprecated
|
|
1780
|
+
*/
|
|
1781
|
+
co2Grams?: number;
|
|
1782
|
+
|
|
1783
|
+
/**
|
|
1784
|
+
* The unique identifier of the customer who placed the order.
|
|
1785
|
+
*/
|
|
1786
|
+
customerId?: string;
|
|
1787
|
+
|
|
1788
|
+
destination?: OrderRetrieveResponse.Destination;
|
|
1789
|
+
|
|
1790
|
+
/**
|
|
1791
|
+
* The customer facing id. This id is displayed to the user during the checkout and
|
|
1792
|
+
* in the merchant dashboard.
|
|
1793
|
+
*/
|
|
1794
|
+
displayId?: string;
|
|
1795
|
+
|
|
1796
|
+
/**
|
|
1797
|
+
* False by default. If set to true, customers skip email input and jump directly
|
|
1798
|
+
* to their bank login. For express Checkout Sessions this is always false.
|
|
1799
|
+
*/
|
|
1800
|
+
guest?: boolean;
|
|
1801
|
+
|
|
1802
|
+
/**
|
|
1803
|
+
* Only valid for sustainable incentive mode. The social / sustainable projects
|
|
1804
|
+
* available to the user during Checkout.
|
|
1805
|
+
*/
|
|
1806
|
+
impactOffsetProjects?: Array<string>;
|
|
1807
|
+
|
|
1808
|
+
/**
|
|
1809
|
+
* The incentive mode of the checkout session. For any use-case apart from
|
|
1810
|
+
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
1811
|
+
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
1812
|
+
* session will contain sustainable incentives for users.
|
|
1813
|
+
*/
|
|
1814
|
+
incentiveMode?: 'white_label' | 'sustainable';
|
|
1815
|
+
|
|
1816
|
+
/**
|
|
1817
|
+
* The line items of the Checkout.
|
|
1818
|
+
*/
|
|
1819
|
+
lineItems?: Array<OrderRetrieveResponse.LineItem>;
|
|
1820
|
+
|
|
1821
|
+
mandate?: OrderRetrieveResponse.Mandate;
|
|
1822
|
+
|
|
1823
|
+
/**
|
|
1824
|
+
* @deprecated
|
|
1825
|
+
*/
|
|
1826
|
+
merchantFinancialAddress?: OrderRetrieveResponse.MerchantFinancialAddress;
|
|
1827
|
+
|
|
1828
|
+
/**
|
|
1829
|
+
* Any data which will be stored and returned for this checkout session and
|
|
1830
|
+
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
1831
|
+
* more info.
|
|
1832
|
+
*/
|
|
1833
|
+
metadata?: Record<string, unknown>;
|
|
1834
|
+
|
|
1835
|
+
/**
|
|
1836
|
+
* Only valid for sustainable incentive mode. The social / sustainability project
|
|
1837
|
+
* chosen by the user during Checkout.
|
|
1838
|
+
*/
|
|
1839
|
+
offsetProject?: string;
|
|
1840
|
+
|
|
1841
|
+
/**
|
|
1842
|
+
* The source bank account where the money is send from.
|
|
1843
|
+
*/
|
|
1844
|
+
payerFinancialAddress?: OrderRetrieveResponse.PayerFinancialAddress;
|
|
1845
|
+
|
|
1846
|
+
paymentMethodType?: 'sepa_debit' | 'customer_balance' | 'manual_bank_transfer';
|
|
1847
|
+
|
|
1848
|
+
/**
|
|
1849
|
+
* The payment mode of the order. Can be either 'settlement' or 'direct'.
|
|
1850
|
+
*/
|
|
1851
|
+
paymentMode?: 'settlement' | 'direct';
|
|
1852
|
+
|
|
1853
|
+
/**
|
|
1854
|
+
* @deprecated Deprecated in favor of `status`. Do not use this field to trigger
|
|
1855
|
+
* actions in your system.
|
|
1856
|
+
*/
|
|
1857
|
+
paymentStatus?:
|
|
1858
|
+
| 'failed'
|
|
1859
|
+
| 'canceled'
|
|
1860
|
+
| 'processing'
|
|
1861
|
+
| 'requires_action'
|
|
1862
|
+
| 'succeeded'
|
|
1863
|
+
| 'in_refund'
|
|
1864
|
+
| 'refunded'
|
|
1865
|
+
| 'refund_failed'
|
|
1866
|
+
| 'partially_refunded'
|
|
1867
|
+
| 'not_settled'
|
|
1868
|
+
| 'disputed'
|
|
1869
|
+
| 'frozen_due_to_aml';
|
|
1870
|
+
|
|
1871
|
+
/**
|
|
1872
|
+
* The total amount in the currency of all successful refunds for this order
|
|
1873
|
+
*/
|
|
1874
|
+
refundAmount?: number;
|
|
1875
|
+
|
|
1876
|
+
/**
|
|
1877
|
+
* The list of refunds connected to this order.
|
|
1878
|
+
*/
|
|
1879
|
+
refunds?: Array<OrderRetrieveResponse.Refund>;
|
|
1880
|
+
|
|
1881
|
+
/**
|
|
1882
|
+
* The shipping address of the user. This is only collected in express Checkouts.
|
|
1883
|
+
*/
|
|
1884
|
+
shippingAddress?: OrderRetrieveResponse.ShippingAddress;
|
|
1885
|
+
|
|
1886
|
+
/**
|
|
1887
|
+
* The selected shipping method by the user. Can either be selected during an
|
|
1888
|
+
* express Checkout Session or passed during Checkout Session creation.
|
|
1889
|
+
*/
|
|
1890
|
+
shippingMethod?: OrderRetrieveResponse.ShippingMethod;
|
|
1891
|
+
|
|
1892
|
+
/**
|
|
1893
|
+
* The logo of the shop provided as a URL.
|
|
1894
|
+
*/
|
|
1895
|
+
shopLogo?: string;
|
|
1896
|
+
|
|
1897
|
+
/**
|
|
1898
|
+
* The shopper object. Contains information collected from the user during the
|
|
1899
|
+
* Checkout.
|
|
1900
|
+
*/
|
|
1901
|
+
shopper?: OrderRetrieveResponse.Shopper;
|
|
1902
|
+
|
|
1903
|
+
/**
|
|
1904
|
+
* @deprecated Deprecated in favor of `shopper.email`. The email of the user if
|
|
1905
|
+
* collected in the Checkout.
|
|
1906
|
+
*/
|
|
1907
|
+
shopperEmail?: string;
|
|
1908
|
+
|
|
1909
|
+
statusClassification?: OrderRetrieveResponse.StatusClassification;
|
|
1910
|
+
|
|
1911
|
+
/**
|
|
1912
|
+
* List of status history items for the order, used for logging every update on
|
|
1913
|
+
* status.
|
|
1914
|
+
*/
|
|
1915
|
+
statusHistoryList?: Array<OrderRetrieveResponse.StatusHistoryList>;
|
|
1916
|
+
|
|
1917
|
+
/**
|
|
1918
|
+
* The subaccount id of the order.
|
|
1919
|
+
*/
|
|
1920
|
+
subaccountId?: string;
|
|
1921
|
+
|
|
1922
|
+
/**
|
|
1923
|
+
* The legal name of the subaccount
|
|
1924
|
+
*/
|
|
1925
|
+
subaccountLegalName?: string;
|
|
1926
|
+
|
|
1927
|
+
/**
|
|
1928
|
+
* @deprecated
|
|
1929
|
+
*/
|
|
1930
|
+
trees?: number;
|
|
1931
|
+
}
|
|
1932
|
+
|
|
1933
|
+
export namespace OrderRetrieveResponse {
|
|
1934
|
+
/**
|
|
1935
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
1936
|
+
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1937
|
+
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1938
|
+
* as this is the format accepted by most banks.
|
|
1939
|
+
*/
|
|
1940
|
+
export interface Price {
|
|
1941
|
+
currency: 'EUR' | 'GBP' | 'PLN';
|
|
1942
|
+
|
|
1943
|
+
/**
|
|
1944
|
+
* The total amount to be paid.
|
|
1945
|
+
*/
|
|
1946
|
+
total: number;
|
|
1947
|
+
|
|
1948
|
+
shipping?: number;
|
|
1949
|
+
|
|
1950
|
+
subTotal?: number;
|
|
1951
|
+
|
|
1952
|
+
totalNet?: number;
|
|
1953
|
+
|
|
1954
|
+
vat?: number;
|
|
1955
|
+
}
|
|
1956
|
+
|
|
1957
|
+
/**
|
|
1958
|
+
* The billing address of the user. Required when handshake=true.
|
|
1959
|
+
*/
|
|
1960
|
+
export interface BillingAddress {
|
|
1961
|
+
city: string;
|
|
1962
|
+
|
|
1963
|
+
/**
|
|
1964
|
+
* The country code in
|
|
1965
|
+
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1966
|
+
*/
|
|
1967
|
+
country:
|
|
1968
|
+
| 'AF'
|
|
1969
|
+
| 'AL'
|
|
1970
|
+
| 'DZ'
|
|
1971
|
+
| 'AS'
|
|
1972
|
+
| 'AD'
|
|
1973
|
+
| 'AO'
|
|
1974
|
+
| 'AI'
|
|
1975
|
+
| 'AQ'
|
|
1976
|
+
| 'AG'
|
|
1977
|
+
| 'AR'
|
|
1978
|
+
| 'AM'
|
|
1979
|
+
| 'AW'
|
|
1980
|
+
| 'AU'
|
|
1981
|
+
| 'AT'
|
|
1982
|
+
| 'AZ'
|
|
1983
|
+
| 'BS'
|
|
1984
|
+
| 'BH'
|
|
1985
|
+
| 'BD'
|
|
1986
|
+
| 'BB'
|
|
1987
|
+
| 'BY'
|
|
1988
|
+
| 'BE'
|
|
1989
|
+
| 'BZ'
|
|
1990
|
+
| 'BJ'
|
|
1991
|
+
| 'BM'
|
|
1992
|
+
| 'BT'
|
|
1993
|
+
| 'BO'
|
|
1994
|
+
| 'BA'
|
|
1995
|
+
| 'BW'
|
|
1996
|
+
| 'BV'
|
|
1997
|
+
| 'BR'
|
|
1998
|
+
| 'IO'
|
|
1999
|
+
| 'BN'
|
|
2000
|
+
| 'BG'
|
|
2001
|
+
| 'BF'
|
|
2002
|
+
| 'BI'
|
|
2003
|
+
| 'KH'
|
|
2004
|
+
| 'CM'
|
|
2005
|
+
| 'CA'
|
|
2006
|
+
| 'CV'
|
|
2007
|
+
| 'KY'
|
|
2008
|
+
| 'CF'
|
|
2009
|
+
| 'TD'
|
|
2010
|
+
| 'CL'
|
|
2011
|
+
| 'CN'
|
|
2012
|
+
| 'CX'
|
|
2013
|
+
| 'CC'
|
|
2014
|
+
| 'CO'
|
|
2015
|
+
| 'KM'
|
|
2016
|
+
| 'CG'
|
|
2017
|
+
| 'CD'
|
|
2018
|
+
| 'CK'
|
|
2019
|
+
| 'CR'
|
|
2020
|
+
| 'CI'
|
|
2021
|
+
| 'HR'
|
|
2022
|
+
| 'CU'
|
|
2023
|
+
| 'CY'
|
|
2024
|
+
| 'CZ'
|
|
2025
|
+
| 'DK'
|
|
2026
|
+
| 'DJ'
|
|
2027
|
+
| 'DM'
|
|
2028
|
+
| 'DO'
|
|
2029
|
+
| 'EC'
|
|
2030
|
+
| 'EG'
|
|
2031
|
+
| 'SV'
|
|
2032
|
+
| 'GQ'
|
|
2033
|
+
| 'ER'
|
|
2034
|
+
| 'EE'
|
|
2035
|
+
| 'ET'
|
|
2036
|
+
| 'FK'
|
|
2037
|
+
| 'FO'
|
|
2038
|
+
| 'FJ'
|
|
2039
|
+
| 'FI'
|
|
2040
|
+
| 'FR'
|
|
2041
|
+
| 'GF'
|
|
2042
|
+
| 'PF'
|
|
2043
|
+
| 'TF'
|
|
2044
|
+
| 'GA'
|
|
2045
|
+
| 'GM'
|
|
2046
|
+
| 'GE'
|
|
2047
|
+
| 'DE'
|
|
2048
|
+
| 'GH'
|
|
2049
|
+
| 'GI'
|
|
2050
|
+
| 'GR'
|
|
2051
|
+
| 'GL'
|
|
2052
|
+
| 'GD'
|
|
2053
|
+
| 'GP'
|
|
2054
|
+
| 'GU'
|
|
2055
|
+
| 'GT'
|
|
2056
|
+
| 'GN'
|
|
2057
|
+
| 'GW'
|
|
2058
|
+
| 'GY'
|
|
2059
|
+
| 'HT'
|
|
2060
|
+
| 'HM'
|
|
2061
|
+
| 'VA'
|
|
2062
|
+
| 'HN'
|
|
2063
|
+
| 'HK'
|
|
2064
|
+
| 'HU'
|
|
2065
|
+
| 'IS'
|
|
2066
|
+
| 'IN'
|
|
2067
|
+
| 'ID'
|
|
2068
|
+
| 'IR'
|
|
2069
|
+
| 'IQ'
|
|
2070
|
+
| 'IE'
|
|
2071
|
+
| 'IL'
|
|
2072
|
+
| 'IT'
|
|
2073
|
+
| 'JM'
|
|
2074
|
+
| 'JP'
|
|
2075
|
+
| 'JO'
|
|
2076
|
+
| 'KZ'
|
|
2077
|
+
| 'KE'
|
|
2078
|
+
| 'KI'
|
|
2079
|
+
| 'KP'
|
|
2080
|
+
| 'KR'
|
|
2081
|
+
| 'KW'
|
|
2082
|
+
| 'KG'
|
|
2083
|
+
| 'LA'
|
|
2084
|
+
| 'LV'
|
|
2085
|
+
| 'LB'
|
|
2086
|
+
| 'LS'
|
|
2087
|
+
| 'LR'
|
|
2088
|
+
| 'LY'
|
|
2089
|
+
| 'LI'
|
|
2090
|
+
| 'LT'
|
|
2091
|
+
| 'LU'
|
|
2092
|
+
| 'MO'
|
|
2093
|
+
| 'MG'
|
|
2094
|
+
| 'MW'
|
|
2095
|
+
| 'MY'
|
|
2096
|
+
| 'MV'
|
|
2097
|
+
| 'ML'
|
|
2098
|
+
| 'MT'
|
|
2099
|
+
| 'MH'
|
|
2100
|
+
| 'MQ'
|
|
2101
|
+
| 'MR'
|
|
2102
|
+
| 'MU'
|
|
2103
|
+
| 'YT'
|
|
2104
|
+
| 'MX'
|
|
2105
|
+
| 'FM'
|
|
2106
|
+
| 'MD'
|
|
2107
|
+
| 'MC'
|
|
2108
|
+
| 'MN'
|
|
2109
|
+
| 'MS'
|
|
2110
|
+
| 'MA'
|
|
2111
|
+
| 'MZ'
|
|
2112
|
+
| 'MM'
|
|
2113
|
+
| 'NA'
|
|
2114
|
+
| 'NR'
|
|
2115
|
+
| 'NP'
|
|
2116
|
+
| 'NL'
|
|
2117
|
+
| 'NC'
|
|
2118
|
+
| 'NZ'
|
|
2119
|
+
| 'NI'
|
|
2120
|
+
| 'NE'
|
|
2121
|
+
| 'NG'
|
|
2122
|
+
| 'NU'
|
|
2123
|
+
| 'NF'
|
|
2124
|
+
| 'MP'
|
|
2125
|
+
| 'MK'
|
|
2126
|
+
| 'NO'
|
|
2127
|
+
| 'OM'
|
|
2128
|
+
| 'PK'
|
|
2129
|
+
| 'PW'
|
|
2130
|
+
| 'PS'
|
|
2131
|
+
| 'PA'
|
|
2132
|
+
| 'PG'
|
|
2133
|
+
| 'PY'
|
|
2134
|
+
| 'PE'
|
|
2135
|
+
| 'PH'
|
|
2136
|
+
| 'PN'
|
|
2137
|
+
| 'PL'
|
|
2138
|
+
| 'PT'
|
|
2139
|
+
| 'PR'
|
|
2140
|
+
| 'QA'
|
|
2141
|
+
| 'RE'
|
|
2142
|
+
| 'RO'
|
|
2143
|
+
| 'RU'
|
|
2144
|
+
| 'RW'
|
|
2145
|
+
| 'SH'
|
|
2146
|
+
| 'KN'
|
|
2147
|
+
| 'LC'
|
|
2148
|
+
| 'PM'
|
|
2149
|
+
| 'VC'
|
|
2150
|
+
| 'WS'
|
|
2151
|
+
| 'SM'
|
|
2152
|
+
| 'ST'
|
|
2153
|
+
| 'SA'
|
|
2154
|
+
| 'SN'
|
|
2155
|
+
| 'SC'
|
|
2156
|
+
| 'SL'
|
|
2157
|
+
| 'SG'
|
|
2158
|
+
| 'SK'
|
|
2159
|
+
| 'SI'
|
|
2160
|
+
| 'SB'
|
|
2161
|
+
| 'SO'
|
|
2162
|
+
| 'ZA'
|
|
2163
|
+
| 'GS'
|
|
2164
|
+
| 'ES'
|
|
2165
|
+
| 'LK'
|
|
2166
|
+
| 'SD'
|
|
2167
|
+
| 'SR'
|
|
2168
|
+
| 'SJ'
|
|
2169
|
+
| 'SZ'
|
|
2170
|
+
| 'SE'
|
|
2171
|
+
| 'CH'
|
|
2172
|
+
| 'SY'
|
|
2173
|
+
| 'TW'
|
|
2174
|
+
| 'TJ'
|
|
2175
|
+
| 'TZ'
|
|
2176
|
+
| 'TH'
|
|
2177
|
+
| 'TL'
|
|
2178
|
+
| 'TG'
|
|
2179
|
+
| 'TK'
|
|
2180
|
+
| 'TO'
|
|
2181
|
+
| 'TT'
|
|
2182
|
+
| 'TN'
|
|
2183
|
+
| 'TR'
|
|
2184
|
+
| 'TM'
|
|
2185
|
+
| 'TC'
|
|
2186
|
+
| 'TV'
|
|
2187
|
+
| 'UG'
|
|
2188
|
+
| 'UA'
|
|
2189
|
+
| 'AE'
|
|
2190
|
+
| 'GB'
|
|
2191
|
+
| 'US'
|
|
2192
|
+
| 'UM'
|
|
2193
|
+
| 'UY'
|
|
2194
|
+
| 'UZ'
|
|
2195
|
+
| 'VU'
|
|
2196
|
+
| 'VE'
|
|
2197
|
+
| 'VN'
|
|
2198
|
+
| 'VG'
|
|
2199
|
+
| 'VI'
|
|
2200
|
+
| 'WF'
|
|
2201
|
+
| 'EH'
|
|
2202
|
+
| 'YE'
|
|
2203
|
+
| 'ZM'
|
|
2204
|
+
| 'ZW'
|
|
2205
|
+
| 'AX'
|
|
2206
|
+
| 'BQ'
|
|
2207
|
+
| 'CW'
|
|
2208
|
+
| 'GG'
|
|
2209
|
+
| 'IM'
|
|
2210
|
+
| 'JE'
|
|
2211
|
+
| 'ME'
|
|
2212
|
+
| 'BL'
|
|
2213
|
+
| 'MF'
|
|
2214
|
+
| 'RS'
|
|
2215
|
+
| 'SX'
|
|
2216
|
+
| 'SS'
|
|
2217
|
+
| 'XK';
|
|
2218
|
+
|
|
2219
|
+
line1: string;
|
|
2220
|
+
|
|
2221
|
+
zipCode: string;
|
|
2222
|
+
|
|
2223
|
+
firstName?: string;
|
|
2224
|
+
|
|
2225
|
+
lastName?: string;
|
|
2226
|
+
|
|
2227
|
+
line2?: string;
|
|
2228
|
+
|
|
2229
|
+
region?: string;
|
|
2230
|
+
}
|
|
2231
|
+
|
|
2232
|
+
/**
|
|
2233
|
+
* @deprecated
|
|
2234
|
+
*/
|
|
2235
|
+
export interface ClimateActionMode {
|
|
2236
|
+
amount: number;
|
|
2237
|
+
|
|
2238
|
+
type: 'transaction' | 'amount';
|
|
2239
|
+
}
|
|
2240
|
+
|
|
2241
|
+
export interface Destination {
|
|
2242
|
+
/**
|
|
2243
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
2244
|
+
* to "iban", the "iban" object must be filled out.
|
|
2245
|
+
*/
|
|
2246
|
+
bankAccount: Destination.BankAccount;
|
|
2247
|
+
|
|
2248
|
+
/**
|
|
2249
|
+
* The bank statement reference of the payment for the order. This is the reference
|
|
2250
|
+
* that will be visible on the bank statement.
|
|
2251
|
+
*/
|
|
2252
|
+
bankStatementReference: string;
|
|
2253
|
+
}
|
|
2254
|
+
|
|
2255
|
+
export namespace Destination {
|
|
2256
|
+
/**
|
|
2257
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
2258
|
+
* to "iban", the "iban" object must be filled out.
|
|
2259
|
+
*/
|
|
2260
|
+
export interface BankAccount {
|
|
2261
|
+
/**
|
|
2262
|
+
* The type of the financial address. The actual destination is determined by this
|
|
2263
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
2264
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
2265
|
+
* in the "iban" object.
|
|
2266
|
+
*
|
|
2267
|
+
* - iban: The IBAN of the account
|
|
2268
|
+
* - sort_code: The sort code of the account
|
|
2269
|
+
* - bank_code: The bank code of the account
|
|
2270
|
+
* - bban: The BBAN of the account
|
|
2271
|
+
*/
|
|
2272
|
+
type: string;
|
|
2273
|
+
|
|
2274
|
+
bankCode?: BankAccount.BankCode;
|
|
2275
|
+
|
|
2276
|
+
bban?: BankAccount.Bban;
|
|
2277
|
+
|
|
2278
|
+
iban?: BankAccount.Iban;
|
|
2279
|
+
|
|
2280
|
+
sortCode?: BankAccount.SortCode;
|
|
2281
|
+
}
|
|
2282
|
+
|
|
2283
|
+
export namespace BankAccount {
|
|
2284
|
+
export interface BankCode {
|
|
2285
|
+
/**
|
|
2286
|
+
* The name of the account holder.
|
|
2287
|
+
*/
|
|
2288
|
+
accountHolderName: string;
|
|
2289
|
+
|
|
2290
|
+
accountNumber: string;
|
|
2291
|
+
|
|
2292
|
+
code: string;
|
|
2293
|
+
}
|
|
2294
|
+
|
|
2295
|
+
export interface Bban {
|
|
2296
|
+
/**
|
|
2297
|
+
* The name of the account holder.
|
|
2298
|
+
*/
|
|
2299
|
+
accountHolderName: string;
|
|
2300
|
+
|
|
2301
|
+
bban: string;
|
|
2302
|
+
|
|
2303
|
+
bic?: string;
|
|
2304
|
+
}
|
|
2305
|
+
|
|
2306
|
+
export interface Iban {
|
|
2307
|
+
/**
|
|
2308
|
+
* The name of the account holder.
|
|
2309
|
+
*/
|
|
2310
|
+
accountHolderName: string;
|
|
2311
|
+
|
|
2312
|
+
iban: string;
|
|
2313
|
+
|
|
2314
|
+
bic?: string;
|
|
2315
|
+
}
|
|
2316
|
+
|
|
2317
|
+
export interface SortCode {
|
|
2318
|
+
/**
|
|
2319
|
+
* The name of the account holder.
|
|
2320
|
+
*/
|
|
2321
|
+
accountHolderName: string;
|
|
2322
|
+
|
|
2323
|
+
accountNumber: string;
|
|
2324
|
+
|
|
2325
|
+
sortCode: string;
|
|
2326
|
+
}
|
|
2327
|
+
}
|
|
2328
|
+
}
|
|
2329
|
+
|
|
2330
|
+
export interface LineItem {
|
|
2331
|
+
/**
|
|
2332
|
+
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
2333
|
+
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
2334
|
+
*/
|
|
2335
|
+
amount: number;
|
|
2336
|
+
|
|
2337
|
+
/**
|
|
2338
|
+
* The name of the line item.
|
|
2339
|
+
*/
|
|
2340
|
+
name: string;
|
|
2341
|
+
|
|
2342
|
+
/**
|
|
2343
|
+
* The quantity of the line item.
|
|
2344
|
+
*/
|
|
2345
|
+
quantity: number;
|
|
2346
|
+
|
|
2347
|
+
/**
|
|
2348
|
+
* The net amount of a single item.
|
|
2349
|
+
*/
|
|
2350
|
+
singleNet: number;
|
|
2351
|
+
|
|
2352
|
+
/**
|
|
2353
|
+
* The VAT amount of a single item.
|
|
2354
|
+
*/
|
|
2355
|
+
singleVat: number;
|
|
2356
|
+
|
|
2357
|
+
/**
|
|
2358
|
+
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
2359
|
+
* the line item.
|
|
2360
|
+
*/
|
|
2361
|
+
category?: string;
|
|
2362
|
+
|
|
2363
|
+
/**
|
|
2364
|
+
* The
|
|
2365
|
+
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
2366
|
+
* of the line item.
|
|
2367
|
+
*/
|
|
2368
|
+
EAN?: string;
|
|
2369
|
+
|
|
2370
|
+
/**
|
|
2371
|
+
* The image of the line item as a URL.
|
|
2372
|
+
*/
|
|
2373
|
+
image?: string;
|
|
2374
|
+
|
|
2375
|
+
/**
|
|
2376
|
+
* The internal unique identifier of the line item.
|
|
2377
|
+
*/
|
|
2378
|
+
referenceId?: string;
|
|
2379
|
+
}
|
|
2380
|
+
|
|
2381
|
+
export interface Mandate {
|
|
2382
|
+
/**
|
|
2383
|
+
* The name of the account holder who signs the mandate.
|
|
2384
|
+
*/
|
|
2385
|
+
accountHolderName?: string;
|
|
2386
|
+
|
|
2387
|
+
/**
|
|
2388
|
+
* Additional information to display to the user during the mandate setup. This
|
|
2389
|
+
* information is not used to setup any recurrence on the mandate. It is only
|
|
2390
|
+
* displayed to the user during checkout.
|
|
2391
|
+
*/
|
|
2392
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
2393
|
+
|
|
2394
|
+
/**
|
|
2395
|
+
* Mandate creditor data
|
|
2396
|
+
*/
|
|
2397
|
+
creditor?: Mandate.Creditor;
|
|
2398
|
+
|
|
2399
|
+
/**
|
|
2400
|
+
* The reference of the mandate going to be setup
|
|
2401
|
+
*/
|
|
2402
|
+
reference?: string;
|
|
2403
|
+
|
|
2404
|
+
/**
|
|
2405
|
+
* The mandate referenceId. Set this to match incoming `mandate_setup_started`,
|
|
2406
|
+
* `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
|
|
2407
|
+
* mandate setup request.
|
|
2408
|
+
*/
|
|
2409
|
+
referenceId?: string;
|
|
2410
|
+
|
|
2411
|
+
/**
|
|
2412
|
+
* If true, a ready to use mandate will be set up after the payment flow.
|
|
2413
|
+
*/
|
|
2414
|
+
setup?: boolean;
|
|
2415
|
+
|
|
2416
|
+
/**
|
|
2417
|
+
* The email of the user who signs the mandate.
|
|
2418
|
+
*/
|
|
2419
|
+
userNotificationEmail?: string;
|
|
2420
|
+
}
|
|
2421
|
+
|
|
2422
|
+
export namespace Mandate {
|
|
2423
|
+
/**
|
|
2424
|
+
* Additional information to display to the user during the mandate setup. This
|
|
2425
|
+
* information is not used to setup any recurrence on the mandate. It is only
|
|
2426
|
+
* displayed to the user during checkout.
|
|
2427
|
+
*/
|
|
2428
|
+
export interface AdditionalDisplayInformation {
|
|
2429
|
+
/**
|
|
2430
|
+
* The intended cadence of charges used for displaying purpose only. On demand
|
|
2431
|
+
* would be used for unscheduled charges.
|
|
2432
|
+
*/
|
|
2433
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
2434
|
+
|
|
2435
|
+
price?: AdditionalDisplayInformation.Price;
|
|
2436
|
+
}
|
|
2437
|
+
|
|
2438
|
+
export namespace AdditionalDisplayInformation {
|
|
2439
|
+
export interface Price {
|
|
2440
|
+
/**
|
|
2441
|
+
* The amount displayed to the user as decimal e.g. 10.23 would be displayed as
|
|
2442
|
+
* 10.23 EUR.
|
|
2443
|
+
*/
|
|
2444
|
+
amount?: number;
|
|
2445
|
+
|
|
2446
|
+
currency?: 'EUR' | 'GBP' | 'PLN';
|
|
2447
|
+
}
|
|
2448
|
+
}
|
|
2449
|
+
|
|
2450
|
+
/**
|
|
2451
|
+
* Mandate creditor data
|
|
2452
|
+
*/
|
|
2453
|
+
export interface Creditor {
|
|
2454
|
+
id?: string;
|
|
2455
|
+
|
|
2456
|
+
name?: string;
|
|
2457
|
+
}
|
|
2458
|
+
}
|
|
2459
|
+
|
|
2460
|
+
/**
|
|
2461
|
+
* @deprecated
|
|
2462
|
+
*/
|
|
2463
|
+
export interface MerchantFinancialAddress {
|
|
2464
|
+
bankCode?: MerchantFinancialAddress.BankCode;
|
|
2465
|
+
|
|
2466
|
+
bban?: MerchantFinancialAddress.Bban;
|
|
2467
|
+
|
|
2468
|
+
iban?: MerchantFinancialAddress.Iban;
|
|
2469
|
+
|
|
2470
|
+
/**
|
|
2471
|
+
* The payment reference for the order. This is the reference that will be visible
|
|
2472
|
+
* on the bank statement.
|
|
2473
|
+
*/
|
|
2474
|
+
paymentReference?: string;
|
|
2475
|
+
|
|
2476
|
+
sortCode?: MerchantFinancialAddress.SortCode;
|
|
2477
|
+
|
|
2478
|
+
/**
|
|
2479
|
+
* The type of the financial address. The actual destination is determined by this
|
|
2480
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
2481
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
2482
|
+
* in the "iban" object.
|
|
2483
|
+
*
|
|
2484
|
+
* - iban: The IBAN of the account
|
|
2485
|
+
* - sort_code: The sort code of the account
|
|
2486
|
+
* - bank_code: The bank code of the account
|
|
2487
|
+
* - bban: The BBAN of the account
|
|
2488
|
+
*/
|
|
2489
|
+
type?: string;
|
|
2490
|
+
}
|
|
2491
|
+
|
|
2492
|
+
export namespace MerchantFinancialAddress {
|
|
2493
|
+
export interface BankCode {
|
|
2494
|
+
/**
|
|
2495
|
+
* The name of the account holder.
|
|
2496
|
+
*/
|
|
2497
|
+
accountHolderName: string;
|
|
2498
|
+
|
|
2499
|
+
accountNumber: string;
|
|
2500
|
+
|
|
2501
|
+
code: string;
|
|
2502
|
+
}
|
|
2503
|
+
|
|
2504
|
+
export interface Bban {
|
|
2505
|
+
/**
|
|
2506
|
+
* The name of the account holder.
|
|
2507
|
+
*/
|
|
2508
|
+
accountHolderName: string;
|
|
2509
|
+
|
|
2510
|
+
bban: string;
|
|
2511
|
+
|
|
2512
|
+
bic?: string;
|
|
2513
|
+
}
|
|
2514
|
+
|
|
2515
|
+
export interface Iban {
|
|
2516
|
+
/**
|
|
2517
|
+
* The name of the account holder.
|
|
2518
|
+
*/
|
|
2519
|
+
accountHolderName: string;
|
|
2520
|
+
|
|
2521
|
+
iban: string;
|
|
2522
|
+
|
|
2523
|
+
bic?: string;
|
|
2524
|
+
}
|
|
2525
|
+
|
|
2526
|
+
export interface SortCode {
|
|
2527
|
+
/**
|
|
2528
|
+
* The name of the account holder.
|
|
2529
|
+
*/
|
|
2530
|
+
accountHolderName: string;
|
|
2531
|
+
|
|
2532
|
+
accountNumber: string;
|
|
2533
|
+
|
|
2534
|
+
sortCode: string;
|
|
2535
|
+
}
|
|
2536
|
+
}
|
|
2537
|
+
|
|
2538
|
+
/**
|
|
2539
|
+
* The source bank account where the money is send from.
|
|
2540
|
+
*/
|
|
2541
|
+
export interface PayerFinancialAddress {
|
|
2542
|
+
/**
|
|
2543
|
+
* The type of the financial address. The actual destination is determined by this
|
|
2544
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
2545
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
2546
|
+
* in the "iban" object.
|
|
2547
|
+
*
|
|
2548
|
+
* - iban: The IBAN of the account
|
|
2549
|
+
* - sort_code: The sort code of the account
|
|
2550
|
+
* - bank_code: The bank code of the account
|
|
2551
|
+
* - bban: The BBAN of the account
|
|
2552
|
+
*/
|
|
2553
|
+
type: string;
|
|
2554
|
+
|
|
2555
|
+
bankCode?: PayerFinancialAddress.BankCode;
|
|
2556
|
+
|
|
2557
|
+
bban?: PayerFinancialAddress.Bban;
|
|
2558
|
+
|
|
2559
|
+
iban?: PayerFinancialAddress.Iban;
|
|
2560
|
+
|
|
2561
|
+
sortCode?: PayerFinancialAddress.SortCode;
|
|
2562
|
+
}
|
|
2563
|
+
|
|
2564
|
+
export namespace PayerFinancialAddress {
|
|
2565
|
+
export interface BankCode {
|
|
2566
|
+
accountNumber: string;
|
|
2567
|
+
|
|
2568
|
+
code: string;
|
|
2569
|
+
|
|
2570
|
+
/**
|
|
2571
|
+
* The name of the account holder.
|
|
2572
|
+
*/
|
|
2573
|
+
accountHolderName?: string;
|
|
2574
|
+
}
|
|
2575
|
+
|
|
2576
|
+
export interface Bban {
|
|
2577
|
+
bban: string;
|
|
2578
|
+
|
|
2579
|
+
/**
|
|
2580
|
+
* The name of the account holder.
|
|
2581
|
+
*/
|
|
2582
|
+
accountHolderName?: string;
|
|
2583
|
+
|
|
2584
|
+
bic?: string;
|
|
2585
|
+
}
|
|
2586
|
+
|
|
2587
|
+
export interface Iban {
|
|
2588
|
+
iban: string;
|
|
2589
|
+
|
|
2590
|
+
/**
|
|
2591
|
+
* The name of the account holder.
|
|
2592
|
+
*/
|
|
2593
|
+
accountHolderName?: string;
|
|
2594
|
+
|
|
2595
|
+
bic?: string;
|
|
2596
|
+
}
|
|
2597
|
+
|
|
2598
|
+
export interface SortCode {
|
|
2599
|
+
accountNumber: string;
|
|
2600
|
+
|
|
2601
|
+
sortCode: string;
|
|
2602
|
+
|
|
2603
|
+
/**
|
|
2604
|
+
* The name of the account holder.
|
|
2605
|
+
*/
|
|
2606
|
+
accountHolderName?: string;
|
|
2607
|
+
}
|
|
2608
|
+
}
|
|
2609
|
+
|
|
2610
|
+
/**
|
|
2611
|
+
* A Refund object. This corresponds to one Refund request.
|
|
2612
|
+
*/
|
|
2613
|
+
export interface Refund {
|
|
2614
|
+
id: string;
|
|
2615
|
+
|
|
2616
|
+
amount: number;
|
|
2617
|
+
|
|
2618
|
+
createdAt: string;
|
|
2619
|
+
|
|
2620
|
+
referenceId: string;
|
|
2621
|
+
|
|
2622
|
+
/**
|
|
2623
|
+
* The status of the refund. Always use the status of the order as your source of
|
|
2624
|
+
* truth to trigger actions in your dashboard.
|
|
2625
|
+
*/
|
|
2626
|
+
status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
|
|
2627
|
+
|
|
2628
|
+
updatedAt: string;
|
|
2629
|
+
|
|
2630
|
+
description?: string;
|
|
2631
|
+
}
|
|
2632
|
+
|
|
2633
|
+
/**
|
|
2634
|
+
* The shipping address of the user. This is only collected in express Checkouts.
|
|
2635
|
+
*/
|
|
2636
|
+
export interface ShippingAddress {
|
|
2637
|
+
city: string;
|
|
2638
|
+
|
|
2639
|
+
/**
|
|
2640
|
+
* The country code in
|
|
2641
|
+
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
2642
|
+
*/
|
|
2643
|
+
country:
|
|
2644
|
+
| 'AF'
|
|
2645
|
+
| 'AL'
|
|
2646
|
+
| 'DZ'
|
|
2647
|
+
| 'AS'
|
|
2648
|
+
| 'AD'
|
|
2649
|
+
| 'AO'
|
|
2650
|
+
| 'AI'
|
|
2651
|
+
| 'AQ'
|
|
2652
|
+
| 'AG'
|
|
2653
|
+
| 'AR'
|
|
2654
|
+
| 'AM'
|
|
2655
|
+
| 'AW'
|
|
2656
|
+
| 'AU'
|
|
2657
|
+
| 'AT'
|
|
2658
|
+
| 'AZ'
|
|
2659
|
+
| 'BS'
|
|
2660
|
+
| 'BH'
|
|
2661
|
+
| 'BD'
|
|
2662
|
+
| 'BB'
|
|
2663
|
+
| 'BY'
|
|
2664
|
+
| 'BE'
|
|
2665
|
+
| 'BZ'
|
|
2666
|
+
| 'BJ'
|
|
2667
|
+
| 'BM'
|
|
2668
|
+
| 'BT'
|
|
2669
|
+
| 'BO'
|
|
2670
|
+
| 'BA'
|
|
2671
|
+
| 'BW'
|
|
2672
|
+
| 'BV'
|
|
2673
|
+
| 'BR'
|
|
2674
|
+
| 'IO'
|
|
2675
|
+
| 'BN'
|
|
2676
|
+
| 'BG'
|
|
2677
|
+
| 'BF'
|
|
2678
|
+
| 'BI'
|
|
2679
|
+
| 'KH'
|
|
2680
|
+
| 'CM'
|
|
2681
|
+
| 'CA'
|
|
2682
|
+
| 'CV'
|
|
2683
|
+
| 'KY'
|
|
2684
|
+
| 'CF'
|
|
2685
|
+
| 'TD'
|
|
2686
|
+
| 'CL'
|
|
2687
|
+
| 'CN'
|
|
2688
|
+
| 'CX'
|
|
2689
|
+
| 'CC'
|
|
2690
|
+
| 'CO'
|
|
2691
|
+
| 'KM'
|
|
2692
|
+
| 'CG'
|
|
2693
|
+
| 'CD'
|
|
2694
|
+
| 'CK'
|
|
2695
|
+
| 'CR'
|
|
2696
|
+
| 'CI'
|
|
2697
|
+
| 'HR'
|
|
2698
|
+
| 'CU'
|
|
2699
|
+
| 'CY'
|
|
2700
|
+
| 'CZ'
|
|
2701
|
+
| 'DK'
|
|
2702
|
+
| 'DJ'
|
|
2703
|
+
| 'DM'
|
|
2704
|
+
| 'DO'
|
|
2705
|
+
| 'EC'
|
|
2706
|
+
| 'EG'
|
|
2707
|
+
| 'SV'
|
|
2708
|
+
| 'GQ'
|
|
2709
|
+
| 'ER'
|
|
2710
|
+
| 'EE'
|
|
2711
|
+
| 'ET'
|
|
2712
|
+
| 'FK'
|
|
2713
|
+
| 'FO'
|
|
2714
|
+
| 'FJ'
|
|
2715
|
+
| 'FI'
|
|
2716
|
+
| 'FR'
|
|
2717
|
+
| 'GF'
|
|
2718
|
+
| 'PF'
|
|
2719
|
+
| 'TF'
|
|
2720
|
+
| 'GA'
|
|
2721
|
+
| 'GM'
|
|
2722
|
+
| 'GE'
|
|
2723
|
+
| 'DE'
|
|
2724
|
+
| 'GH'
|
|
2725
|
+
| 'GI'
|
|
2726
|
+
| 'GR'
|
|
2727
|
+
| 'GL'
|
|
2728
|
+
| 'GD'
|
|
2729
|
+
| 'GP'
|
|
2730
|
+
| 'GU'
|
|
2731
|
+
| 'GT'
|
|
2732
|
+
| 'GN'
|
|
2733
|
+
| 'GW'
|
|
2734
|
+
| 'GY'
|
|
2735
|
+
| 'HT'
|
|
2736
|
+
| 'HM'
|
|
2737
|
+
| 'VA'
|
|
2738
|
+
| 'HN'
|
|
2739
|
+
| 'HK'
|
|
2740
|
+
| 'HU'
|
|
2741
|
+
| 'IS'
|
|
2742
|
+
| 'IN'
|
|
2743
|
+
| 'ID'
|
|
2744
|
+
| 'IR'
|
|
2745
|
+
| 'IQ'
|
|
2746
|
+
| 'IE'
|
|
2747
|
+
| 'IL'
|
|
2748
|
+
| 'IT'
|
|
2749
|
+
| 'JM'
|
|
2750
|
+
| 'JP'
|
|
2751
|
+
| 'JO'
|
|
2752
|
+
| 'KZ'
|
|
2753
|
+
| 'KE'
|
|
2754
|
+
| 'KI'
|
|
2755
|
+
| 'KP'
|
|
2756
|
+
| 'KR'
|
|
2757
|
+
| 'KW'
|
|
2758
|
+
| 'KG'
|
|
2759
|
+
| 'LA'
|
|
2760
|
+
| 'LV'
|
|
2761
|
+
| 'LB'
|
|
2762
|
+
| 'LS'
|
|
2763
|
+
| 'LR'
|
|
2764
|
+
| 'LY'
|
|
2765
|
+
| 'LI'
|
|
2766
|
+
| 'LT'
|
|
2767
|
+
| 'LU'
|
|
2768
|
+
| 'MO'
|
|
2769
|
+
| 'MG'
|
|
2770
|
+
| 'MW'
|
|
2771
|
+
| 'MY'
|
|
2772
|
+
| 'MV'
|
|
2773
|
+
| 'ML'
|
|
2774
|
+
| 'MT'
|
|
2775
|
+
| 'MH'
|
|
2776
|
+
| 'MQ'
|
|
2777
|
+
| 'MR'
|
|
2778
|
+
| 'MU'
|
|
2779
|
+
| 'YT'
|
|
2780
|
+
| 'MX'
|
|
2781
|
+
| 'FM'
|
|
2782
|
+
| 'MD'
|
|
2783
|
+
| 'MC'
|
|
2784
|
+
| 'MN'
|
|
2785
|
+
| 'MS'
|
|
2786
|
+
| 'MA'
|
|
2787
|
+
| 'MZ'
|
|
2788
|
+
| 'MM'
|
|
2789
|
+
| 'NA'
|
|
2790
|
+
| 'NR'
|
|
2791
|
+
| 'NP'
|
|
2792
|
+
| 'NL'
|
|
2793
|
+
| 'NC'
|
|
2794
|
+
| 'NZ'
|
|
2795
|
+
| 'NI'
|
|
2796
|
+
| 'NE'
|
|
2797
|
+
| 'NG'
|
|
2798
|
+
| 'NU'
|
|
2799
|
+
| 'NF'
|
|
2800
|
+
| 'MP'
|
|
2801
|
+
| 'MK'
|
|
2802
|
+
| 'NO'
|
|
2803
|
+
| 'OM'
|
|
2804
|
+
| 'PK'
|
|
2805
|
+
| 'PW'
|
|
2806
|
+
| 'PS'
|
|
2807
|
+
| 'PA'
|
|
2808
|
+
| 'PG'
|
|
2809
|
+
| 'PY'
|
|
2810
|
+
| 'PE'
|
|
2811
|
+
| 'PH'
|
|
2812
|
+
| 'PN'
|
|
2813
|
+
| 'PL'
|
|
2814
|
+
| 'PT'
|
|
2815
|
+
| 'PR'
|
|
2816
|
+
| 'QA'
|
|
2817
|
+
| 'RE'
|
|
2818
|
+
| 'RO'
|
|
2819
|
+
| 'RU'
|
|
2820
|
+
| 'RW'
|
|
2821
|
+
| 'SH'
|
|
2822
|
+
| 'KN'
|
|
2823
|
+
| 'LC'
|
|
2824
|
+
| 'PM'
|
|
2825
|
+
| 'VC'
|
|
2826
|
+
| 'WS'
|
|
2827
|
+
| 'SM'
|
|
2828
|
+
| 'ST'
|
|
2829
|
+
| 'SA'
|
|
2830
|
+
| 'SN'
|
|
2831
|
+
| 'SC'
|
|
2832
|
+
| 'SL'
|
|
2833
|
+
| 'SG'
|
|
2834
|
+
| 'SK'
|
|
2835
|
+
| 'SI'
|
|
2836
|
+
| 'SB'
|
|
2837
|
+
| 'SO'
|
|
2838
|
+
| 'ZA'
|
|
2839
|
+
| 'GS'
|
|
2840
|
+
| 'ES'
|
|
2841
|
+
| 'LK'
|
|
2842
|
+
| 'SD'
|
|
2843
|
+
| 'SR'
|
|
2844
|
+
| 'SJ'
|
|
2845
|
+
| 'SZ'
|
|
2846
|
+
| 'SE'
|
|
2847
|
+
| 'CH'
|
|
2848
|
+
| 'SY'
|
|
2849
|
+
| 'TW'
|
|
2850
|
+
| 'TJ'
|
|
2851
|
+
| 'TZ'
|
|
2852
|
+
| 'TH'
|
|
2853
|
+
| 'TL'
|
|
2854
|
+
| 'TG'
|
|
2855
|
+
| 'TK'
|
|
2856
|
+
| 'TO'
|
|
2857
|
+
| 'TT'
|
|
2858
|
+
| 'TN'
|
|
2859
|
+
| 'TR'
|
|
2860
|
+
| 'TM'
|
|
2861
|
+
| 'TC'
|
|
2862
|
+
| 'TV'
|
|
2863
|
+
| 'UG'
|
|
2864
|
+
| 'UA'
|
|
2865
|
+
| 'AE'
|
|
2866
|
+
| 'GB'
|
|
2867
|
+
| 'US'
|
|
2868
|
+
| 'UM'
|
|
2869
|
+
| 'UY'
|
|
2870
|
+
| 'UZ'
|
|
2871
|
+
| 'VU'
|
|
2872
|
+
| 'VE'
|
|
2873
|
+
| 'VN'
|
|
2874
|
+
| 'VG'
|
|
2875
|
+
| 'VI'
|
|
2876
|
+
| 'WF'
|
|
2877
|
+
| 'EH'
|
|
2878
|
+
| 'YE'
|
|
2879
|
+
| 'ZM'
|
|
2880
|
+
| 'ZW'
|
|
2881
|
+
| 'AX'
|
|
2882
|
+
| 'BQ'
|
|
2883
|
+
| 'CW'
|
|
2884
|
+
| 'GG'
|
|
2885
|
+
| 'IM'
|
|
2886
|
+
| 'JE'
|
|
2887
|
+
| 'ME'
|
|
2888
|
+
| 'BL'
|
|
2889
|
+
| 'MF'
|
|
2890
|
+
| 'RS'
|
|
2891
|
+
| 'SX'
|
|
2892
|
+
| 'SS'
|
|
2893
|
+
| 'XK';
|
|
2894
|
+
|
|
2895
|
+
line1: string;
|
|
2896
|
+
|
|
2897
|
+
zipCode: string;
|
|
2898
|
+
|
|
2899
|
+
firstName?: string;
|
|
2900
|
+
|
|
2901
|
+
lastName?: string;
|
|
2902
|
+
|
|
2903
|
+
line2?: string;
|
|
2904
|
+
|
|
2905
|
+
region?: string;
|
|
2906
|
+
}
|
|
2907
|
+
|
|
2908
|
+
/**
|
|
2909
|
+
* The selected shipping method by the user. Can either be selected during an
|
|
2910
|
+
* express Checkout Session or passed during Checkout Session creation.
|
|
2911
|
+
*/
|
|
2912
|
+
export interface ShippingMethod {
|
|
2913
|
+
/**
|
|
2914
|
+
* The customer-facing name of the shipping method.
|
|
2915
|
+
*/
|
|
2916
|
+
name: string;
|
|
2917
|
+
|
|
2918
|
+
/**
|
|
2919
|
+
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
2920
|
+
*/
|
|
2921
|
+
price: number;
|
|
2922
|
+
|
|
2923
|
+
/**
|
|
2924
|
+
* The unique identifier of the shipping method within Ivy.
|
|
2925
|
+
*/
|
|
2926
|
+
id?: string;
|
|
2927
|
+
|
|
2928
|
+
/**
|
|
2929
|
+
* The list of countries where the shipping method is available.
|
|
2930
|
+
*/
|
|
2931
|
+
countries?: Array<
|
|
2932
|
+
| 'AF'
|
|
2933
|
+
| 'AL'
|
|
2934
|
+
| 'DZ'
|
|
2935
|
+
| 'AS'
|
|
2936
|
+
| 'AD'
|
|
2937
|
+
| 'AO'
|
|
2938
|
+
| 'AI'
|
|
2939
|
+
| 'AQ'
|
|
2940
|
+
| 'AG'
|
|
2941
|
+
| 'AR'
|
|
2942
|
+
| 'AM'
|
|
2943
|
+
| 'AW'
|
|
2944
|
+
| 'AU'
|
|
2945
|
+
| 'AT'
|
|
2946
|
+
| 'AZ'
|
|
2947
|
+
| 'BS'
|
|
2948
|
+
| 'BH'
|
|
2949
|
+
| 'BD'
|
|
2950
|
+
| 'BB'
|
|
2951
|
+
| 'BY'
|
|
2952
|
+
| 'BE'
|
|
2953
|
+
| 'BZ'
|
|
2954
|
+
| 'BJ'
|
|
2955
|
+
| 'BM'
|
|
2956
|
+
| 'BT'
|
|
2957
|
+
| 'BO'
|
|
2958
|
+
| 'BA'
|
|
2959
|
+
| 'BW'
|
|
2960
|
+
| 'BV'
|
|
2961
|
+
| 'BR'
|
|
2962
|
+
| 'IO'
|
|
2963
|
+
| 'BN'
|
|
2964
|
+
| 'BG'
|
|
2965
|
+
| 'BF'
|
|
2966
|
+
| 'BI'
|
|
2967
|
+
| 'KH'
|
|
2968
|
+
| 'CM'
|
|
2969
|
+
| 'CA'
|
|
2970
|
+
| 'CV'
|
|
2971
|
+
| 'KY'
|
|
2972
|
+
| 'CF'
|
|
2973
|
+
| 'TD'
|
|
2974
|
+
| 'CL'
|
|
2975
|
+
| 'CN'
|
|
2976
|
+
| 'CX'
|
|
2977
|
+
| 'CC'
|
|
2978
|
+
| 'CO'
|
|
2979
|
+
| 'KM'
|
|
2980
|
+
| 'CG'
|
|
2981
|
+
| 'CD'
|
|
2982
|
+
| 'CK'
|
|
2983
|
+
| 'CR'
|
|
2984
|
+
| 'CI'
|
|
2985
|
+
| 'HR'
|
|
2986
|
+
| 'CU'
|
|
2987
|
+
| 'CY'
|
|
2988
|
+
| 'CZ'
|
|
2989
|
+
| 'DK'
|
|
2990
|
+
| 'DJ'
|
|
2991
|
+
| 'DM'
|
|
2992
|
+
| 'DO'
|
|
2993
|
+
| 'EC'
|
|
2994
|
+
| 'EG'
|
|
2995
|
+
| 'SV'
|
|
2996
|
+
| 'GQ'
|
|
2997
|
+
| 'ER'
|
|
2998
|
+
| 'EE'
|
|
2999
|
+
| 'ET'
|
|
3000
|
+
| 'FK'
|
|
3001
|
+
| 'FO'
|
|
3002
|
+
| 'FJ'
|
|
3003
|
+
| 'FI'
|
|
3004
|
+
| 'FR'
|
|
3005
|
+
| 'GF'
|
|
3006
|
+
| 'PF'
|
|
3007
|
+
| 'TF'
|
|
3008
|
+
| 'GA'
|
|
3009
|
+
| 'GM'
|
|
3010
|
+
| 'GE'
|
|
3011
|
+
| 'DE'
|
|
3012
|
+
| 'GH'
|
|
3013
|
+
| 'GI'
|
|
3014
|
+
| 'GR'
|
|
3015
|
+
| 'GL'
|
|
3016
|
+
| 'GD'
|
|
3017
|
+
| 'GP'
|
|
3018
|
+
| 'GU'
|
|
3019
|
+
| 'GT'
|
|
3020
|
+
| 'GN'
|
|
3021
|
+
| 'GW'
|
|
3022
|
+
| 'GY'
|
|
3023
|
+
| 'HT'
|
|
3024
|
+
| 'HM'
|
|
3025
|
+
| 'VA'
|
|
3026
|
+
| 'HN'
|
|
3027
|
+
| 'HK'
|
|
3028
|
+
| 'HU'
|
|
3029
|
+
| 'IS'
|
|
3030
|
+
| 'IN'
|
|
3031
|
+
| 'ID'
|
|
3032
|
+
| 'IR'
|
|
3033
|
+
| 'IQ'
|
|
3034
|
+
| 'IE'
|
|
3035
|
+
| 'IL'
|
|
3036
|
+
| 'IT'
|
|
3037
|
+
| 'JM'
|
|
3038
|
+
| 'JP'
|
|
3039
|
+
| 'JO'
|
|
3040
|
+
| 'KZ'
|
|
3041
|
+
| 'KE'
|
|
3042
|
+
| 'KI'
|
|
3043
|
+
| 'KP'
|
|
3044
|
+
| 'KR'
|
|
3045
|
+
| 'KW'
|
|
3046
|
+
| 'KG'
|
|
3047
|
+
| 'LA'
|
|
3048
|
+
| 'LV'
|
|
3049
|
+
| 'LB'
|
|
3050
|
+
| 'LS'
|
|
3051
|
+
| 'LR'
|
|
3052
|
+
| 'LY'
|
|
3053
|
+
| 'LI'
|
|
3054
|
+
| 'LT'
|
|
3055
|
+
| 'LU'
|
|
3056
|
+
| 'MO'
|
|
3057
|
+
| 'MG'
|
|
3058
|
+
| 'MW'
|
|
3059
|
+
| 'MY'
|
|
3060
|
+
| 'MV'
|
|
3061
|
+
| 'ML'
|
|
3062
|
+
| 'MT'
|
|
3063
|
+
| 'MH'
|
|
3064
|
+
| 'MQ'
|
|
3065
|
+
| 'MR'
|
|
3066
|
+
| 'MU'
|
|
3067
|
+
| 'YT'
|
|
3068
|
+
| 'MX'
|
|
3069
|
+
| 'FM'
|
|
3070
|
+
| 'MD'
|
|
3071
|
+
| 'MC'
|
|
3072
|
+
| 'MN'
|
|
3073
|
+
| 'MS'
|
|
3074
|
+
| 'MA'
|
|
3075
|
+
| 'MZ'
|
|
3076
|
+
| 'MM'
|
|
3077
|
+
| 'NA'
|
|
3078
|
+
| 'NR'
|
|
3079
|
+
| 'NP'
|
|
3080
|
+
| 'NL'
|
|
3081
|
+
| 'NC'
|
|
3082
|
+
| 'NZ'
|
|
3083
|
+
| 'NI'
|
|
3084
|
+
| 'NE'
|
|
3085
|
+
| 'NG'
|
|
3086
|
+
| 'NU'
|
|
3087
|
+
| 'NF'
|
|
3088
|
+
| 'MP'
|
|
3089
|
+
| 'MK'
|
|
3090
|
+
| 'NO'
|
|
3091
|
+
| 'OM'
|
|
3092
|
+
| 'PK'
|
|
3093
|
+
| 'PW'
|
|
3094
|
+
| 'PS'
|
|
3095
|
+
| 'PA'
|
|
3096
|
+
| 'PG'
|
|
3097
|
+
| 'PY'
|
|
3098
|
+
| 'PE'
|
|
3099
|
+
| 'PH'
|
|
3100
|
+
| 'PN'
|
|
3101
|
+
| 'PL'
|
|
3102
|
+
| 'PT'
|
|
3103
|
+
| 'PR'
|
|
3104
|
+
| 'QA'
|
|
3105
|
+
| 'RE'
|
|
3106
|
+
| 'RO'
|
|
3107
|
+
| 'RU'
|
|
3108
|
+
| 'RW'
|
|
3109
|
+
| 'SH'
|
|
3110
|
+
| 'KN'
|
|
3111
|
+
| 'LC'
|
|
3112
|
+
| 'PM'
|
|
3113
|
+
| 'VC'
|
|
3114
|
+
| 'WS'
|
|
3115
|
+
| 'SM'
|
|
3116
|
+
| 'ST'
|
|
3117
|
+
| 'SA'
|
|
3118
|
+
| 'SN'
|
|
3119
|
+
| 'SC'
|
|
3120
|
+
| 'SL'
|
|
3121
|
+
| 'SG'
|
|
3122
|
+
| 'SK'
|
|
3123
|
+
| 'SI'
|
|
3124
|
+
| 'SB'
|
|
3125
|
+
| 'SO'
|
|
3126
|
+
| 'ZA'
|
|
3127
|
+
| 'GS'
|
|
3128
|
+
| 'ES'
|
|
3129
|
+
| 'LK'
|
|
3130
|
+
| 'SD'
|
|
3131
|
+
| 'SR'
|
|
3132
|
+
| 'SJ'
|
|
3133
|
+
| 'SZ'
|
|
3134
|
+
| 'SE'
|
|
3135
|
+
| 'CH'
|
|
3136
|
+
| 'SY'
|
|
3137
|
+
| 'TW'
|
|
3138
|
+
| 'TJ'
|
|
3139
|
+
| 'TZ'
|
|
3140
|
+
| 'TH'
|
|
3141
|
+
| 'TL'
|
|
3142
|
+
| 'TG'
|
|
3143
|
+
| 'TK'
|
|
3144
|
+
| 'TO'
|
|
3145
|
+
| 'TT'
|
|
3146
|
+
| 'TN'
|
|
3147
|
+
| 'TR'
|
|
3148
|
+
| 'TM'
|
|
3149
|
+
| 'TC'
|
|
3150
|
+
| 'TV'
|
|
3151
|
+
| 'UG'
|
|
3152
|
+
| 'UA'
|
|
3153
|
+
| 'AE'
|
|
3154
|
+
| 'GB'
|
|
3155
|
+
| 'US'
|
|
3156
|
+
| 'UM'
|
|
3157
|
+
| 'UY'
|
|
3158
|
+
| 'UZ'
|
|
3159
|
+
| 'VU'
|
|
3160
|
+
| 'VE'
|
|
3161
|
+
| 'VN'
|
|
3162
|
+
| 'VG'
|
|
3163
|
+
| 'VI'
|
|
3164
|
+
| 'WF'
|
|
3165
|
+
| 'EH'
|
|
3166
|
+
| 'YE'
|
|
3167
|
+
| 'ZM'
|
|
3168
|
+
| 'ZW'
|
|
3169
|
+
| 'AX'
|
|
3170
|
+
| 'BQ'
|
|
3171
|
+
| 'CW'
|
|
3172
|
+
| 'GG'
|
|
3173
|
+
| 'IM'
|
|
3174
|
+
| 'JE'
|
|
3175
|
+
| 'ME'
|
|
3176
|
+
| 'BL'
|
|
3177
|
+
| 'MF'
|
|
3178
|
+
| 'RS'
|
|
3179
|
+
| 'SX'
|
|
3180
|
+
| 'SS'
|
|
3181
|
+
| 'XK'
|
|
3182
|
+
>;
|
|
3183
|
+
|
|
3184
|
+
/**
|
|
3185
|
+
* The delivery estimate of the shipping method.
|
|
3186
|
+
*/
|
|
3187
|
+
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
3188
|
+
|
|
3189
|
+
/**
|
|
3190
|
+
* The unique identifier within your system of the shipping method.
|
|
3191
|
+
*/
|
|
3192
|
+
reference?: string;
|
|
3193
|
+
|
|
3194
|
+
/**
|
|
3195
|
+
* @deprecated Deprecated in favor of deliveryEstimate
|
|
3196
|
+
*/
|
|
3197
|
+
timeFrame?: string;
|
|
3198
|
+
}
|
|
3199
|
+
|
|
3200
|
+
export namespace ShippingMethod {
|
|
3201
|
+
/**
|
|
3202
|
+
* The delivery estimate of the shipping method.
|
|
3203
|
+
*/
|
|
3204
|
+
export interface DeliveryEstimate {
|
|
3205
|
+
/**
|
|
3206
|
+
* The maximum delivery time.
|
|
3207
|
+
*/
|
|
3208
|
+
maximum?: DeliveryEstimate.Maximum;
|
|
3209
|
+
|
|
3210
|
+
/**
|
|
3211
|
+
* The minimum delivery time.
|
|
3212
|
+
*/
|
|
3213
|
+
minimum?: DeliveryEstimate.Minimum;
|
|
3214
|
+
}
|
|
3215
|
+
|
|
3216
|
+
export namespace DeliveryEstimate {
|
|
3217
|
+
/**
|
|
3218
|
+
* The maximum delivery time.
|
|
3219
|
+
*/
|
|
3220
|
+
export interface Maximum {
|
|
3221
|
+
/**
|
|
3222
|
+
* The unit of the time duration.
|
|
3223
|
+
*/
|
|
3224
|
+
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
3225
|
+
|
|
3226
|
+
/**
|
|
3227
|
+
* The value of the time duration.
|
|
3228
|
+
*/
|
|
3229
|
+
value: number;
|
|
3230
|
+
}
|
|
3231
|
+
|
|
3232
|
+
/**
|
|
3233
|
+
* The minimum delivery time.
|
|
3234
|
+
*/
|
|
3235
|
+
export interface Minimum {
|
|
3236
|
+
/**
|
|
3237
|
+
* The unit of the time duration.
|
|
3238
|
+
*/
|
|
3239
|
+
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
3240
|
+
|
|
3241
|
+
/**
|
|
3242
|
+
* The value of the time duration.
|
|
3243
|
+
*/
|
|
3244
|
+
value: number;
|
|
3245
|
+
}
|
|
3246
|
+
}
|
|
3247
|
+
}
|
|
3248
|
+
|
|
3249
|
+
/**
|
|
3250
|
+
* The shopper object. Contains information collected from the user during the
|
|
3251
|
+
* Checkout.
|
|
3252
|
+
*/
|
|
3253
|
+
export interface Shopper {
|
|
3254
|
+
email?: string;
|
|
3255
|
+
|
|
3256
|
+
phoneNumber?: string;
|
|
3257
|
+
}
|
|
3258
|
+
|
|
3259
|
+
export interface StatusClassification {
|
|
3260
|
+
/**
|
|
3261
|
+
* Populated with the primary payment initiation failure classsification if
|
|
3262
|
+
* available.
|
|
3263
|
+
*/
|
|
3264
|
+
primary?: string;
|
|
3265
|
+
|
|
3266
|
+
/**
|
|
3267
|
+
* Populated with the secondary payment initiation failure classsification if
|
|
3268
|
+
* available.
|
|
3269
|
+
*/
|
|
3270
|
+
secondary?: string;
|
|
3271
|
+
}
|
|
3272
|
+
|
|
3273
|
+
export interface StatusHistoryList {
|
|
3274
|
+
/**
|
|
3275
|
+
* The order status. This status symbolises the state of the user's payment
|
|
3276
|
+
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
3277
|
+
* information.
|
|
3278
|
+
*/
|
|
3279
|
+
currentStatus:
|
|
3280
|
+
| 'failed'
|
|
3281
|
+
| 'canceled'
|
|
3282
|
+
| 'processing'
|
|
3283
|
+
| 'waiting_for_payment'
|
|
3284
|
+
| 'paid'
|
|
3285
|
+
| 'in_refund'
|
|
3286
|
+
| 'refunded'
|
|
3287
|
+
| 'refund_failed'
|
|
3288
|
+
| 'partially_refunded'
|
|
3289
|
+
| 'in_dispute'
|
|
3290
|
+
| 'disputed'
|
|
3291
|
+
| 'refused';
|
|
3292
|
+
|
|
3293
|
+
reason: string;
|
|
3294
|
+
|
|
3295
|
+
updatedAt: string;
|
|
3296
|
+
|
|
3297
|
+
/**
|
|
3298
|
+
* The order status. This status symbolises the state of the user's payment
|
|
3299
|
+
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
3300
|
+
* information.
|
|
3301
|
+
*/
|
|
3302
|
+
previousStatus?:
|
|
3303
|
+
| 'failed'
|
|
3304
|
+
| 'canceled'
|
|
3305
|
+
| 'processing'
|
|
3306
|
+
| 'waiting_for_payment'
|
|
3307
|
+
| 'paid'
|
|
3308
|
+
| 'in_refund'
|
|
3309
|
+
| 'refunded'
|
|
3310
|
+
| 'refund_failed'
|
|
3311
|
+
| 'partially_refunded'
|
|
3312
|
+
| 'in_dispute'
|
|
3313
|
+
| 'disputed'
|
|
3314
|
+
| 'refused'
|
|
3315
|
+
| null;
|
|
3316
|
+
}
|
|
3317
|
+
}
|
|
3318
|
+
|
|
3319
|
+
export interface OrderExpireResponse {
|
|
3320
|
+
/**
|
|
3321
|
+
* The Ivy unique identifier for the order.
|
|
3322
|
+
*/
|
|
3323
|
+
id: string;
|
|
3324
|
+
|
|
3325
|
+
/**
|
|
3326
|
+
* @deprecated The unique identifier for the merchantApp which initiated the order
|
|
3327
|
+
* / payment attempt.
|
|
3328
|
+
*/
|
|
3329
|
+
appId: string;
|
|
3330
|
+
|
|
3331
|
+
/**
|
|
3332
|
+
* The Ivy fee for the payment.
|
|
3333
|
+
*/
|
|
3334
|
+
applicationFeeAmount: number;
|
|
3335
|
+
|
|
3336
|
+
createdAt: string;
|
|
3337
|
+
|
|
3338
|
+
instantPaymentScheme: boolean;
|
|
3339
|
+
|
|
3340
|
+
/**
|
|
3341
|
+
* @deprecated Deprecated in favor of `appId`.
|
|
3342
|
+
*/
|
|
3343
|
+
merchantAppId: string;
|
|
3344
|
+
|
|
3345
|
+
/**
|
|
3346
|
+
* The unique identifier for the merchant which initiated the order / payment
|
|
3347
|
+
* attempt.
|
|
3348
|
+
*/
|
|
3349
|
+
merchantId: string;
|
|
3350
|
+
|
|
3351
|
+
/**
|
|
3352
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
3353
|
+
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
3354
|
+
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
3355
|
+
* as this is the format accepted by most banks.
|
|
3356
|
+
*/
|
|
3357
|
+
price: OrderExpireResponse.Price;
|
|
3358
|
+
|
|
3359
|
+
/**
|
|
3360
|
+
* An internal reference id which will be stored with the checkout & corresponding
|
|
3361
|
+
* order. Needs to be unique per shop per order and can be up to 200 characters.
|
|
3362
|
+
*/
|
|
3363
|
+
referenceId: string;
|
|
3364
|
+
|
|
3365
|
+
/**
|
|
3366
|
+
* The name of the merchant which initiated the order.
|
|
3367
|
+
*/
|
|
3368
|
+
shopName: string;
|
|
3369
|
+
|
|
3370
|
+
/**
|
|
3371
|
+
* The order status. This status symbolises the state of the user's payment
|
|
3372
|
+
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
3373
|
+
* information.
|
|
3374
|
+
*/
|
|
3375
|
+
status:
|
|
3376
|
+
| 'failed'
|
|
3377
|
+
| 'canceled'
|
|
3378
|
+
| 'processing'
|
|
3379
|
+
| 'waiting_for_payment'
|
|
3380
|
+
| 'paid'
|
|
3381
|
+
| 'in_refund'
|
|
3382
|
+
| 'refunded'
|
|
3383
|
+
| 'refund_failed'
|
|
3384
|
+
| 'partially_refunded'
|
|
3385
|
+
| 'in_dispute'
|
|
3386
|
+
| 'disputed'
|
|
3387
|
+
| 'refused';
|
|
3388
|
+
|
|
3389
|
+
updatedAt: string;
|
|
3390
|
+
|
|
3391
|
+
/**
|
|
3392
|
+
* The unique identifier of Ivy of the chosen bank to make the payment. Not there,
|
|
3393
|
+
* if no payment was made.
|
|
3394
|
+
*/
|
|
3395
|
+
bankId?: string;
|
|
3396
|
+
|
|
3397
|
+
/**
|
|
3398
|
+
* @deprecated The bank statement reference of the payment for the order. This is
|
|
3399
|
+
* the reference that will be visible on the bank statement.
|
|
3400
|
+
*/
|
|
3401
|
+
bankStatementReference?: string;
|
|
3402
|
+
|
|
3403
|
+
/**
|
|
3404
|
+
* The billing address of the user. Required when handshake=true.
|
|
3405
|
+
*/
|
|
3406
|
+
billingAddress?: OrderExpireResponse.BillingAddress;
|
|
3407
|
+
|
|
3408
|
+
/**
|
|
3409
|
+
* The merchant category code or
|
|
3410
|
+
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
3411
|
+
*/
|
|
3412
|
+
category?: string;
|
|
3413
|
+
|
|
3414
|
+
/**
|
|
3415
|
+
* @deprecated
|
|
3416
|
+
*/
|
|
3417
|
+
climateActionMode?: OrderExpireResponse.ClimateActionMode;
|
|
3418
|
+
|
|
3419
|
+
/**
|
|
3420
|
+
* @deprecated
|
|
3421
|
+
*/
|
|
3422
|
+
co2Grams?: number;
|
|
3423
|
+
|
|
3424
|
+
/**
|
|
3425
|
+
* The unique identifier of the customer who placed the order.
|
|
3426
|
+
*/
|
|
3427
|
+
customerId?: string;
|
|
3428
|
+
|
|
3429
|
+
destination?: OrderExpireResponse.Destination;
|
|
3430
|
+
|
|
3431
|
+
/**
|
|
3432
|
+
* The customer facing id. This id is displayed to the user during the checkout and
|
|
3433
|
+
* in the merchant dashboard.
|
|
3434
|
+
*/
|
|
3435
|
+
displayId?: string;
|
|
3436
|
+
|
|
3437
|
+
/**
|
|
3438
|
+
* False by default. If set to true, customers skip email input and jump directly
|
|
3439
|
+
* to their bank login. For express Checkout Sessions this is always false.
|
|
3440
|
+
*/
|
|
3441
|
+
guest?: boolean;
|
|
3442
|
+
|
|
3443
|
+
/**
|
|
3444
|
+
* Only valid for sustainable incentive mode. The social / sustainable projects
|
|
3445
|
+
* available to the user during Checkout.
|
|
3446
|
+
*/
|
|
3447
|
+
impactOffsetProjects?: Array<string>;
|
|
3448
|
+
|
|
3449
|
+
/**
|
|
3450
|
+
* The incentive mode of the checkout session. For any use-case apart from
|
|
3451
|
+
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
3452
|
+
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
3453
|
+
* session will contain sustainable incentives for users.
|
|
3454
|
+
*/
|
|
3455
|
+
incentiveMode?: 'white_label' | 'sustainable';
|
|
3456
|
+
|
|
3457
|
+
/**
|
|
3458
|
+
* The line items of the Checkout.
|
|
3459
|
+
*/
|
|
3460
|
+
lineItems?: Array<OrderExpireResponse.LineItem>;
|
|
3461
|
+
|
|
3462
|
+
mandate?: OrderExpireResponse.Mandate;
|
|
3463
|
+
|
|
3464
|
+
/**
|
|
3465
|
+
* @deprecated
|
|
3466
|
+
*/
|
|
3467
|
+
merchantFinancialAddress?: OrderExpireResponse.MerchantFinancialAddress;
|
|
3468
|
+
|
|
3469
|
+
/**
|
|
3470
|
+
* Any data which will be stored and returned for this checkout session and
|
|
3471
|
+
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
3472
|
+
* more info.
|
|
3473
|
+
*/
|
|
3474
|
+
metadata?: Record<string, unknown>;
|
|
3475
|
+
|
|
3476
|
+
/**
|
|
3477
|
+
* Only valid for sustainable incentive mode. The social / sustainability project
|
|
3478
|
+
* chosen by the user during Checkout.
|
|
3479
|
+
*/
|
|
3480
|
+
offsetProject?: string;
|
|
3481
|
+
|
|
3482
|
+
/**
|
|
3483
|
+
* The source bank account where the money is send from.
|
|
3484
|
+
*/
|
|
3485
|
+
payerFinancialAddress?: OrderExpireResponse.PayerFinancialAddress;
|
|
3486
|
+
|
|
3487
|
+
paymentMethodType?: 'sepa_debit' | 'customer_balance' | 'manual_bank_transfer';
|
|
3488
|
+
|
|
3489
|
+
/**
|
|
3490
|
+
* The payment mode of the order. Can be either 'settlement' or 'direct'.
|
|
3491
|
+
*/
|
|
3492
|
+
paymentMode?: 'settlement' | 'direct';
|
|
3493
|
+
|
|
3494
|
+
/**
|
|
3495
|
+
* @deprecated Deprecated in favor of `status`. Do not use this field to trigger
|
|
3496
|
+
* actions in your system.
|
|
3497
|
+
*/
|
|
3498
|
+
paymentStatus?:
|
|
3499
|
+
| 'failed'
|
|
3500
|
+
| 'canceled'
|
|
3501
|
+
| 'processing'
|
|
3502
|
+
| 'requires_action'
|
|
3503
|
+
| 'succeeded'
|
|
3504
|
+
| 'in_refund'
|
|
3505
|
+
| 'refunded'
|
|
3506
|
+
| 'refund_failed'
|
|
3507
|
+
| 'partially_refunded'
|
|
3508
|
+
| 'not_settled'
|
|
3509
|
+
| 'disputed'
|
|
3510
|
+
| 'frozen_due_to_aml';
|
|
3511
|
+
|
|
3512
|
+
/**
|
|
3513
|
+
* The total amount in the currency of all successful refunds for this order
|
|
3514
|
+
*/
|
|
3515
|
+
refundAmount?: number;
|
|
3516
|
+
|
|
3517
|
+
/**
|
|
3518
|
+
* The list of refunds connected to this order.
|
|
3519
|
+
*/
|
|
3520
|
+
refunds?: Array<OrderExpireResponse.Refund>;
|
|
3521
|
+
|
|
3522
|
+
/**
|
|
3523
|
+
* The shipping address of the user. This is only collected in express Checkouts.
|
|
3524
|
+
*/
|
|
3525
|
+
shippingAddress?: OrderExpireResponse.ShippingAddress;
|
|
3526
|
+
|
|
3527
|
+
/**
|
|
3528
|
+
* The selected shipping method by the user. Can either be selected during an
|
|
3529
|
+
* express Checkout Session or passed during Checkout Session creation.
|
|
3530
|
+
*/
|
|
3531
|
+
shippingMethod?: OrderExpireResponse.ShippingMethod;
|
|
3532
|
+
|
|
3533
|
+
/**
|
|
3534
|
+
* The logo of the shop provided as a URL.
|
|
3535
|
+
*/
|
|
3536
|
+
shopLogo?: string;
|
|
3537
|
+
|
|
3538
|
+
/**
|
|
3539
|
+
* The shopper object. Contains information collected from the user during the
|
|
3540
|
+
* Checkout.
|
|
3541
|
+
*/
|
|
3542
|
+
shopper?: OrderExpireResponse.Shopper;
|
|
3543
|
+
|
|
3544
|
+
/**
|
|
3545
|
+
* @deprecated Deprecated in favor of `shopper.email`. The email of the user if
|
|
3546
|
+
* collected in the Checkout.
|
|
3547
|
+
*/
|
|
3548
|
+
shopperEmail?: string;
|
|
3549
|
+
|
|
3550
|
+
statusClassification?: OrderExpireResponse.StatusClassification;
|
|
3551
|
+
|
|
3552
|
+
/**
|
|
3553
|
+
* List of status history items for the order, used for logging every update on
|
|
3554
|
+
* status.
|
|
3555
|
+
*/
|
|
3556
|
+
statusHistoryList?: Array<OrderExpireResponse.StatusHistoryList>;
|
|
3557
|
+
|
|
3558
|
+
/**
|
|
3559
|
+
* The subaccount id of the order.
|
|
3560
|
+
*/
|
|
3561
|
+
subaccountId?: string;
|
|
3562
|
+
|
|
3563
|
+
/**
|
|
3564
|
+
* The legal name of the subaccount
|
|
3565
|
+
*/
|
|
3566
|
+
subaccountLegalName?: string;
|
|
3567
|
+
|
|
3568
|
+
/**
|
|
3569
|
+
* @deprecated
|
|
3570
|
+
*/
|
|
3571
|
+
trees?: number;
|
|
3572
|
+
}
|
|
3573
|
+
|
|
3574
|
+
export namespace OrderExpireResponse {
|
|
3575
|
+
/**
|
|
3576
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
3577
|
+
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
3578
|
+
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
3579
|
+
* as this is the format accepted by most banks.
|
|
3580
|
+
*/
|
|
3581
|
+
export interface Price {
|
|
3582
|
+
currency: 'EUR' | 'GBP' | 'PLN';
|
|
3583
|
+
|
|
3584
|
+
/**
|
|
3585
|
+
* The total amount to be paid.
|
|
3586
|
+
*/
|
|
3587
|
+
total: number;
|
|
3588
|
+
|
|
3589
|
+
shipping?: number;
|
|
3590
|
+
|
|
3591
|
+
subTotal?: number;
|
|
3592
|
+
|
|
3593
|
+
totalNet?: number;
|
|
3594
|
+
|
|
3595
|
+
vat?: number;
|
|
3596
|
+
}
|
|
3597
|
+
|
|
3598
|
+
/**
|
|
3599
|
+
* The billing address of the user. Required when handshake=true.
|
|
3600
|
+
*/
|
|
3601
|
+
export interface BillingAddress {
|
|
3602
|
+
city: string;
|
|
3603
|
+
|
|
3604
|
+
/**
|
|
3605
|
+
* The country code in
|
|
3606
|
+
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
3607
|
+
*/
|
|
3608
|
+
country:
|
|
3609
|
+
| 'AF'
|
|
3610
|
+
| 'AL'
|
|
3611
|
+
| 'DZ'
|
|
3612
|
+
| 'AS'
|
|
3613
|
+
| 'AD'
|
|
3614
|
+
| 'AO'
|
|
3615
|
+
| 'AI'
|
|
3616
|
+
| 'AQ'
|
|
3617
|
+
| 'AG'
|
|
3618
|
+
| 'AR'
|
|
3619
|
+
| 'AM'
|
|
3620
|
+
| 'AW'
|
|
3621
|
+
| 'AU'
|
|
3622
|
+
| 'AT'
|
|
3623
|
+
| 'AZ'
|
|
3624
|
+
| 'BS'
|
|
3625
|
+
| 'BH'
|
|
3626
|
+
| 'BD'
|
|
3627
|
+
| 'BB'
|
|
3628
|
+
| 'BY'
|
|
3629
|
+
| 'BE'
|
|
3630
|
+
| 'BZ'
|
|
3631
|
+
| 'BJ'
|
|
3632
|
+
| 'BM'
|
|
3633
|
+
| 'BT'
|
|
3634
|
+
| 'BO'
|
|
3635
|
+
| 'BA'
|
|
3636
|
+
| 'BW'
|
|
3637
|
+
| 'BV'
|
|
3638
|
+
| 'BR'
|
|
3639
|
+
| 'IO'
|
|
3640
|
+
| 'BN'
|
|
3641
|
+
| 'BG'
|
|
3642
|
+
| 'BF'
|
|
3643
|
+
| 'BI'
|
|
3644
|
+
| 'KH'
|
|
3645
|
+
| 'CM'
|
|
3646
|
+
| 'CA'
|
|
3647
|
+
| 'CV'
|
|
3648
|
+
| 'KY'
|
|
3649
|
+
| 'CF'
|
|
3650
|
+
| 'TD'
|
|
3651
|
+
| 'CL'
|
|
3652
|
+
| 'CN'
|
|
3653
|
+
| 'CX'
|
|
3654
|
+
| 'CC'
|
|
3655
|
+
| 'CO'
|
|
3656
|
+
| 'KM'
|
|
3657
|
+
| 'CG'
|
|
3658
|
+
| 'CD'
|
|
3659
|
+
| 'CK'
|
|
3660
|
+
| 'CR'
|
|
3661
|
+
| 'CI'
|
|
3662
|
+
| 'HR'
|
|
3663
|
+
| 'CU'
|
|
3664
|
+
| 'CY'
|
|
3665
|
+
| 'CZ'
|
|
3666
|
+
| 'DK'
|
|
3667
|
+
| 'DJ'
|
|
3668
|
+
| 'DM'
|
|
3669
|
+
| 'DO'
|
|
3670
|
+
| 'EC'
|
|
3671
|
+
| 'EG'
|
|
3672
|
+
| 'SV'
|
|
3673
|
+
| 'GQ'
|
|
3674
|
+
| 'ER'
|
|
3675
|
+
| 'EE'
|
|
3676
|
+
| 'ET'
|
|
3677
|
+
| 'FK'
|
|
3678
|
+
| 'FO'
|
|
3679
|
+
| 'FJ'
|
|
3680
|
+
| 'FI'
|
|
3681
|
+
| 'FR'
|
|
3682
|
+
| 'GF'
|
|
3683
|
+
| 'PF'
|
|
3684
|
+
| 'TF'
|
|
3685
|
+
| 'GA'
|
|
3686
|
+
| 'GM'
|
|
3687
|
+
| 'GE'
|
|
3688
|
+
| 'DE'
|
|
3689
|
+
| 'GH'
|
|
3690
|
+
| 'GI'
|
|
3691
|
+
| 'GR'
|
|
3692
|
+
| 'GL'
|
|
3693
|
+
| 'GD'
|
|
3694
|
+
| 'GP'
|
|
3695
|
+
| 'GU'
|
|
3696
|
+
| 'GT'
|
|
3697
|
+
| 'GN'
|
|
3698
|
+
| 'GW'
|
|
3699
|
+
| 'GY'
|
|
3700
|
+
| 'HT'
|
|
3701
|
+
| 'HM'
|
|
3702
|
+
| 'VA'
|
|
3703
|
+
| 'HN'
|
|
3704
|
+
| 'HK'
|
|
3705
|
+
| 'HU'
|
|
3706
|
+
| 'IS'
|
|
3707
|
+
| 'IN'
|
|
3708
|
+
| 'ID'
|
|
3709
|
+
| 'IR'
|
|
3710
|
+
| 'IQ'
|
|
3711
|
+
| 'IE'
|
|
3712
|
+
| 'IL'
|
|
3713
|
+
| 'IT'
|
|
3714
|
+
| 'JM'
|
|
3715
|
+
| 'JP'
|
|
3716
|
+
| 'JO'
|
|
3717
|
+
| 'KZ'
|
|
3718
|
+
| 'KE'
|
|
3719
|
+
| 'KI'
|
|
3720
|
+
| 'KP'
|
|
3721
|
+
| 'KR'
|
|
3722
|
+
| 'KW'
|
|
3723
|
+
| 'KG'
|
|
3724
|
+
| 'LA'
|
|
3725
|
+
| 'LV'
|
|
3726
|
+
| 'LB'
|
|
3727
|
+
| 'LS'
|
|
3728
|
+
| 'LR'
|
|
3729
|
+
| 'LY'
|
|
3730
|
+
| 'LI'
|
|
3731
|
+
| 'LT'
|
|
3732
|
+
| 'LU'
|
|
3733
|
+
| 'MO'
|
|
3734
|
+
| 'MG'
|
|
3735
|
+
| 'MW'
|
|
3736
|
+
| 'MY'
|
|
3737
|
+
| 'MV'
|
|
3738
|
+
| 'ML'
|
|
3739
|
+
| 'MT'
|
|
3740
|
+
| 'MH'
|
|
3741
|
+
| 'MQ'
|
|
3742
|
+
| 'MR'
|
|
3743
|
+
| 'MU'
|
|
3744
|
+
| 'YT'
|
|
3745
|
+
| 'MX'
|
|
3746
|
+
| 'FM'
|
|
3747
|
+
| 'MD'
|
|
3748
|
+
| 'MC'
|
|
3749
|
+
| 'MN'
|
|
3750
|
+
| 'MS'
|
|
3751
|
+
| 'MA'
|
|
3752
|
+
| 'MZ'
|
|
3753
|
+
| 'MM'
|
|
3754
|
+
| 'NA'
|
|
3755
|
+
| 'NR'
|
|
3756
|
+
| 'NP'
|
|
3757
|
+
| 'NL'
|
|
3758
|
+
| 'NC'
|
|
3759
|
+
| 'NZ'
|
|
3760
|
+
| 'NI'
|
|
3761
|
+
| 'NE'
|
|
3762
|
+
| 'NG'
|
|
3763
|
+
| 'NU'
|
|
3764
|
+
| 'NF'
|
|
3765
|
+
| 'MP'
|
|
3766
|
+
| 'MK'
|
|
3767
|
+
| 'NO'
|
|
3768
|
+
| 'OM'
|
|
3769
|
+
| 'PK'
|
|
3770
|
+
| 'PW'
|
|
3771
|
+
| 'PS'
|
|
3772
|
+
| 'PA'
|
|
3773
|
+
| 'PG'
|
|
3774
|
+
| 'PY'
|
|
3775
|
+
| 'PE'
|
|
3776
|
+
| 'PH'
|
|
3777
|
+
| 'PN'
|
|
3778
|
+
| 'PL'
|
|
3779
|
+
| 'PT'
|
|
3780
|
+
| 'PR'
|
|
3781
|
+
| 'QA'
|
|
3782
|
+
| 'RE'
|
|
3783
|
+
| 'RO'
|
|
3784
|
+
| 'RU'
|
|
3785
|
+
| 'RW'
|
|
3786
|
+
| 'SH'
|
|
3787
|
+
| 'KN'
|
|
3788
|
+
| 'LC'
|
|
3789
|
+
| 'PM'
|
|
3790
|
+
| 'VC'
|
|
3791
|
+
| 'WS'
|
|
3792
|
+
| 'SM'
|
|
3793
|
+
| 'ST'
|
|
3794
|
+
| 'SA'
|
|
3795
|
+
| 'SN'
|
|
3796
|
+
| 'SC'
|
|
3797
|
+
| 'SL'
|
|
3798
|
+
| 'SG'
|
|
3799
|
+
| 'SK'
|
|
3800
|
+
| 'SI'
|
|
3801
|
+
| 'SB'
|
|
3802
|
+
| 'SO'
|
|
3803
|
+
| 'ZA'
|
|
3804
|
+
| 'GS'
|
|
3805
|
+
| 'ES'
|
|
3806
|
+
| 'LK'
|
|
3807
|
+
| 'SD'
|
|
3808
|
+
| 'SR'
|
|
3809
|
+
| 'SJ'
|
|
3810
|
+
| 'SZ'
|
|
3811
|
+
| 'SE'
|
|
3812
|
+
| 'CH'
|
|
3813
|
+
| 'SY'
|
|
3814
|
+
| 'TW'
|
|
3815
|
+
| 'TJ'
|
|
3816
|
+
| 'TZ'
|
|
3817
|
+
| 'TH'
|
|
3818
|
+
| 'TL'
|
|
3819
|
+
| 'TG'
|
|
3820
|
+
| 'TK'
|
|
3821
|
+
| 'TO'
|
|
3822
|
+
| 'TT'
|
|
3823
|
+
| 'TN'
|
|
3824
|
+
| 'TR'
|
|
3825
|
+
| 'TM'
|
|
3826
|
+
| 'TC'
|
|
3827
|
+
| 'TV'
|
|
3828
|
+
| 'UG'
|
|
3829
|
+
| 'UA'
|
|
3830
|
+
| 'AE'
|
|
3831
|
+
| 'GB'
|
|
3832
|
+
| 'US'
|
|
3833
|
+
| 'UM'
|
|
3834
|
+
| 'UY'
|
|
3835
|
+
| 'UZ'
|
|
3836
|
+
| 'VU'
|
|
3837
|
+
| 'VE'
|
|
3838
|
+
| 'VN'
|
|
3839
|
+
| 'VG'
|
|
3840
|
+
| 'VI'
|
|
3841
|
+
| 'WF'
|
|
3842
|
+
| 'EH'
|
|
3843
|
+
| 'YE'
|
|
3844
|
+
| 'ZM'
|
|
3845
|
+
| 'ZW'
|
|
3846
|
+
| 'AX'
|
|
3847
|
+
| 'BQ'
|
|
3848
|
+
| 'CW'
|
|
3849
|
+
| 'GG'
|
|
3850
|
+
| 'IM'
|
|
3851
|
+
| 'JE'
|
|
3852
|
+
| 'ME'
|
|
3853
|
+
| 'BL'
|
|
3854
|
+
| 'MF'
|
|
3855
|
+
| 'RS'
|
|
3856
|
+
| 'SX'
|
|
3857
|
+
| 'SS'
|
|
3858
|
+
| 'XK';
|
|
3859
|
+
|
|
3860
|
+
line1: string;
|
|
3861
|
+
|
|
3862
|
+
zipCode: string;
|
|
3863
|
+
|
|
3864
|
+
firstName?: string;
|
|
3865
|
+
|
|
3866
|
+
lastName?: string;
|
|
3867
|
+
|
|
3868
|
+
line2?: string;
|
|
3869
|
+
|
|
3870
|
+
region?: string;
|
|
3871
|
+
}
|
|
3872
|
+
|
|
3873
|
+
/**
|
|
3874
|
+
* @deprecated
|
|
3875
|
+
*/
|
|
3876
|
+
export interface ClimateActionMode {
|
|
3877
|
+
amount: number;
|
|
3878
|
+
|
|
3879
|
+
type: 'transaction' | 'amount';
|
|
3880
|
+
}
|
|
3881
|
+
|
|
3882
|
+
export interface Destination {
|
|
3883
|
+
/**
|
|
3884
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
3885
|
+
* to "iban", the "iban" object must be filled out.
|
|
3886
|
+
*/
|
|
3887
|
+
bankAccount: Destination.BankAccount;
|
|
3888
|
+
|
|
3889
|
+
/**
|
|
3890
|
+
* The bank statement reference of the payment for the order. This is the reference
|
|
3891
|
+
* that will be visible on the bank statement.
|
|
3892
|
+
*/
|
|
3893
|
+
bankStatementReference: string;
|
|
3894
|
+
}
|
|
3895
|
+
|
|
3896
|
+
export namespace Destination {
|
|
3897
|
+
/**
|
|
3898
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
3899
|
+
* to "iban", the "iban" object must be filled out.
|
|
3900
|
+
*/
|
|
3901
|
+
export interface BankAccount {
|
|
3902
|
+
/**
|
|
3903
|
+
* The type of the financial address. The actual destination is determined by this
|
|
3904
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
3905
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
3906
|
+
* in the "iban" object.
|
|
3907
|
+
*
|
|
3908
|
+
* - iban: The IBAN of the account
|
|
3909
|
+
* - sort_code: The sort code of the account
|
|
3910
|
+
* - bank_code: The bank code of the account
|
|
3911
|
+
* - bban: The BBAN of the account
|
|
3912
|
+
*/
|
|
3913
|
+
type: string;
|
|
3914
|
+
|
|
3915
|
+
bankCode?: BankAccount.BankCode;
|
|
3916
|
+
|
|
3917
|
+
bban?: BankAccount.Bban;
|
|
3918
|
+
|
|
3919
|
+
iban?: BankAccount.Iban;
|
|
3920
|
+
|
|
3921
|
+
sortCode?: BankAccount.SortCode;
|
|
3922
|
+
}
|
|
3923
|
+
|
|
3924
|
+
export namespace BankAccount {
|
|
3925
|
+
export interface BankCode {
|
|
3926
|
+
/**
|
|
3927
|
+
* The name of the account holder.
|
|
3928
|
+
*/
|
|
3929
|
+
accountHolderName: string;
|
|
3930
|
+
|
|
3931
|
+
accountNumber: string;
|
|
3932
|
+
|
|
3933
|
+
code: string;
|
|
3934
|
+
}
|
|
3935
|
+
|
|
3936
|
+
export interface Bban {
|
|
3937
|
+
/**
|
|
3938
|
+
* The name of the account holder.
|
|
3939
|
+
*/
|
|
3940
|
+
accountHolderName: string;
|
|
3941
|
+
|
|
3942
|
+
bban: string;
|
|
3943
|
+
|
|
3944
|
+
bic?: string;
|
|
3945
|
+
}
|
|
3946
|
+
|
|
3947
|
+
export interface Iban {
|
|
3948
|
+
/**
|
|
3949
|
+
* The name of the account holder.
|
|
3950
|
+
*/
|
|
3951
|
+
accountHolderName: string;
|
|
3952
|
+
|
|
3953
|
+
iban: string;
|
|
3954
|
+
|
|
3955
|
+
bic?: string;
|
|
3956
|
+
}
|
|
3957
|
+
|
|
3958
|
+
export interface SortCode {
|
|
3959
|
+
/**
|
|
3960
|
+
* The name of the account holder.
|
|
3961
|
+
*/
|
|
3962
|
+
accountHolderName: string;
|
|
3963
|
+
|
|
3964
|
+
accountNumber: string;
|
|
3965
|
+
|
|
3966
|
+
sortCode: string;
|
|
3967
|
+
}
|
|
3968
|
+
}
|
|
3969
|
+
}
|
|
3970
|
+
|
|
3971
|
+
export interface LineItem {
|
|
3972
|
+
/**
|
|
3973
|
+
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
3974
|
+
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
3975
|
+
*/
|
|
3976
|
+
amount: number;
|
|
3977
|
+
|
|
3978
|
+
/**
|
|
3979
|
+
* The name of the line item.
|
|
3980
|
+
*/
|
|
3981
|
+
name: string;
|
|
3982
|
+
|
|
3983
|
+
/**
|
|
3984
|
+
* The quantity of the line item.
|
|
3985
|
+
*/
|
|
3986
|
+
quantity: number;
|
|
3987
|
+
|
|
3988
|
+
/**
|
|
3989
|
+
* The net amount of a single item.
|
|
3990
|
+
*/
|
|
3991
|
+
singleNet: number;
|
|
3992
|
+
|
|
3993
|
+
/**
|
|
3994
|
+
* The VAT amount of a single item.
|
|
3995
|
+
*/
|
|
3996
|
+
singleVat: number;
|
|
3997
|
+
|
|
3998
|
+
/**
|
|
3999
|
+
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
4000
|
+
* the line item.
|
|
4001
|
+
*/
|
|
4002
|
+
category?: string;
|
|
4003
|
+
|
|
4004
|
+
/**
|
|
4005
|
+
* The
|
|
4006
|
+
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
4007
|
+
* of the line item.
|
|
4008
|
+
*/
|
|
4009
|
+
EAN?: string;
|
|
4010
|
+
|
|
4011
|
+
/**
|
|
4012
|
+
* The image of the line item as a URL.
|
|
4013
|
+
*/
|
|
4014
|
+
image?: string;
|
|
4015
|
+
|
|
4016
|
+
/**
|
|
4017
|
+
* The internal unique identifier of the line item.
|
|
4018
|
+
*/
|
|
4019
|
+
referenceId?: string;
|
|
4020
|
+
}
|
|
4021
|
+
|
|
4022
|
+
export interface Mandate {
|
|
4023
|
+
/**
|
|
4024
|
+
* The name of the account holder who signs the mandate.
|
|
4025
|
+
*/
|
|
4026
|
+
accountHolderName?: string;
|
|
4027
|
+
|
|
4028
|
+
/**
|
|
4029
|
+
* Additional information to display to the user during the mandate setup. This
|
|
4030
|
+
* information is not used to setup any recurrence on the mandate. It is only
|
|
4031
|
+
* displayed to the user during checkout.
|
|
4032
|
+
*/
|
|
4033
|
+
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
4034
|
+
|
|
4035
|
+
/**
|
|
4036
|
+
* Mandate creditor data
|
|
4037
|
+
*/
|
|
4038
|
+
creditor?: Mandate.Creditor;
|
|
4039
|
+
|
|
4040
|
+
/**
|
|
4041
|
+
* The reference of the mandate going to be setup
|
|
4042
|
+
*/
|
|
4043
|
+
reference?: string;
|
|
4044
|
+
|
|
4045
|
+
/**
|
|
4046
|
+
* The mandate referenceId. Set this to match incoming `mandate_setup_started`,
|
|
4047
|
+
* `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
|
|
4048
|
+
* mandate setup request.
|
|
4049
|
+
*/
|
|
4050
|
+
referenceId?: string;
|
|
4051
|
+
|
|
4052
|
+
/**
|
|
4053
|
+
* If true, a ready to use mandate will be set up after the payment flow.
|
|
4054
|
+
*/
|
|
4055
|
+
setup?: boolean;
|
|
4056
|
+
|
|
4057
|
+
/**
|
|
4058
|
+
* The email of the user who signs the mandate.
|
|
4059
|
+
*/
|
|
4060
|
+
userNotificationEmail?: string;
|
|
4061
|
+
}
|
|
4062
|
+
|
|
4063
|
+
export namespace Mandate {
|
|
4064
|
+
/**
|
|
4065
|
+
* Additional information to display to the user during the mandate setup. This
|
|
4066
|
+
* information is not used to setup any recurrence on the mandate. It is only
|
|
4067
|
+
* displayed to the user during checkout.
|
|
4068
|
+
*/
|
|
4069
|
+
export interface AdditionalDisplayInformation {
|
|
4070
|
+
/**
|
|
4071
|
+
* The intended cadence of charges used for displaying purpose only. On demand
|
|
4072
|
+
* would be used for unscheduled charges.
|
|
4073
|
+
*/
|
|
4074
|
+
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
4075
|
+
|
|
4076
|
+
price?: AdditionalDisplayInformation.Price;
|
|
4077
|
+
}
|
|
4078
|
+
|
|
4079
|
+
export namespace AdditionalDisplayInformation {
|
|
4080
|
+
export interface Price {
|
|
4081
|
+
/**
|
|
4082
|
+
* The amount displayed to the user as decimal e.g. 10.23 would be displayed as
|
|
4083
|
+
* 10.23 EUR.
|
|
4084
|
+
*/
|
|
4085
|
+
amount?: number;
|
|
4086
|
+
|
|
4087
|
+
currency?: 'EUR' | 'GBP' | 'PLN';
|
|
4088
|
+
}
|
|
4089
|
+
}
|
|
4090
|
+
|
|
4091
|
+
/**
|
|
4092
|
+
* Mandate creditor data
|
|
4093
|
+
*/
|
|
4094
|
+
export interface Creditor {
|
|
4095
|
+
id?: string;
|
|
4096
|
+
|
|
4097
|
+
name?: string;
|
|
4098
|
+
}
|
|
4099
|
+
}
|
|
4100
|
+
|
|
4101
|
+
/**
|
|
4102
|
+
* @deprecated
|
|
4103
|
+
*/
|
|
4104
|
+
export interface MerchantFinancialAddress {
|
|
4105
|
+
bankCode?: MerchantFinancialAddress.BankCode;
|
|
4106
|
+
|
|
4107
|
+
bban?: MerchantFinancialAddress.Bban;
|
|
4108
|
+
|
|
4109
|
+
iban?: MerchantFinancialAddress.Iban;
|
|
4110
|
+
|
|
4111
|
+
/**
|
|
4112
|
+
* The payment reference for the order. This is the reference that will be visible
|
|
4113
|
+
* on the bank statement.
|
|
4114
|
+
*/
|
|
4115
|
+
paymentReference?: string;
|
|
4116
|
+
|
|
4117
|
+
sortCode?: MerchantFinancialAddress.SortCode;
|
|
4118
|
+
|
|
4119
|
+
/**
|
|
4120
|
+
* The type of the financial address. The actual destination is determined by this
|
|
4121
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
4122
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
4123
|
+
* in the "iban" object.
|
|
4124
|
+
*
|
|
4125
|
+
* - iban: The IBAN of the account
|
|
4126
|
+
* - sort_code: The sort code of the account
|
|
4127
|
+
* - bank_code: The bank code of the account
|
|
4128
|
+
* - bban: The BBAN of the account
|
|
4129
|
+
*/
|
|
4130
|
+
type?: string;
|
|
4131
|
+
}
|
|
4132
|
+
|
|
4133
|
+
export namespace MerchantFinancialAddress {
|
|
4134
|
+
export interface BankCode {
|
|
4135
|
+
/**
|
|
4136
|
+
* The name of the account holder.
|
|
4137
|
+
*/
|
|
4138
|
+
accountHolderName: string;
|
|
4139
|
+
|
|
4140
|
+
accountNumber: string;
|
|
4141
|
+
|
|
4142
|
+
code: string;
|
|
4143
|
+
}
|
|
4144
|
+
|
|
4145
|
+
export interface Bban {
|
|
4146
|
+
/**
|
|
4147
|
+
* The name of the account holder.
|
|
4148
|
+
*/
|
|
4149
|
+
accountHolderName: string;
|
|
4150
|
+
|
|
4151
|
+
bban: string;
|
|
4152
|
+
|
|
4153
|
+
bic?: string;
|
|
4154
|
+
}
|
|
4155
|
+
|
|
4156
|
+
export interface Iban {
|
|
4157
|
+
/**
|
|
4158
|
+
* The name of the account holder.
|
|
4159
|
+
*/
|
|
4160
|
+
accountHolderName: string;
|
|
4161
|
+
|
|
4162
|
+
iban: string;
|
|
4163
|
+
|
|
4164
|
+
bic?: string;
|
|
4165
|
+
}
|
|
4166
|
+
|
|
4167
|
+
export interface SortCode {
|
|
4168
|
+
/**
|
|
4169
|
+
* The name of the account holder.
|
|
4170
|
+
*/
|
|
4171
|
+
accountHolderName: string;
|
|
4172
|
+
|
|
4173
|
+
accountNumber: string;
|
|
4174
|
+
|
|
4175
|
+
sortCode: string;
|
|
4176
|
+
}
|
|
4177
|
+
}
|
|
4178
|
+
|
|
4179
|
+
/**
|
|
4180
|
+
* The source bank account where the money is send from.
|
|
4181
|
+
*/
|
|
4182
|
+
export interface PayerFinancialAddress {
|
|
4183
|
+
/**
|
|
4184
|
+
* The type of the financial address. The actual destination is determined by this
|
|
4185
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
4186
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
4187
|
+
* in the "iban" object.
|
|
4188
|
+
*
|
|
4189
|
+
* - iban: The IBAN of the account
|
|
4190
|
+
* - sort_code: The sort code of the account
|
|
4191
|
+
* - bank_code: The bank code of the account
|
|
4192
|
+
* - bban: The BBAN of the account
|
|
4193
|
+
*/
|
|
4194
|
+
type: string;
|
|
4195
|
+
|
|
4196
|
+
bankCode?: PayerFinancialAddress.BankCode;
|
|
4197
|
+
|
|
4198
|
+
bban?: PayerFinancialAddress.Bban;
|
|
4199
|
+
|
|
4200
|
+
iban?: PayerFinancialAddress.Iban;
|
|
4201
|
+
|
|
4202
|
+
sortCode?: PayerFinancialAddress.SortCode;
|
|
4203
|
+
}
|
|
4204
|
+
|
|
4205
|
+
export namespace PayerFinancialAddress {
|
|
4206
|
+
export interface BankCode {
|
|
4207
|
+
accountNumber: string;
|
|
4208
|
+
|
|
4209
|
+
code: string;
|
|
4210
|
+
|
|
4211
|
+
/**
|
|
4212
|
+
* The name of the account holder.
|
|
4213
|
+
*/
|
|
4214
|
+
accountHolderName?: string;
|
|
4215
|
+
}
|
|
4216
|
+
|
|
4217
|
+
export interface Bban {
|
|
4218
|
+
bban: string;
|
|
4219
|
+
|
|
4220
|
+
/**
|
|
4221
|
+
* The name of the account holder.
|
|
4222
|
+
*/
|
|
4223
|
+
accountHolderName?: string;
|
|
4224
|
+
|
|
4225
|
+
bic?: string;
|
|
4226
|
+
}
|
|
4227
|
+
|
|
4228
|
+
export interface Iban {
|
|
4229
|
+
iban: string;
|
|
4230
|
+
|
|
4231
|
+
/**
|
|
4232
|
+
* The name of the account holder.
|
|
4233
|
+
*/
|
|
4234
|
+
accountHolderName?: string;
|
|
4235
|
+
|
|
4236
|
+
bic?: string;
|
|
4237
|
+
}
|
|
4238
|
+
|
|
4239
|
+
export interface SortCode {
|
|
4240
|
+
accountNumber: string;
|
|
4241
|
+
|
|
4242
|
+
sortCode: string;
|
|
4243
|
+
|
|
4244
|
+
/**
|
|
4245
|
+
* The name of the account holder.
|
|
4246
|
+
*/
|
|
4247
|
+
accountHolderName?: string;
|
|
4248
|
+
}
|
|
4249
|
+
}
|
|
4250
|
+
|
|
4251
|
+
/**
|
|
4252
|
+
* A Refund object. This corresponds to one Refund request.
|
|
4253
|
+
*/
|
|
4254
|
+
export interface Refund {
|
|
4255
|
+
id: string;
|
|
4256
|
+
|
|
4257
|
+
amount: number;
|
|
4258
|
+
|
|
4259
|
+
createdAt: string;
|
|
4260
|
+
|
|
4261
|
+
referenceId: string;
|
|
4262
|
+
|
|
4263
|
+
/**
|
|
4264
|
+
* The status of the refund. Always use the status of the order as your source of
|
|
4265
|
+
* truth to trigger actions in your dashboard.
|
|
4266
|
+
*/
|
|
4267
|
+
status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
|
|
4268
|
+
|
|
4269
|
+
updatedAt: string;
|
|
4270
|
+
|
|
4271
|
+
description?: string;
|
|
4272
|
+
}
|
|
4273
|
+
|
|
4274
|
+
/**
|
|
4275
|
+
* The shipping address of the user. This is only collected in express Checkouts.
|
|
4276
|
+
*/
|
|
4277
|
+
export interface ShippingAddress {
|
|
4278
|
+
city: string;
|
|
4279
|
+
|
|
4280
|
+
/**
|
|
4281
|
+
* The country code in
|
|
4282
|
+
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
4283
|
+
*/
|
|
4284
|
+
country:
|
|
4285
|
+
| 'AF'
|
|
4286
|
+
| 'AL'
|
|
4287
|
+
| 'DZ'
|
|
4288
|
+
| 'AS'
|
|
4289
|
+
| 'AD'
|
|
4290
|
+
| 'AO'
|
|
4291
|
+
| 'AI'
|
|
4292
|
+
| 'AQ'
|
|
4293
|
+
| 'AG'
|
|
4294
|
+
| 'AR'
|
|
4295
|
+
| 'AM'
|
|
4296
|
+
| 'AW'
|
|
4297
|
+
| 'AU'
|
|
4298
|
+
| 'AT'
|
|
4299
|
+
| 'AZ'
|
|
4300
|
+
| 'BS'
|
|
4301
|
+
| 'BH'
|
|
4302
|
+
| 'BD'
|
|
4303
|
+
| 'BB'
|
|
4304
|
+
| 'BY'
|
|
4305
|
+
| 'BE'
|
|
4306
|
+
| 'BZ'
|
|
4307
|
+
| 'BJ'
|
|
4308
|
+
| 'BM'
|
|
4309
|
+
| 'BT'
|
|
4310
|
+
| 'BO'
|
|
4311
|
+
| 'BA'
|
|
4312
|
+
| 'BW'
|
|
4313
|
+
| 'BV'
|
|
4314
|
+
| 'BR'
|
|
4315
|
+
| 'IO'
|
|
4316
|
+
| 'BN'
|
|
4317
|
+
| 'BG'
|
|
4318
|
+
| 'BF'
|
|
4319
|
+
| 'BI'
|
|
4320
|
+
| 'KH'
|
|
4321
|
+
| 'CM'
|
|
4322
|
+
| 'CA'
|
|
4323
|
+
| 'CV'
|
|
4324
|
+
| 'KY'
|
|
4325
|
+
| 'CF'
|
|
4326
|
+
| 'TD'
|
|
4327
|
+
| 'CL'
|
|
4328
|
+
| 'CN'
|
|
4329
|
+
| 'CX'
|
|
4330
|
+
| 'CC'
|
|
4331
|
+
| 'CO'
|
|
4332
|
+
| 'KM'
|
|
4333
|
+
| 'CG'
|
|
4334
|
+
| 'CD'
|
|
4335
|
+
| 'CK'
|
|
4336
|
+
| 'CR'
|
|
4337
|
+
| 'CI'
|
|
4338
|
+
| 'HR'
|
|
4339
|
+
| 'CU'
|
|
4340
|
+
| 'CY'
|
|
4341
|
+
| 'CZ'
|
|
4342
|
+
| 'DK'
|
|
4343
|
+
| 'DJ'
|
|
4344
|
+
| 'DM'
|
|
4345
|
+
| 'DO'
|
|
4346
|
+
| 'EC'
|
|
4347
|
+
| 'EG'
|
|
4348
|
+
| 'SV'
|
|
4349
|
+
| 'GQ'
|
|
4350
|
+
| 'ER'
|
|
4351
|
+
| 'EE'
|
|
4352
|
+
| 'ET'
|
|
4353
|
+
| 'FK'
|
|
4354
|
+
| 'FO'
|
|
4355
|
+
| 'FJ'
|
|
4356
|
+
| 'FI'
|
|
4357
|
+
| 'FR'
|
|
4358
|
+
| 'GF'
|
|
4359
|
+
| 'PF'
|
|
4360
|
+
| 'TF'
|
|
4361
|
+
| 'GA'
|
|
4362
|
+
| 'GM'
|
|
4363
|
+
| 'GE'
|
|
4364
|
+
| 'DE'
|
|
4365
|
+
| 'GH'
|
|
4366
|
+
| 'GI'
|
|
4367
|
+
| 'GR'
|
|
4368
|
+
| 'GL'
|
|
4369
|
+
| 'GD'
|
|
4370
|
+
| 'GP'
|
|
4371
|
+
| 'GU'
|
|
4372
|
+
| 'GT'
|
|
4373
|
+
| 'GN'
|
|
4374
|
+
| 'GW'
|
|
4375
|
+
| 'GY'
|
|
4376
|
+
| 'HT'
|
|
4377
|
+
| 'HM'
|
|
4378
|
+
| 'VA'
|
|
4379
|
+
| 'HN'
|
|
4380
|
+
| 'HK'
|
|
4381
|
+
| 'HU'
|
|
4382
|
+
| 'IS'
|
|
4383
|
+
| 'IN'
|
|
4384
|
+
| 'ID'
|
|
4385
|
+
| 'IR'
|
|
4386
|
+
| 'IQ'
|
|
4387
|
+
| 'IE'
|
|
4388
|
+
| 'IL'
|
|
4389
|
+
| 'IT'
|
|
4390
|
+
| 'JM'
|
|
4391
|
+
| 'JP'
|
|
4392
|
+
| 'JO'
|
|
4393
|
+
| 'KZ'
|
|
4394
|
+
| 'KE'
|
|
4395
|
+
| 'KI'
|
|
4396
|
+
| 'KP'
|
|
4397
|
+
| 'KR'
|
|
4398
|
+
| 'KW'
|
|
4399
|
+
| 'KG'
|
|
4400
|
+
| 'LA'
|
|
4401
|
+
| 'LV'
|
|
4402
|
+
| 'LB'
|
|
4403
|
+
| 'LS'
|
|
4404
|
+
| 'LR'
|
|
4405
|
+
| 'LY'
|
|
4406
|
+
| 'LI'
|
|
4407
|
+
| 'LT'
|
|
4408
|
+
| 'LU'
|
|
4409
|
+
| 'MO'
|
|
4410
|
+
| 'MG'
|
|
4411
|
+
| 'MW'
|
|
4412
|
+
| 'MY'
|
|
4413
|
+
| 'MV'
|
|
4414
|
+
| 'ML'
|
|
4415
|
+
| 'MT'
|
|
4416
|
+
| 'MH'
|
|
4417
|
+
| 'MQ'
|
|
4418
|
+
| 'MR'
|
|
4419
|
+
| 'MU'
|
|
4420
|
+
| 'YT'
|
|
4421
|
+
| 'MX'
|
|
4422
|
+
| 'FM'
|
|
4423
|
+
| 'MD'
|
|
4424
|
+
| 'MC'
|
|
4425
|
+
| 'MN'
|
|
4426
|
+
| 'MS'
|
|
4427
|
+
| 'MA'
|
|
4428
|
+
| 'MZ'
|
|
4429
|
+
| 'MM'
|
|
4430
|
+
| 'NA'
|
|
4431
|
+
| 'NR'
|
|
4432
|
+
| 'NP'
|
|
4433
|
+
| 'NL'
|
|
4434
|
+
| 'NC'
|
|
4435
|
+
| 'NZ'
|
|
4436
|
+
| 'NI'
|
|
4437
|
+
| 'NE'
|
|
4438
|
+
| 'NG'
|
|
4439
|
+
| 'NU'
|
|
4440
|
+
| 'NF'
|
|
4441
|
+
| 'MP'
|
|
4442
|
+
| 'MK'
|
|
4443
|
+
| 'NO'
|
|
4444
|
+
| 'OM'
|
|
4445
|
+
| 'PK'
|
|
4446
|
+
| 'PW'
|
|
4447
|
+
| 'PS'
|
|
4448
|
+
| 'PA'
|
|
4449
|
+
| 'PG'
|
|
4450
|
+
| 'PY'
|
|
4451
|
+
| 'PE'
|
|
4452
|
+
| 'PH'
|
|
4453
|
+
| 'PN'
|
|
4454
|
+
| 'PL'
|
|
4455
|
+
| 'PT'
|
|
4456
|
+
| 'PR'
|
|
4457
|
+
| 'QA'
|
|
4458
|
+
| 'RE'
|
|
4459
|
+
| 'RO'
|
|
4460
|
+
| 'RU'
|
|
4461
|
+
| 'RW'
|
|
4462
|
+
| 'SH'
|
|
4463
|
+
| 'KN'
|
|
4464
|
+
| 'LC'
|
|
4465
|
+
| 'PM'
|
|
4466
|
+
| 'VC'
|
|
4467
|
+
| 'WS'
|
|
4468
|
+
| 'SM'
|
|
4469
|
+
| 'ST'
|
|
4470
|
+
| 'SA'
|
|
4471
|
+
| 'SN'
|
|
4472
|
+
| 'SC'
|
|
4473
|
+
| 'SL'
|
|
4474
|
+
| 'SG'
|
|
4475
|
+
| 'SK'
|
|
4476
|
+
| 'SI'
|
|
4477
|
+
| 'SB'
|
|
4478
|
+
| 'SO'
|
|
4479
|
+
| 'ZA'
|
|
4480
|
+
| 'GS'
|
|
4481
|
+
| 'ES'
|
|
4482
|
+
| 'LK'
|
|
4483
|
+
| 'SD'
|
|
4484
|
+
| 'SR'
|
|
4485
|
+
| 'SJ'
|
|
4486
|
+
| 'SZ'
|
|
4487
|
+
| 'SE'
|
|
4488
|
+
| 'CH'
|
|
4489
|
+
| 'SY'
|
|
4490
|
+
| 'TW'
|
|
4491
|
+
| 'TJ'
|
|
4492
|
+
| 'TZ'
|
|
4493
|
+
| 'TH'
|
|
4494
|
+
| 'TL'
|
|
4495
|
+
| 'TG'
|
|
4496
|
+
| 'TK'
|
|
4497
|
+
| 'TO'
|
|
4498
|
+
| 'TT'
|
|
4499
|
+
| 'TN'
|
|
4500
|
+
| 'TR'
|
|
4501
|
+
| 'TM'
|
|
4502
|
+
| 'TC'
|
|
4503
|
+
| 'TV'
|
|
4504
|
+
| 'UG'
|
|
4505
|
+
| 'UA'
|
|
4506
|
+
| 'AE'
|
|
4507
|
+
| 'GB'
|
|
4508
|
+
| 'US'
|
|
4509
|
+
| 'UM'
|
|
4510
|
+
| 'UY'
|
|
4511
|
+
| 'UZ'
|
|
4512
|
+
| 'VU'
|
|
4513
|
+
| 'VE'
|
|
4514
|
+
| 'VN'
|
|
4515
|
+
| 'VG'
|
|
4516
|
+
| 'VI'
|
|
4517
|
+
| 'WF'
|
|
4518
|
+
| 'EH'
|
|
4519
|
+
| 'YE'
|
|
4520
|
+
| 'ZM'
|
|
4521
|
+
| 'ZW'
|
|
4522
|
+
| 'AX'
|
|
4523
|
+
| 'BQ'
|
|
4524
|
+
| 'CW'
|
|
4525
|
+
| 'GG'
|
|
4526
|
+
| 'IM'
|
|
4527
|
+
| 'JE'
|
|
4528
|
+
| 'ME'
|
|
4529
|
+
| 'BL'
|
|
4530
|
+
| 'MF'
|
|
4531
|
+
| 'RS'
|
|
4532
|
+
| 'SX'
|
|
4533
|
+
| 'SS'
|
|
4534
|
+
| 'XK';
|
|
4535
|
+
|
|
4536
|
+
line1: string;
|
|
4537
|
+
|
|
4538
|
+
zipCode: string;
|
|
4539
|
+
|
|
4540
|
+
firstName?: string;
|
|
4541
|
+
|
|
4542
|
+
lastName?: string;
|
|
4543
|
+
|
|
4544
|
+
line2?: string;
|
|
4545
|
+
|
|
4546
|
+
region?: string;
|
|
4547
|
+
}
|
|
4548
|
+
|
|
4549
|
+
/**
|
|
4550
|
+
* The selected shipping method by the user. Can either be selected during an
|
|
4551
|
+
* express Checkout Session or passed during Checkout Session creation.
|
|
4552
|
+
*/
|
|
4553
|
+
export interface ShippingMethod {
|
|
4554
|
+
/**
|
|
4555
|
+
* The customer-facing name of the shipping method.
|
|
4556
|
+
*/
|
|
4557
|
+
name: string;
|
|
4558
|
+
|
|
4559
|
+
/**
|
|
4560
|
+
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
4561
|
+
*/
|
|
4562
|
+
price: number;
|
|
4563
|
+
|
|
4564
|
+
/**
|
|
4565
|
+
* The unique identifier of the shipping method within Ivy.
|
|
4566
|
+
*/
|
|
4567
|
+
id?: string;
|
|
4568
|
+
|
|
4569
|
+
/**
|
|
4570
|
+
* The list of countries where the shipping method is available.
|
|
4571
|
+
*/
|
|
4572
|
+
countries?: Array<
|
|
4573
|
+
| 'AF'
|
|
4574
|
+
| 'AL'
|
|
4575
|
+
| 'DZ'
|
|
4576
|
+
| 'AS'
|
|
4577
|
+
| 'AD'
|
|
4578
|
+
| 'AO'
|
|
4579
|
+
| 'AI'
|
|
4580
|
+
| 'AQ'
|
|
4581
|
+
| 'AG'
|
|
4582
|
+
| 'AR'
|
|
4583
|
+
| 'AM'
|
|
4584
|
+
| 'AW'
|
|
4585
|
+
| 'AU'
|
|
4586
|
+
| 'AT'
|
|
4587
|
+
| 'AZ'
|
|
4588
|
+
| 'BS'
|
|
4589
|
+
| 'BH'
|
|
4590
|
+
| 'BD'
|
|
4591
|
+
| 'BB'
|
|
4592
|
+
| 'BY'
|
|
4593
|
+
| 'BE'
|
|
4594
|
+
| 'BZ'
|
|
4595
|
+
| 'BJ'
|
|
4596
|
+
| 'BM'
|
|
4597
|
+
| 'BT'
|
|
4598
|
+
| 'BO'
|
|
4599
|
+
| 'BA'
|
|
4600
|
+
| 'BW'
|
|
4601
|
+
| 'BV'
|
|
4602
|
+
| 'BR'
|
|
4603
|
+
| 'IO'
|
|
4604
|
+
| 'BN'
|
|
4605
|
+
| 'BG'
|
|
4606
|
+
| 'BF'
|
|
4607
|
+
| 'BI'
|
|
4608
|
+
| 'KH'
|
|
4609
|
+
| 'CM'
|
|
4610
|
+
| 'CA'
|
|
4611
|
+
| 'CV'
|
|
4612
|
+
| 'KY'
|
|
4613
|
+
| 'CF'
|
|
4614
|
+
| 'TD'
|
|
4615
|
+
| 'CL'
|
|
4616
|
+
| 'CN'
|
|
4617
|
+
| 'CX'
|
|
4618
|
+
| 'CC'
|
|
4619
|
+
| 'CO'
|
|
4620
|
+
| 'KM'
|
|
4621
|
+
| 'CG'
|
|
4622
|
+
| 'CD'
|
|
4623
|
+
| 'CK'
|
|
4624
|
+
| 'CR'
|
|
4625
|
+
| 'CI'
|
|
4626
|
+
| 'HR'
|
|
4627
|
+
| 'CU'
|
|
4628
|
+
| 'CY'
|
|
4629
|
+
| 'CZ'
|
|
4630
|
+
| 'DK'
|
|
4631
|
+
| 'DJ'
|
|
4632
|
+
| 'DM'
|
|
4633
|
+
| 'DO'
|
|
4634
|
+
| 'EC'
|
|
4635
|
+
| 'EG'
|
|
4636
|
+
| 'SV'
|
|
4637
|
+
| 'GQ'
|
|
4638
|
+
| 'ER'
|
|
4639
|
+
| 'EE'
|
|
4640
|
+
| 'ET'
|
|
4641
|
+
| 'FK'
|
|
4642
|
+
| 'FO'
|
|
4643
|
+
| 'FJ'
|
|
4644
|
+
| 'FI'
|
|
4645
|
+
| 'FR'
|
|
4646
|
+
| 'GF'
|
|
4647
|
+
| 'PF'
|
|
4648
|
+
| 'TF'
|
|
4649
|
+
| 'GA'
|
|
4650
|
+
| 'GM'
|
|
4651
|
+
| 'GE'
|
|
4652
|
+
| 'DE'
|
|
4653
|
+
| 'GH'
|
|
4654
|
+
| 'GI'
|
|
4655
|
+
| 'GR'
|
|
4656
|
+
| 'GL'
|
|
4657
|
+
| 'GD'
|
|
4658
|
+
| 'GP'
|
|
4659
|
+
| 'GU'
|
|
4660
|
+
| 'GT'
|
|
4661
|
+
| 'GN'
|
|
4662
|
+
| 'GW'
|
|
4663
|
+
| 'GY'
|
|
4664
|
+
| 'HT'
|
|
4665
|
+
| 'HM'
|
|
4666
|
+
| 'VA'
|
|
4667
|
+
| 'HN'
|
|
4668
|
+
| 'HK'
|
|
4669
|
+
| 'HU'
|
|
4670
|
+
| 'IS'
|
|
4671
|
+
| 'IN'
|
|
4672
|
+
| 'ID'
|
|
4673
|
+
| 'IR'
|
|
4674
|
+
| 'IQ'
|
|
4675
|
+
| 'IE'
|
|
4676
|
+
| 'IL'
|
|
4677
|
+
| 'IT'
|
|
4678
|
+
| 'JM'
|
|
4679
|
+
| 'JP'
|
|
4680
|
+
| 'JO'
|
|
4681
|
+
| 'KZ'
|
|
4682
|
+
| 'KE'
|
|
4683
|
+
| 'KI'
|
|
4684
|
+
| 'KP'
|
|
4685
|
+
| 'KR'
|
|
4686
|
+
| 'KW'
|
|
4687
|
+
| 'KG'
|
|
4688
|
+
| 'LA'
|
|
4689
|
+
| 'LV'
|
|
4690
|
+
| 'LB'
|
|
4691
|
+
| 'LS'
|
|
4692
|
+
| 'LR'
|
|
4693
|
+
| 'LY'
|
|
4694
|
+
| 'LI'
|
|
4695
|
+
| 'LT'
|
|
4696
|
+
| 'LU'
|
|
4697
|
+
| 'MO'
|
|
4698
|
+
| 'MG'
|
|
4699
|
+
| 'MW'
|
|
4700
|
+
| 'MY'
|
|
4701
|
+
| 'MV'
|
|
4702
|
+
| 'ML'
|
|
4703
|
+
| 'MT'
|
|
4704
|
+
| 'MH'
|
|
4705
|
+
| 'MQ'
|
|
4706
|
+
| 'MR'
|
|
4707
|
+
| 'MU'
|
|
4708
|
+
| 'YT'
|
|
4709
|
+
| 'MX'
|
|
4710
|
+
| 'FM'
|
|
4711
|
+
| 'MD'
|
|
4712
|
+
| 'MC'
|
|
4713
|
+
| 'MN'
|
|
4714
|
+
| 'MS'
|
|
4715
|
+
| 'MA'
|
|
4716
|
+
| 'MZ'
|
|
4717
|
+
| 'MM'
|
|
4718
|
+
| 'NA'
|
|
4719
|
+
| 'NR'
|
|
4720
|
+
| 'NP'
|
|
4721
|
+
| 'NL'
|
|
4722
|
+
| 'NC'
|
|
4723
|
+
| 'NZ'
|
|
4724
|
+
| 'NI'
|
|
4725
|
+
| 'NE'
|
|
4726
|
+
| 'NG'
|
|
4727
|
+
| 'NU'
|
|
4728
|
+
| 'NF'
|
|
4729
|
+
| 'MP'
|
|
4730
|
+
| 'MK'
|
|
4731
|
+
| 'NO'
|
|
4732
|
+
| 'OM'
|
|
4733
|
+
| 'PK'
|
|
4734
|
+
| 'PW'
|
|
4735
|
+
| 'PS'
|
|
4736
|
+
| 'PA'
|
|
4737
|
+
| 'PG'
|
|
4738
|
+
| 'PY'
|
|
4739
|
+
| 'PE'
|
|
4740
|
+
| 'PH'
|
|
4741
|
+
| 'PN'
|
|
4742
|
+
| 'PL'
|
|
4743
|
+
| 'PT'
|
|
4744
|
+
| 'PR'
|
|
4745
|
+
| 'QA'
|
|
4746
|
+
| 'RE'
|
|
4747
|
+
| 'RO'
|
|
4748
|
+
| 'RU'
|
|
4749
|
+
| 'RW'
|
|
4750
|
+
| 'SH'
|
|
4751
|
+
| 'KN'
|
|
4752
|
+
| 'LC'
|
|
4753
|
+
| 'PM'
|
|
4754
|
+
| 'VC'
|
|
4755
|
+
| 'WS'
|
|
4756
|
+
| 'SM'
|
|
4757
|
+
| 'ST'
|
|
4758
|
+
| 'SA'
|
|
4759
|
+
| 'SN'
|
|
4760
|
+
| 'SC'
|
|
4761
|
+
| 'SL'
|
|
4762
|
+
| 'SG'
|
|
4763
|
+
| 'SK'
|
|
4764
|
+
| 'SI'
|
|
4765
|
+
| 'SB'
|
|
4766
|
+
| 'SO'
|
|
4767
|
+
| 'ZA'
|
|
4768
|
+
| 'GS'
|
|
4769
|
+
| 'ES'
|
|
4770
|
+
| 'LK'
|
|
4771
|
+
| 'SD'
|
|
4772
|
+
| 'SR'
|
|
4773
|
+
| 'SJ'
|
|
4774
|
+
| 'SZ'
|
|
4775
|
+
| 'SE'
|
|
4776
|
+
| 'CH'
|
|
4777
|
+
| 'SY'
|
|
4778
|
+
| 'TW'
|
|
4779
|
+
| 'TJ'
|
|
4780
|
+
| 'TZ'
|
|
4781
|
+
| 'TH'
|
|
4782
|
+
| 'TL'
|
|
4783
|
+
| 'TG'
|
|
4784
|
+
| 'TK'
|
|
4785
|
+
| 'TO'
|
|
4786
|
+
| 'TT'
|
|
4787
|
+
| 'TN'
|
|
4788
|
+
| 'TR'
|
|
4789
|
+
| 'TM'
|
|
4790
|
+
| 'TC'
|
|
4791
|
+
| 'TV'
|
|
4792
|
+
| 'UG'
|
|
4793
|
+
| 'UA'
|
|
4794
|
+
| 'AE'
|
|
4795
|
+
| 'GB'
|
|
4796
|
+
| 'US'
|
|
4797
|
+
| 'UM'
|
|
4798
|
+
| 'UY'
|
|
4799
|
+
| 'UZ'
|
|
4800
|
+
| 'VU'
|
|
4801
|
+
| 'VE'
|
|
4802
|
+
| 'VN'
|
|
4803
|
+
| 'VG'
|
|
4804
|
+
| 'VI'
|
|
4805
|
+
| 'WF'
|
|
4806
|
+
| 'EH'
|
|
4807
|
+
| 'YE'
|
|
4808
|
+
| 'ZM'
|
|
4809
|
+
| 'ZW'
|
|
4810
|
+
| 'AX'
|
|
4811
|
+
| 'BQ'
|
|
4812
|
+
| 'CW'
|
|
4813
|
+
| 'GG'
|
|
4814
|
+
| 'IM'
|
|
4815
|
+
| 'JE'
|
|
4816
|
+
| 'ME'
|
|
4817
|
+
| 'BL'
|
|
4818
|
+
| 'MF'
|
|
4819
|
+
| 'RS'
|
|
4820
|
+
| 'SX'
|
|
4821
|
+
| 'SS'
|
|
4822
|
+
| 'XK'
|
|
4823
|
+
>;
|
|
4824
|
+
|
|
4825
|
+
/**
|
|
4826
|
+
* The delivery estimate of the shipping method.
|
|
4827
|
+
*/
|
|
4828
|
+
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
4829
|
+
|
|
4830
|
+
/**
|
|
4831
|
+
* The unique identifier within your system of the shipping method.
|
|
4832
|
+
*/
|
|
4833
|
+
reference?: string;
|
|
4834
|
+
|
|
4835
|
+
/**
|
|
4836
|
+
* @deprecated Deprecated in favor of deliveryEstimate
|
|
4837
|
+
*/
|
|
4838
|
+
timeFrame?: string;
|
|
4839
|
+
}
|
|
4840
|
+
|
|
4841
|
+
export namespace ShippingMethod {
|
|
4842
|
+
/**
|
|
4843
|
+
* The delivery estimate of the shipping method.
|
|
4844
|
+
*/
|
|
4845
|
+
export interface DeliveryEstimate {
|
|
4846
|
+
/**
|
|
4847
|
+
* The maximum delivery time.
|
|
4848
|
+
*/
|
|
4849
|
+
maximum?: DeliveryEstimate.Maximum;
|
|
4850
|
+
|
|
4851
|
+
/**
|
|
4852
|
+
* The minimum delivery time.
|
|
4853
|
+
*/
|
|
4854
|
+
minimum?: DeliveryEstimate.Minimum;
|
|
4855
|
+
}
|
|
4856
|
+
|
|
4857
|
+
export namespace DeliveryEstimate {
|
|
4858
|
+
/**
|
|
4859
|
+
* The maximum delivery time.
|
|
4860
|
+
*/
|
|
4861
|
+
export interface Maximum {
|
|
4862
|
+
/**
|
|
4863
|
+
* The unit of the time duration.
|
|
4864
|
+
*/
|
|
4865
|
+
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
4866
|
+
|
|
4867
|
+
/**
|
|
4868
|
+
* The value of the time duration.
|
|
4869
|
+
*/
|
|
4870
|
+
value: number;
|
|
4871
|
+
}
|
|
4872
|
+
|
|
4873
|
+
/**
|
|
4874
|
+
* The minimum delivery time.
|
|
4875
|
+
*/
|
|
4876
|
+
export interface Minimum {
|
|
4877
|
+
/**
|
|
4878
|
+
* The unit of the time duration.
|
|
4879
|
+
*/
|
|
4880
|
+
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
4881
|
+
|
|
4882
|
+
/**
|
|
4883
|
+
* The value of the time duration.
|
|
4884
|
+
*/
|
|
4885
|
+
value: number;
|
|
4886
|
+
}
|
|
4887
|
+
}
|
|
4888
|
+
}
|
|
4889
|
+
|
|
4890
|
+
/**
|
|
4891
|
+
* The shopper object. Contains information collected from the user during the
|
|
4892
|
+
* Checkout.
|
|
4893
|
+
*/
|
|
4894
|
+
export interface Shopper {
|
|
4895
|
+
email?: string;
|
|
4896
|
+
|
|
4897
|
+
phoneNumber?: string;
|
|
4898
|
+
}
|
|
4899
|
+
|
|
4900
|
+
export interface StatusClassification {
|
|
4901
|
+
/**
|
|
4902
|
+
* Populated with the primary payment initiation failure classsification if
|
|
4903
|
+
* available.
|
|
4904
|
+
*/
|
|
4905
|
+
primary?: string;
|
|
4906
|
+
|
|
4907
|
+
/**
|
|
4908
|
+
* Populated with the secondary payment initiation failure classsification if
|
|
4909
|
+
* available.
|
|
4910
|
+
*/
|
|
4911
|
+
secondary?: string;
|
|
4912
|
+
}
|
|
4913
|
+
|
|
4914
|
+
export interface StatusHistoryList {
|
|
4915
|
+
/**
|
|
4916
|
+
* The order status. This status symbolises the state of the user's payment
|
|
4917
|
+
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
4918
|
+
* information.
|
|
4919
|
+
*/
|
|
4920
|
+
currentStatus:
|
|
4921
|
+
| 'failed'
|
|
4922
|
+
| 'canceled'
|
|
4923
|
+
| 'processing'
|
|
4924
|
+
| 'waiting_for_payment'
|
|
4925
|
+
| 'paid'
|
|
4926
|
+
| 'in_refund'
|
|
4927
|
+
| 'refunded'
|
|
4928
|
+
| 'refund_failed'
|
|
4929
|
+
| 'partially_refunded'
|
|
4930
|
+
| 'in_dispute'
|
|
4931
|
+
| 'disputed'
|
|
4932
|
+
| 'refused';
|
|
4933
|
+
|
|
4934
|
+
reason: string;
|
|
4935
|
+
|
|
4936
|
+
updatedAt: string;
|
|
4937
|
+
|
|
4938
|
+
/**
|
|
4939
|
+
* The order status. This status symbolises the state of the user's payment
|
|
4940
|
+
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
4941
|
+
* information.
|
|
4942
|
+
*/
|
|
4943
|
+
previousStatus?:
|
|
4944
|
+
| 'failed'
|
|
4945
|
+
| 'canceled'
|
|
4946
|
+
| 'processing'
|
|
4947
|
+
| 'waiting_for_payment'
|
|
4948
|
+
| 'paid'
|
|
4949
|
+
| 'in_refund'
|
|
4950
|
+
| 'refunded'
|
|
4951
|
+
| 'refund_failed'
|
|
4952
|
+
| 'partially_refunded'
|
|
4953
|
+
| 'in_dispute'
|
|
4954
|
+
| 'disputed'
|
|
4955
|
+
| 'refused'
|
|
4956
|
+
| null;
|
|
4957
|
+
}
|
|
4958
|
+
}
|
|
4959
|
+
|
|
4960
|
+
export interface OrderCreateParams {
|
|
4961
|
+
/**
|
|
4962
|
+
* The total amount of the order
|
|
4963
|
+
*/
|
|
4964
|
+
amount: number;
|
|
4965
|
+
|
|
4966
|
+
/**
|
|
4967
|
+
* The currency code of the order
|
|
4968
|
+
*/
|
|
4969
|
+
currency: 'EUR' | 'GBP' | 'PLN';
|
|
4970
|
+
|
|
4971
|
+
/**
|
|
4972
|
+
* The merchant's unique reference ID for the order
|
|
4973
|
+
*/
|
|
4974
|
+
referenceId: string;
|
|
4975
|
+
|
|
4976
|
+
/**
|
|
4977
|
+
* The customer of the merchant.
|
|
4978
|
+
*/
|
|
4979
|
+
customer?: OrderCreateParams.Email | OrderCreateParams.ID;
|
|
4980
|
+
|
|
4981
|
+
/**
|
|
4982
|
+
* Optional expiration timestamp in seconds
|
|
4983
|
+
*/
|
|
4984
|
+
expiresAt?: string;
|
|
4985
|
+
|
|
4986
|
+
/**
|
|
4987
|
+
* The subaccount id of the merchant.
|
|
4988
|
+
*/
|
|
4989
|
+
subaccountId?: string;
|
|
4990
|
+
}
|
|
4991
|
+
|
|
4992
|
+
export namespace OrderCreateParams {
|
|
4993
|
+
export interface Email {
|
|
4994
|
+
/**
|
|
4995
|
+
* The email of the customer.
|
|
4996
|
+
*/
|
|
4997
|
+
email: string;
|
|
4998
|
+
}
|
|
4999
|
+
|
|
5000
|
+
export interface ID {
|
|
5001
|
+
/**
|
|
5002
|
+
* The Ivy id of the customer.
|
|
5003
|
+
*/
|
|
5004
|
+
id: string;
|
|
5005
|
+
}
|
|
5006
|
+
}
|
|
5007
|
+
|
|
5008
|
+
export interface OrderRetrieveParams {
|
|
5009
|
+
id: string;
|
|
5010
|
+
}
|
|
5011
|
+
|
|
5012
|
+
export interface OrderExpireParams {
|
|
1659
5013
|
id: string;
|
|
1660
5014
|
}
|
|
1661
5015
|
|
|
1662
5016
|
export declare namespace Orders {
|
|
1663
5017
|
export {
|
|
5018
|
+
type OrderCreateResponse as OrderCreateResponse,
|
|
1664
5019
|
type OrderRetrieveResponse as OrderRetrieveResponse,
|
|
5020
|
+
type OrderExpireResponse as OrderExpireResponse,
|
|
5021
|
+
type OrderCreateParams as OrderCreateParams,
|
|
1665
5022
|
type OrderRetrieveParams as OrderRetrieveParams,
|
|
5023
|
+
type OrderExpireParams as OrderExpireParams,
|
|
1666
5024
|
};
|
|
1667
5025
|
}
|