@vexpay/node 0.8.0 → 0.10.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.
package/dist/index.d.ts CHANGED
@@ -76,8 +76,19 @@ interface components {
76
76
  /** @example 8650.00 */
77
77
  ledgerNetVes: string;
78
78
  /**
79
- * @description Tenant spendable float after reserve (seller obligations already deducted via SELLER_TRANSFER).
80
- * @example 8650.00
79
+ * @description VES under the 24h balance hold: incoming credits count in `ledgerNetVes` but cannot be paid out until their hold ends. Conversions and seller transfers may still use them.
80
+ * @example 4500.00
81
+ */
82
+ heldVes?: string;
83
+ /**
84
+ * Format: date-time
85
+ * @description When the soonest held amount becomes available; null when nothing is held.
86
+ * @example 2026-10-20T00:48:52.784Z
87
+ */
88
+ nextReleaseAt?: string | null;
89
+ /**
90
+ * @description What payouts can spend: ledgerNetVes − reserveVes − heldVes (seller obligations already deducted via SELLER_TRANSFER).
91
+ * @example 4150.00
81
92
  */
82
93
  availableVes: string;
83
94
  /** @example 8650.00 */
@@ -95,6 +106,11 @@ interface components {
95
106
  feePercent: string;
96
107
  /** @example 0.00 */
97
108
  feeFixedUsd: string;
109
+ /**
110
+ * @description Hours each incoming credit is held before payouts can spend it (0 = no hold). Set by VEXPay.
111
+ * @example 24
112
+ */
113
+ balanceHoldHours?: number;
98
114
  };
99
115
  BalanceTransactionDto: {
100
116
  /**
@@ -106,7 +122,7 @@ interface components {
106
122
  * @example chargeback
107
123
  * @enum {string}
108
124
  */
109
- type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal";
125
+ type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee";
110
126
  /**
111
127
  * @description Signed VES amount (negative = money out of your balance).
112
128
  * @example -4000.00
@@ -130,6 +146,11 @@ interface components {
130
146
  externalRef?: string;
131
147
  /** @example Card chargeback (fraud) */
132
148
  description: string;
149
+ /**
150
+ * Format: date-time
151
+ * @description Part of the 24h balance hold: this movement counts in `heldVes` (not `availableVes`) until this time.
152
+ */
153
+ availableAt?: string;
133
154
  /** Format: date-time */
134
155
  createdAt: string;
135
156
  };
@@ -155,7 +176,7 @@ interface components {
155
176
  * "payment.failed"
156
177
  * ]
157
178
  */
158
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
179
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
159
180
  };
160
181
  WebhookEndpointDto: {
161
182
  /** Format: uuid */
@@ -164,7 +185,7 @@ interface components {
164
185
  tenantId: string;
165
186
  /** Format: uri */
166
187
  url: string;
167
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
188
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
168
189
  isActive: boolean;
169
190
  /** Format: date-time */
170
191
  createdAt: string;
@@ -185,7 +206,7 @@ interface components {
185
206
  * "payout.completed"
186
207
  * ]
187
208
  */
188
- events?: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
209
+ events?: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
189
210
  /** @example true */
190
211
  isActive?: boolean;
191
212
  };
@@ -954,10 +975,20 @@ interface components {
954
975
  */
955
976
  currency: "USDT" | "USDC";
956
977
  /**
957
- * @description Available for payouts, in `currency` (ledger).
978
+ * @description Available for payouts, in `currency` (ledger). Excludes `held`.
958
979
  * @example 97.00
959
980
  */
960
981
  available: string;
982
+ /**
983
+ * @description Under the 24h balance hold: credited but not payable until its hold ends, in `currency`.
984
+ * @example 0.00
985
+ */
986
+ held?: string;
987
+ /**
988
+ * Format: date-time
989
+ * @description When the soonest held amount becomes available; null when nothing is held.
990
+ */
991
+ nextReleaseAt?: string | null;
961
992
  /**
962
993
  * @description Reserved by payouts that have not completed yet, in `currency`.
963
994
  * @example 50.10
@@ -973,6 +1004,11 @@ interface components {
973
1004
  * @example 50.10
974
1005
  */
975
1006
  pendingPayoutUsdt?: string;
1007
+ /**
1008
+ * @description USDT only: same as `held`.
1009
+ * @example 0.00
1010
+ */
1011
+ heldUsdt?: string;
976
1012
  /** Format: date-time */
977
1013
  asOf: string;
978
1014
  };
@@ -1169,7 +1205,7 @@ interface components {
1169
1205
  };
1170
1206
  CreateCopPaymentDto: {
1171
1207
  /**
1172
- * @description Amount in whole Colombian pesos.
1208
+ * @description Amount in whole Colombian pesos. At least 2,000 (`amount_below_minimum` otherwise).
1173
1209
  * @example 100000
1174
1210
  */
1175
1211
  amountCop: number;
@@ -1265,10 +1301,20 @@ interface components {
1265
1301
  };
1266
1302
  CopBalanceDto: {
1267
1303
  /**
1268
- * @description Whole pesos available for payout.
1304
+ * @description Whole pesos available for payout. Excludes `heldCop`.
1269
1305
  * @example 96500
1270
1306
  */
1271
1307
  availableCop: number;
1308
+ /**
1309
+ * @description Whole pesos under the 24h balance hold: credited but not payable until the hold ends.
1310
+ * @example 0
1311
+ */
1312
+ heldCop?: number;
1313
+ /**
1314
+ * Format: date-time
1315
+ * @description When the soonest held amount becomes available; null when nothing is held.
1316
+ */
1317
+ nextReleaseAt?: string | null;
1272
1318
  /**
1273
1319
  * @description Whole pesos reserved by payouts in progress.
1274
1320
  * @example 0
@@ -1482,11 +1528,25 @@ interface components {
1482
1528
  /** @example 25 */
1483
1529
  usdAmount: number;
1484
1530
  /**
1485
- * @description Authoritative VEX FX BCV rate used for payment settlement
1531
+ * @description Official VEX FX BCV rate (Bs per $1).
1486
1532
  * @example 36.5
1487
1533
  */
1488
1534
  bcvRate: number;
1489
- /** @example 912.5 */
1535
+ /**
1536
+ * @description Rate your payments are priced at (Bs per $1): `bcvRate` for BCV accounts, the market rate for MARKET accounts.
1537
+ * @example 36.5
1538
+ */
1539
+ rate?: number;
1540
+ /**
1541
+ * @description Your account's Bolívar rate setting.
1542
+ * @example BCV
1543
+ * @enum {string}
1544
+ */
1545
+ rateSource?: "BCV" | "MARKET";
1546
+ /**
1547
+ * @description usdAmount × rate, rounded to the cent: what a payment created now would charge.
1548
+ * @example 912.5
1549
+ */
1490
1550
  vesAmount: number;
1491
1551
  /**
1492
1552
  * @description Median of available BCV sources (VEX FX + bank)
@@ -1519,14 +1579,28 @@ interface components {
1519
1579
  [key: string]: unknown;
1520
1580
  };
1521
1581
  };
1582
+ OnwardPayoutDto: {
1583
+ /**
1584
+ * @description USDT payout network (see GET /v1/crypto/networks).
1585
+ * @example BEP20
1586
+ */
1587
+ network: string;
1588
+ /**
1589
+ * @description Destination wallet address. Only its format is checked: a wrong but valid address cannot be recovered.
1590
+ * @example 0x2f5c…
1591
+ */
1592
+ address: string;
1593
+ /** @description Destination tag / memo, for networks that need one (e.g. TON). */
1594
+ tag?: string;
1595
+ };
1522
1596
  C2pRequestDto: {
1523
1597
  /**
1524
- * @description USD amount. Required unless vesAmount is set. When only usdAmount is set, VES is derived at the live BCV rate.
1598
+ * @description USD amount. Required unless vesAmount is set. When only usdAmount is set, VES is derived at your Bolívar rate (live BCV, or market if you chose it).
1525
1599
  * @example 25
1526
1600
  */
1527
1601
  usdAmount?: number;
1528
1602
  /**
1529
- * @description VES amount debited at the bank. When set, locks the bolívar charge and derives USD at BCV (it wins over usdAmount). The intent keeps this amount until it is executed.
1603
+ * @description VES amount debited at the bank. When set, locks the bolívar charge and derives USD at your Bolívar rate (it wins over usdAmount). The intent keeps this amount until it is executed.
1530
1604
  * @example 50
1531
1605
  */
1532
1606
  vesAmount?: number;
@@ -1559,6 +1633,55 @@ interface components {
1559
1633
  * @example 10
1560
1634
  */
1561
1635
  applicationFeePercent?: number;
1636
+ /** @description Convert this payment's net VES to USDT once it completes and send it to this wallet. Needs USDT and conversions enabled; not allowed with merchantId. See the "Pay in bolívars, receive USDT" guide. */
1637
+ onwardPayout?: components["schemas"]["OnwardPayoutDto"];
1638
+ };
1639
+ OnwardPayoutStatusDto: {
1640
+ /**
1641
+ * @description `waiting_release`: converted, waiting for the 24h balance hold to end before sending (see `sendAfter`).
1642
+ * @example completed
1643
+ * @enum {string}
1644
+ */
1645
+ status: "pending" | "converting" | "waiting_release" | "sending" | "completed" | "held" | "failed" | "canceled";
1646
+ /** @example BEP20 */
1647
+ network: string;
1648
+ /** @example 0x2f5c0000000000000000000000000000000000aa */
1649
+ address: string;
1650
+ tag?: string;
1651
+ /**
1652
+ * Format: uuid
1653
+ * @description The VES → USDT conversion, once created.
1654
+ */
1655
+ conversionId?: string;
1656
+ /**
1657
+ * Format: uuid
1658
+ * @description The USDT payout, once created.
1659
+ */
1660
+ payoutId?: string;
1661
+ /**
1662
+ * @description USDT sent to the address.
1663
+ * @example 18.94
1664
+ */
1665
+ amountUsdt?: string;
1666
+ /**
1667
+ * @description Network payout fee.
1668
+ * @example 0.75
1669
+ */
1670
+ feeUsdt?: string;
1671
+ /** @description On-chain hash once the payout completed. */
1672
+ txHash?: string;
1673
+ /**
1674
+ * @description Why it is held, failed or canceled.
1675
+ * @example below_payout_minimum
1676
+ */
1677
+ reason?: string;
1678
+ /**
1679
+ * Format: date-time
1680
+ * @description `waiting_release` only: when the converted USDT leaves the balance hold and the payout is sent.
1681
+ */
1682
+ sendAfter?: string;
1683
+ /** Format: date-time */
1684
+ updatedAt: string;
1562
1685
  };
1563
1686
  C2pIntentResponseDto: {
1564
1687
  /**
@@ -1579,8 +1702,22 @@ interface components {
1579
1702
  usdAmount: number;
1580
1703
  /** @example 912.5 */
1581
1704
  vesAmount: number;
1582
- /** @example 36.5 */
1705
+ /**
1706
+ * @description Official BCV rate (Bs per $1) when the payment was created. Reference only; see `rate`.
1707
+ * @example 36.5
1708
+ */
1583
1709
  bcvRate: number;
1710
+ /**
1711
+ * @description Rate (Bs per $1) this payment was priced at: equal to `bcvRate` for BCV tenants, the market rate for MARKET tenants.
1712
+ * @example 36.5
1713
+ */
1714
+ rate?: number;
1715
+ /**
1716
+ * @description Source of `rate`: the account's Bolívar rate setting when the payment was created.
1717
+ * @example BCV
1718
+ * @enum {string}
1719
+ */
1720
+ rateSource?: "BCV" | "MARKET";
1584
1721
  /**
1585
1722
  * @description Platform service fee, USD. Clamped 0..usdAmount.
1586
1723
  * @example 0.88
@@ -1633,6 +1770,8 @@ interface components {
1633
1770
  reversalRef?: string;
1634
1771
  /** @example 842950 */
1635
1772
  reversalTxId?: number;
1773
+ /** @description Present when the pay-in was sent with `onwardPayout`. */
1774
+ onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
1636
1775
  /**
1637
1776
  * Format: uuid
1638
1777
  * @description Use this value as intentId when executing the C2P charge.
@@ -1648,12 +1787,12 @@ interface components {
1648
1787
  */
1649
1788
  intentId?: string;
1650
1789
  /**
1651
- * @description USD amount. Required unless vesAmount or intentId is set. When only usdAmount is set, VES is derived at the live BCV rate.
1790
+ * @description USD amount. Required unless vesAmount or intentId is set. When only usdAmount is set, VES is derived at your Bolívar rate (live BCV, or market if you chose it).
1652
1791
  * @example 25
1653
1792
  */
1654
1793
  usdAmount?: number;
1655
1794
  /**
1656
- * @description VES amount debited at the bank. When set, locks the bolívar charge and derives USD at BCV (it wins over usdAmount). With intentId the amount locked on the intent is charged; amounts sent here must match it (±0.01 Bs / ±$0.01).
1795
+ * @description VES amount debited at the bank. When set, locks the bolívar charge and derives USD at your Bolívar rate (it wins over usdAmount). With intentId the amount locked on the intent is charged; amounts sent here must match it (±0.01 Bs / ±$0.01).
1657
1796
  * @example 50
1658
1797
  */
1659
1798
  vesAmount?: number;
@@ -1691,6 +1830,8 @@ interface components {
1691
1830
  * @example 10
1692
1831
  */
1693
1832
  applicationFeePercent?: number;
1833
+ /** @description Convert this payment's net VES to USDT once it completes and send it to this wallet. Needs USDT and conversions enabled; not allowed with merchantId. See the "Pay in bolívars, receive USDT" guide. */
1834
+ onwardPayout?: components["schemas"]["OnwardPayoutDto"];
1694
1835
  };
1695
1836
  PaymentReceiptDto: {
1696
1837
  /**
@@ -1711,8 +1852,22 @@ interface components {
1711
1852
  usdAmount: number;
1712
1853
  /** @example 912.5 */
1713
1854
  vesAmount: number;
1714
- /** @example 36.5 */
1855
+ /**
1856
+ * @description Official BCV rate (Bs per $1) when the payment was created. Reference only; see `rate`.
1857
+ * @example 36.5
1858
+ */
1715
1859
  bcvRate: number;
1860
+ /**
1861
+ * @description Rate (Bs per $1) this payment was priced at: equal to `bcvRate` for BCV tenants, the market rate for MARKET tenants.
1862
+ * @example 36.5
1863
+ */
1864
+ rate?: number;
1865
+ /**
1866
+ * @description Source of `rate`: the account's Bolívar rate setting when the payment was created.
1867
+ * @example BCV
1868
+ * @enum {string}
1869
+ */
1870
+ rateSource?: "BCV" | "MARKET";
1716
1871
  /**
1717
1872
  * @description Platform service fee, USD. Clamped 0..usdAmount.
1718
1873
  * @example 0.88
@@ -1765,15 +1920,17 @@ interface components {
1765
1920
  reversalRef?: string;
1766
1921
  /** @example 842950 */
1767
1922
  reversalTxId?: number;
1923
+ /** @description Present when the pay-in was sent with `onwardPayout`. */
1924
+ onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
1768
1925
  };
1769
1926
  VposPaymentDto: {
1770
1927
  /**
1771
- * @description USD amount. Required unless vesAmount is set. When only usdAmount is set, VES is derived at the live BCV rate.
1928
+ * @description USD amount. Required unless vesAmount is set. When only usdAmount is set, VES is derived at your Bolívar rate (live BCV, or market if you chose it).
1772
1929
  * @example 25
1773
1930
  */
1774
1931
  usdAmount?: number;
1775
1932
  /**
1776
- * @description VES amount charged at the bank. When set, locks the bolívar charge and derives USD at BCV — use this to avoid USD↔VES 2-decimal round-trip drift (e.g. Bs. 50 → $0.07 → Bs. 52.86).
1933
+ * @description VES amount charged at the bank. When set, locks the bolívar charge and derives USD at your Bolívar rate — use this to avoid USD↔VES 2-decimal round-trip drift (e.g. Bs. 50 → $0.07 → Bs. 52.86).
1777
1934
  * @example 50
1778
1935
  */
1779
1936
  vesAmount?: number;
@@ -1814,6 +1971,11 @@ interface components {
1814
1971
  * @example order-1042
1815
1972
  */
1816
1973
  externalRef?: string;
1974
+ /**
1975
+ * @description Who the funds are for when that is not a merchant (e.g. the wallet user being topped up). Shown to ops only; does not affect settlement.
1976
+ * @example @maria
1977
+ */
1978
+ beneficiary?: string;
1817
1979
  /** Format: uuid */
1818
1980
  merchantId?: string;
1819
1981
  /**
@@ -1911,6 +2073,8 @@ interface components {
1911
2073
  * @example 04149333844
1912
2074
  */
1913
2075
  debtorCellPhone?: string;
2076
+ /** @description Convert this payment's net VES to USDT once it completes and send it to this wallet. Needs USDT and conversions enabled; not allowed with merchantId. See the "Pay in bolívars, receive USDT" guide. */
2077
+ onwardPayout?: components["schemas"]["OnwardPayoutDto"];
1914
2078
  };
1915
2079
  PayoutMethodResponseDto: {
1916
2080
  /** Format: uuid */
@@ -2040,6 +2204,33 @@ interface components {
2040
2204
  /** Format: uuid */
2041
2205
  payoutMethodId: string;
2042
2206
  };
2207
+ MerchantCopBalanceDto: {
2208
+ /**
2209
+ * @description COP sales still in the seller hold.
2210
+ * @example 16002
2211
+ */
2212
+ pendingCop: string;
2213
+ /**
2214
+ * @description COP the seller can pay out.
2215
+ * @example 30000
2216
+ */
2217
+ availableCop: string;
2218
+ /**
2219
+ * @description COP payouts requested and not yet paid.
2220
+ * @example 0
2221
+ */
2222
+ payoutPendingCop: string;
2223
+ /**
2224
+ * @description COP paid out to the seller so far.
2225
+ * @example 0
2226
+ */
2227
+ paidOutCop: string;
2228
+ /**
2229
+ * @description VEX Wallet sellers: COP per US$1 a wallet sweep would use now (display only). Omitted when no fresh rate.
2230
+ * @example 3939.0000
2231
+ */
2232
+ sweepRate?: string;
2233
+ };
2043
2234
  MerchantBalanceDto: {
2044
2235
  /** Format: uuid */
2045
2236
  merchantId: string;
@@ -2055,6 +2246,8 @@ interface components {
2055
2246
  paidOutVes: string;
2056
2247
  /** @example 350.00 */
2057
2248
  ledgerNetVes: string;
2249
+ /** @description COP balances from COP sales on seller links. Present only once the seller has COP activity. */
2250
+ cop?: components["schemas"]["MerchantCopBalanceDto"];
2058
2251
  };
2059
2252
  CreateMerchantDto: {
2060
2253
  /** @example usr_7f3a… */
@@ -2390,7 +2583,7 @@ interface operations {
2390
2583
  /** @description Only movements of this payment. */
2391
2584
  paymentId?: string;
2392
2585
  /** @description One or more types (repeat or comma-separate). */
2393
- type?: ("payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal")[];
2586
+ type?: ("payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee")[];
2394
2587
  /** @description `nextCursor` from the previous page. */
2395
2588
  cursor?: string;
2396
2589
  /** @description 1–100, default 50. */
@@ -5878,7 +6071,7 @@ interface operations {
5878
6071
  };
5879
6072
  requestBody?: never;
5880
6073
  responses: {
5881
- /** @description bcvRate/vesAmount are authoritative for settlement; medianRate/medianVesAmount are for display. sources includes per-source rates or errors. */
6074
+ /** @description rate/vesAmount are authoritative for settlement; bcvRate is the official rate; medianRate/medianVesAmount are for display. sources includes per-source rates or errors. */
5882
6075
  200: {
5883
6076
  headers: {
5884
6077
  [name: string]: unknown;
@@ -8807,6 +9000,15 @@ interface operations {
8807
9000
  "application/json": components["schemas"]["ApiErrorDto"];
8808
9001
  };
8809
9002
  };
9003
+ /** @description More than 10 test notifications in 10 minutes. */
9004
+ 429: {
9005
+ headers: {
9006
+ [name: string]: unknown;
9007
+ };
9008
+ content: {
9009
+ "application/json": components["schemas"]["ApiErrorDto"];
9010
+ };
9011
+ };
8810
9012
  /** @description Client error. */
8811
9013
  "4XX": {
8812
9014
  headers: {
@@ -8907,6 +9109,8 @@ declare class Quotes extends APIResource {
8907
9109
  retrieve(params: QueryParams<'Payments_getQuote'>, options?: RequestOptions): Promise<{
8908
9110
  usdAmount: number;
8909
9111
  bcvRate: number;
9112
+ rate?: number;
9113
+ rateSource?: "BCV" | "MARKET";
8910
9114
  vesAmount: number;
8911
9115
  medianRate: number;
8912
9116
  medianVesAmount: number;
@@ -8925,7 +9129,7 @@ declare class BalanceTransactions extends APIResource {
8925
9129
  nextCursor: string | null;
8926
9130
  }, {
8927
9131
  id: string;
8928
- type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal";
9132
+ type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee";
8929
9133
  amountVes: string;
8930
9134
  paymentId?: string;
8931
9135
  payoutId?: string;
@@ -8933,6 +9137,7 @@ declare class BalanceTransactions extends APIResource {
8933
9137
  merchantId?: string;
8934
9138
  externalRef?: string;
8935
9139
  description: string;
9140
+ availableAt?: string;
8936
9141
  createdAt: string;
8937
9142
  }>;
8938
9143
  }
@@ -8949,6 +9154,8 @@ declare class Balance extends APIResource {
8949
9154
  chargebackFeesVes: string;
8950
9155
  reserveVes: string;
8951
9156
  ledgerNetVes: string;
9157
+ heldVes?: string;
9158
+ nextReleaseAt?: string | null;
8952
9159
  availableVes: string;
8953
9160
  platformAvailableVes: string;
8954
9161
  sellerObligationsVes: string;
@@ -8956,6 +9163,7 @@ declare class Balance extends APIResource {
8956
9163
  sellerAvailableVes: string;
8957
9164
  feePercent: string;
8958
9165
  feeFixedUsd: string;
9166
+ balanceHoldHours?: number;
8959
9167
  }>;
8960
9168
  }
8961
9169
  /** VES payouts to verified merchants. `externalRef` is the idempotency key. */
@@ -9138,7 +9346,7 @@ declare class WebhookEndpoints extends APIResource {
9138
9346
  id: string;
9139
9347
  tenantId: string;
9140
9348
  url: string;
9141
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
9349
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
9142
9350
  isActive: boolean;
9143
9351
  createdAt: string;
9144
9352
  secret?: string;
@@ -9147,7 +9355,7 @@ declare class WebhookEndpoints extends APIResource {
9147
9355
  id: string;
9148
9356
  tenantId: string;
9149
9357
  url: string;
9150
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
9358
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
9151
9359
  isActive: boolean;
9152
9360
  createdAt: string;
9153
9361
  secret?: string;
@@ -9156,7 +9364,7 @@ declare class WebhookEndpoints extends APIResource {
9156
9364
  id: string;
9157
9365
  tenantId: string;
9158
9366
  url: string;
9159
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
9367
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
9160
9368
  isActive: boolean;
9161
9369
  createdAt: string;
9162
9370
  secret?: string;
@@ -9567,6 +9775,8 @@ declare class CopPayments extends APIResource {
9567
9775
  declare class CopBalance extends APIResource {
9568
9776
  retrieve(options?: RequestOptions): Promise<{
9569
9777
  availableCop: number;
9778
+ heldCop?: number;
9779
+ nextReleaseAt?: string | null;
9570
9780
  pendingPayoutCop: number;
9571
9781
  asOf: string;
9572
9782
  }>;
@@ -9582,9 +9792,12 @@ declare class CryptoBalance extends APIResource {
9582
9792
  retrieve(params?: QueryParams<'Crypto_getBalance'>, options?: RequestOptions): Promise<{
9583
9793
  currency: "USDT" | "USDC";
9584
9794
  available: string;
9795
+ held?: string;
9796
+ nextReleaseAt?: string | null;
9585
9797
  pendingPayout: string;
9586
9798
  availableUsdt?: string;
9587
9799
  pendingPayoutUsdt?: string;
9800
+ heldUsdt?: string;
9588
9801
  asOf: string;
9589
9802
  }>;
9590
9803
  }
@@ -9856,6 +10069,7 @@ declare class Merchants extends APIResource {
9856
10069
  availableVes: string;
9857
10070
  paidOutVes: string;
9858
10071
  ledgerNetVes: string;
10072
+ cop?: components["schemas"]["MerchantCopBalanceDto"];
9859
10073
  }>;
9860
10074
  /** Move VES between this merchant's balance and another. */
9861
10075
  transfer(id: string, params: RequestBody<'Merchants_transfer'>, options?: RequestOptions): Promise<{
@@ -9866,6 +10080,7 @@ declare class Merchants extends APIResource {
9866
10080
  availableVes: string;
9867
10081
  paidOutVes: string;
9868
10082
  ledgerNetVes: string;
10083
+ cop?: components["schemas"]["MerchantCopBalanceDto"];
9869
10084
  }>;
9870
10085
  listAuditEvents(id: string, options?: RequestOptions): Promise<{
9871
10086
  items: components["schemas"]["MerchantAuditEventDto"][];
@@ -9893,6 +10108,8 @@ declare class C2p extends APIResource {
9893
10108
  usdAmount: number;
9894
10109
  vesAmount: number;
9895
10110
  bcvRate: number;
10111
+ rate?: number;
10112
+ rateSource?: "BCV" | "MARKET";
9896
10113
  feeUsd?: number;
9897
10114
  feeVes?: number;
9898
10115
  netVes?: number;
@@ -9913,6 +10130,7 @@ declare class C2p extends APIResource {
9913
10130
  reversedAt?: string;
9914
10131
  reversalRef?: string;
9915
10132
  reversalTxId?: number;
10133
+ onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
9916
10134
  intentId: string;
9917
10135
  otpRequested: boolean;
9918
10136
  }>;
@@ -9925,6 +10143,8 @@ declare class C2p extends APIResource {
9925
10143
  usdAmount: number;
9926
10144
  vesAmount: number;
9927
10145
  bcvRate: number;
10146
+ rate?: number;
10147
+ rateSource?: "BCV" | "MARKET";
9928
10148
  feeUsd?: number;
9929
10149
  feeVes?: number;
9930
10150
  netVes?: number;
@@ -9945,6 +10165,7 @@ declare class C2p extends APIResource {
9945
10165
  reversedAt?: string;
9946
10166
  reversalRef?: string;
9947
10167
  reversalTxId?: number;
10168
+ onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
9948
10169
  }>;
9949
10170
  }
9950
10171
  /** Card payments (VPOS). Prefer the hosted/embedded checkout so card data never touches your servers. */
@@ -9957,6 +10178,8 @@ declare class Vpos extends APIResource {
9957
10178
  usdAmount: number;
9958
10179
  vesAmount: number;
9959
10180
  bcvRate: number;
10181
+ rate?: number;
10182
+ rateSource?: "BCV" | "MARKET";
9960
10183
  feeUsd?: number;
9961
10184
  feeVes?: number;
9962
10185
  netVes?: number;
@@ -9977,6 +10200,7 @@ declare class Vpos extends APIResource {
9977
10200
  reversedAt?: string;
9978
10201
  reversalRef?: string;
9979
10202
  reversalTxId?: number;
10203
+ onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
9980
10204
  }>;
9981
10205
  }
9982
10206
  /** Confirm a Pago Móvil the customer already sent to you. */
@@ -10003,6 +10227,8 @@ declare class PagoMovil extends APIResource {
10003
10227
  usdAmount: number;
10004
10228
  vesAmount: number;
10005
10229
  bcvRate: number;
10230
+ rate?: number;
10231
+ rateSource?: "BCV" | "MARKET";
10006
10232
  feeUsd?: number;
10007
10233
  feeVes?: number;
10008
10234
  netVes?: number;
@@ -10023,6 +10249,7 @@ declare class PagoMovil extends APIResource {
10023
10249
  reversedAt?: string;
10024
10250
  reversalRef?: string;
10025
10251
  reversalTxId?: number;
10252
+ onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
10026
10253
  }>;
10027
10254
  }
10028
10255
  /** Débito inmediato (advanced payments, enabled per account). */
@@ -10143,6 +10370,8 @@ declare class Payments extends APIResource {
10143
10370
  usdAmount: number;
10144
10371
  vesAmount: number;
10145
10372
  bcvRate: number;
10373
+ rate?: number;
10374
+ rateSource?: "BCV" | "MARKET";
10146
10375
  feeUsd?: number;
10147
10376
  feeVes?: number;
10148
10377
  netVes?: number;
@@ -10163,6 +10392,7 @@ declare class Payments extends APIResource {
10163
10392
  reversedAt?: string;
10164
10393
  reversalRef?: string;
10165
10394
  reversalTxId?: number;
10395
+ onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
10166
10396
  }>;
10167
10397
  /** Look up a payment by the `externalRef` you sent. */
10168
10398
  retrieveByRef(externalRef: string, options?: RequestOptions): Promise<{
@@ -10173,6 +10403,8 @@ declare class Payments extends APIResource {
10173
10403
  usdAmount: number;
10174
10404
  vesAmount: number;
10175
10405
  bcvRate: number;
10406
+ rate?: number;
10407
+ rateSource?: "BCV" | "MARKET";
10176
10408
  feeUsd?: number;
10177
10409
  feeVes?: number;
10178
10410
  netVes?: number;
@@ -10193,6 +10425,7 @@ declare class Payments extends APIResource {
10193
10425
  reversedAt?: string;
10194
10426
  reversalRef?: string;
10195
10427
  reversalTxId?: number;
10428
+ onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
10196
10429
  }>;
10197
10430
  /** Reverse a completed C2P payment. */
10198
10431
  reverse(id: string, options?: RequestOptions): Promise<{
@@ -10203,6 +10436,8 @@ declare class Payments extends APIResource {
10203
10436
  usdAmount: number;
10204
10437
  vesAmount: number;
10205
10438
  bcvRate: number;
10439
+ rate?: number;
10440
+ rateSource?: "BCV" | "MARKET";
10206
10441
  feeUsd?: number;
10207
10442
  feeVes?: number;
10208
10443
  netVes?: number;
@@ -10223,10 +10458,11 @@ declare class Payments extends APIResource {
10223
10458
  reversedAt?: string;
10224
10459
  reversalRef?: string;
10225
10460
  reversalTxId?: number;
10461
+ onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
10226
10462
  }>;
10227
10463
  }
10228
10464
 
10229
- declare const WEBHOOK_EVENT_NAMES: readonly ["payment.pending", "payment.completed", "payment.failed", "payment.canceled", "payment.reversed", "payment.chargeback", "payment.chargeback_closed", "merchant.verified", "merchant.rejected", "merchant.deactivated", "merchant.reactivated", "merchant.balance.updated", "merchant.created", "merchant.activated", "merchant.updated", "merchant.kyb_required", "merchant.restricted", "merchant.capability.updated", "merchant.wallet_credit", "payout.completed", "payout.failed", "conversion.created", "conversion.completed", "conversion.canceled", "tenant.status_changed", "tenant.api_key.created", "tenant.api_key.rotated", "tenant.api_key.revoked", "tenant.live_status_changed", "notification.test"];
10465
+ declare const WEBHOOK_EVENT_NAMES: readonly ["payment.pending", "payment.completed", "payment.failed", "payment.canceled", "payment.reversed", "payment.chargeback", "payment.chargeback_closed", "merchant.verified", "merchant.rejected", "merchant.deactivated", "merchant.reactivated", "merchant.balance.updated", "merchant.created", "merchant.activated", "merchant.updated", "merchant.kyb_required", "merchant.restricted", "merchant.capability.updated", "merchant.wallet_credit", "payout.completed", "payout.failed", "conversion.created", "conversion.completed", "conversion.canceled", "onward_payout.updated", "tenant.status_changed", "tenant.api_key.created", "tenant.api_key.rotated", "tenant.api_key.revoked", "tenant.live_status_changed", "notification.test"];
10230
10466
  type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];
10231
10467
  /** `data` of every `payment.*` event. */
10232
10468
  interface PaymentWebhookData {
@@ -10237,7 +10473,12 @@ interface PaymentWebhookData {
10237
10473
  method: 'C2P' | 'VPOS' | 'PAGO_MOVIL' | 'DEBITO_INMEDIATO' | 'COP';
10238
10474
  usdAmount: number;
10239
10475
  vesAmount: number;
10476
+ /** Official BCV rate (Bs per $1) when the payment was created. */
10240
10477
  bcvRate: number;
10478
+ /** Rate the payment was priced at: `bcvRate` for BCV accounts, the market rate for MARKET accounts. */
10479
+ rate?: number;
10480
+ /** Your account's Bolívar rate setting when the payment was created. */
10481
+ rateSource?: 'BCV' | 'MARKET';
10241
10482
  feeUsd?: number;
10242
10483
  feeVes?: number;
10243
10484
  netVes?: number;
@@ -10413,6 +10654,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
10413
10654
  declare class VexPaySignatureVerificationError extends VexPayError {
10414
10655
  }
10415
10656
 
10416
- declare const VERSION = "0.8.0";
10657
+ declare const VERSION = "0.10.0";
10417
10658
 
10418
10659
  export { type CopPaymentWebhookData, type CursorPage, DEFAULT_BASE_URL, DEFAULT_TOLERANCE_SECONDS, type OperationId, PagePromise, type PathParams, type PaymentWebhookData, type QueryParams, type RequestBody, type RequestOptions, type ResponseBody, SIGNATURE_HEADER, type Schemas, VERSION, VexPay, VexPayAPIError, VexPayAuthenticationError, VexPayConfigurationError, VexPayConflictError, VexPayConnectionError, VexPayError, VexPayInvalidRequestError, VexPayNotFoundError, type VexPayOptions, VexPayRateLimitError, VexPaySignatureVerificationError, VexPayTimeoutError, WEBHOOK_EVENT_NAMES, type WebhookEvent, type WebhookEventName, Webhooks, VexPay as default };