@vexpay/node 0.9.0 → 0.11.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/README.md +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +189 -25
- package/dist/index.d.ts +189 -25
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -76,8 +76,19 @@ interface components {
|
|
|
76
76
|
/** @example 8650.00 */
|
|
77
77
|
ledgerNetVes: string;
|
|
78
78
|
/**
|
|
79
|
-
* @description
|
|
80
|
-
* @example
|
|
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
|
};
|
|
@@ -200,10 +221,15 @@ interface components {
|
|
|
200
221
|
*/
|
|
201
222
|
payoutId: string;
|
|
202
223
|
/**
|
|
203
|
-
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id.
|
|
224
|
+
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit`, funds returned) when rejected.
|
|
225
|
+
* @enum {string}
|
|
226
|
+
*/
|
|
227
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
228
|
+
/**
|
|
229
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent).
|
|
204
230
|
* @enum {string}
|
|
205
231
|
*/
|
|
206
|
-
|
|
232
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
207
233
|
/** @description Bank reference when available. */
|
|
208
234
|
reference?: string | null;
|
|
209
235
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -267,10 +293,15 @@ interface components {
|
|
|
267
293
|
*/
|
|
268
294
|
payoutId: string;
|
|
269
295
|
/**
|
|
270
|
-
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id.
|
|
296
|
+
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit`, funds returned) when rejected.
|
|
297
|
+
* @enum {string}
|
|
298
|
+
*/
|
|
299
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
300
|
+
/**
|
|
301
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent).
|
|
271
302
|
* @enum {string}
|
|
272
303
|
*/
|
|
273
|
-
|
|
304
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
274
305
|
/** @description Bank reference when available. */
|
|
275
306
|
reference?: string | null;
|
|
276
307
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -753,7 +784,7 @@ interface components {
|
|
|
753
784
|
*/
|
|
754
785
|
concepto: string;
|
|
755
786
|
/**
|
|
756
|
-
* @description Tenant correlation value for recovery lookup (GET /v1/payments/by-ref/:externalRef). Not an idempotency key.
|
|
787
|
+
* @description Tenant correlation value for recovery lookup (GET /v1/payments/by-ref/:externalRef). Not an idempotency key; a ref that already has a COMPLETED payment is refused (409 external_ref_already_paid).
|
|
757
788
|
* @example fine_736a0b42-0b6e-454c-b87e-7f3c0e47057b
|
|
758
789
|
*/
|
|
759
790
|
externalRef?: string;
|
|
@@ -954,10 +985,20 @@ interface components {
|
|
|
954
985
|
*/
|
|
955
986
|
currency: "USDT" | "USDC";
|
|
956
987
|
/**
|
|
957
|
-
* @description Available for payouts, in `currency` (ledger).
|
|
988
|
+
* @description Available for payouts, in `currency` (ledger). Excludes `held`.
|
|
958
989
|
* @example 97.00
|
|
959
990
|
*/
|
|
960
991
|
available: string;
|
|
992
|
+
/**
|
|
993
|
+
* @description Under the 24h balance hold: credited but not payable until its hold ends, in `currency`.
|
|
994
|
+
* @example 0.00
|
|
995
|
+
*/
|
|
996
|
+
held?: string;
|
|
997
|
+
/**
|
|
998
|
+
* Format: date-time
|
|
999
|
+
* @description When the soonest held amount becomes available; null when nothing is held.
|
|
1000
|
+
*/
|
|
1001
|
+
nextReleaseAt?: string | null;
|
|
961
1002
|
/**
|
|
962
1003
|
* @description Reserved by payouts that have not completed yet, in `currency`.
|
|
963
1004
|
* @example 50.10
|
|
@@ -973,6 +1014,11 @@ interface components {
|
|
|
973
1014
|
* @example 50.10
|
|
974
1015
|
*/
|
|
975
1016
|
pendingPayoutUsdt?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* @description USDT only: same as `held`.
|
|
1019
|
+
* @example 0.00
|
|
1020
|
+
*/
|
|
1021
|
+
heldUsdt?: string;
|
|
976
1022
|
/** Format: date-time */
|
|
977
1023
|
asOf: string;
|
|
978
1024
|
};
|
|
@@ -1169,7 +1215,7 @@ interface components {
|
|
|
1169
1215
|
};
|
|
1170
1216
|
CreateCopPaymentDto: {
|
|
1171
1217
|
/**
|
|
1172
|
-
* @description Amount in whole Colombian pesos.
|
|
1218
|
+
* @description Amount in whole Colombian pesos. At least 2,000 (`amount_below_minimum` otherwise).
|
|
1173
1219
|
* @example 100000
|
|
1174
1220
|
*/
|
|
1175
1221
|
amountCop: number;
|
|
@@ -1265,10 +1311,20 @@ interface components {
|
|
|
1265
1311
|
};
|
|
1266
1312
|
CopBalanceDto: {
|
|
1267
1313
|
/**
|
|
1268
|
-
* @description Whole pesos available for payout.
|
|
1314
|
+
* @description Whole pesos available for payout. Excludes `heldCop`.
|
|
1269
1315
|
* @example 96500
|
|
1270
1316
|
*/
|
|
1271
1317
|
availableCop: number;
|
|
1318
|
+
/**
|
|
1319
|
+
* @description Whole pesos under the 24h balance hold: credited but not payable until the hold ends.
|
|
1320
|
+
* @example 0
|
|
1321
|
+
*/
|
|
1322
|
+
heldCop?: number;
|
|
1323
|
+
/**
|
|
1324
|
+
* Format: date-time
|
|
1325
|
+
* @description When the soonest held amount becomes available; null when nothing is held.
|
|
1326
|
+
*/
|
|
1327
|
+
nextReleaseAt?: string | null;
|
|
1272
1328
|
/**
|
|
1273
1329
|
* @description Whole pesos reserved by payouts in progress.
|
|
1274
1330
|
* @example 0
|
|
@@ -1571,7 +1627,7 @@ interface components {
|
|
|
1571
1627
|
*/
|
|
1572
1628
|
debtorBankCode: number;
|
|
1573
1629
|
/**
|
|
1574
|
-
* @description Correlation value; not an idempotency key. When present, any other PENDING C2P intent for this tenant + externalRef is canceled (superseded) before the new intent is created.
|
|
1630
|
+
* @description Correlation value; not an idempotency key. A ref that already has a COMPLETED payment is refused (409 external_ref_already_paid). When present, any other PENDING C2P intent for this tenant + externalRef is canceled (superseded) before the new intent is created.
|
|
1575
1631
|
* @example order-1042
|
|
1576
1632
|
*/
|
|
1577
1633
|
externalRef?: string;
|
|
@@ -1592,10 +1648,11 @@ interface components {
|
|
|
1592
1648
|
};
|
|
1593
1649
|
OnwardPayoutStatusDto: {
|
|
1594
1650
|
/**
|
|
1651
|
+
* @description `waiting_release`: converted, waiting for the 24h balance hold to end before sending (see `sendAfter`).
|
|
1595
1652
|
* @example completed
|
|
1596
1653
|
* @enum {string}
|
|
1597
1654
|
*/
|
|
1598
|
-
status: "pending" | "converting" | "sending" | "completed" | "held" | "failed" | "canceled";
|
|
1655
|
+
status: "pending" | "converting" | "waiting_release" | "sending" | "completed" | "held" | "failed" | "canceled";
|
|
1599
1656
|
/** @example BEP20 */
|
|
1600
1657
|
network: string;
|
|
1601
1658
|
/** @example 0x2f5c0000000000000000000000000000000000aa */
|
|
@@ -1628,6 +1685,11 @@ interface components {
|
|
|
1628
1685
|
* @example below_payout_minimum
|
|
1629
1686
|
*/
|
|
1630
1687
|
reason?: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* Format: date-time
|
|
1690
|
+
* @description `waiting_release` only: when the converted USDT leaves the balance hold and the payout is sent.
|
|
1691
|
+
*/
|
|
1692
|
+
sendAfter?: string;
|
|
1631
1693
|
/** Format: date-time */
|
|
1632
1694
|
updatedAt: string;
|
|
1633
1695
|
};
|
|
@@ -1759,7 +1821,7 @@ interface components {
|
|
|
1759
1821
|
*/
|
|
1760
1822
|
token: string;
|
|
1761
1823
|
/**
|
|
1762
|
-
* @description Correlation value; not an idempotency key.
|
|
1824
|
+
* @description Correlation value; not an idempotency key. A ref that already has a COMPLETED payment is refused (409 external_ref_already_paid).
|
|
1763
1825
|
* @example order-1042
|
|
1764
1826
|
*/
|
|
1765
1827
|
externalRef?: string;
|
|
@@ -1915,7 +1977,7 @@ interface components {
|
|
|
1915
1977
|
*/
|
|
1916
1978
|
cardType: 1 | 2 | 3;
|
|
1917
1979
|
/**
|
|
1918
|
-
* @description Correlation value; not an idempotency key.
|
|
1980
|
+
* @description Correlation value; not an idempotency key. A ref that already has a COMPLETED payment is refused (409 external_ref_already_paid).
|
|
1919
1981
|
* @example order-1042
|
|
1920
1982
|
*/
|
|
1921
1983
|
externalRef?: string;
|
|
@@ -2152,6 +2214,33 @@ interface components {
|
|
|
2152
2214
|
/** Format: uuid */
|
|
2153
2215
|
payoutMethodId: string;
|
|
2154
2216
|
};
|
|
2217
|
+
MerchantCopBalanceDto: {
|
|
2218
|
+
/**
|
|
2219
|
+
* @description COP sales still in the seller hold.
|
|
2220
|
+
* @example 16002
|
|
2221
|
+
*/
|
|
2222
|
+
pendingCop: string;
|
|
2223
|
+
/**
|
|
2224
|
+
* @description COP the seller can pay out.
|
|
2225
|
+
* @example 30000
|
|
2226
|
+
*/
|
|
2227
|
+
availableCop: string;
|
|
2228
|
+
/**
|
|
2229
|
+
* @description COP payouts requested and not yet paid.
|
|
2230
|
+
* @example 0
|
|
2231
|
+
*/
|
|
2232
|
+
payoutPendingCop: string;
|
|
2233
|
+
/**
|
|
2234
|
+
* @description COP paid out to the seller so far.
|
|
2235
|
+
* @example 0
|
|
2236
|
+
*/
|
|
2237
|
+
paidOutCop: string;
|
|
2238
|
+
/**
|
|
2239
|
+
* @description VEX Wallet sellers: COP per US$1 a wallet sweep would use now (display only). Omitted when no fresh rate.
|
|
2240
|
+
* @example 3939.0000
|
|
2241
|
+
*/
|
|
2242
|
+
sweepRate?: string;
|
|
2243
|
+
};
|
|
2155
2244
|
MerchantBalanceDto: {
|
|
2156
2245
|
/** Format: uuid */
|
|
2157
2246
|
merchantId: string;
|
|
@@ -2167,6 +2256,8 @@ interface components {
|
|
|
2167
2256
|
paidOutVes: string;
|
|
2168
2257
|
/** @example 350.00 */
|
|
2169
2258
|
ledgerNetVes: string;
|
|
2259
|
+
/** @description COP balances from COP sales on seller links. Present only once the seller has COP activity. */
|
|
2260
|
+
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
2170
2261
|
};
|
|
2171
2262
|
CreateMerchantDto: {
|
|
2172
2263
|
/** @example usr_7f3a… */
|
|
@@ -2294,6 +2385,16 @@ interface components {
|
|
|
2294
2385
|
metadata?: {
|
|
2295
2386
|
[key: string]: string;
|
|
2296
2387
|
};
|
|
2388
|
+
/**
|
|
2389
|
+
* @description Split the payment with one of your merchants (UUID or `mrc_` id). The merchant's share is credited to its VES balance when the payment completes. Only bolívar methods (`c2p`, `pago_movil`, `vpos`) are offered.
|
|
2390
|
+
* @example 3fd84b2d-9ad1-4f74-a2d9-0f2f56984db5
|
|
2391
|
+
*/
|
|
2392
|
+
merchantId?: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* @description Commission percent you keep when `merchantId` is set. Omit to use the merchant's commission, then your default commission.
|
|
2395
|
+
* @example 3
|
|
2396
|
+
*/
|
|
2397
|
+
applicationFeePercent?: number;
|
|
2297
2398
|
};
|
|
2298
2399
|
CheckoutSessionResponseDto: {
|
|
2299
2400
|
/** @example cs_4f0c6f1e2b7d4c1a9e3f5a6b7c8d9e0f */
|
|
@@ -2329,6 +2430,13 @@ interface components {
|
|
|
2329
2430
|
expiresAt: string;
|
|
2330
2431
|
/** Format: date-time */
|
|
2331
2432
|
createdAt: string;
|
|
2433
|
+
/** @description Merchant the payment is split with. */
|
|
2434
|
+
merchantId?: string | null;
|
|
2435
|
+
/**
|
|
2436
|
+
* @description Commission percent set on the session; null = merchant or tenant default at payment time.
|
|
2437
|
+
* @example 3
|
|
2438
|
+
*/
|
|
2439
|
+
applicationFeePercent?: string | null;
|
|
2332
2440
|
/** @description false for test-mode tenants. */
|
|
2333
2441
|
livemode: boolean;
|
|
2334
2442
|
};
|
|
@@ -2502,7 +2610,7 @@ interface operations {
|
|
|
2502
2610
|
/** @description Only movements of this payment. */
|
|
2503
2611
|
paymentId?: string;
|
|
2504
2612
|
/** @description One or more types (repeat or comma-separate). */
|
|
2505
|
-
type?: ("payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal")[];
|
|
2613
|
+
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")[];
|
|
2506
2614
|
/** @description `nextCursor` from the previous page. */
|
|
2507
2615
|
cursor?: string;
|
|
2508
2616
|
/** @description 1–100, default 50. */
|
|
@@ -2831,8 +2939,8 @@ interface operations {
|
|
|
2831
2939
|
Payouts_list: {
|
|
2832
2940
|
parameters: {
|
|
2833
2941
|
query?: {
|
|
2834
|
-
/** @description Optional status filter. */
|
|
2835
|
-
status?: "pending" | "completed" | "failed";
|
|
2942
|
+
/** @description Optional status filter. `awaiting_approval` lists payouts held for VEX Pay review. */
|
|
2943
|
+
status?: "pending" | "awaiting_approval" | "completed" | "failed";
|
|
2836
2944
|
/** @description Opaque cursor from a previous `nextCursor`. */
|
|
2837
2945
|
cursor?: string;
|
|
2838
2946
|
/** @description Page size 1–100 (default 25). */
|
|
@@ -3847,6 +3955,15 @@ interface operations {
|
|
|
3847
3955
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3848
3956
|
};
|
|
3849
3957
|
};
|
|
3958
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
3959
|
+
409: {
|
|
3960
|
+
headers: {
|
|
3961
|
+
[name: string]: unknown;
|
|
3962
|
+
};
|
|
3963
|
+
content: {
|
|
3964
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3965
|
+
};
|
|
3966
|
+
};
|
|
3850
3967
|
/** @description The banking network rejected the operation. */
|
|
3851
3968
|
422: {
|
|
3852
3969
|
headers: {
|
|
@@ -6097,6 +6214,15 @@ interface operations {
|
|
|
6097
6214
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6098
6215
|
};
|
|
6099
6216
|
};
|
|
6217
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
6218
|
+
409: {
|
|
6219
|
+
headers: {
|
|
6220
|
+
[name: string]: unknown;
|
|
6221
|
+
};
|
|
6222
|
+
content: {
|
|
6223
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6224
|
+
};
|
|
6225
|
+
};
|
|
6100
6226
|
/** @description Client error. */
|
|
6101
6227
|
"4XX": {
|
|
6102
6228
|
headers: {
|
|
@@ -6178,6 +6304,15 @@ interface operations {
|
|
|
6178
6304
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6179
6305
|
};
|
|
6180
6306
|
};
|
|
6307
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
6308
|
+
409: {
|
|
6309
|
+
headers: {
|
|
6310
|
+
[name: string]: unknown;
|
|
6311
|
+
};
|
|
6312
|
+
content: {
|
|
6313
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6314
|
+
};
|
|
6315
|
+
};
|
|
6181
6316
|
/** @description The provider rejected the charge. */
|
|
6182
6317
|
422: {
|
|
6183
6318
|
headers: {
|
|
@@ -6258,6 +6393,15 @@ interface operations {
|
|
|
6258
6393
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6259
6394
|
};
|
|
6260
6395
|
};
|
|
6396
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
6397
|
+
409: {
|
|
6398
|
+
headers: {
|
|
6399
|
+
[name: string]: unknown;
|
|
6400
|
+
};
|
|
6401
|
+
content: {
|
|
6402
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6403
|
+
};
|
|
6404
|
+
};
|
|
6261
6405
|
/** @description The provider rejected the charge. */
|
|
6262
6406
|
422: {
|
|
6263
6407
|
headers: {
|
|
@@ -9048,7 +9192,7 @@ declare class BalanceTransactions extends APIResource {
|
|
|
9048
9192
|
nextCursor: string | null;
|
|
9049
9193
|
}, {
|
|
9050
9194
|
id: string;
|
|
9051
|
-
type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal";
|
|
9195
|
+
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";
|
|
9052
9196
|
amountVes: string;
|
|
9053
9197
|
paymentId?: string;
|
|
9054
9198
|
payoutId?: string;
|
|
@@ -9056,6 +9200,7 @@ declare class BalanceTransactions extends APIResource {
|
|
|
9056
9200
|
merchantId?: string;
|
|
9057
9201
|
externalRef?: string;
|
|
9058
9202
|
description: string;
|
|
9203
|
+
availableAt?: string;
|
|
9059
9204
|
createdAt: string;
|
|
9060
9205
|
}>;
|
|
9061
9206
|
}
|
|
@@ -9072,6 +9217,8 @@ declare class Balance extends APIResource {
|
|
|
9072
9217
|
chargebackFeesVes: string;
|
|
9073
9218
|
reserveVes: string;
|
|
9074
9219
|
ledgerNetVes: string;
|
|
9220
|
+
heldVes?: string;
|
|
9221
|
+
nextReleaseAt?: string | null;
|
|
9075
9222
|
availableVes: string;
|
|
9076
9223
|
platformAvailableVes: string;
|
|
9077
9224
|
sellerObligationsVes: string;
|
|
@@ -9079,13 +9226,15 @@ declare class Balance extends APIResource {
|
|
|
9079
9226
|
sellerAvailableVes: string;
|
|
9080
9227
|
feePercent: string;
|
|
9081
9228
|
feeFixedUsd: string;
|
|
9229
|
+
balanceHoldHours?: number;
|
|
9082
9230
|
}>;
|
|
9083
9231
|
}
|
|
9084
9232
|
/** VES payouts to verified merchants. `externalRef` is the idempotency key. */
|
|
9085
9233
|
declare class Payouts extends APIResource {
|
|
9086
9234
|
create(params: RequestBody<'Payouts_create'>, options?: RequestOptions): Promise<{
|
|
9087
9235
|
payoutId: string;
|
|
9088
|
-
status: "completed" | "pending" | "failed";
|
|
9236
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9237
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9089
9238
|
reference?: string | null;
|
|
9090
9239
|
failureCode?: string | null;
|
|
9091
9240
|
externalRef?: string;
|
|
@@ -9107,7 +9256,8 @@ declare class Payouts extends APIResource {
|
|
|
9107
9256
|
/** Pay out immediately (crédito inmediato). */
|
|
9108
9257
|
createInstant(params: RequestBody<'Payouts_createInstant'>, options?: RequestOptions): Promise<{
|
|
9109
9258
|
payoutId: string;
|
|
9110
|
-
status: "completed" | "pending" | "failed";
|
|
9259
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9260
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9111
9261
|
reference?: string | null;
|
|
9112
9262
|
failureCode?: string | null;
|
|
9113
9263
|
externalRef?: string;
|
|
@@ -9138,7 +9288,8 @@ declare class Payouts extends APIResource {
|
|
|
9138
9288
|
nextCursor?: string | null;
|
|
9139
9289
|
}, {
|
|
9140
9290
|
payoutId: string;
|
|
9141
|
-
status: "completed" | "pending" | "failed";
|
|
9291
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9292
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9142
9293
|
reference?: string | null;
|
|
9143
9294
|
failureCode?: string | null;
|
|
9144
9295
|
externalRef?: string;
|
|
@@ -9159,7 +9310,8 @@ declare class Payouts extends APIResource {
|
|
|
9159
9310
|
}>;
|
|
9160
9311
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
9161
9312
|
payoutId: string;
|
|
9162
|
-
status: "completed" | "pending" | "failed";
|
|
9313
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9314
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9163
9315
|
reference?: string | null;
|
|
9164
9316
|
failureCode?: string | null;
|
|
9165
9317
|
externalRef?: string;
|
|
@@ -9180,7 +9332,8 @@ declare class Payouts extends APIResource {
|
|
|
9180
9332
|
}>;
|
|
9181
9333
|
retrieveByRef(externalRef: string, options?: RequestOptions): Promise<{
|
|
9182
9334
|
payoutId: string;
|
|
9183
|
-
status: "completed" | "pending" | "failed";
|
|
9335
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9336
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9184
9337
|
reference?: string | null;
|
|
9185
9338
|
failureCode?: string | null;
|
|
9186
9339
|
externalRef?: string;
|
|
@@ -9317,6 +9470,8 @@ declare class CheckoutSessions extends APIResource {
|
|
|
9317
9470
|
paymentId?: string | null;
|
|
9318
9471
|
expiresAt: string;
|
|
9319
9472
|
createdAt: string;
|
|
9473
|
+
merchantId?: string | null;
|
|
9474
|
+
applicationFeePercent?: string | null;
|
|
9320
9475
|
livemode: boolean;
|
|
9321
9476
|
}>;
|
|
9322
9477
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
@@ -9338,6 +9493,8 @@ declare class CheckoutSessions extends APIResource {
|
|
|
9338
9493
|
paymentId?: string | null;
|
|
9339
9494
|
expiresAt: string;
|
|
9340
9495
|
createdAt: string;
|
|
9496
|
+
merchantId?: string | null;
|
|
9497
|
+
applicationFeePercent?: string | null;
|
|
9341
9498
|
livemode: boolean;
|
|
9342
9499
|
}>;
|
|
9343
9500
|
}
|
|
@@ -9690,6 +9847,8 @@ declare class CopPayments extends APIResource {
|
|
|
9690
9847
|
declare class CopBalance extends APIResource {
|
|
9691
9848
|
retrieve(options?: RequestOptions): Promise<{
|
|
9692
9849
|
availableCop: number;
|
|
9850
|
+
heldCop?: number;
|
|
9851
|
+
nextReleaseAt?: string | null;
|
|
9693
9852
|
pendingPayoutCop: number;
|
|
9694
9853
|
asOf: string;
|
|
9695
9854
|
}>;
|
|
@@ -9705,9 +9864,12 @@ declare class CryptoBalance extends APIResource {
|
|
|
9705
9864
|
retrieve(params?: QueryParams<'Crypto_getBalance'>, options?: RequestOptions): Promise<{
|
|
9706
9865
|
currency: "USDT" | "USDC";
|
|
9707
9866
|
available: string;
|
|
9867
|
+
held?: string;
|
|
9868
|
+
nextReleaseAt?: string | null;
|
|
9708
9869
|
pendingPayout: string;
|
|
9709
9870
|
availableUsdt?: string;
|
|
9710
9871
|
pendingPayoutUsdt?: string;
|
|
9872
|
+
heldUsdt?: string;
|
|
9711
9873
|
asOf: string;
|
|
9712
9874
|
}>;
|
|
9713
9875
|
}
|
|
@@ -9979,6 +10141,7 @@ declare class Merchants extends APIResource {
|
|
|
9979
10141
|
availableVes: string;
|
|
9980
10142
|
paidOutVes: string;
|
|
9981
10143
|
ledgerNetVes: string;
|
|
10144
|
+
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
9982
10145
|
}>;
|
|
9983
10146
|
/** Move VES between this merchant's balance and another. */
|
|
9984
10147
|
transfer(id: string, params: RequestBody<'Merchants_transfer'>, options?: RequestOptions): Promise<{
|
|
@@ -9989,6 +10152,7 @@ declare class Merchants extends APIResource {
|
|
|
9989
10152
|
availableVes: string;
|
|
9990
10153
|
paidOutVes: string;
|
|
9991
10154
|
ledgerNetVes: string;
|
|
10155
|
+
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
9992
10156
|
}>;
|
|
9993
10157
|
listAuditEvents(id: string, options?: RequestOptions): Promise<{
|
|
9994
10158
|
items: components["schemas"]["MerchantAuditEventDto"][];
|
|
@@ -10562,6 +10726,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
10562
10726
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
10563
10727
|
}
|
|
10564
10728
|
|
|
10565
|
-
declare const VERSION = "0.
|
|
10729
|
+
declare const VERSION = "0.11.0";
|
|
10566
10730
|
|
|
10567
10731
|
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 };
|