@peable.to/contracts 4.1.0 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/dist/cjs/resources/checkout/checkoutSessions.js +22 -1
  2. package/dist/cjs/resources/payments/paymentIntents.js +42 -5
  3. package/dist/cjs/resources/payments/social.js +6 -1
  4. package/dist/cjs/vocabulary/errors.js +1 -0
  5. package/dist/cjs/vocabulary/payments.js +7 -2
  6. package/dist/esm/resources/checkout/checkoutSessions.js +22 -1
  7. package/dist/esm/resources/payments/paymentIntents.js +41 -4
  8. package/dist/esm/resources/payments/social.js +6 -1
  9. package/dist/esm/vocabulary/errors.js +1 -0
  10. package/dist/esm/vocabulary/payments.js +7 -2
  11. package/dist/types/resources/checkout/checkoutSessions.d.ts +9 -0
  12. package/dist/types/resources/checkout/index.d.ts +4 -0
  13. package/dist/types/resources/payments/index.d.ts +142 -30
  14. package/dist/types/resources/payments/paymentIntents.d.ts +159 -33
  15. package/dist/types/resources/payments/social.d.ts +3 -0
  16. package/dist/types/resources/payments/testHelpers.d.ts +14 -3
  17. package/dist/types/vocabulary/errors.d.ts +1 -0
  18. package/dist/types/vocabulary/payments.d.ts +7 -3
  19. package/package.json +1 -1
package/dist/types/resources/payments/paymentIntents.d.ts CHANGED
@@ -17,6 +17,12 @@ export declare const paymentErrorSchema: z.ZodObject<{
17
17
  message: z.ZodString;
18
18
  }, z.core.$strict>;
19
19
  export type PaymentIntentLastPaymentError = z.output<typeof paymentErrorSchema>;
20
+ /** One output of a FairCoin payment, as the payer pays it (ADR 0021 D6). */
21
+ export declare const faircoinPaymentOutputSchema: z.ZodObject<{
22
+ address: z.ZodString;
23
+ amount: z.ZodString;
24
+ }, z.core.$strict>;
25
+ export type FaircoinPaymentOutput = z.output<typeof faircoinPaymentOutputSchema>;
20
26
  /**
21
27
  * What the payer must do next (`status: 'requires_action'`).
22
28
  *
@@ -29,14 +35,18 @@ export type PaymentIntentLastPaymentError = z.output<typeof paymentErrorSchema>;
29
35
  export declare const paymentIntentNextActionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
30
36
  type: z.ZodLiteral<"faircoin_payment">;
31
37
  faircoin_payment: z.ZodObject<{
32
- address: z.ZodString;
38
+ address: z.ZodNullable<z.ZodString>;
33
39
  network: z.ZodEnum<{
34
40
  mainnet: "mainnet";
35
41
  testnet: "testnet";
36
42
  }>;
37
43
  amount: z.ZodString;
38
44
  currency: z.ZodLiteral<"FAIR">;
39
- uri: z.ZodString;
45
+ uri: z.ZodNullable<z.ZodString>;
46
+ outputs: z.ZodArray<z.ZodObject<{
47
+ address: z.ZodString;
48
+ amount: z.ZodString;
49
+ }, z.core.$strict>>;
40
50
  }, z.core.$strict>;
41
51
  }, z.core.$strict>, z.ZodObject<{
42
52
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -91,7 +101,12 @@ export declare const paymentIntentFaircoinSchema: z.ZodObject<{
91
101
  mainnet: "mainnet";
92
102
  testnet: "testnet";
93
103
  }>;
94
- address: z.ZodString;
104
+ address: z.ZodNullable<z.ZodString>;
105
+ outputs: z.ZodArray<z.ZodObject<{
106
+ address: z.ZodString;
107
+ amount: z.ZodString;
108
+ connected_account: z.ZodNullable<z.ZodString>;
109
+ }, z.core.$strict>>;
95
110
  txid: z.ZodNullable<z.ZodString>;
96
111
  confirmations: z.ZodNumber;
97
112
  required_confirmations: z.ZodNumber;
@@ -126,6 +141,7 @@ export declare const paymentIntentFaircoinSchema: z.ZodObject<{
126
141
  quoted_at: z.ZodNumber;
127
142
  expires_at: z.ZodNumber;
128
143
  }, z.core.$strict>>;
144
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
129
145
  }, z.core.$strict>;
130
146
  export type PaymentIntentFaircoin = z.output<typeof paymentIntentFaircoinSchema>;
131
147
  /** Where a destination charge's funds go (`transfer_data`, ADR 0015 §2). */
@@ -219,14 +235,18 @@ export declare const paymentIntentSchema: z.ZodObject<{
219
235
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
220
236
  type: z.ZodLiteral<"faircoin_payment">;
221
237
  faircoin_payment: z.ZodObject<{
222
- address: z.ZodString;
238
+ address: z.ZodNullable<z.ZodString>;
223
239
  network: z.ZodEnum<{
224
240
  mainnet: "mainnet";
225
241
  testnet: "testnet";
226
242
  }>;
227
243
  amount: z.ZodString;
228
244
  currency: z.ZodLiteral<"FAIR">;
229
- uri: z.ZodString;
245
+ uri: z.ZodNullable<z.ZodString>;
246
+ outputs: z.ZodArray<z.ZodObject<{
247
+ address: z.ZodString;
248
+ amount: z.ZodString;
249
+ }, z.core.$strict>>;
230
250
  }, z.core.$strict>;
231
251
  }, z.core.$strict>, z.ZodObject<{
232
252
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -246,6 +266,7 @@ export declare const paymentIntentSchema: z.ZodObject<{
246
266
  fraudulent: "fraudulent";
247
267
  abandoned: "abandoned";
248
268
  automatic: "automatic";
269
+ recipient_key_changed: "recipient_key_changed";
249
270
  requested_by_customer: "requested_by_customer";
250
271
  underpaid: "underpaid";
251
272
  }>>;
@@ -272,7 +293,12 @@ export declare const paymentIntentSchema: z.ZodObject<{
272
293
  mainnet: "mainnet";
273
294
  testnet: "testnet";
274
295
  }>;
275
- address: z.ZodString;
296
+ address: z.ZodNullable<z.ZodString>;
297
+ outputs: z.ZodArray<z.ZodObject<{
298
+ address: z.ZodString;
299
+ amount: z.ZodString;
300
+ connected_account: z.ZodNullable<z.ZodString>;
301
+ }, z.core.$strict>>;
276
302
  txid: z.ZodNullable<z.ZodString>;
277
303
  confirmations: z.ZodNumber;
278
304
  required_confirmations: z.ZodNumber;
@@ -307,6 +333,7 @@ export declare const paymentIntentSchema: z.ZodObject<{
307
333
  quoted_at: z.ZodNumber;
308
334
  expires_at: z.ZodNumber;
309
335
  }, z.core.$strict>>;
336
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
310
337
  }, z.core.$strict>>;
311
338
  merchant_id: z.ZodString;
312
339
  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">>>>;
@@ -716,14 +743,18 @@ export declare const paymentIntentRoutes: readonly [{
716
743
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
717
744
  type: z.ZodLiteral<"faircoin_payment">;
718
745
  faircoin_payment: z.ZodObject<{
719
- address: z.ZodString;
746
+ address: z.ZodNullable<z.ZodString>;
720
747
  network: z.ZodEnum<{
721
748
  mainnet: "mainnet";
722
749
  testnet: "testnet";
723
750
  }>;
724
751
  amount: z.ZodString;
725
752
  currency: z.ZodLiteral<"FAIR">;
726
- uri: z.ZodString;
753
+ uri: z.ZodNullable<z.ZodString>;
754
+ outputs: z.ZodArray<z.ZodObject<{
755
+ address: z.ZodString;
756
+ amount: z.ZodString;
757
+ }, z.core.$strict>>;
727
758
  }, z.core.$strict>;
728
759
  }, z.core.$strict>, z.ZodObject<{
729
760
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -743,6 +774,7 @@ export declare const paymentIntentRoutes: readonly [{
743
774
  fraudulent: "fraudulent";
744
775
  abandoned: "abandoned";
745
776
  automatic: "automatic";
777
+ recipient_key_changed: "recipient_key_changed";
746
778
  requested_by_customer: "requested_by_customer";
747
779
  underpaid: "underpaid";
748
780
  }>>;
@@ -769,7 +801,12 @@ export declare const paymentIntentRoutes: readonly [{
769
801
  mainnet: "mainnet";
770
802
  testnet: "testnet";
771
803
  }>;
772
- address: z.ZodString;
804
+ address: z.ZodNullable<z.ZodString>;
805
+ outputs: z.ZodArray<z.ZodObject<{
806
+ address: z.ZodString;
807
+ amount: z.ZodString;
808
+ connected_account: z.ZodNullable<z.ZodString>;
809
+ }, z.core.$strict>>;
773
810
  txid: z.ZodNullable<z.ZodString>;
774
811
  confirmations: z.ZodNumber;
775
812
  required_confirmations: z.ZodNumber;
@@ -804,6 +841,7 @@ export declare const paymentIntentRoutes: readonly [{
804
841
  quoted_at: z.ZodNumber;
805
842
  expires_at: z.ZodNumber;
806
843
  }, z.core.$strict>>;
844
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
807
845
  }, z.core.$strict>>;
808
846
  merchant_id: z.ZodString;
809
847
  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">>>>;
@@ -929,14 +967,18 @@ export declare const paymentIntentRoutes: readonly [{
929
967
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
930
968
  type: z.ZodLiteral<"faircoin_payment">;
931
969
  faircoin_payment: z.ZodObject<{
932
- address: z.ZodString;
970
+ address: z.ZodNullable<z.ZodString>;
933
971
  network: z.ZodEnum<{
934
972
  mainnet: "mainnet";
935
973
  testnet: "testnet";
936
974
  }>;
937
975
  amount: z.ZodString;
938
976
  currency: z.ZodLiteral<"FAIR">;
939
- uri: z.ZodString;
977
+ uri: z.ZodNullable<z.ZodString>;
978
+ outputs: z.ZodArray<z.ZodObject<{
979
+ address: z.ZodString;
980
+ amount: z.ZodString;
981
+ }, z.core.$strict>>;
940
982
  }, z.core.$strict>;
941
983
  }, z.core.$strict>, z.ZodObject<{
942
984
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -956,6 +998,7 @@ export declare const paymentIntentRoutes: readonly [{
956
998
  fraudulent: "fraudulent";
957
999
  abandoned: "abandoned";
958
1000
  automatic: "automatic";
1001
+ recipient_key_changed: "recipient_key_changed";
959
1002
  requested_by_customer: "requested_by_customer";
960
1003
  underpaid: "underpaid";
961
1004
  }>>;
@@ -982,7 +1025,12 @@ export declare const paymentIntentRoutes: readonly [{
982
1025
  mainnet: "mainnet";
983
1026
  testnet: "testnet";
984
1027
  }>;
985
- address: z.ZodString;
1028
+ address: z.ZodNullable<z.ZodString>;
1029
+ outputs: z.ZodArray<z.ZodObject<{
1030
+ address: z.ZodString;
1031
+ amount: z.ZodString;
1032
+ connected_account: z.ZodNullable<z.ZodString>;
1033
+ }, z.core.$strict>>;
986
1034
  txid: z.ZodNullable<z.ZodString>;
987
1035
  confirmations: z.ZodNumber;
988
1036
  required_confirmations: z.ZodNumber;
@@ -1017,6 +1065,7 @@ export declare const paymentIntentRoutes: readonly [{
1017
1065
  quoted_at: z.ZodNumber;
1018
1066
  expires_at: z.ZodNumber;
1019
1067
  }, z.core.$strict>>;
1068
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
1020
1069
  }, z.core.$strict>>;
1021
1070
  merchant_id: z.ZodString;
1022
1071
  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">>>>;
@@ -1123,14 +1172,18 @@ export declare const paymentIntentRoutes: readonly [{
1123
1172
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
1124
1173
  type: z.ZodLiteral<"faircoin_payment">;
1125
1174
  faircoin_payment: z.ZodObject<{
1126
- address: z.ZodString;
1175
+ address: z.ZodNullable<z.ZodString>;
1127
1176
  network: z.ZodEnum<{
1128
1177
  mainnet: "mainnet";
1129
1178
  testnet: "testnet";
1130
1179
  }>;
1131
1180
  amount: z.ZodString;
1132
1181
  currency: z.ZodLiteral<"FAIR">;
1133
- uri: z.ZodString;
1182
+ uri: z.ZodNullable<z.ZodString>;
1183
+ outputs: z.ZodArray<z.ZodObject<{
1184
+ address: z.ZodString;
1185
+ amount: z.ZodString;
1186
+ }, z.core.$strict>>;
1134
1187
  }, z.core.$strict>;
1135
1188
  }, z.core.$strict>, z.ZodObject<{
1136
1189
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -1150,6 +1203,7 @@ export declare const paymentIntentRoutes: readonly [{
1150
1203
  fraudulent: "fraudulent";
1151
1204
  abandoned: "abandoned";
1152
1205
  automatic: "automatic";
1206
+ recipient_key_changed: "recipient_key_changed";
1153
1207
  requested_by_customer: "requested_by_customer";
1154
1208
  underpaid: "underpaid";
1155
1209
  }>>;
@@ -1176,7 +1230,12 @@ export declare const paymentIntentRoutes: readonly [{
1176
1230
  mainnet: "mainnet";
1177
1231
  testnet: "testnet";
1178
1232
  }>;
1179
- address: z.ZodString;
1233
+ address: z.ZodNullable<z.ZodString>;
1234
+ outputs: z.ZodArray<z.ZodObject<{
1235
+ address: z.ZodString;
1236
+ amount: z.ZodString;
1237
+ connected_account: z.ZodNullable<z.ZodString>;
1238
+ }, z.core.$strict>>;
1180
1239
  txid: z.ZodNullable<z.ZodString>;
1181
1240
  confirmations: z.ZodNumber;
1182
1241
  required_confirmations: z.ZodNumber;
@@ -1211,6 +1270,7 @@ export declare const paymentIntentRoutes: readonly [{
1211
1270
  quoted_at: z.ZodNumber;
1212
1271
  expires_at: z.ZodNumber;
1213
1272
  }, z.core.$strict>>;
1273
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
1214
1274
  }, z.core.$strict>>;
1215
1275
  merchant_id: z.ZodString;
1216
1276
  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">>>>;
@@ -1331,14 +1391,18 @@ export declare const paymentIntentRoutes: readonly [{
1331
1391
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
1332
1392
  type: z.ZodLiteral<"faircoin_payment">;
1333
1393
  faircoin_payment: z.ZodObject<{
1334
- address: z.ZodString;
1394
+ address: z.ZodNullable<z.ZodString>;
1335
1395
  network: z.ZodEnum<{
1336
1396
  mainnet: "mainnet";
1337
1397
  testnet: "testnet";
1338
1398
  }>;
1339
1399
  amount: z.ZodString;
1340
1400
  currency: z.ZodLiteral<"FAIR">;
1341
- uri: z.ZodString;
1401
+ uri: z.ZodNullable<z.ZodString>;
1402
+ outputs: z.ZodArray<z.ZodObject<{
1403
+ address: z.ZodString;
1404
+ amount: z.ZodString;
1405
+ }, z.core.$strict>>;
1342
1406
  }, z.core.$strict>;
1343
1407
  }, z.core.$strict>, z.ZodObject<{
1344
1408
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -1358,6 +1422,7 @@ export declare const paymentIntentRoutes: readonly [{
1358
1422
  fraudulent: "fraudulent";
1359
1423
  abandoned: "abandoned";
1360
1424
  automatic: "automatic";
1425
+ recipient_key_changed: "recipient_key_changed";
1361
1426
  requested_by_customer: "requested_by_customer";
1362
1427
  underpaid: "underpaid";
1363
1428
  }>>;
@@ -1384,7 +1449,12 @@ export declare const paymentIntentRoutes: readonly [{
1384
1449
  mainnet: "mainnet";
1385
1450
  testnet: "testnet";
1386
1451
  }>;
1387
- address: z.ZodString;
1452
+ address: z.ZodNullable<z.ZodString>;
1453
+ outputs: z.ZodArray<z.ZodObject<{
1454
+ address: z.ZodString;
1455
+ amount: z.ZodString;
1456
+ connected_account: z.ZodNullable<z.ZodString>;
1457
+ }, z.core.$strict>>;
1388
1458
  txid: z.ZodNullable<z.ZodString>;
1389
1459
  confirmations: z.ZodNumber;
1390
1460
  required_confirmations: z.ZodNumber;
@@ -1419,6 +1489,7 @@ export declare const paymentIntentRoutes: readonly [{
1419
1489
  quoted_at: z.ZodNumber;
1420
1490
  expires_at: z.ZodNumber;
1421
1491
  }, z.core.$strict>>;
1492
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
1422
1493
  }, z.core.$strict>>;
1423
1494
  merchant_id: z.ZodString;
1424
1495
  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">>>>;
@@ -1569,14 +1640,18 @@ export declare const paymentIntentRoutes: readonly [{
1569
1640
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
1570
1641
  type: z.ZodLiteral<"faircoin_payment">;
1571
1642
  faircoin_payment: z.ZodObject<{
1572
- address: z.ZodString;
1643
+ address: z.ZodNullable<z.ZodString>;
1573
1644
  network: z.ZodEnum<{
1574
1645
  mainnet: "mainnet";
1575
1646
  testnet: "testnet";
1576
1647
  }>;
1577
1648
  amount: z.ZodString;
1578
1649
  currency: z.ZodLiteral<"FAIR">;
1579
- uri: z.ZodString;
1650
+ uri: z.ZodNullable<z.ZodString>;
1651
+ outputs: z.ZodArray<z.ZodObject<{
1652
+ address: z.ZodString;
1653
+ amount: z.ZodString;
1654
+ }, z.core.$strict>>;
1580
1655
  }, z.core.$strict>;
1581
1656
  }, z.core.$strict>, z.ZodObject<{
1582
1657
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -1596,6 +1671,7 @@ export declare const paymentIntentRoutes: readonly [{
1596
1671
  fraudulent: "fraudulent";
1597
1672
  abandoned: "abandoned";
1598
1673
  automatic: "automatic";
1674
+ recipient_key_changed: "recipient_key_changed";
1599
1675
  requested_by_customer: "requested_by_customer";
1600
1676
  underpaid: "underpaid";
1601
1677
  }>>;
@@ -1622,7 +1698,12 @@ export declare const paymentIntentRoutes: readonly [{
1622
1698
  mainnet: "mainnet";
1623
1699
  testnet: "testnet";
1624
1700
  }>;
1625
- address: z.ZodString;
1701
+ address: z.ZodNullable<z.ZodString>;
1702
+ outputs: z.ZodArray<z.ZodObject<{
1703
+ address: z.ZodString;
1704
+ amount: z.ZodString;
1705
+ connected_account: z.ZodNullable<z.ZodString>;
1706
+ }, z.core.$strict>>;
1626
1707
  txid: z.ZodNullable<z.ZodString>;
1627
1708
  confirmations: z.ZodNumber;
1628
1709
  required_confirmations: z.ZodNumber;
@@ -1657,6 +1738,7 @@ export declare const paymentIntentRoutes: readonly [{
1657
1738
  quoted_at: z.ZodNumber;
1658
1739
  expires_at: z.ZodNumber;
1659
1740
  }, z.core.$strict>>;
1741
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
1660
1742
  }, z.core.$strict>>;
1661
1743
  merchant_id: z.ZodString;
1662
1744
  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">>>>;
@@ -1761,14 +1843,18 @@ export declare const paymentIntentRoutes: readonly [{
1761
1843
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
1762
1844
  type: z.ZodLiteral<"faircoin_payment">;
1763
1845
  faircoin_payment: z.ZodObject<{
1764
- address: z.ZodString;
1846
+ address: z.ZodNullable<z.ZodString>;
1765
1847
  network: z.ZodEnum<{
1766
1848
  mainnet: "mainnet";
1767
1849
  testnet: "testnet";
1768
1850
  }>;
1769
1851
  amount: z.ZodString;
1770
1852
  currency: z.ZodLiteral<"FAIR">;
1771
- uri: z.ZodString;
1853
+ uri: z.ZodNullable<z.ZodString>;
1854
+ outputs: z.ZodArray<z.ZodObject<{
1855
+ address: z.ZodString;
1856
+ amount: z.ZodString;
1857
+ }, z.core.$strict>>;
1772
1858
  }, z.core.$strict>;
1773
1859
  }, z.core.$strict>, z.ZodObject<{
1774
1860
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -1788,6 +1874,7 @@ export declare const paymentIntentRoutes: readonly [{
1788
1874
  fraudulent: "fraudulent";
1789
1875
  abandoned: "abandoned";
1790
1876
  automatic: "automatic";
1877
+ recipient_key_changed: "recipient_key_changed";
1791
1878
  requested_by_customer: "requested_by_customer";
1792
1879
  underpaid: "underpaid";
1793
1880
  }>>;
@@ -1814,7 +1901,12 @@ export declare const paymentIntentRoutes: readonly [{
1814
1901
  mainnet: "mainnet";
1815
1902
  testnet: "testnet";
1816
1903
  }>;
1817
- address: z.ZodString;
1904
+ address: z.ZodNullable<z.ZodString>;
1905
+ outputs: z.ZodArray<z.ZodObject<{
1906
+ address: z.ZodString;
1907
+ amount: z.ZodString;
1908
+ connected_account: z.ZodNullable<z.ZodString>;
1909
+ }, z.core.$strict>>;
1818
1910
  txid: z.ZodNullable<z.ZodString>;
1819
1911
  confirmations: z.ZodNumber;
1820
1912
  required_confirmations: z.ZodNumber;
@@ -1849,6 +1941,7 @@ export declare const paymentIntentRoutes: readonly [{
1849
1941
  quoted_at: z.ZodNumber;
1850
1942
  expires_at: z.ZodNumber;
1851
1943
  }, z.core.$strict>>;
1944
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
1852
1945
  }, z.core.$strict>>;
1853
1946
  merchant_id: z.ZodString;
1854
1947
  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">>>>;
@@ -1958,14 +2051,18 @@ export declare const paymentIntentRoutes: readonly [{
1958
2051
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
1959
2052
  type: z.ZodLiteral<"faircoin_payment">;
1960
2053
  faircoin_payment: z.ZodObject<{
1961
- address: z.ZodString;
2054
+ address: z.ZodNullable<z.ZodString>;
1962
2055
  network: z.ZodEnum<{
1963
2056
  mainnet: "mainnet";
1964
2057
  testnet: "testnet";
1965
2058
  }>;
1966
2059
  amount: z.ZodString;
1967
2060
  currency: z.ZodLiteral<"FAIR">;
1968
- uri: z.ZodString;
2061
+ uri: z.ZodNullable<z.ZodString>;
2062
+ outputs: z.ZodArray<z.ZodObject<{
2063
+ address: z.ZodString;
2064
+ amount: z.ZodString;
2065
+ }, z.core.$strict>>;
1969
2066
  }, z.core.$strict>;
1970
2067
  }, z.core.$strict>, z.ZodObject<{
1971
2068
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -1985,6 +2082,7 @@ export declare const paymentIntentRoutes: readonly [{
1985
2082
  fraudulent: "fraudulent";
1986
2083
  abandoned: "abandoned";
1987
2084
  automatic: "automatic";
2085
+ recipient_key_changed: "recipient_key_changed";
1988
2086
  requested_by_customer: "requested_by_customer";
1989
2087
  underpaid: "underpaid";
1990
2088
  }>>;
@@ -2011,7 +2109,12 @@ export declare const paymentIntentRoutes: readonly [{
2011
2109
  mainnet: "mainnet";
2012
2110
  testnet: "testnet";
2013
2111
  }>;
2014
- address: z.ZodString;
2112
+ address: z.ZodNullable<z.ZodString>;
2113
+ outputs: z.ZodArray<z.ZodObject<{
2114
+ address: z.ZodString;
2115
+ amount: z.ZodString;
2116
+ connected_account: z.ZodNullable<z.ZodString>;
2117
+ }, z.core.$strict>>;
2015
2118
  txid: z.ZodNullable<z.ZodString>;
2016
2119
  confirmations: z.ZodNumber;
2017
2120
  required_confirmations: z.ZodNumber;
@@ -2046,6 +2149,7 @@ export declare const paymentIntentRoutes: readonly [{
2046
2149
  quoted_at: z.ZodNumber;
2047
2150
  expires_at: z.ZodNumber;
2048
2151
  }, z.core.$strict>>;
2152
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
2049
2153
  }, z.core.$strict>>;
2050
2154
  merchant_id: z.ZodString;
2051
2155
  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">>>>;
@@ -2148,14 +2252,18 @@ export declare const paymentIntentRoutes: readonly [{
2148
2252
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
2149
2253
  type: z.ZodLiteral<"faircoin_payment">;
2150
2254
  faircoin_payment: z.ZodObject<{
2151
- address: z.ZodString;
2255
+ address: z.ZodNullable<z.ZodString>;
2152
2256
  network: z.ZodEnum<{
2153
2257
  mainnet: "mainnet";
2154
2258
  testnet: "testnet";
2155
2259
  }>;
2156
2260
  amount: z.ZodString;
2157
2261
  currency: z.ZodLiteral<"FAIR">;
2158
- uri: z.ZodString;
2262
+ uri: z.ZodNullable<z.ZodString>;
2263
+ outputs: z.ZodArray<z.ZodObject<{
2264
+ address: z.ZodString;
2265
+ amount: z.ZodString;
2266
+ }, z.core.$strict>>;
2159
2267
  }, z.core.$strict>;
2160
2268
  }, z.core.$strict>, z.ZodObject<{
2161
2269
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -2175,6 +2283,7 @@ export declare const paymentIntentRoutes: readonly [{
2175
2283
  fraudulent: "fraudulent";
2176
2284
  abandoned: "abandoned";
2177
2285
  automatic: "automatic";
2286
+ recipient_key_changed: "recipient_key_changed";
2178
2287
  requested_by_customer: "requested_by_customer";
2179
2288
  underpaid: "underpaid";
2180
2289
  }>>;
@@ -2201,7 +2310,12 @@ export declare const paymentIntentRoutes: readonly [{
2201
2310
  mainnet: "mainnet";
2202
2311
  testnet: "testnet";
2203
2312
  }>;
2204
- address: z.ZodString;
2313
+ address: z.ZodNullable<z.ZodString>;
2314
+ outputs: z.ZodArray<z.ZodObject<{
2315
+ address: z.ZodString;
2316
+ amount: z.ZodString;
2317
+ connected_account: z.ZodNullable<z.ZodString>;
2318
+ }, z.core.$strict>>;
2205
2319
  txid: z.ZodNullable<z.ZodString>;
2206
2320
  confirmations: z.ZodNumber;
2207
2321
  required_confirmations: z.ZodNumber;
@@ -2236,6 +2350,7 @@ export declare const paymentIntentRoutes: readonly [{
2236
2350
  quoted_at: z.ZodNumber;
2237
2351
  expires_at: z.ZodNumber;
2238
2352
  }, z.core.$strict>>;
2353
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
2239
2354
  }, z.core.$strict>>;
2240
2355
  merchant_id: z.ZodString;
2241
2356
  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">>>>;
@@ -2338,14 +2453,18 @@ export declare const paymentIntentRoutes: readonly [{
2338
2453
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
2339
2454
  type: z.ZodLiteral<"faircoin_payment">;
2340
2455
  faircoin_payment: z.ZodObject<{
2341
- address: z.ZodString;
2456
+ address: z.ZodNullable<z.ZodString>;
2342
2457
  network: z.ZodEnum<{
2343
2458
  mainnet: "mainnet";
2344
2459
  testnet: "testnet";
2345
2460
  }>;
2346
2461
  amount: z.ZodString;
2347
2462
  currency: z.ZodLiteral<"FAIR">;
2348
- uri: z.ZodString;
2463
+ uri: z.ZodNullable<z.ZodString>;
2464
+ outputs: z.ZodArray<z.ZodObject<{
2465
+ address: z.ZodString;
2466
+ amount: z.ZodString;
2467
+ }, z.core.$strict>>;
2349
2468
  }, z.core.$strict>;
2350
2469
  }, z.core.$strict>, z.ZodObject<{
2351
2470
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -2365,6 +2484,7 @@ export declare const paymentIntentRoutes: readonly [{
2365
2484
  fraudulent: "fraudulent";
2366
2485
  abandoned: "abandoned";
2367
2486
  automatic: "automatic";
2487
+ recipient_key_changed: "recipient_key_changed";
2368
2488
  requested_by_customer: "requested_by_customer";
2369
2489
  underpaid: "underpaid";
2370
2490
  }>>;
@@ -2391,7 +2511,12 @@ export declare const paymentIntentRoutes: readonly [{
2391
2511
  mainnet: "mainnet";
2392
2512
  testnet: "testnet";
2393
2513
  }>;
2394
- address: z.ZodString;
2514
+ address: z.ZodNullable<z.ZodString>;
2515
+ outputs: z.ZodArray<z.ZodObject<{
2516
+ address: z.ZodString;
2517
+ amount: z.ZodString;
2518
+ connected_account: z.ZodNullable<z.ZodString>;
2519
+ }, z.core.$strict>>;
2395
2520
  txid: z.ZodNullable<z.ZodString>;
2396
2521
  confirmations: z.ZodNumber;
2397
2522
  required_confirmations: z.ZodNumber;
@@ -2426,6 +2551,7 @@ export declare const paymentIntentRoutes: readonly [{
2426
2551
  quoted_at: z.ZodNumber;
2427
2552
  expires_at: z.ZodNumber;
2428
2553
  }, z.core.$strict>>;
2554
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
2429
2555
  }, z.core.$strict>>;
2430
2556
  merchant_id: z.ZodString;
2431
2557
  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">>>>;
package/dist/types/resources/payments/social.d.ts CHANGED
@@ -76,6 +76,7 @@ export type SocialReceiveCursorParams = z.input<typeof socialReceiveCursorQuery>
76
76
  export declare const socialReceiveCursorSchema: z.ZodObject<{
77
77
  reserved_through: z.ZodNumber;
78
78
  identity_public_key: z.ZodNullable<z.ZodString>;
79
+ account_identity_public_key: z.ZodNullable<z.ZodString>;
79
80
  }, z.core.$strict>;
80
81
  export type SocialReceiveCursorResponse = z.output<typeof socialReceiveCursorSchema>;
81
82
  export declare const socialPaymentsQuery: z.ZodObject<{
@@ -190,6 +191,7 @@ export declare const socialRoutes: readonly [{
190
191
  readonly path: "/v1/social/me/cursor";
191
192
  readonly tag: "Social payments";
192
193
  readonly summary: "Retrieve the caller's receive cursor";
194
+ readonly description: "How far the caller's receive tree has been reserved, the key the last reservation used, and the caller's current `#key-1` read fresh from Oxy (ADR 0002). A 503 when Oxy cannot be asked for the current key.";
193
195
  readonly auth: "user";
194
196
  readonly query: z.ZodObject<{
195
197
  network: z.ZodEnum<{
@@ -200,6 +202,7 @@ export declare const socialRoutes: readonly [{
200
202
  readonly response: z.ZodObject<{
201
203
  reserved_through: z.ZodNumber;
202
204
  identity_public_key: z.ZodNullable<z.ZodString>;
205
+ account_identity_public_key: z.ZodNullable<z.ZodString>;
203
206
  }, z.core.$strict>;
204
207
  }, {
205
208
  readonly operationId: "listSocialPayments";
package/dist/types/resources/payments/testHelpers.d.ts CHANGED
@@ -93,14 +93,18 @@ export declare const paymentIntentTestHelperRoutes: readonly [{
93
93
  next_action: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
94
94
  type: z.ZodLiteral<"faircoin_payment">;
95
95
  faircoin_payment: z.ZodObject<{
96
- address: z.ZodString;
96
+ address: z.ZodNullable<z.ZodString>;
97
97
  network: z.ZodEnum<{
98
98
  mainnet: "mainnet";
99
99
  testnet: "testnet";
100
100
  }>;
101
101
  amount: z.ZodString;
102
102
  currency: z.ZodLiteral<"FAIR">;
103
- uri: z.ZodString;
103
+ uri: z.ZodNullable<z.ZodString>;
104
+ outputs: z.ZodArray<z.ZodObject<{
105
+ address: z.ZodString;
106
+ amount: z.ZodString;
107
+ }, z.core.$strict>>;
104
108
  }, z.core.$strict>;
105
109
  }, z.core.$strict>, z.ZodObject<{
106
110
  type: z.ZodLiteral<"use_peable_sdk">;
@@ -120,6 +124,7 @@ export declare const paymentIntentTestHelperRoutes: readonly [{
120
124
  fraudulent: "fraudulent";
121
125
  abandoned: "abandoned";
122
126
  automatic: "automatic";
127
+ recipient_key_changed: "recipient_key_changed";
123
128
  requested_by_customer: "requested_by_customer";
124
129
  underpaid: "underpaid";
125
130
  }>>;
@@ -146,7 +151,12 @@ export declare const paymentIntentTestHelperRoutes: readonly [{
146
151
  mainnet: "mainnet";
147
152
  testnet: "testnet";
148
153
  }>;
149
- address: z.ZodString;
154
+ address: z.ZodNullable<z.ZodString>;
155
+ outputs: z.ZodArray<z.ZodObject<{
156
+ address: z.ZodString;
157
+ amount: z.ZodString;
158
+ connected_account: z.ZodNullable<z.ZodString>;
159
+ }, z.core.$strict>>;
150
160
  txid: z.ZodNullable<z.ZodString>;
151
161
  confirmations: z.ZodNumber;
152
162
  required_confirmations: z.ZodNumber;
@@ -181,6 +191,7 @@ export declare const paymentIntentTestHelperRoutes: readonly [{
181
191
  quoted_at: z.ZodNumber;
182
192
  expires_at: z.ZodNumber;
183
193
  }, z.core.$strict>>;
194
+ recipient_key_replaced_at: z.ZodNullable<z.ZodNumber>;
184
195
  }, z.core.$strict>>;
185
196
  merchant_id: z.ZodString;
186
197
  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">>>>;
package/dist/types/vocabulary/errors.d.ts CHANGED
@@ -108,6 +108,7 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
108
108
  readonly faircoin_price_unavailable: "No fresh FairCoin price exists right now, so this order cannot be quoted in FAIR. The other payment methods still work; try FairCoin again shortly.";
109
109
  readonly faircoin_wallet_missing: "The Peable wallet that receives this payment (the merchant owner's, or the seller's) isn't set up yet, so it cannot be paid in FairCoin. The other payment methods still work.";
110
110
  readonly faircoin_network_closed: "FairCoin payments on this network are not open on this deployment yet. The other payment methods still work.";
111
+ readonly faircoin_amount_too_small: "One seller's share of this order is below the smallest amount the FairCoin network relays, so it cannot be paid in FairCoin. The other payment methods still work.";
111
112
  readonly credit_note_exceeds_invoice: "The credit note's amount exceeds what the invoice can still credit.";
112
113
  readonly test_clock_unexpected_state: "The test clock is advancing; wait until it is ready.";
113
114
  readonly meter_event_customer_missing: "The meter event names no customer of this merchant.";
package/dist/types/vocabulary/payments.d.ts CHANGED
@@ -13,10 +13,14 @@ export type PaymentIntentRail = (typeof PAYMENT_INTENT_RAILS)[number];
13
13
  export declare const PAYMENT_INTENT_STATUSES: readonly ["requires_payment_method", "requires_confirmation", "requires_action", "processing", "requires_capture", "succeeded", "canceled"];
14
14
  export type PaymentIntentStatus = (typeof PAYMENT_INTENT_STATUSES)[number];
15
15
  /**
16
- * Why an intent was cancelled — Stripe's reasons, plus `underpaid` (FairCoin
17
- * only: a transaction paid less than the amount).
16
+ * Why an intent was cancelled — Stripe's reasons, plus two FairCoin-only ones:
17
+ * `underpaid` (a transaction paid less than the amount) and
18
+ * `recipient_key_changed` (the recipient's identity key was replaced after the
19
+ * address was reserved, so the address is no longer in the wallet it pays —
20
+ * ADR 0002, amended 2026-11-06; nothing had been broadcast, and the order stays
21
+ * open for a fresh address).
18
22
  */
19
- export declare const PAYMENT_INTENT_CANCELLATION_REASONS: readonly ["abandoned", "automatic", "duplicate", "fraudulent", "requested_by_customer", "underpaid"];
23
+ export declare const PAYMENT_INTENT_CANCELLATION_REASONS: readonly ["abandoned", "automatic", "duplicate", "fraudulent", "recipient_key_changed", "requested_by_customer", "underpaid"];
20
24
  export type PaymentIntentCancellationReason = (typeof PAYMENT_INTENT_CANCELLATION_REASONS)[number];
21
25
  /** The reasons a MERCHANT may give `POST /v1/payment_intents/:id/cancel`. */
22
26
  export declare const MERCHANT_CANCELLATION_REASONS: readonly ["abandoned", "duplicate", "fraudulent", "requested_by_customer"];