@vexpay/node 0.2.1 → 0.4.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 +71 -0
- package/dist/index.cjs +62 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +957 -60
- package/dist/index.d.ts +957 -60
- package/dist/index.js +62 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -61,6 +61,16 @@ interface components {
|
|
|
61
61
|
feesVes: string;
|
|
62
62
|
/** @example 1000.00 */
|
|
63
63
|
paidOutVes: string;
|
|
64
|
+
/**
|
|
65
|
+
* @description Net VES spent on VES→USDT conversions.
|
|
66
|
+
* @example 0.00
|
|
67
|
+
*/
|
|
68
|
+
convertedVes: string;
|
|
69
|
+
/**
|
|
70
|
+
* @description Net card chargeback fees charged (fees minus fees returned on won disputes).
|
|
71
|
+
* @example 0.00
|
|
72
|
+
*/
|
|
73
|
+
chargebackFeesVes: string;
|
|
64
74
|
/** @example 100.00 */
|
|
65
75
|
reserveVes: string;
|
|
66
76
|
/** @example 8650.00 */
|
|
@@ -86,6 +96,48 @@ interface components {
|
|
|
86
96
|
/** @example 0.00 */
|
|
87
97
|
feeFixedUsd: string;
|
|
88
98
|
};
|
|
99
|
+
BalanceTransactionDto: {
|
|
100
|
+
/**
|
|
101
|
+
* Format: uuid
|
|
102
|
+
* @description Stable id of the movement; never changes or disappears.
|
|
103
|
+
*/
|
|
104
|
+
id: string;
|
|
105
|
+
/**
|
|
106
|
+
* @example chargeback
|
|
107
|
+
* @enum {string}
|
|
108
|
+
*/
|
|
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";
|
|
110
|
+
/**
|
|
111
|
+
* @description Signed VES amount (negative = money out of your balance).
|
|
112
|
+
* @example -4000.00
|
|
113
|
+
*/
|
|
114
|
+
amountVes: string;
|
|
115
|
+
/** Format: uuid */
|
|
116
|
+
paymentId?: string;
|
|
117
|
+
/** Format: uuid */
|
|
118
|
+
payoutId?: string;
|
|
119
|
+
/**
|
|
120
|
+
* Format: uuid
|
|
121
|
+
* @description Present on chargeback movements.
|
|
122
|
+
*/
|
|
123
|
+
chargebackId?: string;
|
|
124
|
+
/** Format: uuid */
|
|
125
|
+
merchantId?: string;
|
|
126
|
+
/**
|
|
127
|
+
* @description externalRef of the linked payment or payout.
|
|
128
|
+
* @example order-1042
|
|
129
|
+
*/
|
|
130
|
+
externalRef?: string;
|
|
131
|
+
/** @example Card chargeback (fraud) */
|
|
132
|
+
description: string;
|
|
133
|
+
/** Format: date-time */
|
|
134
|
+
createdAt: string;
|
|
135
|
+
};
|
|
136
|
+
BalanceTransactionListDto: {
|
|
137
|
+
items: components["schemas"]["BalanceTransactionDto"][];
|
|
138
|
+
/** @description Pass as `cursor` to get the next (older) page; null on the last page. */
|
|
139
|
+
nextCursor: string | null;
|
|
140
|
+
};
|
|
89
141
|
CreateWebhookDto: {
|
|
90
142
|
/**
|
|
91
143
|
* Format: uri
|
|
@@ -103,7 +155,7 @@ interface components {
|
|
|
103
155
|
* "payment.failed"
|
|
104
156
|
* ]
|
|
105
157
|
*/
|
|
106
|
-
events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "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" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
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.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
107
159
|
};
|
|
108
160
|
WebhookEndpointDto: {
|
|
109
161
|
/** Format: uuid */
|
|
@@ -112,7 +164,7 @@ interface components {
|
|
|
112
164
|
tenantId: string;
|
|
113
165
|
/** Format: uri */
|
|
114
166
|
url: string;
|
|
115
|
-
events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "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" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
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.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
116
168
|
isActive: boolean;
|
|
117
169
|
/** Format: date-time */
|
|
118
170
|
createdAt: string;
|
|
@@ -133,7 +185,7 @@ interface components {
|
|
|
133
185
|
* "payout.completed"
|
|
134
186
|
* ]
|
|
135
187
|
*/
|
|
136
|
-
events?: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "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" | "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.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
137
189
|
/** @example true */
|
|
138
190
|
isActive?: boolean;
|
|
139
191
|
};
|
|
@@ -896,21 +948,38 @@ interface components {
|
|
|
896
948
|
ip?: string;
|
|
897
949
|
};
|
|
898
950
|
CryptoBalanceDto: {
|
|
899
|
-
/** @example USDT */
|
|
900
|
-
currency: string;
|
|
901
951
|
/**
|
|
902
|
-
* @
|
|
952
|
+
* @example USDT
|
|
953
|
+
* @enum {string}
|
|
954
|
+
*/
|
|
955
|
+
currency: "USDT" | "USDC";
|
|
956
|
+
/**
|
|
957
|
+
* @description Available for payouts, in `currency` (ledger).
|
|
958
|
+
* @example 97.00
|
|
959
|
+
*/
|
|
960
|
+
available: string;
|
|
961
|
+
/**
|
|
962
|
+
* @description Reserved by payouts that have not completed yet, in `currency`.
|
|
963
|
+
* @example 50.10
|
|
964
|
+
*/
|
|
965
|
+
pendingPayout: string;
|
|
966
|
+
/**
|
|
967
|
+
* @description USDT only: same as `available`.
|
|
903
968
|
* @example 97.00
|
|
904
969
|
*/
|
|
905
|
-
availableUsdt
|
|
970
|
+
availableUsdt?: string;
|
|
906
971
|
/**
|
|
907
|
-
* @description USDT
|
|
972
|
+
* @description USDT only: same as `pendingPayout`.
|
|
908
973
|
* @example 50.10
|
|
909
974
|
*/
|
|
910
|
-
pendingPayoutUsdt
|
|
975
|
+
pendingPayoutUsdt?: string;
|
|
911
976
|
/** Format: date-time */
|
|
912
977
|
asOf: string;
|
|
913
978
|
};
|
|
979
|
+
CryptoBalancesDto: {
|
|
980
|
+
/** @description One balance per stablecoin (USDT, USDC). */
|
|
981
|
+
data: components["schemas"]["CryptoBalanceDto"][];
|
|
982
|
+
};
|
|
914
983
|
CreateDepositAddressDto: {
|
|
915
984
|
/**
|
|
916
985
|
* @description Your identifier for the customer this address belongs to (1–128 chars: A–Z a–z 0–9 _ . : @ -).
|
|
@@ -918,18 +987,29 @@ interface components {
|
|
|
918
987
|
*/
|
|
919
988
|
customerRef: string;
|
|
920
989
|
/**
|
|
990
|
+
* @description USDT: TRC20, BEP20, POLYGON, SOL, TON, ARB1. USDC: POLYGON, BASE.
|
|
921
991
|
* @example BEP20
|
|
922
992
|
* @enum {string}
|
|
923
993
|
*/
|
|
924
|
-
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1";
|
|
994
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1" | "BASE";
|
|
995
|
+
/**
|
|
996
|
+
* @description Stablecoin the address receives.
|
|
997
|
+
* @default USDT
|
|
998
|
+
* @example USDT
|
|
999
|
+
* @enum {string}
|
|
1000
|
+
*/
|
|
1001
|
+
currency?: "USDT" | "USDC";
|
|
925
1002
|
};
|
|
926
1003
|
DepositAddressDto: {
|
|
927
1004
|
/** @example user_123 */
|
|
928
1005
|
customerRef: string;
|
|
929
1006
|
/** @example BEP20 */
|
|
930
1007
|
network: string;
|
|
931
|
-
/**
|
|
932
|
-
|
|
1008
|
+
/**
|
|
1009
|
+
* @example USDT
|
|
1010
|
+
* @enum {string}
|
|
1011
|
+
*/
|
|
1012
|
+
currency: "USDT" | "USDC";
|
|
933
1013
|
/** @example 0x9f3c… */
|
|
934
1014
|
address: string;
|
|
935
1015
|
/** @description Destination tag / memo the payer must include (TON). */
|
|
@@ -940,35 +1020,69 @@ interface components {
|
|
|
940
1020
|
createdAt: string;
|
|
941
1021
|
};
|
|
942
1022
|
CryptoNetworkDto: {
|
|
1023
|
+
/**
|
|
1024
|
+
* @example USDT
|
|
1025
|
+
* @enum {string}
|
|
1026
|
+
*/
|
|
1027
|
+
currency: "USDT" | "USDC";
|
|
943
1028
|
/** @example POLYGON */
|
|
944
1029
|
network: string;
|
|
945
1030
|
/** @example Polygon */
|
|
946
1031
|
displayName: string;
|
|
947
1032
|
receiveEnabled: boolean;
|
|
948
1033
|
payoutEnabled: boolean;
|
|
949
|
-
/**
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
1034
|
+
/**
|
|
1035
|
+
* @description Payout fee in `currency`.
|
|
1036
|
+
* @example 0.10
|
|
1037
|
+
*/
|
|
1038
|
+
payoutFee: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* @description Minimum payout in `currency`.
|
|
1041
|
+
* @example 1.00
|
|
1042
|
+
*/
|
|
1043
|
+
minPayout: string;
|
|
1044
|
+
/**
|
|
1045
|
+
* @description USDT only: same as `payoutFee`.
|
|
1046
|
+
* @example 0.10
|
|
1047
|
+
*/
|
|
1048
|
+
payoutFeeUsdt?: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* @description USDT only: same as `minPayout`.
|
|
1051
|
+
* @example 1.00
|
|
1052
|
+
*/
|
|
1053
|
+
minPayoutUsdt?: string;
|
|
953
1054
|
tagRequired: boolean;
|
|
954
1055
|
/** @description Whether a payout of the requested amount can be sent on this network now. */
|
|
955
1056
|
available: boolean;
|
|
956
1057
|
};
|
|
957
1058
|
CreateCryptoPayoutDto: {
|
|
958
1059
|
/**
|
|
1060
|
+
* @description Stablecoin to send; debits that balance.
|
|
1061
|
+
* @default USDT
|
|
1062
|
+
* @example USDT
|
|
1063
|
+
* @enum {string}
|
|
1064
|
+
*/
|
|
1065
|
+
currency?: "USDT" | "USDC";
|
|
1066
|
+
/**
|
|
1067
|
+
* @description USDT: TRC20, BEP20, POLYGON, SOL, TON, ARB1. USDC: POLYGON, BASE.
|
|
959
1068
|
* @example POLYGON
|
|
960
1069
|
* @enum {string}
|
|
961
1070
|
*/
|
|
962
|
-
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1";
|
|
1071
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1" | "BASE";
|
|
963
1072
|
/** @example 0x9f3c4e1b2a7d6c5e4f3a2b1c0d9e8f7a6b5c4d3e */
|
|
964
1073
|
address: string;
|
|
965
1074
|
/** @description Destination tag / memo (required on TON). */
|
|
966
1075
|
tag?: string;
|
|
967
1076
|
/**
|
|
968
|
-
* @description Amount the destination receives, in
|
|
1077
|
+
* @description Amount the destination receives, in `currency` (max 2 decimals).
|
|
1078
|
+
* @example 50.00
|
|
1079
|
+
*/
|
|
1080
|
+
amount?: string;
|
|
1081
|
+
/**
|
|
1082
|
+
* @description USDT only: alias of `amount`.
|
|
969
1083
|
* @example 50.00
|
|
970
1084
|
*/
|
|
971
|
-
amountUsdt
|
|
1085
|
+
amountUsdt?: string;
|
|
972
1086
|
/**
|
|
973
1087
|
* @description Your customer reference, echoed on webhooks.
|
|
974
1088
|
* @example user_123
|
|
@@ -984,20 +1098,36 @@ interface components {
|
|
|
984
1098
|
id: string;
|
|
985
1099
|
/** @example crypto.payout */
|
|
986
1100
|
object: string;
|
|
987
|
-
/**
|
|
988
|
-
|
|
1101
|
+
/**
|
|
1102
|
+
* @example USDT
|
|
1103
|
+
* @enum {string}
|
|
1104
|
+
*/
|
|
1105
|
+
currency: "USDT" | "USDC";
|
|
989
1106
|
/** @enum {string} */
|
|
990
1107
|
status: "pending" | "processing" | "completed" | "failed";
|
|
991
1108
|
network: string;
|
|
992
1109
|
address: string;
|
|
993
1110
|
tag?: string;
|
|
994
|
-
/** @example 50.00 */
|
|
995
|
-
amountUsdt: string;
|
|
996
1111
|
/**
|
|
997
|
-
* @description
|
|
1112
|
+
* @description Amount sent, in `currency`.
|
|
1113
|
+
* @example 50.00
|
|
1114
|
+
*/
|
|
1115
|
+
amount: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* @description Network fee + margin, in `currency` (0 for internal).
|
|
998
1118
|
* @example 0.10
|
|
999
1119
|
*/
|
|
1000
|
-
|
|
1120
|
+
fee: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* @description USDT only: same as `amount`.
|
|
1123
|
+
* @example 50.00
|
|
1124
|
+
*/
|
|
1125
|
+
amountUsdt?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* @description USDT only: same as `fee`.
|
|
1128
|
+
* @example 0.10
|
|
1129
|
+
*/
|
|
1130
|
+
feeUsdt?: string;
|
|
1001
1131
|
customerRef?: string;
|
|
1002
1132
|
merchantId?: string;
|
|
1003
1133
|
idempotencyKey: string;
|
|
@@ -1010,6 +1140,94 @@ interface components {
|
|
|
1010
1140
|
/** Format: date-time */
|
|
1011
1141
|
completedAt?: string;
|
|
1012
1142
|
};
|
|
1143
|
+
CreateConversionQuoteDto: {
|
|
1144
|
+
/**
|
|
1145
|
+
* @description VES to spend. Send this or `targetAmountUsdt`, not both.
|
|
1146
|
+
* @example 10000.00
|
|
1147
|
+
*/
|
|
1148
|
+
sourceAmountVes?: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* @description USDT to receive. Send this or `sourceAmountVes`, not both.
|
|
1151
|
+
* @example 50.00
|
|
1152
|
+
*/
|
|
1153
|
+
targetAmountUsdt?: string;
|
|
1154
|
+
};
|
|
1155
|
+
ConversionQuoteDto: {
|
|
1156
|
+
id: string;
|
|
1157
|
+
/** @example conversion_quote */
|
|
1158
|
+
object: string;
|
|
1159
|
+
/**
|
|
1160
|
+
* @description VES per 1 USDT you get: market rate plus your spread.
|
|
1161
|
+
* @example 998.8299
|
|
1162
|
+
*/
|
|
1163
|
+
rate: string;
|
|
1164
|
+
/**
|
|
1165
|
+
* @description Market USDT/VES rate the quote is based on.
|
|
1166
|
+
* @example 979.2450
|
|
1167
|
+
*/
|
|
1168
|
+
marketRate: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* @description Your spread, in percent.
|
|
1171
|
+
* @example 2.0000
|
|
1172
|
+
*/
|
|
1173
|
+
spreadPercent: string;
|
|
1174
|
+
/**
|
|
1175
|
+
* @example market
|
|
1176
|
+
* @enum {string}
|
|
1177
|
+
*/
|
|
1178
|
+
rateSource: "market";
|
|
1179
|
+
/** @example 10000.00 */
|
|
1180
|
+
sourceAmountVes: string;
|
|
1181
|
+
/**
|
|
1182
|
+
* @description Rounded down to the cent.
|
|
1183
|
+
* @example 10.01
|
|
1184
|
+
*/
|
|
1185
|
+
targetAmountUsdt: string;
|
|
1186
|
+
/** @description The quote can be accepted until this time (60 seconds). */
|
|
1187
|
+
expiresAt: string;
|
|
1188
|
+
createdAt: string;
|
|
1189
|
+
};
|
|
1190
|
+
CreateConversionDto: {
|
|
1191
|
+
/** @description A live quote from `POST /v1/conversions/quotes`. Each quote can be used once. */
|
|
1192
|
+
quoteId: string;
|
|
1193
|
+
/**
|
|
1194
|
+
* @description Your reference, echoed on the conversion and its webhooks.
|
|
1195
|
+
* @example treasury-2026-10-03
|
|
1196
|
+
*/
|
|
1197
|
+
reference?: string;
|
|
1198
|
+
};
|
|
1199
|
+
ConversionDto: {
|
|
1200
|
+
id: string;
|
|
1201
|
+
/** @example conversion */
|
|
1202
|
+
object: string;
|
|
1203
|
+
/** @enum {string} */
|
|
1204
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
1205
|
+
reference: string | null;
|
|
1206
|
+
/** @example 998.8299 */
|
|
1207
|
+
rate: string;
|
|
1208
|
+
/** @example 979.2450 */
|
|
1209
|
+
marketRate: string;
|
|
1210
|
+
/** @example 2.0000 */
|
|
1211
|
+
spreadPercent: string;
|
|
1212
|
+
/**
|
|
1213
|
+
* @example market
|
|
1214
|
+
* @enum {string}
|
|
1215
|
+
*/
|
|
1216
|
+
rateSource: "market";
|
|
1217
|
+
/** @example 10000.00 */
|
|
1218
|
+
sourceAmountVes: string;
|
|
1219
|
+
/** @example 10.01 */
|
|
1220
|
+
targetAmountUsdt: string;
|
|
1221
|
+
createdAt: string;
|
|
1222
|
+
completedAt: string | null;
|
|
1223
|
+
canceledAt: string | null;
|
|
1224
|
+
cancelReason: string | null;
|
|
1225
|
+
};
|
|
1226
|
+
ConversionListDto: {
|
|
1227
|
+
items: components["schemas"]["ConversionDto"][];
|
|
1228
|
+
/** @description Pass as `cursor` to get the next page. */
|
|
1229
|
+
nextCursor: string | null;
|
|
1230
|
+
};
|
|
1013
1231
|
BankResponseDto: {
|
|
1014
1232
|
/**
|
|
1015
1233
|
* @description Canonical four-digit SIMF bank code.
|
|
@@ -1685,7 +1903,7 @@ interface components {
|
|
|
1685
1903
|
*/
|
|
1686
1904
|
allowedOrigins?: string[];
|
|
1687
1905
|
/** @description Payment methods offered. Defaults to every method your account can accept. */
|
|
1688
|
-
methods?: ("c2p" | "vpos" | "usdt")[];
|
|
1906
|
+
methods?: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
1689
1907
|
/**
|
|
1690
1908
|
* @description Up to 20 string key/value pairs (keys ≤ 40 chars, values ≤ 500 chars).
|
|
1691
1909
|
* @example {
|
|
@@ -1721,7 +1939,7 @@ interface components {
|
|
|
1721
1939
|
[key: string]: string;
|
|
1722
1940
|
};
|
|
1723
1941
|
allowedOrigins: string[];
|
|
1724
|
-
methods: ("c2p" | "vpos" | "usdt")[];
|
|
1942
|
+
methods: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
1725
1943
|
successUrl?: string | null;
|
|
1726
1944
|
cancelUrl?: string | null;
|
|
1727
1945
|
/** @description Latest payment for this session, once one exists. */
|
|
@@ -1891,6 +2109,85 @@ interface operations {
|
|
|
1891
2109
|
};
|
|
1892
2110
|
};
|
|
1893
2111
|
};
|
|
2112
|
+
Balance_listTransactions: {
|
|
2113
|
+
parameters: {
|
|
2114
|
+
query?: {
|
|
2115
|
+
/** @description ISO 8601, exclusive (createdAt). */
|
|
2116
|
+
to?: string;
|
|
2117
|
+
/** @description ISO 8601, inclusive (createdAt). */
|
|
2118
|
+
from?: string;
|
|
2119
|
+
/** @description Only movements of this payout. */
|
|
2120
|
+
payoutId?: string;
|
|
2121
|
+
/** @description Only movements of this payment. */
|
|
2122
|
+
paymentId?: string;
|
|
2123
|
+
/** @description One or more types (repeat or comma-separate). */
|
|
2124
|
+
type?: ("payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal")[];
|
|
2125
|
+
/** @description `nextCursor` from the previous page. */
|
|
2126
|
+
cursor?: string;
|
|
2127
|
+
/** @description 1–100, default 50. */
|
|
2128
|
+
limit?: number;
|
|
2129
|
+
};
|
|
2130
|
+
header?: never;
|
|
2131
|
+
path?: never;
|
|
2132
|
+
cookie?: never;
|
|
2133
|
+
};
|
|
2134
|
+
requestBody?: never;
|
|
2135
|
+
responses: {
|
|
2136
|
+
200: {
|
|
2137
|
+
headers: {
|
|
2138
|
+
[name: string]: unknown;
|
|
2139
|
+
};
|
|
2140
|
+
content: {
|
|
2141
|
+
"application/json": components["schemas"]["BalanceTransactionListDto"];
|
|
2142
|
+
};
|
|
2143
|
+
};
|
|
2144
|
+
/** @description `invalid_data` — a parameter is invalid. */
|
|
2145
|
+
400: {
|
|
2146
|
+
headers: {
|
|
2147
|
+
[name: string]: unknown;
|
|
2148
|
+
};
|
|
2149
|
+
content: {
|
|
2150
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2151
|
+
};
|
|
2152
|
+
};
|
|
2153
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
2154
|
+
401: {
|
|
2155
|
+
headers: {
|
|
2156
|
+
[name: string]: unknown;
|
|
2157
|
+
};
|
|
2158
|
+
content: {
|
|
2159
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2160
|
+
};
|
|
2161
|
+
};
|
|
2162
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2163
|
+
403: {
|
|
2164
|
+
headers: {
|
|
2165
|
+
[name: string]: unknown;
|
|
2166
|
+
};
|
|
2167
|
+
content: {
|
|
2168
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2169
|
+
};
|
|
2170
|
+
};
|
|
2171
|
+
/** @description Client error. */
|
|
2172
|
+
"4XX": {
|
|
2173
|
+
headers: {
|
|
2174
|
+
[name: string]: unknown;
|
|
2175
|
+
};
|
|
2176
|
+
content: {
|
|
2177
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2178
|
+
};
|
|
2179
|
+
};
|
|
2180
|
+
/** @description Server or upstream bank error. */
|
|
2181
|
+
"5XX": {
|
|
2182
|
+
headers: {
|
|
2183
|
+
[name: string]: unknown;
|
|
2184
|
+
};
|
|
2185
|
+
content: {
|
|
2186
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2187
|
+
};
|
|
2188
|
+
};
|
|
2189
|
+
};
|
|
2190
|
+
};
|
|
1894
2191
|
Webhooks_listWebhooks: {
|
|
1895
2192
|
parameters: {
|
|
1896
2193
|
query?: never;
|
|
@@ -3856,7 +4153,9 @@ interface operations {
|
|
|
3856
4153
|
};
|
|
3857
4154
|
Crypto_getBalance: {
|
|
3858
4155
|
parameters: {
|
|
3859
|
-
query?:
|
|
4156
|
+
query?: {
|
|
4157
|
+
currency?: "USDT" | "USDC";
|
|
4158
|
+
};
|
|
3860
4159
|
header?: never;
|
|
3861
4160
|
path?: never;
|
|
3862
4161
|
cookie?: never;
|
|
@@ -3871,6 +4170,70 @@ interface operations {
|
|
|
3871
4170
|
"application/json": components["schemas"]["CryptoBalanceDto"];
|
|
3872
4171
|
};
|
|
3873
4172
|
};
|
|
4173
|
+
/** @description `unsupported_currency`. */
|
|
4174
|
+
400: {
|
|
4175
|
+
headers: {
|
|
4176
|
+
[name: string]: unknown;
|
|
4177
|
+
};
|
|
4178
|
+
content: {
|
|
4179
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4180
|
+
};
|
|
4181
|
+
};
|
|
4182
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4183
|
+
401: {
|
|
4184
|
+
headers: {
|
|
4185
|
+
[name: string]: unknown;
|
|
4186
|
+
};
|
|
4187
|
+
content: {
|
|
4188
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4189
|
+
};
|
|
4190
|
+
};
|
|
4191
|
+
/** @description `method_not_allowed` — USDC is not enabled for this account. */
|
|
4192
|
+
403: {
|
|
4193
|
+
headers: {
|
|
4194
|
+
[name: string]: unknown;
|
|
4195
|
+
};
|
|
4196
|
+
content: {
|
|
4197
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4198
|
+
};
|
|
4199
|
+
};
|
|
4200
|
+
/** @description Client error. */
|
|
4201
|
+
"4XX": {
|
|
4202
|
+
headers: {
|
|
4203
|
+
[name: string]: unknown;
|
|
4204
|
+
};
|
|
4205
|
+
content: {
|
|
4206
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4207
|
+
};
|
|
4208
|
+
};
|
|
4209
|
+
/** @description Server or upstream bank error. */
|
|
4210
|
+
"5XX": {
|
|
4211
|
+
headers: {
|
|
4212
|
+
[name: string]: unknown;
|
|
4213
|
+
};
|
|
4214
|
+
content: {
|
|
4215
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4216
|
+
};
|
|
4217
|
+
};
|
|
4218
|
+
};
|
|
4219
|
+
};
|
|
4220
|
+
Crypto_getBalances: {
|
|
4221
|
+
parameters: {
|
|
4222
|
+
query?: never;
|
|
4223
|
+
header?: never;
|
|
4224
|
+
path?: never;
|
|
4225
|
+
cookie?: never;
|
|
4226
|
+
};
|
|
4227
|
+
requestBody?: never;
|
|
4228
|
+
responses: {
|
|
4229
|
+
200: {
|
|
4230
|
+
headers: {
|
|
4231
|
+
[name: string]: unknown;
|
|
4232
|
+
};
|
|
4233
|
+
content: {
|
|
4234
|
+
"application/json": components["schemas"]["CryptoBalancesDto"];
|
|
4235
|
+
};
|
|
4236
|
+
};
|
|
3874
4237
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
3875
4238
|
401: {
|
|
3876
4239
|
headers: {
|
|
@@ -3933,7 +4296,7 @@ interface operations {
|
|
|
3933
4296
|
"application/json": components["schemas"]["DepositAddressDto"];
|
|
3934
4297
|
};
|
|
3935
4298
|
};
|
|
3936
|
-
/** @description `unsupported_network` or invalid `customerRef`. */
|
|
4299
|
+
/** @description `unsupported_currency`, `unsupported_network` or invalid `customerRef`. */
|
|
3937
4300
|
400: {
|
|
3938
4301
|
headers: {
|
|
3939
4302
|
[name: string]: unknown;
|
|
@@ -3951,7 +4314,7 @@ interface operations {
|
|
|
3951
4314
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3952
4315
|
};
|
|
3953
4316
|
};
|
|
3954
|
-
/** @description `method_not_allowed` —
|
|
4317
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
3955
4318
|
403: {
|
|
3956
4319
|
headers: {
|
|
3957
4320
|
[name: string]: unknown;
|
|
@@ -3983,7 +4346,10 @@ interface operations {
|
|
|
3983
4346
|
Crypto_listNetworks: {
|
|
3984
4347
|
parameters: {
|
|
3985
4348
|
query?: {
|
|
4349
|
+
/** @description Alias of `amount`. */
|
|
3986
4350
|
amountUsdt?: string;
|
|
4351
|
+
currency?: "USDT" | "USDC";
|
|
4352
|
+
amount?: string;
|
|
3987
4353
|
};
|
|
3988
4354
|
header?: never;
|
|
3989
4355
|
path?: never;
|
|
@@ -3999,6 +4365,15 @@ interface operations {
|
|
|
3999
4365
|
"application/json": components["schemas"]["CryptoNetworkDto"][];
|
|
4000
4366
|
};
|
|
4001
4367
|
};
|
|
4368
|
+
/** @description `unsupported_currency`. */
|
|
4369
|
+
400: {
|
|
4370
|
+
headers: {
|
|
4371
|
+
[name: string]: unknown;
|
|
4372
|
+
};
|
|
4373
|
+
content: {
|
|
4374
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4375
|
+
};
|
|
4376
|
+
};
|
|
4002
4377
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4003
4378
|
401: {
|
|
4004
4379
|
headers: {
|
|
@@ -4008,7 +4383,7 @@ interface operations {
|
|
|
4008
4383
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4009
4384
|
};
|
|
4010
4385
|
};
|
|
4011
|
-
/** @description `method_not_allowed` —
|
|
4386
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
4012
4387
|
403: {
|
|
4013
4388
|
headers: {
|
|
4014
4389
|
[name: string]: unknown;
|
|
@@ -4071,7 +4446,7 @@ interface operations {
|
|
|
4071
4446
|
"application/json": components["schemas"]["CryptoPayoutDto"];
|
|
4072
4447
|
};
|
|
4073
4448
|
};
|
|
4074
|
-
/** @description `unsupported_network`, `invalid_address` or `invalid_data`. */
|
|
4449
|
+
/** @description `unsupported_currency`, `unsupported_network`, `invalid_address` or `invalid_data`. */
|
|
4075
4450
|
400: {
|
|
4076
4451
|
headers: {
|
|
4077
4452
|
[name: string]: unknown;
|
|
@@ -4089,7 +4464,7 @@ interface operations {
|
|
|
4089
4464
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4090
4465
|
};
|
|
4091
4466
|
};
|
|
4092
|
-
/** @description
|
|
4467
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
4093
4468
|
403: {
|
|
4094
4469
|
headers: {
|
|
4095
4470
|
[name: string]: unknown;
|
|
@@ -4193,10 +4568,398 @@ interface operations {
|
|
|
4193
4568
|
};
|
|
4194
4569
|
};
|
|
4195
4570
|
};
|
|
4196
|
-
|
|
4571
|
+
Conversions_createQuote: {
|
|
4197
4572
|
parameters: {
|
|
4198
4573
|
query?: never;
|
|
4199
|
-
header?:
|
|
4574
|
+
header?: {
|
|
4575
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4576
|
+
"Idempotency-Key"?: string;
|
|
4577
|
+
};
|
|
4578
|
+
path?: never;
|
|
4579
|
+
cookie?: never;
|
|
4580
|
+
};
|
|
4581
|
+
requestBody: {
|
|
4582
|
+
content: {
|
|
4583
|
+
"application/json": components["schemas"]["CreateConversionQuoteDto"];
|
|
4584
|
+
};
|
|
4585
|
+
};
|
|
4586
|
+
responses: {
|
|
4587
|
+
201: {
|
|
4588
|
+
headers: {
|
|
4589
|
+
[name: string]: unknown;
|
|
4590
|
+
};
|
|
4591
|
+
content: {
|
|
4592
|
+
"application/json": components["schemas"]["ConversionQuoteDto"];
|
|
4593
|
+
};
|
|
4594
|
+
};
|
|
4595
|
+
/** @description `invalid_amount` — send exactly one positive amount. */
|
|
4596
|
+
400: {
|
|
4597
|
+
headers: {
|
|
4598
|
+
[name: string]: unknown;
|
|
4599
|
+
};
|
|
4600
|
+
content: {
|
|
4601
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4602
|
+
};
|
|
4603
|
+
};
|
|
4604
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4605
|
+
401: {
|
|
4606
|
+
headers: {
|
|
4607
|
+
[name: string]: unknown;
|
|
4608
|
+
};
|
|
4609
|
+
content: {
|
|
4610
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4611
|
+
};
|
|
4612
|
+
};
|
|
4613
|
+
/** @description `conversions_not_enabled`. */
|
|
4614
|
+
403: {
|
|
4615
|
+
headers: {
|
|
4616
|
+
[name: string]: unknown;
|
|
4617
|
+
};
|
|
4618
|
+
content: {
|
|
4619
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4620
|
+
};
|
|
4621
|
+
};
|
|
4622
|
+
/** @description `amount_below_minimum` or `insufficient_balance`. */
|
|
4623
|
+
422: {
|
|
4624
|
+
headers: {
|
|
4625
|
+
[name: string]: unknown;
|
|
4626
|
+
};
|
|
4627
|
+
content: {
|
|
4628
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4629
|
+
};
|
|
4630
|
+
};
|
|
4631
|
+
/** @description `rate_unavailable` — no current market rate; retry shortly. */
|
|
4632
|
+
503: {
|
|
4633
|
+
headers: {
|
|
4634
|
+
[name: string]: unknown;
|
|
4635
|
+
};
|
|
4636
|
+
content: {
|
|
4637
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4638
|
+
};
|
|
4639
|
+
};
|
|
4640
|
+
/** @description Client error. */
|
|
4641
|
+
"4XX": {
|
|
4642
|
+
headers: {
|
|
4643
|
+
[name: string]: unknown;
|
|
4644
|
+
};
|
|
4645
|
+
content: {
|
|
4646
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4647
|
+
};
|
|
4648
|
+
};
|
|
4649
|
+
/** @description Server or upstream bank error. */
|
|
4650
|
+
"5XX": {
|
|
4651
|
+
headers: {
|
|
4652
|
+
[name: string]: unknown;
|
|
4653
|
+
};
|
|
4654
|
+
content: {
|
|
4655
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4656
|
+
};
|
|
4657
|
+
};
|
|
4658
|
+
};
|
|
4659
|
+
};
|
|
4660
|
+
Conversions_list: {
|
|
4661
|
+
parameters: {
|
|
4662
|
+
query?: {
|
|
4663
|
+
status?: "PENDING" | "COMPLETED" | "CANCELED";
|
|
4664
|
+
cursor?: string;
|
|
4665
|
+
limit?: string;
|
|
4666
|
+
};
|
|
4667
|
+
header?: never;
|
|
4668
|
+
path?: never;
|
|
4669
|
+
cookie?: never;
|
|
4670
|
+
};
|
|
4671
|
+
requestBody?: never;
|
|
4672
|
+
responses: {
|
|
4673
|
+
200: {
|
|
4674
|
+
headers: {
|
|
4675
|
+
[name: string]: unknown;
|
|
4676
|
+
};
|
|
4677
|
+
content: {
|
|
4678
|
+
"application/json": components["schemas"]["ConversionListDto"];
|
|
4679
|
+
};
|
|
4680
|
+
};
|
|
4681
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4682
|
+
401: {
|
|
4683
|
+
headers: {
|
|
4684
|
+
[name: string]: unknown;
|
|
4685
|
+
};
|
|
4686
|
+
content: {
|
|
4687
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4688
|
+
};
|
|
4689
|
+
};
|
|
4690
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4691
|
+
403: {
|
|
4692
|
+
headers: {
|
|
4693
|
+
[name: string]: unknown;
|
|
4694
|
+
};
|
|
4695
|
+
content: {
|
|
4696
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4697
|
+
};
|
|
4698
|
+
};
|
|
4699
|
+
/** @description Client error. */
|
|
4700
|
+
"4XX": {
|
|
4701
|
+
headers: {
|
|
4702
|
+
[name: string]: unknown;
|
|
4703
|
+
};
|
|
4704
|
+
content: {
|
|
4705
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4706
|
+
};
|
|
4707
|
+
};
|
|
4708
|
+
/** @description Server or upstream bank error. */
|
|
4709
|
+
"5XX": {
|
|
4710
|
+
headers: {
|
|
4711
|
+
[name: string]: unknown;
|
|
4712
|
+
};
|
|
4713
|
+
content: {
|
|
4714
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4715
|
+
};
|
|
4716
|
+
};
|
|
4717
|
+
};
|
|
4718
|
+
};
|
|
4719
|
+
Conversions_create: {
|
|
4720
|
+
parameters: {
|
|
4721
|
+
query?: never;
|
|
4722
|
+
header?: {
|
|
4723
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4724
|
+
"Idempotency-Key"?: string;
|
|
4725
|
+
};
|
|
4726
|
+
path?: never;
|
|
4727
|
+
cookie?: never;
|
|
4728
|
+
};
|
|
4729
|
+
requestBody: {
|
|
4730
|
+
content: {
|
|
4731
|
+
"application/json": components["schemas"]["CreateConversionDto"];
|
|
4732
|
+
};
|
|
4733
|
+
};
|
|
4734
|
+
responses: {
|
|
4735
|
+
201: {
|
|
4736
|
+
headers: {
|
|
4737
|
+
[name: string]: unknown;
|
|
4738
|
+
};
|
|
4739
|
+
content: {
|
|
4740
|
+
"application/json": components["schemas"]["ConversionDto"];
|
|
4741
|
+
};
|
|
4742
|
+
};
|
|
4743
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4744
|
+
401: {
|
|
4745
|
+
headers: {
|
|
4746
|
+
[name: string]: unknown;
|
|
4747
|
+
};
|
|
4748
|
+
content: {
|
|
4749
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4750
|
+
};
|
|
4751
|
+
};
|
|
4752
|
+
/** @description `conversions_not_enabled` or `live_mode_not_activated`. */
|
|
4753
|
+
403: {
|
|
4754
|
+
headers: {
|
|
4755
|
+
[name: string]: unknown;
|
|
4756
|
+
};
|
|
4757
|
+
content: {
|
|
4758
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4759
|
+
};
|
|
4760
|
+
};
|
|
4761
|
+
/** @description Unknown quote. */
|
|
4762
|
+
404: {
|
|
4763
|
+
headers: {
|
|
4764
|
+
[name: string]: unknown;
|
|
4765
|
+
};
|
|
4766
|
+
content: {
|
|
4767
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4768
|
+
};
|
|
4769
|
+
};
|
|
4770
|
+
/** @description `quote_used`. */
|
|
4771
|
+
409: {
|
|
4772
|
+
headers: {
|
|
4773
|
+
[name: string]: unknown;
|
|
4774
|
+
};
|
|
4775
|
+
content: {
|
|
4776
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4777
|
+
};
|
|
4778
|
+
};
|
|
4779
|
+
/** @description `quote_expired` — request a new quote. */
|
|
4780
|
+
410: {
|
|
4781
|
+
headers: {
|
|
4782
|
+
[name: string]: unknown;
|
|
4783
|
+
};
|
|
4784
|
+
content: {
|
|
4785
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4786
|
+
};
|
|
4787
|
+
};
|
|
4788
|
+
/** @description `insufficient_balance` or `daily_limit_exceeded`. */
|
|
4789
|
+
422: {
|
|
4790
|
+
headers: {
|
|
4791
|
+
[name: string]: unknown;
|
|
4792
|
+
};
|
|
4793
|
+
content: {
|
|
4794
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4795
|
+
};
|
|
4796
|
+
};
|
|
4797
|
+
/** @description Client error. */
|
|
4798
|
+
"4XX": {
|
|
4799
|
+
headers: {
|
|
4800
|
+
[name: string]: unknown;
|
|
4801
|
+
};
|
|
4802
|
+
content: {
|
|
4803
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4804
|
+
};
|
|
4805
|
+
};
|
|
4806
|
+
/** @description Server or upstream bank error. */
|
|
4807
|
+
"5XX": {
|
|
4808
|
+
headers: {
|
|
4809
|
+
[name: string]: unknown;
|
|
4810
|
+
};
|
|
4811
|
+
content: {
|
|
4812
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4813
|
+
};
|
|
4814
|
+
};
|
|
4815
|
+
};
|
|
4816
|
+
};
|
|
4817
|
+
Conversions_get: {
|
|
4818
|
+
parameters: {
|
|
4819
|
+
query?: never;
|
|
4820
|
+
header?: never;
|
|
4821
|
+
path: {
|
|
4822
|
+
id: string;
|
|
4823
|
+
};
|
|
4824
|
+
cookie?: never;
|
|
4825
|
+
};
|
|
4826
|
+
requestBody?: never;
|
|
4827
|
+
responses: {
|
|
4828
|
+
200: {
|
|
4829
|
+
headers: {
|
|
4830
|
+
[name: string]: unknown;
|
|
4831
|
+
};
|
|
4832
|
+
content: {
|
|
4833
|
+
"application/json": components["schemas"]["ConversionDto"];
|
|
4834
|
+
};
|
|
4835
|
+
};
|
|
4836
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4837
|
+
401: {
|
|
4838
|
+
headers: {
|
|
4839
|
+
[name: string]: unknown;
|
|
4840
|
+
};
|
|
4841
|
+
content: {
|
|
4842
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4843
|
+
};
|
|
4844
|
+
};
|
|
4845
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4846
|
+
403: {
|
|
4847
|
+
headers: {
|
|
4848
|
+
[name: string]: unknown;
|
|
4849
|
+
};
|
|
4850
|
+
content: {
|
|
4851
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4852
|
+
};
|
|
4853
|
+
};
|
|
4854
|
+
404: {
|
|
4855
|
+
headers: {
|
|
4856
|
+
[name: string]: unknown;
|
|
4857
|
+
};
|
|
4858
|
+
content: {
|
|
4859
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4860
|
+
};
|
|
4861
|
+
};
|
|
4862
|
+
/** @description Client error. */
|
|
4863
|
+
"4XX": {
|
|
4864
|
+
headers: {
|
|
4865
|
+
[name: string]: unknown;
|
|
4866
|
+
};
|
|
4867
|
+
content: {
|
|
4868
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4869
|
+
};
|
|
4870
|
+
};
|
|
4871
|
+
/** @description Server or upstream bank error. */
|
|
4872
|
+
"5XX": {
|
|
4873
|
+
headers: {
|
|
4874
|
+
[name: string]: unknown;
|
|
4875
|
+
};
|
|
4876
|
+
content: {
|
|
4877
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4878
|
+
};
|
|
4879
|
+
};
|
|
4880
|
+
};
|
|
4881
|
+
};
|
|
4882
|
+
Conversions_cancel: {
|
|
4883
|
+
parameters: {
|
|
4884
|
+
query?: never;
|
|
4885
|
+
header?: {
|
|
4886
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4887
|
+
"Idempotency-Key"?: string;
|
|
4888
|
+
};
|
|
4889
|
+
path: {
|
|
4890
|
+
id: string;
|
|
4891
|
+
};
|
|
4892
|
+
cookie?: never;
|
|
4893
|
+
};
|
|
4894
|
+
requestBody?: never;
|
|
4895
|
+
responses: {
|
|
4896
|
+
200: {
|
|
4897
|
+
headers: {
|
|
4898
|
+
[name: string]: unknown;
|
|
4899
|
+
};
|
|
4900
|
+
content: {
|
|
4901
|
+
"application/json": components["schemas"]["ConversionDto"];
|
|
4902
|
+
};
|
|
4903
|
+
};
|
|
4904
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4905
|
+
401: {
|
|
4906
|
+
headers: {
|
|
4907
|
+
[name: string]: unknown;
|
|
4908
|
+
};
|
|
4909
|
+
content: {
|
|
4910
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4911
|
+
};
|
|
4912
|
+
};
|
|
4913
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4914
|
+
403: {
|
|
4915
|
+
headers: {
|
|
4916
|
+
[name: string]: unknown;
|
|
4917
|
+
};
|
|
4918
|
+
content: {
|
|
4919
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4920
|
+
};
|
|
4921
|
+
};
|
|
4922
|
+
404: {
|
|
4923
|
+
headers: {
|
|
4924
|
+
[name: string]: unknown;
|
|
4925
|
+
};
|
|
4926
|
+
content: {
|
|
4927
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4928
|
+
};
|
|
4929
|
+
};
|
|
4930
|
+
/** @description `conversion_not_cancelable` — already completed or canceled. */
|
|
4931
|
+
409: {
|
|
4932
|
+
headers: {
|
|
4933
|
+
[name: string]: unknown;
|
|
4934
|
+
};
|
|
4935
|
+
content: {
|
|
4936
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4937
|
+
};
|
|
4938
|
+
};
|
|
4939
|
+
/** @description Client error. */
|
|
4940
|
+
"4XX": {
|
|
4941
|
+
headers: {
|
|
4942
|
+
[name: string]: unknown;
|
|
4943
|
+
};
|
|
4944
|
+
content: {
|
|
4945
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4946
|
+
};
|
|
4947
|
+
};
|
|
4948
|
+
/** @description Server or upstream bank error. */
|
|
4949
|
+
"5XX": {
|
|
4950
|
+
headers: {
|
|
4951
|
+
[name: string]: unknown;
|
|
4952
|
+
};
|
|
4953
|
+
content: {
|
|
4954
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4955
|
+
};
|
|
4956
|
+
};
|
|
4957
|
+
};
|
|
4958
|
+
};
|
|
4959
|
+
Payments_getBanks: {
|
|
4960
|
+
parameters: {
|
|
4961
|
+
query?: never;
|
|
4962
|
+
header?: never;
|
|
4200
4963
|
path?: never;
|
|
4201
4964
|
cookie?: never;
|
|
4202
4965
|
};
|
|
@@ -7244,14 +8007,36 @@ declare class Quotes extends APIResource {
|
|
|
7244
8007
|
};
|
|
7245
8008
|
}>;
|
|
7246
8009
|
}
|
|
8010
|
+
/** Every movement in your VES balance (payments, fees, payouts, chargebacks, …), newest first. */
|
|
8011
|
+
declare class BalanceTransactions extends APIResource {
|
|
8012
|
+
/** Await for one page, or `for await` over every movement. The amounts sum to `ledgerNetVes`. */
|
|
8013
|
+
list(params?: QueryParams<'Balance_listTransactions'>, options?: RequestOptions): PagePromise<{
|
|
8014
|
+
items: components["schemas"]["BalanceTransactionDto"][];
|
|
8015
|
+
nextCursor: string | null;
|
|
8016
|
+
}, {
|
|
8017
|
+
id: string;
|
|
8018
|
+
type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal";
|
|
8019
|
+
amountVes: string;
|
|
8020
|
+
paymentId?: string;
|
|
8021
|
+
payoutId?: string;
|
|
8022
|
+
chargebackId?: string;
|
|
8023
|
+
merchantId?: string;
|
|
8024
|
+
externalRef?: string;
|
|
8025
|
+
description: string;
|
|
8026
|
+
createdAt: string;
|
|
8027
|
+
}>;
|
|
8028
|
+
}
|
|
7247
8029
|
/** Your platform balance. */
|
|
7248
8030
|
declare class Balance extends APIResource {
|
|
8031
|
+
readonly transactions: BalanceTransactions;
|
|
7249
8032
|
retrieve(options?: RequestOptions): Promise<{
|
|
7250
8033
|
tenantId: string;
|
|
7251
8034
|
platformId: string;
|
|
7252
8035
|
collectedVes: string;
|
|
7253
8036
|
feesVes: string;
|
|
7254
8037
|
paidOutVes: string;
|
|
8038
|
+
convertedVes: string;
|
|
8039
|
+
chargebackFeesVes: string;
|
|
7255
8040
|
reserveVes: string;
|
|
7256
8041
|
ledgerNetVes: string;
|
|
7257
8042
|
availableVes: string;
|
|
@@ -7443,7 +8228,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
7443
8228
|
id: string;
|
|
7444
8229
|
tenantId: string;
|
|
7445
8230
|
url: string;
|
|
7446
|
-
events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "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" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
8231
|
+
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.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
7447
8232
|
isActive: boolean;
|
|
7448
8233
|
createdAt: string;
|
|
7449
8234
|
secret?: string;
|
|
@@ -7452,7 +8237,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
7452
8237
|
id: string;
|
|
7453
8238
|
tenantId: string;
|
|
7454
8239
|
url: string;
|
|
7455
|
-
events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "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" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
8240
|
+
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.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
7456
8241
|
isActive: boolean;
|
|
7457
8242
|
createdAt: string;
|
|
7458
8243
|
secret?: string;
|
|
@@ -7461,7 +8246,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
7461
8246
|
id: string;
|
|
7462
8247
|
tenantId: string;
|
|
7463
8248
|
url: string;
|
|
7464
|
-
events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "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" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
8249
|
+
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.completed" | "conversion.canceled" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
|
|
7465
8250
|
isActive: boolean;
|
|
7466
8251
|
createdAt: string;
|
|
7467
8252
|
secret?: string;
|
|
@@ -7493,7 +8278,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
7493
8278
|
[key: string]: string;
|
|
7494
8279
|
};
|
|
7495
8280
|
allowedOrigins: string[];
|
|
7496
|
-
methods: ("c2p" | "vpos" | "usdt")[];
|
|
8281
|
+
methods: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
7497
8282
|
successUrl?: string | null;
|
|
7498
8283
|
cancelUrl?: string | null;
|
|
7499
8284
|
paymentId?: string | null;
|
|
@@ -7514,7 +8299,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
7514
8299
|
[key: string]: string;
|
|
7515
8300
|
};
|
|
7516
8301
|
allowedOrigins: string[];
|
|
7517
|
-
methods: ("c2p" | "vpos" | "usdt")[];
|
|
8302
|
+
methods: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
7518
8303
|
successUrl?: string | null;
|
|
7519
8304
|
cancelUrl?: string | null;
|
|
7520
8305
|
paymentId?: string | null;
|
|
@@ -7619,53 +8404,160 @@ declare class PaymentLinks extends APIResource {
|
|
|
7619
8404
|
delete(id: string, options?: RequestOptions): Promise<void>;
|
|
7620
8405
|
}
|
|
7621
8406
|
|
|
7622
|
-
/**
|
|
8407
|
+
/** A rate for converting VES to USDT, locked for 60 seconds. */
|
|
8408
|
+
declare class ConversionQuotes extends APIResource {
|
|
8409
|
+
/** Send `sourceAmountVes` (VES to spend) or `targetAmountUsdt` (USDT to receive) — exactly one. */
|
|
8410
|
+
create(params: RequestBody<'Conversions_createQuote'>, options?: RequestOptions): Promise<{
|
|
8411
|
+
id: string;
|
|
8412
|
+
object: string;
|
|
8413
|
+
rate: string;
|
|
8414
|
+
marketRate: string;
|
|
8415
|
+
spreadPercent: string;
|
|
8416
|
+
rateSource: "market";
|
|
8417
|
+
sourceAmountVes: string;
|
|
8418
|
+
targetAmountUsdt: string;
|
|
8419
|
+
expiresAt: string;
|
|
8420
|
+
createdAt: string;
|
|
8421
|
+
}>;
|
|
8422
|
+
}
|
|
8423
|
+
/**
|
|
8424
|
+
* Convert available VES into your USDT balance. Accepting a quote debits the VES at once; the
|
|
8425
|
+
* conversion is `PENDING` until VEXPay delivers the USDT (`conversion.completed`). Enabled per account.
|
|
8426
|
+
*/
|
|
8427
|
+
declare class Conversions extends APIResource {
|
|
8428
|
+
readonly quotes: ConversionQuotes;
|
|
8429
|
+
/** Accept a quote (`quoteId`). Pass `idempotencyKey` in options to retry safely. */
|
|
8430
|
+
create(params: RequestBody<'Conversions_create'>, options?: RequestOptions): Promise<{
|
|
8431
|
+
id: string;
|
|
8432
|
+
object: string;
|
|
8433
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
8434
|
+
reference: string | null;
|
|
8435
|
+
rate: string;
|
|
8436
|
+
marketRate: string;
|
|
8437
|
+
spreadPercent: string;
|
|
8438
|
+
rateSource: "market";
|
|
8439
|
+
sourceAmountVes: string;
|
|
8440
|
+
targetAmountUsdt: string;
|
|
8441
|
+
createdAt: string;
|
|
8442
|
+
completedAt: string | null;
|
|
8443
|
+
canceledAt: string | null;
|
|
8444
|
+
cancelReason: string | null;
|
|
8445
|
+
}>;
|
|
8446
|
+
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
8447
|
+
id: string;
|
|
8448
|
+
object: string;
|
|
8449
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
8450
|
+
reference: string | null;
|
|
8451
|
+
rate: string;
|
|
8452
|
+
marketRate: string;
|
|
8453
|
+
spreadPercent: string;
|
|
8454
|
+
rateSource: "market";
|
|
8455
|
+
sourceAmountVes: string;
|
|
8456
|
+
targetAmountUsdt: string;
|
|
8457
|
+
createdAt: string;
|
|
8458
|
+
completedAt: string | null;
|
|
8459
|
+
canceledAt: string | null;
|
|
8460
|
+
cancelReason: string | null;
|
|
8461
|
+
}>;
|
|
8462
|
+
/** Await for one page, or `for await` over every conversion (newest first). */
|
|
8463
|
+
list(params?: QueryParams<'Conversions_list'>, options?: RequestOptions): PagePromise<{
|
|
8464
|
+
items: components["schemas"]["ConversionDto"][];
|
|
8465
|
+
nextCursor: string | null;
|
|
8466
|
+
}, {
|
|
8467
|
+
id: string;
|
|
8468
|
+
object: string;
|
|
8469
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
8470
|
+
reference: string | null;
|
|
8471
|
+
rate: string;
|
|
8472
|
+
marketRate: string;
|
|
8473
|
+
spreadPercent: string;
|
|
8474
|
+
rateSource: "market";
|
|
8475
|
+
sourceAmountVes: string;
|
|
8476
|
+
targetAmountUsdt: string;
|
|
8477
|
+
createdAt: string;
|
|
8478
|
+
completedAt: string | null;
|
|
8479
|
+
canceledAt: string | null;
|
|
8480
|
+
cancelReason: string | null;
|
|
8481
|
+
}>;
|
|
8482
|
+
/** Cancel a `PENDING` conversion; the VES returns to your available balance. */
|
|
8483
|
+
cancel(id: string, options?: RequestOptions): Promise<{
|
|
8484
|
+
id: string;
|
|
8485
|
+
object: string;
|
|
8486
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
8487
|
+
reference: string | null;
|
|
8488
|
+
rate: string;
|
|
8489
|
+
marketRate: string;
|
|
8490
|
+
spreadPercent: string;
|
|
8491
|
+
rateSource: "market";
|
|
8492
|
+
sourceAmountVes: string;
|
|
8493
|
+
targetAmountUsdt: string;
|
|
8494
|
+
createdAt: string;
|
|
8495
|
+
completedAt: string | null;
|
|
8496
|
+
canceledAt: string | null;
|
|
8497
|
+
cancelReason: string | null;
|
|
8498
|
+
}>;
|
|
8499
|
+
}
|
|
8500
|
+
|
|
8501
|
+
/** One stablecoin balance (`currency`: USDT by default, or USDC). Never converted to VES. */
|
|
7623
8502
|
declare class CryptoBalance extends APIResource {
|
|
7624
|
-
retrieve(options?: RequestOptions): Promise<{
|
|
7625
|
-
currency:
|
|
7626
|
-
|
|
7627
|
-
|
|
8503
|
+
retrieve(params?: QueryParams<'Crypto_getBalance'>, options?: RequestOptions): Promise<{
|
|
8504
|
+
currency: "USDT" | "USDC";
|
|
8505
|
+
available: string;
|
|
8506
|
+
pendingPayout: string;
|
|
8507
|
+
availableUsdt?: string;
|
|
8508
|
+
pendingPayoutUsdt?: string;
|
|
7628
8509
|
asOf: string;
|
|
7629
8510
|
}>;
|
|
7630
8511
|
}
|
|
7631
|
-
/**
|
|
8512
|
+
/** Every stablecoin balance (USDT and USDC). */
|
|
8513
|
+
declare class CryptoBalances extends APIResource {
|
|
8514
|
+
list(options?: RequestOptions): Promise<{
|
|
8515
|
+
data: components["schemas"]["CryptoBalanceDto"][];
|
|
8516
|
+
}>;
|
|
8517
|
+
}
|
|
8518
|
+
/** Static deposit addresses per customer, stablecoin (`currency`) and network. */
|
|
7632
8519
|
declare class DepositAddresses extends APIResource {
|
|
7633
8520
|
/** Get or create — calling again for the same customer and network returns the same address. */
|
|
7634
8521
|
create(params: RequestBody<'Crypto_createDepositAddress'>, options?: RequestOptions): Promise<{
|
|
7635
8522
|
customerRef: string;
|
|
7636
8523
|
network: string;
|
|
7637
|
-
currency:
|
|
8524
|
+
currency: "USDT" | "USDC";
|
|
7638
8525
|
address: string;
|
|
7639
8526
|
tag?: string;
|
|
7640
8527
|
tagRequired: boolean;
|
|
7641
8528
|
createdAt: string;
|
|
7642
8529
|
}>;
|
|
7643
8530
|
}
|
|
7644
|
-
/** Enabled
|
|
8531
|
+
/** Enabled networks for one stablecoin (`currency`) with the payout fee and availability for an amount. */
|
|
7645
8532
|
declare class CryptoNetworks extends APIResource {
|
|
7646
8533
|
list(params?: QueryParams<'Crypto_listNetworks'>, options?: RequestOptions): Promise<{
|
|
8534
|
+
currency: "USDT" | "USDC";
|
|
7647
8535
|
network: string;
|
|
7648
8536
|
displayName: string;
|
|
7649
8537
|
receiveEnabled: boolean;
|
|
7650
8538
|
payoutEnabled: boolean;
|
|
7651
|
-
|
|
7652
|
-
|
|
8539
|
+
payoutFee: string;
|
|
8540
|
+
minPayout: string;
|
|
8541
|
+
payoutFeeUsdt?: string;
|
|
8542
|
+
minPayoutUsdt?: string;
|
|
7653
8543
|
tagRequired: boolean;
|
|
7654
8544
|
available: boolean;
|
|
7655
8545
|
}[]>;
|
|
7656
8546
|
}
|
|
7657
|
-
/**
|
|
8547
|
+
/** Stablecoin payouts to external addresses (`currency`: USDT or USDC). `idempotencyKey` (in the body) makes retries safe. */
|
|
7658
8548
|
declare class CryptoPayouts extends APIResource {
|
|
7659
8549
|
create(params: RequestBody<'Crypto_createPayout'>, options?: RequestOptions): Promise<{
|
|
7660
8550
|
id: string;
|
|
7661
8551
|
object: string;
|
|
7662
|
-
currency:
|
|
8552
|
+
currency: "USDT" | "USDC";
|
|
7663
8553
|
status: "pending" | "processing" | "completed" | "failed";
|
|
7664
8554
|
network: string;
|
|
7665
8555
|
address: string;
|
|
7666
8556
|
tag?: string;
|
|
7667
|
-
|
|
7668
|
-
|
|
8557
|
+
amount: string;
|
|
8558
|
+
fee: string;
|
|
8559
|
+
amountUsdt?: string;
|
|
8560
|
+
feeUsdt?: string;
|
|
7669
8561
|
customerRef?: string;
|
|
7670
8562
|
merchantId?: string;
|
|
7671
8563
|
idempotencyKey: string;
|
|
@@ -7678,13 +8570,15 @@ declare class CryptoPayouts extends APIResource {
|
|
|
7678
8570
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
7679
8571
|
id: string;
|
|
7680
8572
|
object: string;
|
|
7681
|
-
currency:
|
|
8573
|
+
currency: "USDT" | "USDC";
|
|
7682
8574
|
status: "pending" | "processing" | "completed" | "failed";
|
|
7683
8575
|
network: string;
|
|
7684
8576
|
address: string;
|
|
7685
8577
|
tag?: string;
|
|
7686
|
-
|
|
7687
|
-
|
|
8578
|
+
amount: string;
|
|
8579
|
+
fee: string;
|
|
8580
|
+
amountUsdt?: string;
|
|
8581
|
+
feeUsdt?: string;
|
|
7688
8582
|
customerRef?: string;
|
|
7689
8583
|
merchantId?: string;
|
|
7690
8584
|
idempotencyKey: string;
|
|
@@ -7695,9 +8589,10 @@ declare class CryptoPayouts extends APIResource {
|
|
|
7695
8589
|
completedAt?: string;
|
|
7696
8590
|
}>;
|
|
7697
8591
|
}
|
|
7698
|
-
/** USDT: deposit addresses,
|
|
8592
|
+
/** Stablecoins (USDT, USDC): deposit addresses, balances, networks and payouts. */
|
|
7699
8593
|
declare class Crypto extends APIResource {
|
|
7700
8594
|
readonly balance: CryptoBalance;
|
|
8595
|
+
readonly balances: CryptoBalances;
|
|
7701
8596
|
readonly depositAddresses: DepositAddresses;
|
|
7702
8597
|
readonly networks: CryptoNetworks;
|
|
7703
8598
|
readonly payouts: CryptoPayouts;
|
|
@@ -8247,7 +9142,7 @@ declare class Payments extends APIResource {
|
|
|
8247
9142
|
}>;
|
|
8248
9143
|
}
|
|
8249
9144
|
|
|
8250
|
-
declare const WEBHOOK_EVENT_NAMES: readonly ["payment.pending", "payment.completed", "payment.failed", "payment.canceled", "payment.reversed", "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", "tenant.status_changed", "tenant.api_key.created", "tenant.api_key.rotated", "tenant.api_key.revoked", "tenant.live_status_changed", "notification.test"];
|
|
9145
|
+
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.completed", "conversion.canceled", "tenant.status_changed", "tenant.api_key.created", "tenant.api_key.rotated", "tenant.api_key.revoked", "tenant.live_status_changed", "notification.test"];
|
|
8251
9146
|
type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];
|
|
8252
9147
|
/** `data` of every `payment.*` event. */
|
|
8253
9148
|
interface PaymentWebhookData {
|
|
@@ -8341,6 +9236,8 @@ declare class VexPay {
|
|
|
8341
9236
|
readonly payouts: Payouts;
|
|
8342
9237
|
/** USDT: deposit addresses, balance, networks and payouts. */
|
|
8343
9238
|
readonly crypto: Crypto;
|
|
9239
|
+
/** Convert available VES to USDT (enabled per account). */
|
|
9240
|
+
readonly conversions: Conversions;
|
|
8344
9241
|
readonly products: Products;
|
|
8345
9242
|
readonly paymentLinks: PaymentLinks;
|
|
8346
9243
|
readonly tenantPayoutAccount: TenantPayoutAccount;
|
|
@@ -8398,6 +9295,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
8398
9295
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
8399
9296
|
}
|
|
8400
9297
|
|
|
8401
|
-
declare const VERSION = "0.
|
|
9298
|
+
declare const VERSION = "0.4.0";
|
|
8402
9299
|
|
|
8403
9300
|
export { 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 };
|