@vexpay/node 0.9.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.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +102 -10
- package/dist/index.d.ts +102 -10
- 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
|
};
|
|
@@ -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
|
|
@@ -1592,10 +1638,11 @@ interface components {
|
|
|
1592
1638
|
};
|
|
1593
1639
|
OnwardPayoutStatusDto: {
|
|
1594
1640
|
/**
|
|
1641
|
+
* @description `waiting_release`: converted, waiting for the 24h balance hold to end before sending (see `sendAfter`).
|
|
1595
1642
|
* @example completed
|
|
1596
1643
|
* @enum {string}
|
|
1597
1644
|
*/
|
|
1598
|
-
status: "pending" | "converting" | "sending" | "completed" | "held" | "failed" | "canceled";
|
|
1645
|
+
status: "pending" | "converting" | "waiting_release" | "sending" | "completed" | "held" | "failed" | "canceled";
|
|
1599
1646
|
/** @example BEP20 */
|
|
1600
1647
|
network: string;
|
|
1601
1648
|
/** @example 0x2f5c0000000000000000000000000000000000aa */
|
|
@@ -1628,6 +1675,11 @@ interface components {
|
|
|
1628
1675
|
* @example below_payout_minimum
|
|
1629
1676
|
*/
|
|
1630
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;
|
|
1631
1683
|
/** Format: date-time */
|
|
1632
1684
|
updatedAt: string;
|
|
1633
1685
|
};
|
|
@@ -2152,6 +2204,33 @@ interface components {
|
|
|
2152
2204
|
/** Format: uuid */
|
|
2153
2205
|
payoutMethodId: string;
|
|
2154
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
|
+
};
|
|
2155
2234
|
MerchantBalanceDto: {
|
|
2156
2235
|
/** Format: uuid */
|
|
2157
2236
|
merchantId: string;
|
|
@@ -2167,6 +2246,8 @@ interface components {
|
|
|
2167
2246
|
paidOutVes: string;
|
|
2168
2247
|
/** @example 350.00 */
|
|
2169
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"];
|
|
2170
2251
|
};
|
|
2171
2252
|
CreateMerchantDto: {
|
|
2172
2253
|
/** @example usr_7f3a… */
|
|
@@ -2502,7 +2583,7 @@ interface operations {
|
|
|
2502
2583
|
/** @description Only movements of this payment. */
|
|
2503
2584
|
paymentId?: string;
|
|
2504
2585
|
/** @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")[];
|
|
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")[];
|
|
2506
2587
|
/** @description `nextCursor` from the previous page. */
|
|
2507
2588
|
cursor?: string;
|
|
2508
2589
|
/** @description 1–100, default 50. */
|
|
@@ -9048,7 +9129,7 @@ declare class BalanceTransactions extends APIResource {
|
|
|
9048
9129
|
nextCursor: string | null;
|
|
9049
9130
|
}, {
|
|
9050
9131
|
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";
|
|
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";
|
|
9052
9133
|
amountVes: string;
|
|
9053
9134
|
paymentId?: string;
|
|
9054
9135
|
payoutId?: string;
|
|
@@ -9056,6 +9137,7 @@ declare class BalanceTransactions extends APIResource {
|
|
|
9056
9137
|
merchantId?: string;
|
|
9057
9138
|
externalRef?: string;
|
|
9058
9139
|
description: string;
|
|
9140
|
+
availableAt?: string;
|
|
9059
9141
|
createdAt: string;
|
|
9060
9142
|
}>;
|
|
9061
9143
|
}
|
|
@@ -9072,6 +9154,8 @@ declare class Balance extends APIResource {
|
|
|
9072
9154
|
chargebackFeesVes: string;
|
|
9073
9155
|
reserveVes: string;
|
|
9074
9156
|
ledgerNetVes: string;
|
|
9157
|
+
heldVes?: string;
|
|
9158
|
+
nextReleaseAt?: string | null;
|
|
9075
9159
|
availableVes: string;
|
|
9076
9160
|
platformAvailableVes: string;
|
|
9077
9161
|
sellerObligationsVes: string;
|
|
@@ -9079,6 +9163,7 @@ declare class Balance extends APIResource {
|
|
|
9079
9163
|
sellerAvailableVes: string;
|
|
9080
9164
|
feePercent: string;
|
|
9081
9165
|
feeFixedUsd: string;
|
|
9166
|
+
balanceHoldHours?: number;
|
|
9082
9167
|
}>;
|
|
9083
9168
|
}
|
|
9084
9169
|
/** VES payouts to verified merchants. `externalRef` is the idempotency key. */
|
|
@@ -9690,6 +9775,8 @@ declare class CopPayments extends APIResource {
|
|
|
9690
9775
|
declare class CopBalance extends APIResource {
|
|
9691
9776
|
retrieve(options?: RequestOptions): Promise<{
|
|
9692
9777
|
availableCop: number;
|
|
9778
|
+
heldCop?: number;
|
|
9779
|
+
nextReleaseAt?: string | null;
|
|
9693
9780
|
pendingPayoutCop: number;
|
|
9694
9781
|
asOf: string;
|
|
9695
9782
|
}>;
|
|
@@ -9705,9 +9792,12 @@ declare class CryptoBalance extends APIResource {
|
|
|
9705
9792
|
retrieve(params?: QueryParams<'Crypto_getBalance'>, options?: RequestOptions): Promise<{
|
|
9706
9793
|
currency: "USDT" | "USDC";
|
|
9707
9794
|
available: string;
|
|
9795
|
+
held?: string;
|
|
9796
|
+
nextReleaseAt?: string | null;
|
|
9708
9797
|
pendingPayout: string;
|
|
9709
9798
|
availableUsdt?: string;
|
|
9710
9799
|
pendingPayoutUsdt?: string;
|
|
9800
|
+
heldUsdt?: string;
|
|
9711
9801
|
asOf: string;
|
|
9712
9802
|
}>;
|
|
9713
9803
|
}
|
|
@@ -9979,6 +10069,7 @@ declare class Merchants extends APIResource {
|
|
|
9979
10069
|
availableVes: string;
|
|
9980
10070
|
paidOutVes: string;
|
|
9981
10071
|
ledgerNetVes: string;
|
|
10072
|
+
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
9982
10073
|
}>;
|
|
9983
10074
|
/** Move VES between this merchant's balance and another. */
|
|
9984
10075
|
transfer(id: string, params: RequestBody<'Merchants_transfer'>, options?: RequestOptions): Promise<{
|
|
@@ -9989,6 +10080,7 @@ declare class Merchants extends APIResource {
|
|
|
9989
10080
|
availableVes: string;
|
|
9990
10081
|
paidOutVes: string;
|
|
9991
10082
|
ledgerNetVes: string;
|
|
10083
|
+
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
9992
10084
|
}>;
|
|
9993
10085
|
listAuditEvents(id: string, options?: RequestOptions): Promise<{
|
|
9994
10086
|
items: components["schemas"]["MerchantAuditEventDto"][];
|
|
@@ -10562,6 +10654,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
10562
10654
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
10563
10655
|
}
|
|
10564
10656
|
|
|
10565
|
-
declare const VERSION = "0.
|
|
10657
|
+
declare const VERSION = "0.10.0";
|
|
10566
10658
|
|
|
10567
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 };
|
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
|
|
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
|
};
|
|
@@ -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
|
|
@@ -1592,10 +1638,11 @@ interface components {
|
|
|
1592
1638
|
};
|
|
1593
1639
|
OnwardPayoutStatusDto: {
|
|
1594
1640
|
/**
|
|
1641
|
+
* @description `waiting_release`: converted, waiting for the 24h balance hold to end before sending (see `sendAfter`).
|
|
1595
1642
|
* @example completed
|
|
1596
1643
|
* @enum {string}
|
|
1597
1644
|
*/
|
|
1598
|
-
status: "pending" | "converting" | "sending" | "completed" | "held" | "failed" | "canceled";
|
|
1645
|
+
status: "pending" | "converting" | "waiting_release" | "sending" | "completed" | "held" | "failed" | "canceled";
|
|
1599
1646
|
/** @example BEP20 */
|
|
1600
1647
|
network: string;
|
|
1601
1648
|
/** @example 0x2f5c0000000000000000000000000000000000aa */
|
|
@@ -1628,6 +1675,11 @@ interface components {
|
|
|
1628
1675
|
* @example below_payout_minimum
|
|
1629
1676
|
*/
|
|
1630
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;
|
|
1631
1683
|
/** Format: date-time */
|
|
1632
1684
|
updatedAt: string;
|
|
1633
1685
|
};
|
|
@@ -2152,6 +2204,33 @@ interface components {
|
|
|
2152
2204
|
/** Format: uuid */
|
|
2153
2205
|
payoutMethodId: string;
|
|
2154
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
|
+
};
|
|
2155
2234
|
MerchantBalanceDto: {
|
|
2156
2235
|
/** Format: uuid */
|
|
2157
2236
|
merchantId: string;
|
|
@@ -2167,6 +2246,8 @@ interface components {
|
|
|
2167
2246
|
paidOutVes: string;
|
|
2168
2247
|
/** @example 350.00 */
|
|
2169
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"];
|
|
2170
2251
|
};
|
|
2171
2252
|
CreateMerchantDto: {
|
|
2172
2253
|
/** @example usr_7f3a… */
|
|
@@ -2502,7 +2583,7 @@ interface operations {
|
|
|
2502
2583
|
/** @description Only movements of this payment. */
|
|
2503
2584
|
paymentId?: string;
|
|
2504
2585
|
/** @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")[];
|
|
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")[];
|
|
2506
2587
|
/** @description `nextCursor` from the previous page. */
|
|
2507
2588
|
cursor?: string;
|
|
2508
2589
|
/** @description 1–100, default 50. */
|
|
@@ -9048,7 +9129,7 @@ declare class BalanceTransactions extends APIResource {
|
|
|
9048
9129
|
nextCursor: string | null;
|
|
9049
9130
|
}, {
|
|
9050
9131
|
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";
|
|
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";
|
|
9052
9133
|
amountVes: string;
|
|
9053
9134
|
paymentId?: string;
|
|
9054
9135
|
payoutId?: string;
|
|
@@ -9056,6 +9137,7 @@ declare class BalanceTransactions extends APIResource {
|
|
|
9056
9137
|
merchantId?: string;
|
|
9057
9138
|
externalRef?: string;
|
|
9058
9139
|
description: string;
|
|
9140
|
+
availableAt?: string;
|
|
9059
9141
|
createdAt: string;
|
|
9060
9142
|
}>;
|
|
9061
9143
|
}
|
|
@@ -9072,6 +9154,8 @@ declare class Balance extends APIResource {
|
|
|
9072
9154
|
chargebackFeesVes: string;
|
|
9073
9155
|
reserveVes: string;
|
|
9074
9156
|
ledgerNetVes: string;
|
|
9157
|
+
heldVes?: string;
|
|
9158
|
+
nextReleaseAt?: string | null;
|
|
9075
9159
|
availableVes: string;
|
|
9076
9160
|
platformAvailableVes: string;
|
|
9077
9161
|
sellerObligationsVes: string;
|
|
@@ -9079,6 +9163,7 @@ declare class Balance extends APIResource {
|
|
|
9079
9163
|
sellerAvailableVes: string;
|
|
9080
9164
|
feePercent: string;
|
|
9081
9165
|
feeFixedUsd: string;
|
|
9166
|
+
balanceHoldHours?: number;
|
|
9082
9167
|
}>;
|
|
9083
9168
|
}
|
|
9084
9169
|
/** VES payouts to verified merchants. `externalRef` is the idempotency key. */
|
|
@@ -9690,6 +9775,8 @@ declare class CopPayments extends APIResource {
|
|
|
9690
9775
|
declare class CopBalance extends APIResource {
|
|
9691
9776
|
retrieve(options?: RequestOptions): Promise<{
|
|
9692
9777
|
availableCop: number;
|
|
9778
|
+
heldCop?: number;
|
|
9779
|
+
nextReleaseAt?: string | null;
|
|
9693
9780
|
pendingPayoutCop: number;
|
|
9694
9781
|
asOf: string;
|
|
9695
9782
|
}>;
|
|
@@ -9705,9 +9792,12 @@ declare class CryptoBalance extends APIResource {
|
|
|
9705
9792
|
retrieve(params?: QueryParams<'Crypto_getBalance'>, options?: RequestOptions): Promise<{
|
|
9706
9793
|
currency: "USDT" | "USDC";
|
|
9707
9794
|
available: string;
|
|
9795
|
+
held?: string;
|
|
9796
|
+
nextReleaseAt?: string | null;
|
|
9708
9797
|
pendingPayout: string;
|
|
9709
9798
|
availableUsdt?: string;
|
|
9710
9799
|
pendingPayoutUsdt?: string;
|
|
9800
|
+
heldUsdt?: string;
|
|
9711
9801
|
asOf: string;
|
|
9712
9802
|
}>;
|
|
9713
9803
|
}
|
|
@@ -9979,6 +10069,7 @@ declare class Merchants extends APIResource {
|
|
|
9979
10069
|
availableVes: string;
|
|
9980
10070
|
paidOutVes: string;
|
|
9981
10071
|
ledgerNetVes: string;
|
|
10072
|
+
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
9982
10073
|
}>;
|
|
9983
10074
|
/** Move VES between this merchant's balance and another. */
|
|
9984
10075
|
transfer(id: string, params: RequestBody<'Merchants_transfer'>, options?: RequestOptions): Promise<{
|
|
@@ -9989,6 +10080,7 @@ declare class Merchants extends APIResource {
|
|
|
9989
10080
|
availableVes: string;
|
|
9990
10081
|
paidOutVes: string;
|
|
9991
10082
|
ledgerNetVes: string;
|
|
10083
|
+
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
9992
10084
|
}>;
|
|
9993
10085
|
listAuditEvents(id: string, options?: RequestOptions): Promise<{
|
|
9994
10086
|
items: components["schemas"]["MerchantAuditEventDto"][];
|
|
@@ -10562,6 +10654,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
10562
10654
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
10563
10655
|
}
|
|
10564
10656
|
|
|
10565
|
-
declare const VERSION = "0.
|
|
10657
|
+
declare const VERSION = "0.10.0";
|
|
10566
10658
|
|
|
10567
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 };
|