@getivy/node-sdk 0.1.0-alpha.2 → 0.1.0-alpha.20
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 +209 -0
- package/LICENSE +1 -1
- package/README.md +18 -18
- package/_shims/index.d.ts +2 -0
- package/_shims/index.js +5 -1
- package/_shims/index.mjs +5 -1
- package/core.d.ts +12 -1
- package/core.d.ts.map +1 -1
- package/core.js +29 -20
- package/core.js.map +1 -1
- package/core.mjs +31 -22
- package/core.mjs.map +1 -1
- package/error.d.ts +2 -2
- package/error.d.ts.map +1 -1
- package/error.js +4 -4
- package/error.js.map +1 -1
- package/error.mjs +2 -2
- package/error.mjs.map +1 -1
- package/index.d.mts +15 -12
- package/index.d.ts +15 -12
- package/index.d.ts.map +1 -1
- package/index.js +45 -42
- package/index.js.map +1 -1
- package/index.mjs +43 -40
- package/index.mjs.map +1 -1
- package/package.json +3 -3
- package/resource.d.ts +3 -3
- package/resource.d.ts.map +1 -1
- package/resource.js.map +1 -1
- package/resource.mjs.map +1 -1
- package/resources/banks.d.ts +12 -0
- package/resources/banks.d.ts.map +1 -1
- package/resources/charges.d.ts +0 -13
- package/resources/charges.d.ts.map +1 -1
- package/resources/checkoutsession.d.ts +444 -1305
- package/resources/checkoutsession.d.ts.map +1 -1
- package/resources/customers.d.ts +41 -4
- package/resources/customers.d.ts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -1
- package/resources/index.mjs.map +1 -1
- package/resources/orders.d.ts +89 -659
- package/resources/orders.d.ts.map +1 -1
- package/resources/orders.js +0 -6
- package/resources/orders.js.map +1 -1
- package/resources/orders.mjs +0 -6
- package/resources/orders.mjs.map +1 -1
- package/resources/refunds.d.ts +1 -1
- package/resources/refunds.d.ts.map +1 -1
- package/resources/webhooksubscription.d.ts +155 -0
- package/resources/webhooksubscription.d.ts.map +1 -0
- package/resources/webhooksubscription.js +42 -0
- package/resources/webhooksubscription.js.map +1 -0
- package/resources/webhooksubscription.mjs +38 -0
- package/resources/webhooksubscription.mjs.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +18 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/_shims/index.d.ts +2 -0
- package/src/_shims/index.js +5 -1
- package/src/_shims/index.mjs +5 -1
- package/src/core.ts +49 -22
- package/src/error.ts +2 -2
- package/src/index.ts +57 -36
- package/src/resource.ts +3 -3
- package/src/resources/banks.ts +15 -0
- package/src/resources/charges.ts +0 -13
- package/src/resources/checkoutsession.ts +2103 -4416
- package/src/resources/customers.ts +46 -4
- package/src/resources/index.ts +14 -7
- package/src/resources/orders.ts +107 -1635
- package/src/resources/refunds.ts +0 -1
- package/src/resources/webhooksubscription.ts +353 -0
- package/src/resources.ts +1 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
package/src/resources/orders.ts
CHANGED
|
@@ -12,13 +12,6 @@ export class Orders extends APIResource {
|
|
|
12
12
|
retrieve(body: OrderRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<OrderRetrieveResponse> {
|
|
13
13
|
return this._client.post('/api/service/order/details', { body, ...options });
|
|
14
14
|
}
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* Update certain fields of the specified order.
|
|
18
|
-
*/
|
|
19
|
-
update(body: OrderUpdateParams, options?: Core.RequestOptions): Core.APIPromise<OrderUpdateResponse> {
|
|
20
|
-
return this._client.post('/api/service/order/update', { body, ...options });
|
|
21
|
-
}
|
|
22
15
|
}
|
|
23
16
|
|
|
24
17
|
export interface OrderRetrieveResponse {
|
|
@@ -54,7 +47,7 @@ export interface OrderRetrieveResponse {
|
|
|
54
47
|
merchantId: string;
|
|
55
48
|
|
|
56
49
|
/**
|
|
57
|
-
* The
|
|
50
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
58
51
|
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
59
52
|
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
60
53
|
* as this is the format accepted by most banks.
|
|
@@ -81,7 +74,6 @@ export interface OrderRetrieveResponse {
|
|
|
81
74
|
| 'failed'
|
|
82
75
|
| 'canceled'
|
|
83
76
|
| 'processing'
|
|
84
|
-
| 'in_handshake'
|
|
85
77
|
| 'waiting_for_payment'
|
|
86
78
|
| 'paid'
|
|
87
79
|
| 'in_refund'
|
|
@@ -95,8 +87,14 @@ export interface OrderRetrieveResponse {
|
|
|
95
87
|
updatedAt: string;
|
|
96
88
|
|
|
97
89
|
/**
|
|
98
|
-
* The
|
|
99
|
-
*
|
|
90
|
+
* The unique identifier of Ivy of the chosen bank to make the payment. Not there,
|
|
91
|
+
* if no payment was made.
|
|
92
|
+
*/
|
|
93
|
+
bankId?: string;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* @deprecated The bank statement reference of the payment for the order. This is
|
|
97
|
+
* the reference that will be visible on the bank statement.
|
|
100
98
|
*/
|
|
101
99
|
bankStatementReference?: string;
|
|
102
100
|
|
|
@@ -126,6 +124,8 @@ export interface OrderRetrieveResponse {
|
|
|
126
124
|
*/
|
|
127
125
|
customerId?: string;
|
|
128
126
|
|
|
127
|
+
destination?: OrderRetrieveResponse.Destination;
|
|
128
|
+
|
|
129
129
|
/**
|
|
130
130
|
* The customer facing id. This id is displayed to the user during the checkout and
|
|
131
131
|
* in the merchant dashboard.
|
|
@@ -160,7 +160,7 @@ export interface OrderRetrieveResponse {
|
|
|
160
160
|
mandate?: OrderRetrieveResponse.Mandate;
|
|
161
161
|
|
|
162
162
|
/**
|
|
163
|
-
*
|
|
163
|
+
* @deprecated
|
|
164
164
|
*/
|
|
165
165
|
merchantFinancialAddress?: OrderRetrieveResponse.MerchantFinancialAddress;
|
|
166
166
|
|
|
@@ -182,7 +182,7 @@ export interface OrderRetrieveResponse {
|
|
|
182
182
|
*/
|
|
183
183
|
payerFinancialAddress?: OrderRetrieveResponse.PayerFinancialAddress;
|
|
184
184
|
|
|
185
|
-
paymentMethodType?: 'sepa_debit' | 'customer_balance';
|
|
185
|
+
paymentMethodType?: 'sepa_debit' | 'customer_balance' | 'manual_bank_transfer';
|
|
186
186
|
|
|
187
187
|
/**
|
|
188
188
|
* The payment mode of the order. Can be either 'settlement' or 'direct'.
|
|
@@ -204,7 +204,8 @@ export interface OrderRetrieveResponse {
|
|
|
204
204
|
| 'refund_failed'
|
|
205
205
|
| 'partially_refunded'
|
|
206
206
|
| 'not_settled'
|
|
207
|
-
| 'disputed'
|
|
207
|
+
| 'disputed'
|
|
208
|
+
| 'frozen_due_to_aml';
|
|
208
209
|
|
|
209
210
|
/**
|
|
210
211
|
* The total amount in the currency of all successful refunds for this order
|
|
@@ -270,7 +271,7 @@ export interface OrderRetrieveResponse {
|
|
|
270
271
|
|
|
271
272
|
export namespace OrderRetrieveResponse {
|
|
272
273
|
/**
|
|
273
|
-
* The
|
|
274
|
+
* The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
|
|
274
275
|
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
275
276
|
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
276
277
|
* as this is the format accepted by most banks.
|
|
@@ -283,25 +284,12 @@ export namespace OrderRetrieveResponse {
|
|
|
283
284
|
*/
|
|
284
285
|
total: number;
|
|
285
286
|
|
|
286
|
-
/**
|
|
287
|
-
* The shipping amount.
|
|
288
|
-
*/
|
|
289
287
|
shipping?: number;
|
|
290
288
|
|
|
291
|
-
/**
|
|
292
|
-
* The subtotal amount, i.e. the total amount without VAT and shipping.
|
|
293
|
-
*/
|
|
294
289
|
subTotal?: number;
|
|
295
290
|
|
|
296
|
-
/**
|
|
297
|
-
* The total net amount, i.e. the total amount without VAT. This value is rounded
|
|
298
|
-
* to 2 decimal places for the actual transfer.
|
|
299
|
-
*/
|
|
300
291
|
totalNet?: number;
|
|
301
292
|
|
|
302
|
-
/**
|
|
303
|
-
* The VAT amount.
|
|
304
|
-
*/
|
|
305
293
|
vat?: number;
|
|
306
294
|
}
|
|
307
295
|
|
|
@@ -589,6 +577,95 @@ export namespace OrderRetrieveResponse {
|
|
|
589
577
|
type: 'transaction' | 'amount';
|
|
590
578
|
}
|
|
591
579
|
|
|
580
|
+
export interface Destination {
|
|
581
|
+
/**
|
|
582
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
583
|
+
* to "iban", the "iban" object must be filled out.
|
|
584
|
+
*/
|
|
585
|
+
bankAccount: Destination.BankAccount;
|
|
586
|
+
|
|
587
|
+
/**
|
|
588
|
+
* The bank statement reference of the payment for the order. This is the reference
|
|
589
|
+
* that will be visible on the bank statement.
|
|
590
|
+
*/
|
|
591
|
+
bankStatementReference: string;
|
|
592
|
+
}
|
|
593
|
+
|
|
594
|
+
export namespace Destination {
|
|
595
|
+
/**
|
|
596
|
+
* The validation logic is based on the "type" field. For example, if "type" is set
|
|
597
|
+
* to "iban", the "iban" object must be filled out.
|
|
598
|
+
*/
|
|
599
|
+
export interface BankAccount {
|
|
600
|
+
/**
|
|
601
|
+
* The type of the financial address. The actual destination is determined by this
|
|
602
|
+
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
603
|
+
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
604
|
+
* in the "iban" object.
|
|
605
|
+
*
|
|
606
|
+
* - iban: The IBAN of the account
|
|
607
|
+
* - sort_code: The sort code of the account
|
|
608
|
+
* - bank_code: The bank code of the account
|
|
609
|
+
* - bban: The BBAN of the account
|
|
610
|
+
*/
|
|
611
|
+
type: string;
|
|
612
|
+
|
|
613
|
+
bankCode?: BankAccount.BankCode;
|
|
614
|
+
|
|
615
|
+
bban?: BankAccount.Bban;
|
|
616
|
+
|
|
617
|
+
iban?: BankAccount.Iban;
|
|
618
|
+
|
|
619
|
+
sortCode?: BankAccount.SortCode;
|
|
620
|
+
}
|
|
621
|
+
|
|
622
|
+
export namespace BankAccount {
|
|
623
|
+
export interface BankCode {
|
|
624
|
+
/**
|
|
625
|
+
* The name of the account holder.
|
|
626
|
+
*/
|
|
627
|
+
accountHolderName: string;
|
|
628
|
+
|
|
629
|
+
accountNumber: string;
|
|
630
|
+
|
|
631
|
+
code: string;
|
|
632
|
+
}
|
|
633
|
+
|
|
634
|
+
export interface Bban {
|
|
635
|
+
/**
|
|
636
|
+
* The name of the account holder.
|
|
637
|
+
*/
|
|
638
|
+
accountHolderName: string;
|
|
639
|
+
|
|
640
|
+
bban: string;
|
|
641
|
+
|
|
642
|
+
bic?: string;
|
|
643
|
+
}
|
|
644
|
+
|
|
645
|
+
export interface Iban {
|
|
646
|
+
/**
|
|
647
|
+
* The name of the account holder.
|
|
648
|
+
*/
|
|
649
|
+
accountHolderName: string;
|
|
650
|
+
|
|
651
|
+
iban: string;
|
|
652
|
+
|
|
653
|
+
bic?: string;
|
|
654
|
+
}
|
|
655
|
+
|
|
656
|
+
export interface SortCode {
|
|
657
|
+
/**
|
|
658
|
+
* The name of the account holder.
|
|
659
|
+
*/
|
|
660
|
+
accountHolderName: string;
|
|
661
|
+
|
|
662
|
+
accountNumber: string;
|
|
663
|
+
|
|
664
|
+
sortCode: string;
|
|
665
|
+
}
|
|
666
|
+
}
|
|
667
|
+
}
|
|
668
|
+
|
|
592
669
|
export interface LineItem {
|
|
593
670
|
/**
|
|
594
671
|
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
@@ -720,7 +797,7 @@ export namespace OrderRetrieveResponse {
|
|
|
720
797
|
}
|
|
721
798
|
|
|
722
799
|
/**
|
|
723
|
-
*
|
|
800
|
+
* @deprecated
|
|
724
801
|
*/
|
|
725
802
|
export interface MerchantFinancialAddress {
|
|
726
803
|
bankCode?: MerchantFinancialAddress.BankCode;
|
|
@@ -1542,7 +1619,6 @@ export namespace OrderRetrieveResponse {
|
|
|
1542
1619
|
| 'failed'
|
|
1543
1620
|
| 'canceled'
|
|
1544
1621
|
| 'processing'
|
|
1545
|
-
| 'in_handshake'
|
|
1546
1622
|
| 'waiting_for_payment'
|
|
1547
1623
|
| 'paid'
|
|
1548
1624
|
| 'in_refund'
|
|
@@ -1566,7 +1642,6 @@ export namespace OrderRetrieveResponse {
|
|
|
1566
1642
|
| 'failed'
|
|
1567
1643
|
| 'canceled'
|
|
1568
1644
|
| 'processing'
|
|
1569
|
-
| 'in_handshake'
|
|
1570
1645
|
| 'waiting_for_payment'
|
|
1571
1646
|
| 'paid'
|
|
1572
1647
|
| 'in_refund'
|
|
@@ -1580,1616 +1655,13 @@ export namespace OrderRetrieveResponse {
|
|
|
1580
1655
|
}
|
|
1581
1656
|
}
|
|
1582
1657
|
|
|
1583
|
-
export interface
|
|
1584
|
-
/**
|
|
1585
|
-
* The Ivy unique identifier for the order.
|
|
1586
|
-
*/
|
|
1658
|
+
export interface OrderRetrieveParams {
|
|
1587
1659
|
id: string;
|
|
1588
|
-
|
|
1589
|
-
/**
|
|
1590
|
-
* @deprecated The unique identifier for the merchantApp which initiated the order
|
|
1591
|
-
* / payment attempt.
|
|
1592
|
-
*/
|
|
1593
|
-
appId: string;
|
|
1594
|
-
|
|
1595
|
-
/**
|
|
1596
|
-
* The Ivy fee for the payment.
|
|
1597
|
-
*/
|
|
1598
|
-
applicationFeeAmount: number;
|
|
1599
|
-
|
|
1600
|
-
createdAt: string;
|
|
1601
|
-
|
|
1602
|
-
instantPaymentScheme: boolean;
|
|
1603
|
-
|
|
1604
|
-
/**
|
|
1605
|
-
* @deprecated Deprecated in favor of `appId`.
|
|
1606
|
-
*/
|
|
1607
|
-
merchantAppId: string;
|
|
1608
|
-
|
|
1609
|
-
/**
|
|
1610
|
-
* The unique identifier for the merchant which initiated the order / payment
|
|
1611
|
-
* attempt.
|
|
1612
|
-
*/
|
|
1613
|
-
merchantId: string;
|
|
1614
|
-
|
|
1615
|
-
/**
|
|
1616
|
-
* The price to be paid by the user. All amounts are in decimals, i.e. 10.23
|
|
1617
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1618
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1619
|
-
* as this is the format accepted by most banks.
|
|
1620
|
-
*/
|
|
1621
|
-
price: OrderUpdateResponse.Price;
|
|
1622
|
-
|
|
1623
|
-
/**
|
|
1624
|
-
* An internal reference id which will be stored with the checkout & corresponding
|
|
1625
|
-
* order. Needs to be unique per shop per order and can be up to 200 characters.
|
|
1626
|
-
*/
|
|
1627
|
-
referenceId: string;
|
|
1628
|
-
|
|
1629
|
-
/**
|
|
1630
|
-
* The name of the merchant which initiated the order.
|
|
1631
|
-
*/
|
|
1632
|
-
shopName: string;
|
|
1633
|
-
|
|
1634
|
-
/**
|
|
1635
|
-
* The order status. This status symbolises the state of the user's payment
|
|
1636
|
-
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
1637
|
-
* information.
|
|
1638
|
-
*/
|
|
1639
|
-
status:
|
|
1640
|
-
| 'failed'
|
|
1641
|
-
| 'canceled'
|
|
1642
|
-
| 'processing'
|
|
1643
|
-
| 'in_handshake'
|
|
1644
|
-
| 'waiting_for_payment'
|
|
1645
|
-
| 'paid'
|
|
1646
|
-
| 'in_refund'
|
|
1647
|
-
| 'refunded'
|
|
1648
|
-
| 'refund_failed'
|
|
1649
|
-
| 'partially_refunded'
|
|
1650
|
-
| 'in_dispute'
|
|
1651
|
-
| 'disputed'
|
|
1652
|
-
| 'refused';
|
|
1653
|
-
|
|
1654
|
-
updatedAt: string;
|
|
1655
|
-
|
|
1656
|
-
/**
|
|
1657
|
-
* The bank statement reference of the payment for the order. This is the reference
|
|
1658
|
-
* that will be visible on the bank statement.
|
|
1659
|
-
*/
|
|
1660
|
-
bankStatementReference?: string;
|
|
1661
|
-
|
|
1662
|
-
/**
|
|
1663
|
-
* The billing address of the user. Required when handshake=true.
|
|
1664
|
-
*/
|
|
1665
|
-
billingAddress?: OrderUpdateResponse.BillingAddress;
|
|
1666
|
-
|
|
1667
|
-
/**
|
|
1668
|
-
* The merchant category code or
|
|
1669
|
-
* [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
|
|
1670
|
-
*/
|
|
1671
|
-
category?: string;
|
|
1672
|
-
|
|
1673
|
-
/**
|
|
1674
|
-
* @deprecated
|
|
1675
|
-
*/
|
|
1676
|
-
climateActionMode?: OrderUpdateResponse.ClimateActionMode;
|
|
1677
|
-
|
|
1678
|
-
/**
|
|
1679
|
-
* @deprecated
|
|
1680
|
-
*/
|
|
1681
|
-
co2Grams?: number;
|
|
1682
|
-
|
|
1683
|
-
/**
|
|
1684
|
-
* The unique identifier of the customer who placed the order.
|
|
1685
|
-
*/
|
|
1686
|
-
customerId?: string;
|
|
1687
|
-
|
|
1688
|
-
/**
|
|
1689
|
-
* The customer facing id. This id is displayed to the user during the checkout and
|
|
1690
|
-
* in the merchant dashboard.
|
|
1691
|
-
*/
|
|
1692
|
-
displayId?: string;
|
|
1693
|
-
|
|
1694
|
-
/**
|
|
1695
|
-
* False by default. If set to true, customers skip email input and jump directly
|
|
1696
|
-
* to their bank login. For express Checkout Sessions this is always false.
|
|
1697
|
-
*/
|
|
1698
|
-
guest?: boolean;
|
|
1699
|
-
|
|
1700
|
-
/**
|
|
1701
|
-
* Only valid for sustainable incentive mode. The social / sustainable projects
|
|
1702
|
-
* available to the user during Checkout.
|
|
1703
|
-
*/
|
|
1704
|
-
impactOffsetProjects?: Array<string>;
|
|
1705
|
-
|
|
1706
|
-
/**
|
|
1707
|
-
* The incentive mode of the checkout session. For any use-case apart from
|
|
1708
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
1709
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
1710
|
-
* session will contain sustainable incentives for users.
|
|
1711
|
-
*/
|
|
1712
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
1713
|
-
|
|
1714
|
-
/**
|
|
1715
|
-
* The line items of the Checkout.
|
|
1716
|
-
*/
|
|
1717
|
-
lineItems?: Array<OrderUpdateResponse.LineItem>;
|
|
1718
|
-
|
|
1719
|
-
mandate?: OrderUpdateResponse.Mandate;
|
|
1720
|
-
|
|
1721
|
-
/**
|
|
1722
|
-
* The destination bank account where the money will be sent to.
|
|
1723
|
-
*/
|
|
1724
|
-
merchantFinancialAddress?: OrderUpdateResponse.MerchantFinancialAddress;
|
|
1725
|
-
|
|
1726
|
-
/**
|
|
1727
|
-
* Any data which will be stored and returned for this checkout session and
|
|
1728
|
-
* corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
|
|
1729
|
-
* more info.
|
|
1730
|
-
*/
|
|
1731
|
-
metadata?: Record<string, unknown>;
|
|
1732
|
-
|
|
1733
|
-
/**
|
|
1734
|
-
* Only valid for sustainable incentive mode. The social / sustainability project
|
|
1735
|
-
* chosen by the user during Checkout.
|
|
1736
|
-
*/
|
|
1737
|
-
offsetProject?: string;
|
|
1738
|
-
|
|
1739
|
-
/**
|
|
1740
|
-
* The source bank account where the money is send from.
|
|
1741
|
-
*/
|
|
1742
|
-
payerFinancialAddress?: OrderUpdateResponse.PayerFinancialAddress;
|
|
1743
|
-
|
|
1744
|
-
paymentMethodType?: 'sepa_debit' | 'customer_balance';
|
|
1745
|
-
|
|
1746
|
-
/**
|
|
1747
|
-
* The payment mode of the order. Can be either 'settlement' or 'direct'.
|
|
1748
|
-
*/
|
|
1749
|
-
paymentMode?: 'settlement' | 'direct';
|
|
1750
|
-
|
|
1751
|
-
/**
|
|
1752
|
-
* @deprecated Deprecated in favor of `status`. Do not use this field to trigger
|
|
1753
|
-
* actions in your system.
|
|
1754
|
-
*/
|
|
1755
|
-
paymentStatus?:
|
|
1756
|
-
| 'failed'
|
|
1757
|
-
| 'canceled'
|
|
1758
|
-
| 'processing'
|
|
1759
|
-
| 'requires_action'
|
|
1760
|
-
| 'succeeded'
|
|
1761
|
-
| 'in_refund'
|
|
1762
|
-
| 'refunded'
|
|
1763
|
-
| 'refund_failed'
|
|
1764
|
-
| 'partially_refunded'
|
|
1765
|
-
| 'not_settled'
|
|
1766
|
-
| 'disputed';
|
|
1767
|
-
|
|
1768
|
-
/**
|
|
1769
|
-
* The total amount in the currency of all successful refunds for this order
|
|
1770
|
-
*/
|
|
1771
|
-
refundAmount?: number;
|
|
1772
|
-
|
|
1773
|
-
/**
|
|
1774
|
-
* The list of refunds connected to this order.
|
|
1775
|
-
*/
|
|
1776
|
-
refunds?: Array<OrderUpdateResponse.Refund>;
|
|
1777
|
-
|
|
1778
|
-
/**
|
|
1779
|
-
* The shipping address of the user. This is only collected in express Checkouts.
|
|
1780
|
-
*/
|
|
1781
|
-
shippingAddress?: OrderUpdateResponse.ShippingAddress;
|
|
1782
|
-
|
|
1783
|
-
/**
|
|
1784
|
-
* The selected shipping method by the user. Can either be selected during an
|
|
1785
|
-
* express Checkout Session or passed during Checkout Session creation.
|
|
1786
|
-
*/
|
|
1787
|
-
shippingMethod?: OrderUpdateResponse.ShippingMethod;
|
|
1788
|
-
|
|
1789
|
-
/**
|
|
1790
|
-
* The logo of the shop provided as a URL.
|
|
1791
|
-
*/
|
|
1792
|
-
shopLogo?: string;
|
|
1793
|
-
|
|
1794
|
-
/**
|
|
1795
|
-
* The shopper object. Contains information collected from the user during the
|
|
1796
|
-
* Checkout.
|
|
1797
|
-
*/
|
|
1798
|
-
shopper?: OrderUpdateResponse.Shopper;
|
|
1799
|
-
|
|
1800
|
-
/**
|
|
1801
|
-
* @deprecated Deprecated in favor of `shopper.email`. The email of the user if
|
|
1802
|
-
* collected in the Checkout.
|
|
1803
|
-
*/
|
|
1804
|
-
shopperEmail?: string;
|
|
1805
|
-
|
|
1806
|
-
statusClassification?: OrderUpdateResponse.StatusClassification;
|
|
1807
|
-
|
|
1808
|
-
/**
|
|
1809
|
-
* List of status history items for the order, used for logging every update on
|
|
1810
|
-
* status.
|
|
1811
|
-
*/
|
|
1812
|
-
statusHistoryList?: Array<OrderUpdateResponse.StatusHistoryList>;
|
|
1813
|
-
|
|
1814
|
-
/**
|
|
1815
|
-
* The subaccount id of the order.
|
|
1816
|
-
*/
|
|
1817
|
-
subaccountId?: string;
|
|
1818
|
-
|
|
1819
|
-
/**
|
|
1820
|
-
* The legal name of the subaccount
|
|
1821
|
-
*/
|
|
1822
|
-
subaccountLegalName?: string;
|
|
1823
|
-
|
|
1824
|
-
/**
|
|
1825
|
-
* @deprecated
|
|
1826
|
-
*/
|
|
1827
|
-
trees?: number;
|
|
1828
|
-
}
|
|
1829
|
-
|
|
1830
|
-
export namespace OrderUpdateResponse {
|
|
1831
|
-
/**
|
|
1832
|
-
* The price to be paid by the user. All amounts are in decimals, i.e. 10.23
|
|
1833
|
-
* represents EUR 10.23. Any amount of decimal places can be provided on
|
|
1834
|
-
* initialization, but the actual transfer amount is rounded to 2 decimal places,
|
|
1835
|
-
* as this is the format accepted by most banks.
|
|
1836
|
-
*/
|
|
1837
|
-
export interface Price {
|
|
1838
|
-
currency: 'EUR' | 'GBP' | 'PLN';
|
|
1839
|
-
|
|
1840
|
-
/**
|
|
1841
|
-
* The total amount to be paid.
|
|
1842
|
-
*/
|
|
1843
|
-
total: number;
|
|
1844
|
-
|
|
1845
|
-
/**
|
|
1846
|
-
* The shipping amount.
|
|
1847
|
-
*/
|
|
1848
|
-
shipping?: number;
|
|
1849
|
-
|
|
1850
|
-
/**
|
|
1851
|
-
* The subtotal amount, i.e. the total amount without VAT and shipping.
|
|
1852
|
-
*/
|
|
1853
|
-
subTotal?: number;
|
|
1854
|
-
|
|
1855
|
-
/**
|
|
1856
|
-
* The total net amount, i.e. the total amount without VAT. This value is rounded
|
|
1857
|
-
* to 2 decimal places for the actual transfer.
|
|
1858
|
-
*/
|
|
1859
|
-
totalNet?: number;
|
|
1860
|
-
|
|
1861
|
-
/**
|
|
1862
|
-
* The VAT amount.
|
|
1863
|
-
*/
|
|
1864
|
-
vat?: number;
|
|
1865
|
-
}
|
|
1866
|
-
|
|
1867
|
-
/**
|
|
1868
|
-
* The billing address of the user. Required when handshake=true.
|
|
1869
|
-
*/
|
|
1870
|
-
export interface BillingAddress {
|
|
1871
|
-
city: string;
|
|
1872
|
-
|
|
1873
|
-
/**
|
|
1874
|
-
* The country code in
|
|
1875
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1876
|
-
*/
|
|
1877
|
-
country:
|
|
1878
|
-
| 'AF'
|
|
1879
|
-
| 'AL'
|
|
1880
|
-
| 'DZ'
|
|
1881
|
-
| 'AS'
|
|
1882
|
-
| 'AD'
|
|
1883
|
-
| 'AO'
|
|
1884
|
-
| 'AI'
|
|
1885
|
-
| 'AQ'
|
|
1886
|
-
| 'AG'
|
|
1887
|
-
| 'AR'
|
|
1888
|
-
| 'AM'
|
|
1889
|
-
| 'AW'
|
|
1890
|
-
| 'AU'
|
|
1891
|
-
| 'AT'
|
|
1892
|
-
| 'AZ'
|
|
1893
|
-
| 'BS'
|
|
1894
|
-
| 'BH'
|
|
1895
|
-
| 'BD'
|
|
1896
|
-
| 'BB'
|
|
1897
|
-
| 'BY'
|
|
1898
|
-
| 'BE'
|
|
1899
|
-
| 'BZ'
|
|
1900
|
-
| 'BJ'
|
|
1901
|
-
| 'BM'
|
|
1902
|
-
| 'BT'
|
|
1903
|
-
| 'BO'
|
|
1904
|
-
| 'BA'
|
|
1905
|
-
| 'BW'
|
|
1906
|
-
| 'BV'
|
|
1907
|
-
| 'BR'
|
|
1908
|
-
| 'IO'
|
|
1909
|
-
| 'BN'
|
|
1910
|
-
| 'BG'
|
|
1911
|
-
| 'BF'
|
|
1912
|
-
| 'BI'
|
|
1913
|
-
| 'KH'
|
|
1914
|
-
| 'CM'
|
|
1915
|
-
| 'CA'
|
|
1916
|
-
| 'CV'
|
|
1917
|
-
| 'KY'
|
|
1918
|
-
| 'CF'
|
|
1919
|
-
| 'TD'
|
|
1920
|
-
| 'CL'
|
|
1921
|
-
| 'CN'
|
|
1922
|
-
| 'CX'
|
|
1923
|
-
| 'CC'
|
|
1924
|
-
| 'CO'
|
|
1925
|
-
| 'KM'
|
|
1926
|
-
| 'CG'
|
|
1927
|
-
| 'CD'
|
|
1928
|
-
| 'CK'
|
|
1929
|
-
| 'CR'
|
|
1930
|
-
| 'CI'
|
|
1931
|
-
| 'HR'
|
|
1932
|
-
| 'CU'
|
|
1933
|
-
| 'CY'
|
|
1934
|
-
| 'CZ'
|
|
1935
|
-
| 'DK'
|
|
1936
|
-
| 'DJ'
|
|
1937
|
-
| 'DM'
|
|
1938
|
-
| 'DO'
|
|
1939
|
-
| 'EC'
|
|
1940
|
-
| 'EG'
|
|
1941
|
-
| 'SV'
|
|
1942
|
-
| 'GQ'
|
|
1943
|
-
| 'ER'
|
|
1944
|
-
| 'EE'
|
|
1945
|
-
| 'ET'
|
|
1946
|
-
| 'FK'
|
|
1947
|
-
| 'FO'
|
|
1948
|
-
| 'FJ'
|
|
1949
|
-
| 'FI'
|
|
1950
|
-
| 'FR'
|
|
1951
|
-
| 'GF'
|
|
1952
|
-
| 'PF'
|
|
1953
|
-
| 'TF'
|
|
1954
|
-
| 'GA'
|
|
1955
|
-
| 'GM'
|
|
1956
|
-
| 'GE'
|
|
1957
|
-
| 'DE'
|
|
1958
|
-
| 'GH'
|
|
1959
|
-
| 'GI'
|
|
1960
|
-
| 'GR'
|
|
1961
|
-
| 'GL'
|
|
1962
|
-
| 'GD'
|
|
1963
|
-
| 'GP'
|
|
1964
|
-
| 'GU'
|
|
1965
|
-
| 'GT'
|
|
1966
|
-
| 'GN'
|
|
1967
|
-
| 'GW'
|
|
1968
|
-
| 'GY'
|
|
1969
|
-
| 'HT'
|
|
1970
|
-
| 'HM'
|
|
1971
|
-
| 'VA'
|
|
1972
|
-
| 'HN'
|
|
1973
|
-
| 'HK'
|
|
1974
|
-
| 'HU'
|
|
1975
|
-
| 'IS'
|
|
1976
|
-
| 'IN'
|
|
1977
|
-
| 'ID'
|
|
1978
|
-
| 'IR'
|
|
1979
|
-
| 'IQ'
|
|
1980
|
-
| 'IE'
|
|
1981
|
-
| 'IL'
|
|
1982
|
-
| 'IT'
|
|
1983
|
-
| 'JM'
|
|
1984
|
-
| 'JP'
|
|
1985
|
-
| 'JO'
|
|
1986
|
-
| 'KZ'
|
|
1987
|
-
| 'KE'
|
|
1988
|
-
| 'KI'
|
|
1989
|
-
| 'KP'
|
|
1990
|
-
| 'KR'
|
|
1991
|
-
| 'KW'
|
|
1992
|
-
| 'KG'
|
|
1993
|
-
| 'LA'
|
|
1994
|
-
| 'LV'
|
|
1995
|
-
| 'LB'
|
|
1996
|
-
| 'LS'
|
|
1997
|
-
| 'LR'
|
|
1998
|
-
| 'LY'
|
|
1999
|
-
| 'LI'
|
|
2000
|
-
| 'LT'
|
|
2001
|
-
| 'LU'
|
|
2002
|
-
| 'MO'
|
|
2003
|
-
| 'MG'
|
|
2004
|
-
| 'MW'
|
|
2005
|
-
| 'MY'
|
|
2006
|
-
| 'MV'
|
|
2007
|
-
| 'ML'
|
|
2008
|
-
| 'MT'
|
|
2009
|
-
| 'MH'
|
|
2010
|
-
| 'MQ'
|
|
2011
|
-
| 'MR'
|
|
2012
|
-
| 'MU'
|
|
2013
|
-
| 'YT'
|
|
2014
|
-
| 'MX'
|
|
2015
|
-
| 'FM'
|
|
2016
|
-
| 'MD'
|
|
2017
|
-
| 'MC'
|
|
2018
|
-
| 'MN'
|
|
2019
|
-
| 'MS'
|
|
2020
|
-
| 'MA'
|
|
2021
|
-
| 'MZ'
|
|
2022
|
-
| 'MM'
|
|
2023
|
-
| 'NA'
|
|
2024
|
-
| 'NR'
|
|
2025
|
-
| 'NP'
|
|
2026
|
-
| 'NL'
|
|
2027
|
-
| 'NC'
|
|
2028
|
-
| 'NZ'
|
|
2029
|
-
| 'NI'
|
|
2030
|
-
| 'NE'
|
|
2031
|
-
| 'NG'
|
|
2032
|
-
| 'NU'
|
|
2033
|
-
| 'NF'
|
|
2034
|
-
| 'MP'
|
|
2035
|
-
| 'MK'
|
|
2036
|
-
| 'NO'
|
|
2037
|
-
| 'OM'
|
|
2038
|
-
| 'PK'
|
|
2039
|
-
| 'PW'
|
|
2040
|
-
| 'PS'
|
|
2041
|
-
| 'PA'
|
|
2042
|
-
| 'PG'
|
|
2043
|
-
| 'PY'
|
|
2044
|
-
| 'PE'
|
|
2045
|
-
| 'PH'
|
|
2046
|
-
| 'PN'
|
|
2047
|
-
| 'PL'
|
|
2048
|
-
| 'PT'
|
|
2049
|
-
| 'PR'
|
|
2050
|
-
| 'QA'
|
|
2051
|
-
| 'RE'
|
|
2052
|
-
| 'RO'
|
|
2053
|
-
| 'RU'
|
|
2054
|
-
| 'RW'
|
|
2055
|
-
| 'SH'
|
|
2056
|
-
| 'KN'
|
|
2057
|
-
| 'LC'
|
|
2058
|
-
| 'PM'
|
|
2059
|
-
| 'VC'
|
|
2060
|
-
| 'WS'
|
|
2061
|
-
| 'SM'
|
|
2062
|
-
| 'ST'
|
|
2063
|
-
| 'SA'
|
|
2064
|
-
| 'SN'
|
|
2065
|
-
| 'SC'
|
|
2066
|
-
| 'SL'
|
|
2067
|
-
| 'SG'
|
|
2068
|
-
| 'SK'
|
|
2069
|
-
| 'SI'
|
|
2070
|
-
| 'SB'
|
|
2071
|
-
| 'SO'
|
|
2072
|
-
| 'ZA'
|
|
2073
|
-
| 'GS'
|
|
2074
|
-
| 'ES'
|
|
2075
|
-
| 'LK'
|
|
2076
|
-
| 'SD'
|
|
2077
|
-
| 'SR'
|
|
2078
|
-
| 'SJ'
|
|
2079
|
-
| 'SZ'
|
|
2080
|
-
| 'SE'
|
|
2081
|
-
| 'CH'
|
|
2082
|
-
| 'SY'
|
|
2083
|
-
| 'TW'
|
|
2084
|
-
| 'TJ'
|
|
2085
|
-
| 'TZ'
|
|
2086
|
-
| 'TH'
|
|
2087
|
-
| 'TL'
|
|
2088
|
-
| 'TG'
|
|
2089
|
-
| 'TK'
|
|
2090
|
-
| 'TO'
|
|
2091
|
-
| 'TT'
|
|
2092
|
-
| 'TN'
|
|
2093
|
-
| 'TR'
|
|
2094
|
-
| 'TM'
|
|
2095
|
-
| 'TC'
|
|
2096
|
-
| 'TV'
|
|
2097
|
-
| 'UG'
|
|
2098
|
-
| 'UA'
|
|
2099
|
-
| 'AE'
|
|
2100
|
-
| 'GB'
|
|
2101
|
-
| 'US'
|
|
2102
|
-
| 'UM'
|
|
2103
|
-
| 'UY'
|
|
2104
|
-
| 'UZ'
|
|
2105
|
-
| 'VU'
|
|
2106
|
-
| 'VE'
|
|
2107
|
-
| 'VN'
|
|
2108
|
-
| 'VG'
|
|
2109
|
-
| 'VI'
|
|
2110
|
-
| 'WF'
|
|
2111
|
-
| 'EH'
|
|
2112
|
-
| 'YE'
|
|
2113
|
-
| 'ZM'
|
|
2114
|
-
| 'ZW'
|
|
2115
|
-
| 'AX'
|
|
2116
|
-
| 'BQ'
|
|
2117
|
-
| 'CW'
|
|
2118
|
-
| 'GG'
|
|
2119
|
-
| 'IM'
|
|
2120
|
-
| 'JE'
|
|
2121
|
-
| 'ME'
|
|
2122
|
-
| 'BL'
|
|
2123
|
-
| 'MF'
|
|
2124
|
-
| 'RS'
|
|
2125
|
-
| 'SX'
|
|
2126
|
-
| 'SS'
|
|
2127
|
-
| 'XK';
|
|
2128
|
-
|
|
2129
|
-
line1: string;
|
|
2130
|
-
|
|
2131
|
-
zipCode: string;
|
|
2132
|
-
|
|
2133
|
-
firstName?: string;
|
|
2134
|
-
|
|
2135
|
-
lastName?: string;
|
|
2136
|
-
|
|
2137
|
-
line2?: string;
|
|
2138
|
-
|
|
2139
|
-
region?: string;
|
|
2140
|
-
}
|
|
2141
|
-
|
|
2142
|
-
/**
|
|
2143
|
-
* @deprecated
|
|
2144
|
-
*/
|
|
2145
|
-
export interface ClimateActionMode {
|
|
2146
|
-
amount: number;
|
|
2147
|
-
|
|
2148
|
-
type: 'transaction' | 'amount';
|
|
2149
|
-
}
|
|
2150
|
-
|
|
2151
|
-
export interface LineItem {
|
|
2152
|
-
/**
|
|
2153
|
-
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
2154
|
-
* decimals, i.e. 10.23 represents EUR 10.23.
|
|
2155
|
-
*/
|
|
2156
|
-
amount: number;
|
|
2157
|
-
|
|
2158
|
-
/**
|
|
2159
|
-
* The name of the line item.
|
|
2160
|
-
*/
|
|
2161
|
-
name: string;
|
|
2162
|
-
|
|
2163
|
-
/**
|
|
2164
|
-
* The quantity of the line item.
|
|
2165
|
-
*/
|
|
2166
|
-
quantity: number;
|
|
2167
|
-
|
|
2168
|
-
/**
|
|
2169
|
-
* The net amount of a single item.
|
|
2170
|
-
*/
|
|
2171
|
-
singleNet: number;
|
|
2172
|
-
|
|
2173
|
-
/**
|
|
2174
|
-
* The VAT amount of a single item.
|
|
2175
|
-
*/
|
|
2176
|
-
singleVat: number;
|
|
2177
|
-
|
|
2178
|
-
/**
|
|
2179
|
-
* The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
|
|
2180
|
-
* the line item.
|
|
2181
|
-
*/
|
|
2182
|
-
category?: string;
|
|
2183
|
-
|
|
2184
|
-
/**
|
|
2185
|
-
* The
|
|
2186
|
-
* [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
|
|
2187
|
-
* of the line item.
|
|
2188
|
-
*/
|
|
2189
|
-
EAN?: string;
|
|
2190
|
-
|
|
2191
|
-
/**
|
|
2192
|
-
* The image of the line item as a URL.
|
|
2193
|
-
*/
|
|
2194
|
-
image?: string;
|
|
2195
|
-
|
|
2196
|
-
/**
|
|
2197
|
-
* The internal unique identifier of the line item.
|
|
2198
|
-
*/
|
|
2199
|
-
referenceId?: string;
|
|
2200
|
-
}
|
|
2201
|
-
|
|
2202
|
-
export interface Mandate {
|
|
2203
|
-
/**
|
|
2204
|
-
* The name of the account holder who signs the mandate.
|
|
2205
|
-
*/
|
|
2206
|
-
accountHolderName?: string;
|
|
2207
|
-
|
|
2208
|
-
/**
|
|
2209
|
-
* Additional information to display to the user during the mandate setup. This
|
|
2210
|
-
* information is not used to setup any recurrence on the mandate. It is only
|
|
2211
|
-
* displayed to the user during checkout.
|
|
2212
|
-
*/
|
|
2213
|
-
additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
|
|
2214
|
-
|
|
2215
|
-
/**
|
|
2216
|
-
* Mandate creditor data
|
|
2217
|
-
*/
|
|
2218
|
-
creditor?: Mandate.Creditor;
|
|
2219
|
-
|
|
2220
|
-
/**
|
|
2221
|
-
* The reference of the mandate going to be setup
|
|
2222
|
-
*/
|
|
2223
|
-
reference?: string;
|
|
2224
|
-
|
|
2225
|
-
/**
|
|
2226
|
-
* The mandate referenceId. Set this to match incoming `mandate_setup_started`,
|
|
2227
|
-
* `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
|
|
2228
|
-
* mandate setup request.
|
|
2229
|
-
*/
|
|
2230
|
-
referenceId?: string;
|
|
2231
|
-
|
|
2232
|
-
/**
|
|
2233
|
-
* If true, a ready to use mandate will be set up after the payment flow.
|
|
2234
|
-
*/
|
|
2235
|
-
setup?: boolean;
|
|
2236
|
-
|
|
2237
|
-
/**
|
|
2238
|
-
* The email of the user who signs the mandate.
|
|
2239
|
-
*/
|
|
2240
|
-
userNotificationEmail?: string;
|
|
2241
|
-
}
|
|
2242
|
-
|
|
2243
|
-
export namespace Mandate {
|
|
2244
|
-
/**
|
|
2245
|
-
* Additional information to display to the user during the mandate setup. This
|
|
2246
|
-
* information is not used to setup any recurrence on the mandate. It is only
|
|
2247
|
-
* displayed to the user during checkout.
|
|
2248
|
-
*/
|
|
2249
|
-
export interface AdditionalDisplayInformation {
|
|
2250
|
-
/**
|
|
2251
|
-
* The intended cadence of charges used for displaying purpose only. On demand
|
|
2252
|
-
* would be used for unscheduled charges.
|
|
2253
|
-
*/
|
|
2254
|
-
cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
|
|
2255
|
-
|
|
2256
|
-
price?: AdditionalDisplayInformation.Price;
|
|
2257
|
-
}
|
|
2258
|
-
|
|
2259
|
-
export namespace AdditionalDisplayInformation {
|
|
2260
|
-
export interface Price {
|
|
2261
|
-
/**
|
|
2262
|
-
* The amount displayed to the user as decimal e.g. 10.23 would be displayed as
|
|
2263
|
-
* 10.23 EUR.
|
|
2264
|
-
*/
|
|
2265
|
-
amount?: number;
|
|
2266
|
-
|
|
2267
|
-
currency?: 'EUR' | 'GBP' | 'PLN';
|
|
2268
|
-
}
|
|
2269
|
-
}
|
|
2270
|
-
|
|
2271
|
-
/**
|
|
2272
|
-
* Mandate creditor data
|
|
2273
|
-
*/
|
|
2274
|
-
export interface Creditor {
|
|
2275
|
-
id?: string;
|
|
2276
|
-
|
|
2277
|
-
name?: string;
|
|
2278
|
-
}
|
|
2279
|
-
}
|
|
2280
|
-
|
|
2281
|
-
/**
|
|
2282
|
-
* The destination bank account where the money will be sent to.
|
|
2283
|
-
*/
|
|
2284
|
-
export interface MerchantFinancialAddress {
|
|
2285
|
-
bankCode?: MerchantFinancialAddress.BankCode;
|
|
2286
|
-
|
|
2287
|
-
bban?: MerchantFinancialAddress.Bban;
|
|
2288
|
-
|
|
2289
|
-
iban?: MerchantFinancialAddress.Iban;
|
|
2290
|
-
|
|
2291
|
-
/**
|
|
2292
|
-
* The payment reference for the order. This is the reference that will be visible
|
|
2293
|
-
* on the bank statement.
|
|
2294
|
-
*/
|
|
2295
|
-
paymentReference?: string;
|
|
2296
|
-
|
|
2297
|
-
sortCode?: MerchantFinancialAddress.SortCode;
|
|
2298
|
-
|
|
2299
|
-
/**
|
|
2300
|
-
* The type of the financial address. The actual destination is determined by this
|
|
2301
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
2302
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
2303
|
-
* in the "iban" object.
|
|
2304
|
-
*
|
|
2305
|
-
* - iban: The IBAN of the account
|
|
2306
|
-
* - sort_code: The sort code of the account
|
|
2307
|
-
* - bank_code: The bank code of the account
|
|
2308
|
-
* - bban: The BBAN of the account
|
|
2309
|
-
*/
|
|
2310
|
-
type?: string;
|
|
2311
|
-
}
|
|
2312
|
-
|
|
2313
|
-
export namespace MerchantFinancialAddress {
|
|
2314
|
-
export interface BankCode {
|
|
2315
|
-
/**
|
|
2316
|
-
* The name of the account holder.
|
|
2317
|
-
*/
|
|
2318
|
-
accountHolderName: string;
|
|
2319
|
-
|
|
2320
|
-
accountNumber: string;
|
|
2321
|
-
|
|
2322
|
-
code: string;
|
|
2323
|
-
}
|
|
2324
|
-
|
|
2325
|
-
export interface Bban {
|
|
2326
|
-
/**
|
|
2327
|
-
* The name of the account holder.
|
|
2328
|
-
*/
|
|
2329
|
-
accountHolderName: string;
|
|
2330
|
-
|
|
2331
|
-
bban: string;
|
|
2332
|
-
|
|
2333
|
-
bic?: string;
|
|
2334
|
-
}
|
|
2335
|
-
|
|
2336
|
-
export interface Iban {
|
|
2337
|
-
/**
|
|
2338
|
-
* The name of the account holder.
|
|
2339
|
-
*/
|
|
2340
|
-
accountHolderName: string;
|
|
2341
|
-
|
|
2342
|
-
iban: string;
|
|
2343
|
-
|
|
2344
|
-
bic?: string;
|
|
2345
|
-
}
|
|
2346
|
-
|
|
2347
|
-
export interface SortCode {
|
|
2348
|
-
/**
|
|
2349
|
-
* The name of the account holder.
|
|
2350
|
-
*/
|
|
2351
|
-
accountHolderName: string;
|
|
2352
|
-
|
|
2353
|
-
accountNumber: string;
|
|
2354
|
-
|
|
2355
|
-
sortCode: string;
|
|
2356
|
-
}
|
|
2357
|
-
}
|
|
2358
|
-
|
|
2359
|
-
/**
|
|
2360
|
-
* The source bank account where the money is send from.
|
|
2361
|
-
*/
|
|
2362
|
-
export interface PayerFinancialAddress {
|
|
2363
|
-
/**
|
|
2364
|
-
* The type of the financial address. The actual destination is determined by this
|
|
2365
|
-
* field which can be either "iban", "sortCode", "bankCode", or "bban". The
|
|
2366
|
-
* validation will fail if you set e.g. type="iban", but then not fill any values
|
|
2367
|
-
* in the "iban" object.
|
|
2368
|
-
*
|
|
2369
|
-
* - iban: The IBAN of the account
|
|
2370
|
-
* - sort_code: The sort code of the account
|
|
2371
|
-
* - bank_code: The bank code of the account
|
|
2372
|
-
* - bban: The BBAN of the account
|
|
2373
|
-
*/
|
|
2374
|
-
type: string;
|
|
2375
|
-
|
|
2376
|
-
bankCode?: PayerFinancialAddress.BankCode;
|
|
2377
|
-
|
|
2378
|
-
bban?: PayerFinancialAddress.Bban;
|
|
2379
|
-
|
|
2380
|
-
iban?: PayerFinancialAddress.Iban;
|
|
2381
|
-
|
|
2382
|
-
sortCode?: PayerFinancialAddress.SortCode;
|
|
2383
|
-
}
|
|
2384
|
-
|
|
2385
|
-
export namespace PayerFinancialAddress {
|
|
2386
|
-
export interface BankCode {
|
|
2387
|
-
accountNumber: string;
|
|
2388
|
-
|
|
2389
|
-
code: string;
|
|
2390
|
-
|
|
2391
|
-
/**
|
|
2392
|
-
* The name of the account holder.
|
|
2393
|
-
*/
|
|
2394
|
-
accountHolderName?: string;
|
|
2395
|
-
}
|
|
2396
|
-
|
|
2397
|
-
export interface Bban {
|
|
2398
|
-
bban: string;
|
|
2399
|
-
|
|
2400
|
-
/**
|
|
2401
|
-
* The name of the account holder.
|
|
2402
|
-
*/
|
|
2403
|
-
accountHolderName?: string;
|
|
2404
|
-
|
|
2405
|
-
bic?: string;
|
|
2406
|
-
}
|
|
2407
|
-
|
|
2408
|
-
export interface Iban {
|
|
2409
|
-
iban: string;
|
|
2410
|
-
|
|
2411
|
-
/**
|
|
2412
|
-
* The name of the account holder.
|
|
2413
|
-
*/
|
|
2414
|
-
accountHolderName?: string;
|
|
2415
|
-
|
|
2416
|
-
bic?: string;
|
|
2417
|
-
}
|
|
2418
|
-
|
|
2419
|
-
export interface SortCode {
|
|
2420
|
-
accountNumber: string;
|
|
2421
|
-
|
|
2422
|
-
sortCode: string;
|
|
2423
|
-
|
|
2424
|
-
/**
|
|
2425
|
-
* The name of the account holder.
|
|
2426
|
-
*/
|
|
2427
|
-
accountHolderName?: string;
|
|
2428
|
-
}
|
|
2429
|
-
}
|
|
2430
|
-
|
|
2431
|
-
/**
|
|
2432
|
-
* A Refund object. This corresponds to one Refund request.
|
|
2433
|
-
*/
|
|
2434
|
-
export interface Refund {
|
|
2435
|
-
id: string;
|
|
2436
|
-
|
|
2437
|
-
amount: number;
|
|
2438
|
-
|
|
2439
|
-
createdAt: string;
|
|
2440
|
-
|
|
2441
|
-
referenceId: string;
|
|
2442
|
-
|
|
2443
|
-
/**
|
|
2444
|
-
* The status of the refund. Always use the status of the order as your source of
|
|
2445
|
-
* truth to trigger actions in your dashboard.
|
|
2446
|
-
*/
|
|
2447
|
-
status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
|
|
2448
|
-
|
|
2449
|
-
updatedAt: string;
|
|
2450
|
-
|
|
2451
|
-
description?: string;
|
|
2452
|
-
}
|
|
2453
|
-
|
|
2454
|
-
/**
|
|
2455
|
-
* The shipping address of the user. This is only collected in express Checkouts.
|
|
2456
|
-
*/
|
|
2457
|
-
export interface ShippingAddress {
|
|
2458
|
-
city: string;
|
|
2459
|
-
|
|
2460
|
-
/**
|
|
2461
|
-
* The country code in
|
|
2462
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
2463
|
-
*/
|
|
2464
|
-
country:
|
|
2465
|
-
| 'AF'
|
|
2466
|
-
| 'AL'
|
|
2467
|
-
| 'DZ'
|
|
2468
|
-
| 'AS'
|
|
2469
|
-
| 'AD'
|
|
2470
|
-
| 'AO'
|
|
2471
|
-
| 'AI'
|
|
2472
|
-
| 'AQ'
|
|
2473
|
-
| 'AG'
|
|
2474
|
-
| 'AR'
|
|
2475
|
-
| 'AM'
|
|
2476
|
-
| 'AW'
|
|
2477
|
-
| 'AU'
|
|
2478
|
-
| 'AT'
|
|
2479
|
-
| 'AZ'
|
|
2480
|
-
| 'BS'
|
|
2481
|
-
| 'BH'
|
|
2482
|
-
| 'BD'
|
|
2483
|
-
| 'BB'
|
|
2484
|
-
| 'BY'
|
|
2485
|
-
| 'BE'
|
|
2486
|
-
| 'BZ'
|
|
2487
|
-
| 'BJ'
|
|
2488
|
-
| 'BM'
|
|
2489
|
-
| 'BT'
|
|
2490
|
-
| 'BO'
|
|
2491
|
-
| 'BA'
|
|
2492
|
-
| 'BW'
|
|
2493
|
-
| 'BV'
|
|
2494
|
-
| 'BR'
|
|
2495
|
-
| 'IO'
|
|
2496
|
-
| 'BN'
|
|
2497
|
-
| 'BG'
|
|
2498
|
-
| 'BF'
|
|
2499
|
-
| 'BI'
|
|
2500
|
-
| 'KH'
|
|
2501
|
-
| 'CM'
|
|
2502
|
-
| 'CA'
|
|
2503
|
-
| 'CV'
|
|
2504
|
-
| 'KY'
|
|
2505
|
-
| 'CF'
|
|
2506
|
-
| 'TD'
|
|
2507
|
-
| 'CL'
|
|
2508
|
-
| 'CN'
|
|
2509
|
-
| 'CX'
|
|
2510
|
-
| 'CC'
|
|
2511
|
-
| 'CO'
|
|
2512
|
-
| 'KM'
|
|
2513
|
-
| 'CG'
|
|
2514
|
-
| 'CD'
|
|
2515
|
-
| 'CK'
|
|
2516
|
-
| 'CR'
|
|
2517
|
-
| 'CI'
|
|
2518
|
-
| 'HR'
|
|
2519
|
-
| 'CU'
|
|
2520
|
-
| 'CY'
|
|
2521
|
-
| 'CZ'
|
|
2522
|
-
| 'DK'
|
|
2523
|
-
| 'DJ'
|
|
2524
|
-
| 'DM'
|
|
2525
|
-
| 'DO'
|
|
2526
|
-
| 'EC'
|
|
2527
|
-
| 'EG'
|
|
2528
|
-
| 'SV'
|
|
2529
|
-
| 'GQ'
|
|
2530
|
-
| 'ER'
|
|
2531
|
-
| 'EE'
|
|
2532
|
-
| 'ET'
|
|
2533
|
-
| 'FK'
|
|
2534
|
-
| 'FO'
|
|
2535
|
-
| 'FJ'
|
|
2536
|
-
| 'FI'
|
|
2537
|
-
| 'FR'
|
|
2538
|
-
| 'GF'
|
|
2539
|
-
| 'PF'
|
|
2540
|
-
| 'TF'
|
|
2541
|
-
| 'GA'
|
|
2542
|
-
| 'GM'
|
|
2543
|
-
| 'GE'
|
|
2544
|
-
| 'DE'
|
|
2545
|
-
| 'GH'
|
|
2546
|
-
| 'GI'
|
|
2547
|
-
| 'GR'
|
|
2548
|
-
| 'GL'
|
|
2549
|
-
| 'GD'
|
|
2550
|
-
| 'GP'
|
|
2551
|
-
| 'GU'
|
|
2552
|
-
| 'GT'
|
|
2553
|
-
| 'GN'
|
|
2554
|
-
| 'GW'
|
|
2555
|
-
| 'GY'
|
|
2556
|
-
| 'HT'
|
|
2557
|
-
| 'HM'
|
|
2558
|
-
| 'VA'
|
|
2559
|
-
| 'HN'
|
|
2560
|
-
| 'HK'
|
|
2561
|
-
| 'HU'
|
|
2562
|
-
| 'IS'
|
|
2563
|
-
| 'IN'
|
|
2564
|
-
| 'ID'
|
|
2565
|
-
| 'IR'
|
|
2566
|
-
| 'IQ'
|
|
2567
|
-
| 'IE'
|
|
2568
|
-
| 'IL'
|
|
2569
|
-
| 'IT'
|
|
2570
|
-
| 'JM'
|
|
2571
|
-
| 'JP'
|
|
2572
|
-
| 'JO'
|
|
2573
|
-
| 'KZ'
|
|
2574
|
-
| 'KE'
|
|
2575
|
-
| 'KI'
|
|
2576
|
-
| 'KP'
|
|
2577
|
-
| 'KR'
|
|
2578
|
-
| 'KW'
|
|
2579
|
-
| 'KG'
|
|
2580
|
-
| 'LA'
|
|
2581
|
-
| 'LV'
|
|
2582
|
-
| 'LB'
|
|
2583
|
-
| 'LS'
|
|
2584
|
-
| 'LR'
|
|
2585
|
-
| 'LY'
|
|
2586
|
-
| 'LI'
|
|
2587
|
-
| 'LT'
|
|
2588
|
-
| 'LU'
|
|
2589
|
-
| 'MO'
|
|
2590
|
-
| 'MG'
|
|
2591
|
-
| 'MW'
|
|
2592
|
-
| 'MY'
|
|
2593
|
-
| 'MV'
|
|
2594
|
-
| 'ML'
|
|
2595
|
-
| 'MT'
|
|
2596
|
-
| 'MH'
|
|
2597
|
-
| 'MQ'
|
|
2598
|
-
| 'MR'
|
|
2599
|
-
| 'MU'
|
|
2600
|
-
| 'YT'
|
|
2601
|
-
| 'MX'
|
|
2602
|
-
| 'FM'
|
|
2603
|
-
| 'MD'
|
|
2604
|
-
| 'MC'
|
|
2605
|
-
| 'MN'
|
|
2606
|
-
| 'MS'
|
|
2607
|
-
| 'MA'
|
|
2608
|
-
| 'MZ'
|
|
2609
|
-
| 'MM'
|
|
2610
|
-
| 'NA'
|
|
2611
|
-
| 'NR'
|
|
2612
|
-
| 'NP'
|
|
2613
|
-
| 'NL'
|
|
2614
|
-
| 'NC'
|
|
2615
|
-
| 'NZ'
|
|
2616
|
-
| 'NI'
|
|
2617
|
-
| 'NE'
|
|
2618
|
-
| 'NG'
|
|
2619
|
-
| 'NU'
|
|
2620
|
-
| 'NF'
|
|
2621
|
-
| 'MP'
|
|
2622
|
-
| 'MK'
|
|
2623
|
-
| 'NO'
|
|
2624
|
-
| 'OM'
|
|
2625
|
-
| 'PK'
|
|
2626
|
-
| 'PW'
|
|
2627
|
-
| 'PS'
|
|
2628
|
-
| 'PA'
|
|
2629
|
-
| 'PG'
|
|
2630
|
-
| 'PY'
|
|
2631
|
-
| 'PE'
|
|
2632
|
-
| 'PH'
|
|
2633
|
-
| 'PN'
|
|
2634
|
-
| 'PL'
|
|
2635
|
-
| 'PT'
|
|
2636
|
-
| 'PR'
|
|
2637
|
-
| 'QA'
|
|
2638
|
-
| 'RE'
|
|
2639
|
-
| 'RO'
|
|
2640
|
-
| 'RU'
|
|
2641
|
-
| 'RW'
|
|
2642
|
-
| 'SH'
|
|
2643
|
-
| 'KN'
|
|
2644
|
-
| 'LC'
|
|
2645
|
-
| 'PM'
|
|
2646
|
-
| 'VC'
|
|
2647
|
-
| 'WS'
|
|
2648
|
-
| 'SM'
|
|
2649
|
-
| 'ST'
|
|
2650
|
-
| 'SA'
|
|
2651
|
-
| 'SN'
|
|
2652
|
-
| 'SC'
|
|
2653
|
-
| 'SL'
|
|
2654
|
-
| 'SG'
|
|
2655
|
-
| 'SK'
|
|
2656
|
-
| 'SI'
|
|
2657
|
-
| 'SB'
|
|
2658
|
-
| 'SO'
|
|
2659
|
-
| 'ZA'
|
|
2660
|
-
| 'GS'
|
|
2661
|
-
| 'ES'
|
|
2662
|
-
| 'LK'
|
|
2663
|
-
| 'SD'
|
|
2664
|
-
| 'SR'
|
|
2665
|
-
| 'SJ'
|
|
2666
|
-
| 'SZ'
|
|
2667
|
-
| 'SE'
|
|
2668
|
-
| 'CH'
|
|
2669
|
-
| 'SY'
|
|
2670
|
-
| 'TW'
|
|
2671
|
-
| 'TJ'
|
|
2672
|
-
| 'TZ'
|
|
2673
|
-
| 'TH'
|
|
2674
|
-
| 'TL'
|
|
2675
|
-
| 'TG'
|
|
2676
|
-
| 'TK'
|
|
2677
|
-
| 'TO'
|
|
2678
|
-
| 'TT'
|
|
2679
|
-
| 'TN'
|
|
2680
|
-
| 'TR'
|
|
2681
|
-
| 'TM'
|
|
2682
|
-
| 'TC'
|
|
2683
|
-
| 'TV'
|
|
2684
|
-
| 'UG'
|
|
2685
|
-
| 'UA'
|
|
2686
|
-
| 'AE'
|
|
2687
|
-
| 'GB'
|
|
2688
|
-
| 'US'
|
|
2689
|
-
| 'UM'
|
|
2690
|
-
| 'UY'
|
|
2691
|
-
| 'UZ'
|
|
2692
|
-
| 'VU'
|
|
2693
|
-
| 'VE'
|
|
2694
|
-
| 'VN'
|
|
2695
|
-
| 'VG'
|
|
2696
|
-
| 'VI'
|
|
2697
|
-
| 'WF'
|
|
2698
|
-
| 'EH'
|
|
2699
|
-
| 'YE'
|
|
2700
|
-
| 'ZM'
|
|
2701
|
-
| 'ZW'
|
|
2702
|
-
| 'AX'
|
|
2703
|
-
| 'BQ'
|
|
2704
|
-
| 'CW'
|
|
2705
|
-
| 'GG'
|
|
2706
|
-
| 'IM'
|
|
2707
|
-
| 'JE'
|
|
2708
|
-
| 'ME'
|
|
2709
|
-
| 'BL'
|
|
2710
|
-
| 'MF'
|
|
2711
|
-
| 'RS'
|
|
2712
|
-
| 'SX'
|
|
2713
|
-
| 'SS'
|
|
2714
|
-
| 'XK';
|
|
2715
|
-
|
|
2716
|
-
line1: string;
|
|
2717
|
-
|
|
2718
|
-
zipCode: string;
|
|
2719
|
-
|
|
2720
|
-
firstName?: string;
|
|
2721
|
-
|
|
2722
|
-
lastName?: string;
|
|
2723
|
-
|
|
2724
|
-
line2?: string;
|
|
2725
|
-
|
|
2726
|
-
region?: string;
|
|
2727
|
-
}
|
|
2728
|
-
|
|
2729
|
-
/**
|
|
2730
|
-
* The selected shipping method by the user. Can either be selected during an
|
|
2731
|
-
* express Checkout Session or passed during Checkout Session creation.
|
|
2732
|
-
*/
|
|
2733
|
-
export interface ShippingMethod {
|
|
2734
|
-
/**
|
|
2735
|
-
* The customer-facing name of the shipping method.
|
|
2736
|
-
*/
|
|
2737
|
-
name: string;
|
|
2738
|
-
|
|
2739
|
-
/**
|
|
2740
|
-
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
2741
|
-
*/
|
|
2742
|
-
price: number;
|
|
2743
|
-
|
|
2744
|
-
/**
|
|
2745
|
-
* The unique identifier of the shipping method within Ivy.
|
|
2746
|
-
*/
|
|
2747
|
-
id?: string;
|
|
2748
|
-
|
|
2749
|
-
/**
|
|
2750
|
-
* The list of countries where the shipping method is available.
|
|
2751
|
-
*/
|
|
2752
|
-
countries?: Array<
|
|
2753
|
-
| 'AF'
|
|
2754
|
-
| 'AL'
|
|
2755
|
-
| 'DZ'
|
|
2756
|
-
| 'AS'
|
|
2757
|
-
| 'AD'
|
|
2758
|
-
| 'AO'
|
|
2759
|
-
| 'AI'
|
|
2760
|
-
| 'AQ'
|
|
2761
|
-
| 'AG'
|
|
2762
|
-
| 'AR'
|
|
2763
|
-
| 'AM'
|
|
2764
|
-
| 'AW'
|
|
2765
|
-
| 'AU'
|
|
2766
|
-
| 'AT'
|
|
2767
|
-
| 'AZ'
|
|
2768
|
-
| 'BS'
|
|
2769
|
-
| 'BH'
|
|
2770
|
-
| 'BD'
|
|
2771
|
-
| 'BB'
|
|
2772
|
-
| 'BY'
|
|
2773
|
-
| 'BE'
|
|
2774
|
-
| 'BZ'
|
|
2775
|
-
| 'BJ'
|
|
2776
|
-
| 'BM'
|
|
2777
|
-
| 'BT'
|
|
2778
|
-
| 'BO'
|
|
2779
|
-
| 'BA'
|
|
2780
|
-
| 'BW'
|
|
2781
|
-
| 'BV'
|
|
2782
|
-
| 'BR'
|
|
2783
|
-
| 'IO'
|
|
2784
|
-
| 'BN'
|
|
2785
|
-
| 'BG'
|
|
2786
|
-
| 'BF'
|
|
2787
|
-
| 'BI'
|
|
2788
|
-
| 'KH'
|
|
2789
|
-
| 'CM'
|
|
2790
|
-
| 'CA'
|
|
2791
|
-
| 'CV'
|
|
2792
|
-
| 'KY'
|
|
2793
|
-
| 'CF'
|
|
2794
|
-
| 'TD'
|
|
2795
|
-
| 'CL'
|
|
2796
|
-
| 'CN'
|
|
2797
|
-
| 'CX'
|
|
2798
|
-
| 'CC'
|
|
2799
|
-
| 'CO'
|
|
2800
|
-
| 'KM'
|
|
2801
|
-
| 'CG'
|
|
2802
|
-
| 'CD'
|
|
2803
|
-
| 'CK'
|
|
2804
|
-
| 'CR'
|
|
2805
|
-
| 'CI'
|
|
2806
|
-
| 'HR'
|
|
2807
|
-
| 'CU'
|
|
2808
|
-
| 'CY'
|
|
2809
|
-
| 'CZ'
|
|
2810
|
-
| 'DK'
|
|
2811
|
-
| 'DJ'
|
|
2812
|
-
| 'DM'
|
|
2813
|
-
| 'DO'
|
|
2814
|
-
| 'EC'
|
|
2815
|
-
| 'EG'
|
|
2816
|
-
| 'SV'
|
|
2817
|
-
| 'GQ'
|
|
2818
|
-
| 'ER'
|
|
2819
|
-
| 'EE'
|
|
2820
|
-
| 'ET'
|
|
2821
|
-
| 'FK'
|
|
2822
|
-
| 'FO'
|
|
2823
|
-
| 'FJ'
|
|
2824
|
-
| 'FI'
|
|
2825
|
-
| 'FR'
|
|
2826
|
-
| 'GF'
|
|
2827
|
-
| 'PF'
|
|
2828
|
-
| 'TF'
|
|
2829
|
-
| 'GA'
|
|
2830
|
-
| 'GM'
|
|
2831
|
-
| 'GE'
|
|
2832
|
-
| 'DE'
|
|
2833
|
-
| 'GH'
|
|
2834
|
-
| 'GI'
|
|
2835
|
-
| 'GR'
|
|
2836
|
-
| 'GL'
|
|
2837
|
-
| 'GD'
|
|
2838
|
-
| 'GP'
|
|
2839
|
-
| 'GU'
|
|
2840
|
-
| 'GT'
|
|
2841
|
-
| 'GN'
|
|
2842
|
-
| 'GW'
|
|
2843
|
-
| 'GY'
|
|
2844
|
-
| 'HT'
|
|
2845
|
-
| 'HM'
|
|
2846
|
-
| 'VA'
|
|
2847
|
-
| 'HN'
|
|
2848
|
-
| 'HK'
|
|
2849
|
-
| 'HU'
|
|
2850
|
-
| 'IS'
|
|
2851
|
-
| 'IN'
|
|
2852
|
-
| 'ID'
|
|
2853
|
-
| 'IR'
|
|
2854
|
-
| 'IQ'
|
|
2855
|
-
| 'IE'
|
|
2856
|
-
| 'IL'
|
|
2857
|
-
| 'IT'
|
|
2858
|
-
| 'JM'
|
|
2859
|
-
| 'JP'
|
|
2860
|
-
| 'JO'
|
|
2861
|
-
| 'KZ'
|
|
2862
|
-
| 'KE'
|
|
2863
|
-
| 'KI'
|
|
2864
|
-
| 'KP'
|
|
2865
|
-
| 'KR'
|
|
2866
|
-
| 'KW'
|
|
2867
|
-
| 'KG'
|
|
2868
|
-
| 'LA'
|
|
2869
|
-
| 'LV'
|
|
2870
|
-
| 'LB'
|
|
2871
|
-
| 'LS'
|
|
2872
|
-
| 'LR'
|
|
2873
|
-
| 'LY'
|
|
2874
|
-
| 'LI'
|
|
2875
|
-
| 'LT'
|
|
2876
|
-
| 'LU'
|
|
2877
|
-
| 'MO'
|
|
2878
|
-
| 'MG'
|
|
2879
|
-
| 'MW'
|
|
2880
|
-
| 'MY'
|
|
2881
|
-
| 'MV'
|
|
2882
|
-
| 'ML'
|
|
2883
|
-
| 'MT'
|
|
2884
|
-
| 'MH'
|
|
2885
|
-
| 'MQ'
|
|
2886
|
-
| 'MR'
|
|
2887
|
-
| 'MU'
|
|
2888
|
-
| 'YT'
|
|
2889
|
-
| 'MX'
|
|
2890
|
-
| 'FM'
|
|
2891
|
-
| 'MD'
|
|
2892
|
-
| 'MC'
|
|
2893
|
-
| 'MN'
|
|
2894
|
-
| 'MS'
|
|
2895
|
-
| 'MA'
|
|
2896
|
-
| 'MZ'
|
|
2897
|
-
| 'MM'
|
|
2898
|
-
| 'NA'
|
|
2899
|
-
| 'NR'
|
|
2900
|
-
| 'NP'
|
|
2901
|
-
| 'NL'
|
|
2902
|
-
| 'NC'
|
|
2903
|
-
| 'NZ'
|
|
2904
|
-
| 'NI'
|
|
2905
|
-
| 'NE'
|
|
2906
|
-
| 'NG'
|
|
2907
|
-
| 'NU'
|
|
2908
|
-
| 'NF'
|
|
2909
|
-
| 'MP'
|
|
2910
|
-
| 'MK'
|
|
2911
|
-
| 'NO'
|
|
2912
|
-
| 'OM'
|
|
2913
|
-
| 'PK'
|
|
2914
|
-
| 'PW'
|
|
2915
|
-
| 'PS'
|
|
2916
|
-
| 'PA'
|
|
2917
|
-
| 'PG'
|
|
2918
|
-
| 'PY'
|
|
2919
|
-
| 'PE'
|
|
2920
|
-
| 'PH'
|
|
2921
|
-
| 'PN'
|
|
2922
|
-
| 'PL'
|
|
2923
|
-
| 'PT'
|
|
2924
|
-
| 'PR'
|
|
2925
|
-
| 'QA'
|
|
2926
|
-
| 'RE'
|
|
2927
|
-
| 'RO'
|
|
2928
|
-
| 'RU'
|
|
2929
|
-
| 'RW'
|
|
2930
|
-
| 'SH'
|
|
2931
|
-
| 'KN'
|
|
2932
|
-
| 'LC'
|
|
2933
|
-
| 'PM'
|
|
2934
|
-
| 'VC'
|
|
2935
|
-
| 'WS'
|
|
2936
|
-
| 'SM'
|
|
2937
|
-
| 'ST'
|
|
2938
|
-
| 'SA'
|
|
2939
|
-
| 'SN'
|
|
2940
|
-
| 'SC'
|
|
2941
|
-
| 'SL'
|
|
2942
|
-
| 'SG'
|
|
2943
|
-
| 'SK'
|
|
2944
|
-
| 'SI'
|
|
2945
|
-
| 'SB'
|
|
2946
|
-
| 'SO'
|
|
2947
|
-
| 'ZA'
|
|
2948
|
-
| 'GS'
|
|
2949
|
-
| 'ES'
|
|
2950
|
-
| 'LK'
|
|
2951
|
-
| 'SD'
|
|
2952
|
-
| 'SR'
|
|
2953
|
-
| 'SJ'
|
|
2954
|
-
| 'SZ'
|
|
2955
|
-
| 'SE'
|
|
2956
|
-
| 'CH'
|
|
2957
|
-
| 'SY'
|
|
2958
|
-
| 'TW'
|
|
2959
|
-
| 'TJ'
|
|
2960
|
-
| 'TZ'
|
|
2961
|
-
| 'TH'
|
|
2962
|
-
| 'TL'
|
|
2963
|
-
| 'TG'
|
|
2964
|
-
| 'TK'
|
|
2965
|
-
| 'TO'
|
|
2966
|
-
| 'TT'
|
|
2967
|
-
| 'TN'
|
|
2968
|
-
| 'TR'
|
|
2969
|
-
| 'TM'
|
|
2970
|
-
| 'TC'
|
|
2971
|
-
| 'TV'
|
|
2972
|
-
| 'UG'
|
|
2973
|
-
| 'UA'
|
|
2974
|
-
| 'AE'
|
|
2975
|
-
| 'GB'
|
|
2976
|
-
| 'US'
|
|
2977
|
-
| 'UM'
|
|
2978
|
-
| 'UY'
|
|
2979
|
-
| 'UZ'
|
|
2980
|
-
| 'VU'
|
|
2981
|
-
| 'VE'
|
|
2982
|
-
| 'VN'
|
|
2983
|
-
| 'VG'
|
|
2984
|
-
| 'VI'
|
|
2985
|
-
| 'WF'
|
|
2986
|
-
| 'EH'
|
|
2987
|
-
| 'YE'
|
|
2988
|
-
| 'ZM'
|
|
2989
|
-
| 'ZW'
|
|
2990
|
-
| 'AX'
|
|
2991
|
-
| 'BQ'
|
|
2992
|
-
| 'CW'
|
|
2993
|
-
| 'GG'
|
|
2994
|
-
| 'IM'
|
|
2995
|
-
| 'JE'
|
|
2996
|
-
| 'ME'
|
|
2997
|
-
| 'BL'
|
|
2998
|
-
| 'MF'
|
|
2999
|
-
| 'RS'
|
|
3000
|
-
| 'SX'
|
|
3001
|
-
| 'SS'
|
|
3002
|
-
| 'XK'
|
|
3003
|
-
>;
|
|
3004
|
-
|
|
3005
|
-
/**
|
|
3006
|
-
* The delivery estimate of the shipping method.
|
|
3007
|
-
*/
|
|
3008
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
3009
|
-
|
|
3010
|
-
/**
|
|
3011
|
-
* The unique identifier within your system of the shipping method.
|
|
3012
|
-
*/
|
|
3013
|
-
reference?: string;
|
|
3014
|
-
|
|
3015
|
-
/**
|
|
3016
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
3017
|
-
*/
|
|
3018
|
-
timeFrame?: string;
|
|
3019
|
-
}
|
|
3020
|
-
|
|
3021
|
-
export namespace ShippingMethod {
|
|
3022
|
-
/**
|
|
3023
|
-
* The delivery estimate of the shipping method.
|
|
3024
|
-
*/
|
|
3025
|
-
export interface DeliveryEstimate {
|
|
3026
|
-
/**
|
|
3027
|
-
* The maximum delivery time.
|
|
3028
|
-
*/
|
|
3029
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
3030
|
-
|
|
3031
|
-
/**
|
|
3032
|
-
* The minimum delivery time.
|
|
3033
|
-
*/
|
|
3034
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
3035
|
-
}
|
|
3036
|
-
|
|
3037
|
-
export namespace DeliveryEstimate {
|
|
3038
|
-
/**
|
|
3039
|
-
* The maximum delivery time.
|
|
3040
|
-
*/
|
|
3041
|
-
export interface Maximum {
|
|
3042
|
-
/**
|
|
3043
|
-
* The unit of the time duration.
|
|
3044
|
-
*/
|
|
3045
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
3046
|
-
|
|
3047
|
-
/**
|
|
3048
|
-
* The value of the time duration.
|
|
3049
|
-
*/
|
|
3050
|
-
value: number;
|
|
3051
|
-
}
|
|
3052
|
-
|
|
3053
|
-
/**
|
|
3054
|
-
* The minimum delivery time.
|
|
3055
|
-
*/
|
|
3056
|
-
export interface Minimum {
|
|
3057
|
-
/**
|
|
3058
|
-
* The unit of the time duration.
|
|
3059
|
-
*/
|
|
3060
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
3061
|
-
|
|
3062
|
-
/**
|
|
3063
|
-
* The value of the time duration.
|
|
3064
|
-
*/
|
|
3065
|
-
value: number;
|
|
3066
|
-
}
|
|
3067
|
-
}
|
|
3068
|
-
}
|
|
3069
|
-
|
|
3070
|
-
/**
|
|
3071
|
-
* The shopper object. Contains information collected from the user during the
|
|
3072
|
-
* Checkout.
|
|
3073
|
-
*/
|
|
3074
|
-
export interface Shopper {
|
|
3075
|
-
email?: string;
|
|
3076
|
-
|
|
3077
|
-
phoneNumber?: string;
|
|
3078
|
-
}
|
|
3079
|
-
|
|
3080
|
-
export interface StatusClassification {
|
|
3081
|
-
/**
|
|
3082
|
-
* Populated with the primary payment initiation failure classsification if
|
|
3083
|
-
* available.
|
|
3084
|
-
*/
|
|
3085
|
-
primary?: string;
|
|
3086
|
-
|
|
3087
|
-
/**
|
|
3088
|
-
* Populated with the secondary payment initiation failure classsification if
|
|
3089
|
-
* available.
|
|
3090
|
-
*/
|
|
3091
|
-
secondary?: string;
|
|
3092
|
-
}
|
|
3093
|
-
|
|
3094
|
-
export interface StatusHistoryList {
|
|
3095
|
-
/**
|
|
3096
|
-
* The order status. This status symbolises the state of the user's payment
|
|
3097
|
-
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
3098
|
-
* information.
|
|
3099
|
-
*/
|
|
3100
|
-
currentStatus:
|
|
3101
|
-
| 'failed'
|
|
3102
|
-
| 'canceled'
|
|
3103
|
-
| 'processing'
|
|
3104
|
-
| 'in_handshake'
|
|
3105
|
-
| 'waiting_for_payment'
|
|
3106
|
-
| 'paid'
|
|
3107
|
-
| 'in_refund'
|
|
3108
|
-
| 'refunded'
|
|
3109
|
-
| 'refund_failed'
|
|
3110
|
-
| 'partially_refunded'
|
|
3111
|
-
| 'in_dispute'
|
|
3112
|
-
| 'disputed'
|
|
3113
|
-
| 'refused';
|
|
3114
|
-
|
|
3115
|
-
reason: string;
|
|
3116
|
-
|
|
3117
|
-
updatedAt: string;
|
|
3118
|
-
|
|
3119
|
-
/**
|
|
3120
|
-
* The order status. This status symbolises the state of the user's payment
|
|
3121
|
-
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
3122
|
-
* information.
|
|
3123
|
-
*/
|
|
3124
|
-
previousStatus?:
|
|
3125
|
-
| 'failed'
|
|
3126
|
-
| 'canceled'
|
|
3127
|
-
| 'processing'
|
|
3128
|
-
| 'in_handshake'
|
|
3129
|
-
| 'waiting_for_payment'
|
|
3130
|
-
| 'paid'
|
|
3131
|
-
| 'in_refund'
|
|
3132
|
-
| 'refunded'
|
|
3133
|
-
| 'refund_failed'
|
|
3134
|
-
| 'partially_refunded'
|
|
3135
|
-
| 'in_dispute'
|
|
3136
|
-
| 'disputed'
|
|
3137
|
-
| 'refused'
|
|
3138
|
-
| null;
|
|
3139
|
-
}
|
|
3140
|
-
}
|
|
3141
|
-
|
|
3142
|
-
export interface OrderRetrieveParams {
|
|
3143
|
-
id: string;
|
|
3144
|
-
}
|
|
3145
|
-
|
|
3146
|
-
export interface OrderUpdateParams {
|
|
3147
|
-
id: string;
|
|
3148
|
-
|
|
3149
|
-
/**
|
|
3150
|
-
* The customer-facing id of the order. This id will also be shown next to the
|
|
3151
|
-
* orders in the Ivy Dashboard.
|
|
3152
|
-
*/
|
|
3153
|
-
displayId?: string;
|
|
3154
|
-
|
|
3155
|
-
/**
|
|
3156
|
-
* An internal reference id which will be stored with the checkout & corresponding
|
|
3157
|
-
* order. Needs to be unique per shop per order and can be up to 200 characters. We
|
|
3158
|
-
* recommend to use your internal order id here.
|
|
3159
|
-
*/
|
|
3160
|
-
referenceId?: string;
|
|
3161
|
-
|
|
3162
|
-
/**
|
|
3163
|
-
* The customer-facing name of the shop.
|
|
3164
|
-
*/
|
|
3165
|
-
shopName?: string;
|
|
3166
|
-
|
|
3167
|
-
/**
|
|
3168
|
-
* The order status. This status symbolises the state of the user's payment
|
|
3169
|
-
* attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
|
|
3170
|
-
* information.
|
|
3171
|
-
*/
|
|
3172
|
-
status?:
|
|
3173
|
-
| 'failed'
|
|
3174
|
-
| 'canceled'
|
|
3175
|
-
| 'processing'
|
|
3176
|
-
| 'in_handshake'
|
|
3177
|
-
| 'waiting_for_payment'
|
|
3178
|
-
| 'paid'
|
|
3179
|
-
| 'in_refund'
|
|
3180
|
-
| 'refunded'
|
|
3181
|
-
| 'refund_failed'
|
|
3182
|
-
| 'partially_refunded'
|
|
3183
|
-
| 'in_dispute'
|
|
3184
|
-
| 'disputed'
|
|
3185
|
-
| 'refused';
|
|
3186
1660
|
}
|
|
3187
1661
|
|
|
3188
1662
|
export declare namespace Orders {
|
|
3189
1663
|
export {
|
|
3190
1664
|
type OrderRetrieveResponse as OrderRetrieveResponse,
|
|
3191
|
-
type OrderUpdateResponse as OrderUpdateResponse,
|
|
3192
1665
|
type OrderRetrieveParams as OrderRetrieveParams,
|
|
3193
|
-
type OrderUpdateParams as OrderUpdateParams,
|
|
3194
1666
|
};
|
|
3195
1667
|
}
|