@getivy/node-sdk 0.1.0-alpha.17 → 0.1.0-alpha.19

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