@peable.to/contracts 3.0.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/dist/cjs/resources/billingEngine/public.js +22 -3
  2. package/dist/cjs/resources/checkout/checkoutSessions.js +34 -9
  3. package/dist/cjs/resources/checkout/merchants.js +10 -23
  4. package/dist/cjs/resources/checkout/paymentMethodConfigurations.js +56 -10
  5. package/dist/cjs/resources/connect/balance.js +5 -0
  6. package/dist/cjs/resources/connect/connectedAccounts.js +11 -12
  7. package/dist/cjs/resources/connect/onboarding.js +13 -24
  8. package/dist/cjs/resources/events/webhookDeliveries.js +1 -1
  9. package/dist/cjs/resources/events/webhookEndpoints.js +1 -1
  10. package/dist/cjs/resources/payments/disputes.js +16 -0
  11. package/dist/cjs/resources/payments/paymentIntents.js +39 -2
  12. package/dist/cjs/resources/payments/refunds.js +46 -11
  13. package/dist/cjs/vocabulary/checkout.js +18 -1
  14. package/dist/cjs/vocabulary/errors.js +5 -3
  15. package/dist/cjs/vocabulary/events.js +5 -0
  16. package/dist/cjs/vocabulary/paymentMethodConfigurations.js +24 -4
  17. package/dist/esm/resources/billingEngine/public.js +22 -3
  18. package/dist/esm/resources/checkout/checkoutSessions.js +35 -10
  19. package/dist/esm/resources/checkout/merchants.js +10 -23
  20. package/dist/esm/resources/checkout/paymentMethodConfigurations.js +57 -11
  21. package/dist/esm/resources/connect/balance.js +5 -0
  22. package/dist/esm/resources/connect/connectedAccounts.js +11 -12
  23. package/dist/esm/resources/connect/onboarding.js +12 -23
  24. package/dist/esm/resources/events/webhookDeliveries.js +1 -1
  25. package/dist/esm/resources/events/webhookEndpoints.js +1 -1
  26. package/dist/esm/resources/payments/disputes.js +16 -0
  27. package/dist/esm/resources/payments/paymentIntents.js +39 -2
  28. package/dist/esm/resources/payments/refunds.js +46 -11
  29. package/dist/esm/vocabulary/checkout.js +17 -0
  30. package/dist/esm/vocabulary/errors.js +5 -3
  31. package/dist/esm/vocabulary/events.js +5 -0
  32. package/dist/esm/vocabulary/paymentMethodConfigurations.js +25 -5
  33. package/dist/types/resources/billingEngine/index.d.ts +16 -2
  34. package/dist/types/resources/billingEngine/public.d.ts +32 -3
  35. package/dist/types/resources/checkout/checkoutSessions.d.ts +96 -31
  36. package/dist/types/resources/checkout/index.d.ts +406 -41
  37. package/dist/types/resources/checkout/merchants.d.ts +17 -28
  38. package/dist/types/resources/checkout/paymentMethodConfigurations.d.ts +440 -8
  39. package/dist/types/resources/connect/balance.d.ts +103 -10
  40. package/dist/types/resources/connect/connectedAccounts.d.ts +4 -4
  41. package/dist/types/resources/connect/index.d.ts +105 -14
  42. package/dist/types/resources/connect/onboarding.d.ts +15 -15
  43. package/dist/types/resources/connect/payouts.d.ts +66 -4
  44. package/dist/types/resources/events/index.d.ts +5 -0
  45. package/dist/types/resources/events/webhookEndpoints.d.ts +7 -0
  46. package/dist/types/resources/payments/disputes.d.ts +35 -0
  47. package/dist/types/resources/payments/index.d.ts +382 -0
  48. package/dist/types/resources/payments/paymentIntents.d.ts +380 -0
  49. package/dist/types/resources/payments/refunds.d.ts +56 -5
  50. package/dist/types/resources/payments/testHelpers.d.ts +31 -0
  51. package/dist/types/resources/tax/deadlines.d.ts +3 -3
  52. package/dist/types/resources/tax/index.d.ts +2 -2
  53. package/dist/types/resources/tax/registrations.d.ts +2 -2
  54. package/dist/types/vocabulary/checkout.d.ts +13 -0
  55. package/dist/types/vocabulary/errors.d.ts +5 -3
  56. package/dist/types/vocabulary/events.d.ts +5 -1
  57. package/dist/types/vocabulary/paymentMethodConfigurations.d.ts +21 -7
  58. package/package.json +1 -1
@@ -42,6 +42,45 @@ export declare const paymentIntentNextActionSchema: z.ZodDiscriminatedUnion<[z.Z
42
42
  type: z.ZodLiteral<"use_peable_sdk">;
43
43
  }, z.core.$strict>], "type">;
44
44
  export type PaymentIntentNextAction = z.output<typeof paymentIntentNextActionSchema>;
45
+ /**
46
+ * The FairCoin price of a FIAT order (ADR 0021 D4), carried by the FairCoin
47
+ * payment the payer chose for it. Pricing, never exchange: the payer pays
48
+ * `amount` FAIR (the intent's) to the payee's own address, and no fiat moves.
49
+ * `rate` is for display; the FAIR amount is exactly
50
+ * `ceil(amount ÷ rate)` computed from the sources' own figures.
51
+ */
52
+ export declare const faircoinQuoteSchema: z.ZodObject<{
53
+ currency: z.ZodEnum<{
54
+ EUR: "EUR";
55
+ USD: "USD";
56
+ GBP: "GBP";
57
+ CHF: "CHF";
58
+ SEK: "SEK";
59
+ NOK: "NOK";
60
+ DKK: "DKK";
61
+ PLN: "PLN";
62
+ CZK: "CZK";
63
+ CAD: "CAD";
64
+ AUD: "AUD";
65
+ JPY: "JPY";
66
+ }>;
67
+ amount: z.ZodString;
68
+ rate: z.ZodString;
69
+ price: z.ZodObject<{
70
+ source: z.ZodLiteral<"wfair-base">;
71
+ usd_per_fair: z.ZodString;
72
+ observed_at: z.ZodNumber;
73
+ }, z.core.$strict>;
74
+ reference_rates: z.ZodNullable<z.ZodObject<{
75
+ source: z.ZodLiteral<"ecb">;
76
+ usd_per_eur: z.ZodString;
77
+ currency_per_eur: z.ZodString;
78
+ observed_at: z.ZodNumber;
79
+ }, z.core.$strict>>;
80
+ quoted_at: z.ZodNumber;
81
+ expires_at: z.ZodNumber;
82
+ }, z.core.$strict>;
83
+ export type FaircoinQuote = z.output<typeof faircoinQuoteSchema>;
45
84
  /**
46
85
  * The chain side of a FairCoin payment. `txid` and `confirmations` describe the
47
86
  * transaction the payer reported: `null`/`0` while `requires_action`, the
@@ -56,6 +95,37 @@ export declare const paymentIntentFaircoinSchema: z.ZodObject<{
56
95
  txid: z.ZodNullable<z.ZodString>;
57
96
  confirmations: z.ZodNumber;
58
97
  required_confirmations: z.ZodNumber;
98
+ quote: z.ZodNullable<z.ZodObject<{
99
+ currency: z.ZodEnum<{
100
+ EUR: "EUR";
101
+ USD: "USD";
102
+ GBP: "GBP";
103
+ CHF: "CHF";
104
+ SEK: "SEK";
105
+ NOK: "NOK";
106
+ DKK: "DKK";
107
+ PLN: "PLN";
108
+ CZK: "CZK";
109
+ CAD: "CAD";
110
+ AUD: "AUD";
111
+ JPY: "JPY";
112
+ }>;
113
+ amount: z.ZodString;
114
+ rate: z.ZodString;
115
+ price: z.ZodObject<{
116
+ source: z.ZodLiteral<"wfair-base">;
117
+ usd_per_fair: z.ZodString;
118
+ observed_at: z.ZodNumber;
119
+ }, z.core.$strict>;
120
+ reference_rates: z.ZodNullable<z.ZodObject<{
121
+ source: z.ZodLiteral<"ecb">;
122
+ usd_per_eur: z.ZodString;
123
+ currency_per_eur: z.ZodString;
124
+ observed_at: z.ZodNumber;
125
+ }, z.core.$strict>>;
126
+ quoted_at: z.ZodNumber;
127
+ expires_at: z.ZodNumber;
128
+ }, z.core.$strict>>;
59
129
  }, z.core.$strict>;
60
130
  export type PaymentIntentFaircoin = z.output<typeof paymentIntentFaircoinSchema>;
61
131
  /** Where a destination charge's funds go (`transfer_data`, ADR 0015 §2). */
@@ -206,6 +276,37 @@ export declare const paymentIntentSchema: z.ZodObject<{
206
276
  txid: z.ZodNullable<z.ZodString>;
207
277
  confirmations: z.ZodNumber;
208
278
  required_confirmations: z.ZodNumber;
279
+ quote: z.ZodNullable<z.ZodObject<{
280
+ currency: z.ZodEnum<{
281
+ EUR: "EUR";
282
+ USD: "USD";
283
+ GBP: "GBP";
284
+ CHF: "CHF";
285
+ SEK: "SEK";
286
+ NOK: "NOK";
287
+ DKK: "DKK";
288
+ PLN: "PLN";
289
+ CZK: "CZK";
290
+ CAD: "CAD";
291
+ AUD: "AUD";
292
+ JPY: "JPY";
293
+ }>;
294
+ amount: z.ZodString;
295
+ rate: z.ZodString;
296
+ price: z.ZodObject<{
297
+ source: z.ZodLiteral<"wfair-base">;
298
+ usd_per_fair: z.ZodString;
299
+ observed_at: z.ZodNumber;
300
+ }, z.core.$strict>;
301
+ reference_rates: z.ZodNullable<z.ZodObject<{
302
+ source: z.ZodLiteral<"ecb">;
303
+ usd_per_eur: z.ZodString;
304
+ currency_per_eur: z.ZodString;
305
+ observed_at: z.ZodNumber;
306
+ }, z.core.$strict>>;
307
+ quoted_at: z.ZodNumber;
308
+ expires_at: z.ZodNumber;
309
+ }, z.core.$strict>>;
209
310
  }, z.core.$strict>>;
210
311
  merchant_id: z.ZodString;
211
312
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -672,6 +773,37 @@ export declare const paymentIntentRoutes: readonly [{
672
773
  txid: z.ZodNullable<z.ZodString>;
673
774
  confirmations: z.ZodNumber;
674
775
  required_confirmations: z.ZodNumber;
776
+ quote: z.ZodNullable<z.ZodObject<{
777
+ currency: z.ZodEnum<{
778
+ EUR: "EUR";
779
+ USD: "USD";
780
+ GBP: "GBP";
781
+ CHF: "CHF";
782
+ SEK: "SEK";
783
+ NOK: "NOK";
784
+ DKK: "DKK";
785
+ PLN: "PLN";
786
+ CZK: "CZK";
787
+ CAD: "CAD";
788
+ AUD: "AUD";
789
+ JPY: "JPY";
790
+ }>;
791
+ amount: z.ZodString;
792
+ rate: z.ZodString;
793
+ price: z.ZodObject<{
794
+ source: z.ZodLiteral<"wfair-base">;
795
+ usd_per_fair: z.ZodString;
796
+ observed_at: z.ZodNumber;
797
+ }, z.core.$strict>;
798
+ reference_rates: z.ZodNullable<z.ZodObject<{
799
+ source: z.ZodLiteral<"ecb">;
800
+ usd_per_eur: z.ZodString;
801
+ currency_per_eur: z.ZodString;
802
+ observed_at: z.ZodNumber;
803
+ }, z.core.$strict>>;
804
+ quoted_at: z.ZodNumber;
805
+ expires_at: z.ZodNumber;
806
+ }, z.core.$strict>>;
675
807
  }, z.core.$strict>>;
676
808
  merchant_id: z.ZodString;
677
809
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -854,6 +986,37 @@ export declare const paymentIntentRoutes: readonly [{
854
986
  txid: z.ZodNullable<z.ZodString>;
855
987
  confirmations: z.ZodNumber;
856
988
  required_confirmations: z.ZodNumber;
989
+ quote: z.ZodNullable<z.ZodObject<{
990
+ currency: z.ZodEnum<{
991
+ EUR: "EUR";
992
+ USD: "USD";
993
+ GBP: "GBP";
994
+ CHF: "CHF";
995
+ SEK: "SEK";
996
+ NOK: "NOK";
997
+ DKK: "DKK";
998
+ PLN: "PLN";
999
+ CZK: "CZK";
1000
+ CAD: "CAD";
1001
+ AUD: "AUD";
1002
+ JPY: "JPY";
1003
+ }>;
1004
+ amount: z.ZodString;
1005
+ rate: z.ZodString;
1006
+ price: z.ZodObject<{
1007
+ source: z.ZodLiteral<"wfair-base">;
1008
+ usd_per_fair: z.ZodString;
1009
+ observed_at: z.ZodNumber;
1010
+ }, z.core.$strict>;
1011
+ reference_rates: z.ZodNullable<z.ZodObject<{
1012
+ source: z.ZodLiteral<"ecb">;
1013
+ usd_per_eur: z.ZodString;
1014
+ currency_per_eur: z.ZodString;
1015
+ observed_at: z.ZodNumber;
1016
+ }, z.core.$strict>>;
1017
+ quoted_at: z.ZodNumber;
1018
+ expires_at: z.ZodNumber;
1019
+ }, z.core.$strict>>;
857
1020
  }, z.core.$strict>>;
858
1021
  merchant_id: z.ZodString;
859
1022
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -1017,6 +1180,37 @@ export declare const paymentIntentRoutes: readonly [{
1017
1180
  txid: z.ZodNullable<z.ZodString>;
1018
1181
  confirmations: z.ZodNumber;
1019
1182
  required_confirmations: z.ZodNumber;
1183
+ quote: z.ZodNullable<z.ZodObject<{
1184
+ currency: z.ZodEnum<{
1185
+ EUR: "EUR";
1186
+ USD: "USD";
1187
+ GBP: "GBP";
1188
+ CHF: "CHF";
1189
+ SEK: "SEK";
1190
+ NOK: "NOK";
1191
+ DKK: "DKK";
1192
+ PLN: "PLN";
1193
+ CZK: "CZK";
1194
+ CAD: "CAD";
1195
+ AUD: "AUD";
1196
+ JPY: "JPY";
1197
+ }>;
1198
+ amount: z.ZodString;
1199
+ rate: z.ZodString;
1200
+ price: z.ZodObject<{
1201
+ source: z.ZodLiteral<"wfair-base">;
1202
+ usd_per_fair: z.ZodString;
1203
+ observed_at: z.ZodNumber;
1204
+ }, z.core.$strict>;
1205
+ reference_rates: z.ZodNullable<z.ZodObject<{
1206
+ source: z.ZodLiteral<"ecb">;
1207
+ usd_per_eur: z.ZodString;
1208
+ currency_per_eur: z.ZodString;
1209
+ observed_at: z.ZodNumber;
1210
+ }, z.core.$strict>>;
1211
+ quoted_at: z.ZodNumber;
1212
+ expires_at: z.ZodNumber;
1213
+ }, z.core.$strict>>;
1020
1214
  }, z.core.$strict>>;
1021
1215
  merchant_id: z.ZodString;
1022
1216
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -1194,6 +1388,37 @@ export declare const paymentIntentRoutes: readonly [{
1194
1388
  txid: z.ZodNullable<z.ZodString>;
1195
1389
  confirmations: z.ZodNumber;
1196
1390
  required_confirmations: z.ZodNumber;
1391
+ quote: z.ZodNullable<z.ZodObject<{
1392
+ currency: z.ZodEnum<{
1393
+ EUR: "EUR";
1394
+ USD: "USD";
1395
+ GBP: "GBP";
1396
+ CHF: "CHF";
1397
+ SEK: "SEK";
1398
+ NOK: "NOK";
1399
+ DKK: "DKK";
1400
+ PLN: "PLN";
1401
+ CZK: "CZK";
1402
+ CAD: "CAD";
1403
+ AUD: "AUD";
1404
+ JPY: "JPY";
1405
+ }>;
1406
+ amount: z.ZodString;
1407
+ rate: z.ZodString;
1408
+ price: z.ZodObject<{
1409
+ source: z.ZodLiteral<"wfair-base">;
1410
+ usd_per_fair: z.ZodString;
1411
+ observed_at: z.ZodNumber;
1412
+ }, z.core.$strict>;
1413
+ reference_rates: z.ZodNullable<z.ZodObject<{
1414
+ source: z.ZodLiteral<"ecb">;
1415
+ usd_per_eur: z.ZodString;
1416
+ currency_per_eur: z.ZodString;
1417
+ observed_at: z.ZodNumber;
1418
+ }, z.core.$strict>>;
1419
+ quoted_at: z.ZodNumber;
1420
+ expires_at: z.ZodNumber;
1421
+ }, z.core.$strict>>;
1197
1422
  }, z.core.$strict>>;
1198
1423
  merchant_id: z.ZodString;
1199
1424
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -1401,6 +1626,37 @@ export declare const paymentIntentRoutes: readonly [{
1401
1626
  txid: z.ZodNullable<z.ZodString>;
1402
1627
  confirmations: z.ZodNumber;
1403
1628
  required_confirmations: z.ZodNumber;
1629
+ quote: z.ZodNullable<z.ZodObject<{
1630
+ currency: z.ZodEnum<{
1631
+ EUR: "EUR";
1632
+ USD: "USD";
1633
+ GBP: "GBP";
1634
+ CHF: "CHF";
1635
+ SEK: "SEK";
1636
+ NOK: "NOK";
1637
+ DKK: "DKK";
1638
+ PLN: "PLN";
1639
+ CZK: "CZK";
1640
+ CAD: "CAD";
1641
+ AUD: "AUD";
1642
+ JPY: "JPY";
1643
+ }>;
1644
+ amount: z.ZodString;
1645
+ rate: z.ZodString;
1646
+ price: z.ZodObject<{
1647
+ source: z.ZodLiteral<"wfair-base">;
1648
+ usd_per_fair: z.ZodString;
1649
+ observed_at: z.ZodNumber;
1650
+ }, z.core.$strict>;
1651
+ reference_rates: z.ZodNullable<z.ZodObject<{
1652
+ source: z.ZodLiteral<"ecb">;
1653
+ usd_per_eur: z.ZodString;
1654
+ currency_per_eur: z.ZodString;
1655
+ observed_at: z.ZodNumber;
1656
+ }, z.core.$strict>>;
1657
+ quoted_at: z.ZodNumber;
1658
+ expires_at: z.ZodNumber;
1659
+ }, z.core.$strict>>;
1404
1660
  }, z.core.$strict>>;
1405
1661
  merchant_id: z.ZodString;
1406
1662
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -1562,6 +1818,37 @@ export declare const paymentIntentRoutes: readonly [{
1562
1818
  txid: z.ZodNullable<z.ZodString>;
1563
1819
  confirmations: z.ZodNumber;
1564
1820
  required_confirmations: z.ZodNumber;
1821
+ quote: z.ZodNullable<z.ZodObject<{
1822
+ currency: z.ZodEnum<{
1823
+ EUR: "EUR";
1824
+ USD: "USD";
1825
+ GBP: "GBP";
1826
+ CHF: "CHF";
1827
+ SEK: "SEK";
1828
+ NOK: "NOK";
1829
+ DKK: "DKK";
1830
+ PLN: "PLN";
1831
+ CZK: "CZK";
1832
+ CAD: "CAD";
1833
+ AUD: "AUD";
1834
+ JPY: "JPY";
1835
+ }>;
1836
+ amount: z.ZodString;
1837
+ rate: z.ZodString;
1838
+ price: z.ZodObject<{
1839
+ source: z.ZodLiteral<"wfair-base">;
1840
+ usd_per_fair: z.ZodString;
1841
+ observed_at: z.ZodNumber;
1842
+ }, z.core.$strict>;
1843
+ reference_rates: z.ZodNullable<z.ZodObject<{
1844
+ source: z.ZodLiteral<"ecb">;
1845
+ usd_per_eur: z.ZodString;
1846
+ currency_per_eur: z.ZodString;
1847
+ observed_at: z.ZodNumber;
1848
+ }, z.core.$strict>>;
1849
+ quoted_at: z.ZodNumber;
1850
+ expires_at: z.ZodNumber;
1851
+ }, z.core.$strict>>;
1565
1852
  }, z.core.$strict>>;
1566
1853
  merchant_id: z.ZodString;
1567
1854
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -1728,6 +2015,37 @@ export declare const paymentIntentRoutes: readonly [{
1728
2015
  txid: z.ZodNullable<z.ZodString>;
1729
2016
  confirmations: z.ZodNumber;
1730
2017
  required_confirmations: z.ZodNumber;
2018
+ quote: z.ZodNullable<z.ZodObject<{
2019
+ currency: z.ZodEnum<{
2020
+ EUR: "EUR";
2021
+ USD: "USD";
2022
+ GBP: "GBP";
2023
+ CHF: "CHF";
2024
+ SEK: "SEK";
2025
+ NOK: "NOK";
2026
+ DKK: "DKK";
2027
+ PLN: "PLN";
2028
+ CZK: "CZK";
2029
+ CAD: "CAD";
2030
+ AUD: "AUD";
2031
+ JPY: "JPY";
2032
+ }>;
2033
+ amount: z.ZodString;
2034
+ rate: z.ZodString;
2035
+ price: z.ZodObject<{
2036
+ source: z.ZodLiteral<"wfair-base">;
2037
+ usd_per_fair: z.ZodString;
2038
+ observed_at: z.ZodNumber;
2039
+ }, z.core.$strict>;
2040
+ reference_rates: z.ZodNullable<z.ZodObject<{
2041
+ source: z.ZodLiteral<"ecb">;
2042
+ usd_per_eur: z.ZodString;
2043
+ currency_per_eur: z.ZodString;
2044
+ observed_at: z.ZodNumber;
2045
+ }, z.core.$strict>>;
2046
+ quoted_at: z.ZodNumber;
2047
+ expires_at: z.ZodNumber;
2048
+ }, z.core.$strict>>;
1731
2049
  }, z.core.$strict>>;
1732
2050
  merchant_id: z.ZodString;
1733
2051
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -1887,6 +2205,37 @@ export declare const paymentIntentRoutes: readonly [{
1887
2205
  txid: z.ZodNullable<z.ZodString>;
1888
2206
  confirmations: z.ZodNumber;
1889
2207
  required_confirmations: z.ZodNumber;
2208
+ quote: z.ZodNullable<z.ZodObject<{
2209
+ currency: z.ZodEnum<{
2210
+ EUR: "EUR";
2211
+ USD: "USD";
2212
+ GBP: "GBP";
2213
+ CHF: "CHF";
2214
+ SEK: "SEK";
2215
+ NOK: "NOK";
2216
+ DKK: "DKK";
2217
+ PLN: "PLN";
2218
+ CZK: "CZK";
2219
+ CAD: "CAD";
2220
+ AUD: "AUD";
2221
+ JPY: "JPY";
2222
+ }>;
2223
+ amount: z.ZodString;
2224
+ rate: z.ZodString;
2225
+ price: z.ZodObject<{
2226
+ source: z.ZodLiteral<"wfair-base">;
2227
+ usd_per_fair: z.ZodString;
2228
+ observed_at: z.ZodNumber;
2229
+ }, z.core.$strict>;
2230
+ reference_rates: z.ZodNullable<z.ZodObject<{
2231
+ source: z.ZodLiteral<"ecb">;
2232
+ usd_per_eur: z.ZodString;
2233
+ currency_per_eur: z.ZodString;
2234
+ observed_at: z.ZodNumber;
2235
+ }, z.core.$strict>>;
2236
+ quoted_at: z.ZodNumber;
2237
+ expires_at: z.ZodNumber;
2238
+ }, z.core.$strict>>;
1890
2239
  }, z.core.$strict>>;
1891
2240
  merchant_id: z.ZodString;
1892
2241
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -2046,6 +2395,37 @@ export declare const paymentIntentRoutes: readonly [{
2046
2395
  txid: z.ZodNullable<z.ZodString>;
2047
2396
  confirmations: z.ZodNumber;
2048
2397
  required_confirmations: z.ZodNumber;
2398
+ quote: z.ZodNullable<z.ZodObject<{
2399
+ currency: z.ZodEnum<{
2400
+ EUR: "EUR";
2401
+ USD: "USD";
2402
+ GBP: "GBP";
2403
+ CHF: "CHF";
2404
+ SEK: "SEK";
2405
+ NOK: "NOK";
2406
+ DKK: "DKK";
2407
+ PLN: "PLN";
2408
+ CZK: "CZK";
2409
+ CAD: "CAD";
2410
+ AUD: "AUD";
2411
+ JPY: "JPY";
2412
+ }>;
2413
+ amount: z.ZodString;
2414
+ rate: z.ZodString;
2415
+ price: z.ZodObject<{
2416
+ source: z.ZodLiteral<"wfair-base">;
2417
+ usd_per_fair: z.ZodString;
2418
+ observed_at: z.ZodNumber;
2419
+ }, z.core.$strict>;
2420
+ reference_rates: z.ZodNullable<z.ZodObject<{
2421
+ source: z.ZodLiteral<"ecb">;
2422
+ usd_per_eur: z.ZodString;
2423
+ currency_per_eur: z.ZodString;
2424
+ observed_at: z.ZodNumber;
2425
+ }, z.core.$strict>>;
2426
+ quoted_at: z.ZodNumber;
2427
+ expires_at: z.ZodNumber;
2428
+ }, z.core.$strict>>;
2049
2429
  }, z.core.$strict>>;
2050
2430
  merchant_id: z.ZodString;
2051
2431
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -1,7 +1,8 @@
1
1
  import { z } from 'zod';
2
2
  import { type Expand } from '../../common/objects';
3
3
  /**
4
- * Refunds (`re_…`) and a payment's settlement figures. The provider's own
4
+ * Refunds (`re_…`) and the settlement figures of a payment, a refund or a
5
+ * dispute. The provider's own
5
6
  * refund id never appears: a merchant integrates against Peable and never
6
7
  * learns which acquirer sat behind it (ADR 0001 D3).
7
8
  */
@@ -49,15 +50,28 @@ export declare const refundSchema: z.ZodObject<{
49
50
  }, z.core.$strict>;
50
51
  export type Refund = Expand<z.output<typeof refundSchema>>;
51
52
  /**
52
- * What a payment actually came to, as the PROVIDER reports it. Every figure is
53
- * nullable and that is the contract: "the fee was zero" and "the fee is not
54
- * known yet" are different facts, and `status` says which produced the nulls.
55
- * It reports what the provider took; it attributes that cost to nobody.
53
+ * One movement of the settlement balance, as the PROVIDER reports it: what a
54
+ * payment brought in (`GET /v1/payment_intents/{intentId}/settlement`), what a
55
+ * refund took out (`GET /v1/refunds/{id}/settlement`) or what a dispute
56
+ * withdrew (`GET /v1/disputes/{disputeId}/settlement`). `refund` and `dispute`
57
+ * say which: both `null` for a payment's.
58
+ *
59
+ * Every figure is nullable and that is the contract: "the fee was zero" and
60
+ * "the fee is not known yet" are different facts, and `status` says which
61
+ * produced the nulls. It reports what the provider took; it attributes that
62
+ * cost to nobody.
63
+ *
64
+ * The signs: `gross` is the MAGNITUDE of the movement, `fee` the provider's fee
65
+ * on it (positive when charged, negative when returned), `net` its SIGNED
66
+ * effect on the balance — so `net = gross − fee` for a payment and
67
+ * `net = −gross − fee` for a refund or a dispute.
56
68
  */
57
69
  export declare const settlementSchema: z.ZodObject<{
58
70
  object: z.ZodLiteral<"settlement">;
59
71
  livemode: z.ZodBoolean;
60
72
  payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
73
+ refund: z.ZodNullable<z.ZodType<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">, z.core.$ZodTypeInternals<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">>>>;
74
+ dispute: z.ZodNullable<z.ZodType<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">, z.core.$ZodTypeInternals<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">>>>;
61
75
  status: z.ZodEnum<{
62
76
  unknown: "unknown";
63
77
  pending: "pending";
@@ -601,6 +615,8 @@ export declare const refundRoutes: readonly [{
601
615
  object: z.ZodLiteral<"settlement">;
602
616
  livemode: z.ZodBoolean;
603
617
  payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
618
+ refund: z.ZodNullable<z.ZodType<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">, z.core.$ZodTypeInternals<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">>>>;
619
+ dispute: z.ZodNullable<z.ZodType<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">, z.core.$ZodTypeInternals<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">>>>;
604
620
  status: z.ZodEnum<{
605
621
  unknown: "unknown";
606
622
  pending: "pending";
@@ -615,6 +631,41 @@ export declare const refundRoutes: readonly [{
615
631
  }, z.core.$strict>;
616
632
  readonly sdk: "refunds.settlement";
617
633
  readonly expandable: "settlement";
634
+ }, {
635
+ readonly operationId: "retrieveRefundSettlement";
636
+ readonly method: "get";
637
+ readonly path: "/v1/refunds/{id}/settlement";
638
+ readonly tag: "Refunds";
639
+ readonly summary: "Retrieve a refund's settlement";
640
+ readonly description: "What the refund took off the settlement balance — `gross`, `fee`, a negative `net` — in the settlement currency, read live from the provider. A missing figure is `null` with a `status`, never `0`; a refund that failed or was canceled is `unknown`.";
641
+ readonly auth: "service";
642
+ readonly scope: "payments:read";
643
+ readonly params: {
644
+ id: string;
645
+ };
646
+ readonly query: z.ZodObject<{
647
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
648
+ }, z.core.$strict>;
649
+ readonly response: z.ZodObject<{
650
+ object: z.ZodLiteral<"settlement">;
651
+ livemode: z.ZodBoolean;
652
+ payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
653
+ refund: z.ZodNullable<z.ZodType<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">, z.core.$ZodTypeInternals<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">>>>;
654
+ dispute: z.ZodNullable<z.ZodType<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">, z.core.$ZodTypeInternals<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">>>>;
655
+ status: z.ZodEnum<{
656
+ unknown: "unknown";
657
+ pending: "pending";
658
+ available: "available";
659
+ }>;
660
+ gross: z.ZodNullable<z.ZodString>;
661
+ fee: z.ZodNullable<z.ZodString>;
662
+ net: z.ZodNullable<z.ZodString>;
663
+ currency: z.ZodNullable<z.ZodString>;
664
+ available_on: z.ZodNullable<z.ZodNumber>;
665
+ exchange_rate: z.ZodNullable<z.ZodNumber>;
666
+ }, z.core.$strict>;
667
+ readonly sdk: "refunds.refundSettlement";
668
+ readonly expandable: "settlement";
618
669
  }, {
619
670
  readonly operationId: "searchRefunds";
620
671
  readonly method: "get";
@@ -150,6 +150,37 @@ export declare const paymentIntentTestHelperRoutes: readonly [{
150
150
  txid: z.ZodNullable<z.ZodString>;
151
151
  confirmations: z.ZodNumber;
152
152
  required_confirmations: z.ZodNumber;
153
+ quote: z.ZodNullable<z.ZodObject<{
154
+ currency: z.ZodEnum<{
155
+ EUR: "EUR";
156
+ USD: "USD";
157
+ GBP: "GBP";
158
+ CHF: "CHF";
159
+ SEK: "SEK";
160
+ NOK: "NOK";
161
+ DKK: "DKK";
162
+ PLN: "PLN";
163
+ CZK: "CZK";
164
+ CAD: "CAD";
165
+ AUD: "AUD";
166
+ JPY: "JPY";
167
+ }>;
168
+ amount: z.ZodString;
169
+ rate: z.ZodString;
170
+ price: z.ZodObject<{
171
+ source: z.ZodLiteral<"wfair-base">;
172
+ usd_per_fair: z.ZodString;
173
+ observed_at: z.ZodNumber;
174
+ }, z.core.$strict>;
175
+ reference_rates: z.ZodNullable<z.ZodObject<{
176
+ source: z.ZodLiteral<"ecb">;
177
+ usd_per_eur: z.ZodString;
178
+ currency_per_eur: z.ZodString;
179
+ observed_at: z.ZodNumber;
180
+ }, z.core.$strict>>;
181
+ quoted_at: z.ZodNumber;
182
+ expires_at: z.ZodNumber;
183
+ }, z.core.$strict>>;
153
184
  }, z.core.$strict>>;
154
185
  merchant_id: z.ZodString;
155
186
  connected_account: z.ZodNullable<z.ZodType<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">, z.core.$ZodTypeInternals<string | import("../..").Ref<"connected_account">, string | import("../..").Ref<"connected_account">>>>;
@@ -7,8 +7,8 @@ import { type Expand } from '../../common/objects';
7
7
  export declare const taxDeadlineSchema: z.ZodObject<{
8
8
  object: z.ZodLiteral<"tax.deadline">;
9
9
  kind: z.ZodEnum<{
10
- return: "return";
11
10
  payment: "payment";
11
+ return: "return";
12
12
  registration: "registration";
13
13
  }>;
14
14
  rule: z.ZodString;
@@ -50,8 +50,8 @@ export declare const taxDeadlineListSchema: z.ZodObject<{
50
50
  data: z.ZodArray<z.ZodObject<{
51
51
  object: z.ZodLiteral<"tax.deadline">;
52
52
  kind: z.ZodEnum<{
53
- return: "return";
54
53
  payment: "payment";
54
+ return: "return";
55
55
  registration: "registration";
56
56
  }>;
57
57
  rule: z.ZodString;
@@ -97,8 +97,8 @@ export declare const taxDeadlineRoutes: readonly [{
97
97
  data: z.ZodArray<z.ZodObject<{
98
98
  object: z.ZodLiteral<"tax.deadline">;
99
99
  kind: z.ZodEnum<{
100
- return: "return";
101
100
  payment: "payment";
101
+ return: "return";
102
102
  registration: "registration";
103
103
  }>;
104
104
  rule: z.ZodString;
@@ -108,9 +108,9 @@ export declare const taxRoutes: readonly [{
108
108
  expires_at: import("zod").ZodNullable<import("zod").ZodNumber>;
109
109
  status: import("zod").ZodEnum<{
110
110
  active: "active";
111
+ expired: "expired";
111
112
  pending_approval: "pending_approval";
112
113
  scheduled: "scheduled";
113
- expired: "expired";
114
114
  }>;
115
115
  approved_at: import("zod").ZodNullable<import("zod").ZodNumber>;
116
116
  provider_registration_ref: import("zod").ZodNullable<import("zod").ZodString>;
@@ -1275,8 +1275,8 @@ export declare const taxRoutes: readonly [{
1275
1275
  data: import("zod").ZodArray<import("zod").ZodObject<{
1276
1276
  object: import("zod").ZodLiteral<"tax.deadline">;
1277
1277
  kind: import("zod").ZodEnum<{
1278
- return: "return";
1279
1278
  payment: "payment";
1279
+ return: "return";
1280
1280
  registration: "registration";
1281
1281
  }>;
1282
1282
  rule: import("zod").ZodString;
@@ -23,9 +23,9 @@ export declare const taxRegistrationSchema: z.ZodObject<{
23
23
  expires_at: z.ZodNullable<z.ZodNumber>;
24
24
  status: z.ZodEnum<{
25
25
  active: "active";
26
+ expired: "expired";
26
27
  pending_approval: "pending_approval";
27
28
  scheduled: "scheduled";
28
- expired: "expired";
29
29
  }>;
30
30
  approved_at: z.ZodNullable<z.ZodNumber>;
31
31
  provider_registration_ref: z.ZodNullable<z.ZodString>;
@@ -88,9 +88,9 @@ export declare const taxRegistrationRoutes: readonly [{
88
88
  expires_at: z.ZodNullable<z.ZodNumber>;
89
89
  status: z.ZodEnum<{
90
90
  active: "active";
91
+ expired: "expired";
91
92
  pending_approval: "pending_approval";
92
93
  scheduled: "scheduled";
93
- expired: "expired";
94
94
  }>;
95
95
  approved_at: z.ZodNullable<z.ZodNumber>;
96
96
  provider_registration_ref: z.ZodNullable<z.ZodString>;