@vexpay/node 0.2.0 → 0.3.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 +49 -0
- package/dist/index.cjs +49 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +880 -107
- package/dist/index.d.ts +880 -107
- package/dist/index.js +49 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -61,6 +61,11 @@ 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;
|
|
64
69
|
/** @example 100.00 */
|
|
65
70
|
reserveVes: string;
|
|
66
71
|
/** @example 8650.00 */
|
|
@@ -103,7 +108,7 @@ interface components {
|
|
|
103
108
|
* "payment.failed"
|
|
104
109
|
* ]
|
|
105
110
|
*/
|
|
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")[];
|
|
111
|
+
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" | "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
112
|
};
|
|
108
113
|
WebhookEndpointDto: {
|
|
109
114
|
/** Format: uuid */
|
|
@@ -112,7 +117,7 @@ interface components {
|
|
|
112
117
|
tenantId: string;
|
|
113
118
|
/** Format: uri */
|
|
114
119
|
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")[];
|
|
120
|
+
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" | "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
121
|
isActive: boolean;
|
|
117
122
|
/** Format: date-time */
|
|
118
123
|
createdAt: string;
|
|
@@ -133,7 +138,7 @@ interface components {
|
|
|
133
138
|
* "payout.completed"
|
|
134
139
|
* ]
|
|
135
140
|
*/
|
|
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")[];
|
|
141
|
+
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" | "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
142
|
/** @example true */
|
|
138
143
|
isActive?: boolean;
|
|
139
144
|
};
|
|
@@ -712,7 +717,10 @@ interface components {
|
|
|
712
717
|
* @example 50.00
|
|
713
718
|
*/
|
|
714
719
|
applicationFeeVes?: string;
|
|
715
|
-
/**
|
|
720
|
+
/**
|
|
721
|
+
* @description Optional percent of vesAmount used when applicationFeeVes is omitted. When both are omitted and merchantId is set, the merchant's commission (or the tenant default commission) applies.
|
|
722
|
+
* @example 10
|
|
723
|
+
*/
|
|
716
724
|
applicationFeePercent?: number;
|
|
717
725
|
};
|
|
718
726
|
ManualOperationPollDto: {
|
|
@@ -893,21 +901,38 @@ interface components {
|
|
|
893
901
|
ip?: string;
|
|
894
902
|
};
|
|
895
903
|
CryptoBalanceDto: {
|
|
896
|
-
/** @example USDT */
|
|
897
|
-
currency: string;
|
|
898
904
|
/**
|
|
899
|
-
* @
|
|
905
|
+
* @example USDT
|
|
906
|
+
* @enum {string}
|
|
907
|
+
*/
|
|
908
|
+
currency: "USDT" | "USDC";
|
|
909
|
+
/**
|
|
910
|
+
* @description Available for payouts, in `currency` (ledger).
|
|
900
911
|
* @example 97.00
|
|
901
912
|
*/
|
|
902
|
-
|
|
913
|
+
available: string;
|
|
903
914
|
/**
|
|
904
|
-
* @description
|
|
915
|
+
* @description Reserved by payouts that have not completed yet, in `currency`.
|
|
905
916
|
* @example 50.10
|
|
906
917
|
*/
|
|
907
|
-
|
|
918
|
+
pendingPayout: string;
|
|
919
|
+
/**
|
|
920
|
+
* @description USDT only: same as `available`.
|
|
921
|
+
* @example 97.00
|
|
922
|
+
*/
|
|
923
|
+
availableUsdt?: string;
|
|
924
|
+
/**
|
|
925
|
+
* @description USDT only: same as `pendingPayout`.
|
|
926
|
+
* @example 50.10
|
|
927
|
+
*/
|
|
928
|
+
pendingPayoutUsdt?: string;
|
|
908
929
|
/** Format: date-time */
|
|
909
930
|
asOf: string;
|
|
910
931
|
};
|
|
932
|
+
CryptoBalancesDto: {
|
|
933
|
+
/** @description One balance per stablecoin (USDT, USDC). */
|
|
934
|
+
data: components["schemas"]["CryptoBalanceDto"][];
|
|
935
|
+
};
|
|
911
936
|
CreateDepositAddressDto: {
|
|
912
937
|
/**
|
|
913
938
|
* @description Your identifier for the customer this address belongs to (1–128 chars: A–Z a–z 0–9 _ . : @ -).
|
|
@@ -915,18 +940,29 @@ interface components {
|
|
|
915
940
|
*/
|
|
916
941
|
customerRef: string;
|
|
917
942
|
/**
|
|
943
|
+
* @description USDT: TRC20, BEP20, POLYGON, SOL, TON, ARB1. USDC: POLYGON, BASE.
|
|
918
944
|
* @example BEP20
|
|
919
945
|
* @enum {string}
|
|
920
946
|
*/
|
|
921
|
-
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1";
|
|
947
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1" | "BASE";
|
|
948
|
+
/**
|
|
949
|
+
* @description Stablecoin the address receives.
|
|
950
|
+
* @default USDT
|
|
951
|
+
* @example USDT
|
|
952
|
+
* @enum {string}
|
|
953
|
+
*/
|
|
954
|
+
currency?: "USDT" | "USDC";
|
|
922
955
|
};
|
|
923
956
|
DepositAddressDto: {
|
|
924
957
|
/** @example user_123 */
|
|
925
958
|
customerRef: string;
|
|
926
959
|
/** @example BEP20 */
|
|
927
960
|
network: string;
|
|
928
|
-
/**
|
|
929
|
-
|
|
961
|
+
/**
|
|
962
|
+
* @example USDT
|
|
963
|
+
* @enum {string}
|
|
964
|
+
*/
|
|
965
|
+
currency: "USDT" | "USDC";
|
|
930
966
|
/** @example 0x9f3c… */
|
|
931
967
|
address: string;
|
|
932
968
|
/** @description Destination tag / memo the payer must include (TON). */
|
|
@@ -937,35 +973,69 @@ interface components {
|
|
|
937
973
|
createdAt: string;
|
|
938
974
|
};
|
|
939
975
|
CryptoNetworkDto: {
|
|
976
|
+
/**
|
|
977
|
+
* @example USDT
|
|
978
|
+
* @enum {string}
|
|
979
|
+
*/
|
|
980
|
+
currency: "USDT" | "USDC";
|
|
940
981
|
/** @example POLYGON */
|
|
941
982
|
network: string;
|
|
942
983
|
/** @example Polygon */
|
|
943
984
|
displayName: string;
|
|
944
985
|
receiveEnabled: boolean;
|
|
945
986
|
payoutEnabled: boolean;
|
|
946
|
-
/**
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
987
|
+
/**
|
|
988
|
+
* @description Payout fee in `currency`.
|
|
989
|
+
* @example 0.10
|
|
990
|
+
*/
|
|
991
|
+
payoutFee: string;
|
|
992
|
+
/**
|
|
993
|
+
* @description Minimum payout in `currency`.
|
|
994
|
+
* @example 1.00
|
|
995
|
+
*/
|
|
996
|
+
minPayout: string;
|
|
997
|
+
/**
|
|
998
|
+
* @description USDT only: same as `payoutFee`.
|
|
999
|
+
* @example 0.10
|
|
1000
|
+
*/
|
|
1001
|
+
payoutFeeUsdt?: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* @description USDT only: same as `minPayout`.
|
|
1004
|
+
* @example 1.00
|
|
1005
|
+
*/
|
|
1006
|
+
minPayoutUsdt?: string;
|
|
950
1007
|
tagRequired: boolean;
|
|
951
1008
|
/** @description Whether a payout of the requested amount can be sent on this network now. */
|
|
952
1009
|
available: boolean;
|
|
953
1010
|
};
|
|
954
1011
|
CreateCryptoPayoutDto: {
|
|
955
1012
|
/**
|
|
1013
|
+
* @description Stablecoin to send; debits that balance.
|
|
1014
|
+
* @default USDT
|
|
1015
|
+
* @example USDT
|
|
1016
|
+
* @enum {string}
|
|
1017
|
+
*/
|
|
1018
|
+
currency?: "USDT" | "USDC";
|
|
1019
|
+
/**
|
|
1020
|
+
* @description USDT: TRC20, BEP20, POLYGON, SOL, TON, ARB1. USDC: POLYGON, BASE.
|
|
956
1021
|
* @example POLYGON
|
|
957
1022
|
* @enum {string}
|
|
958
1023
|
*/
|
|
959
|
-
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1";
|
|
1024
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1" | "BASE";
|
|
960
1025
|
/** @example 0x9f3c4e1b2a7d6c5e4f3a2b1c0d9e8f7a6b5c4d3e */
|
|
961
1026
|
address: string;
|
|
962
1027
|
/** @description Destination tag / memo (required on TON). */
|
|
963
1028
|
tag?: string;
|
|
964
1029
|
/**
|
|
965
|
-
* @description Amount the destination receives, in
|
|
1030
|
+
* @description Amount the destination receives, in `currency` (max 2 decimals).
|
|
1031
|
+
* @example 50.00
|
|
1032
|
+
*/
|
|
1033
|
+
amount?: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* @description USDT only: alias of `amount`.
|
|
966
1036
|
* @example 50.00
|
|
967
1037
|
*/
|
|
968
|
-
amountUsdt
|
|
1038
|
+
amountUsdt?: string;
|
|
969
1039
|
/**
|
|
970
1040
|
* @description Your customer reference, echoed on webhooks.
|
|
971
1041
|
* @example user_123
|
|
@@ -981,20 +1051,36 @@ interface components {
|
|
|
981
1051
|
id: string;
|
|
982
1052
|
/** @example crypto.payout */
|
|
983
1053
|
object: string;
|
|
984
|
-
/**
|
|
985
|
-
|
|
1054
|
+
/**
|
|
1055
|
+
* @example USDT
|
|
1056
|
+
* @enum {string}
|
|
1057
|
+
*/
|
|
1058
|
+
currency: "USDT" | "USDC";
|
|
986
1059
|
/** @enum {string} */
|
|
987
1060
|
status: "pending" | "processing" | "completed" | "failed";
|
|
988
1061
|
network: string;
|
|
989
1062
|
address: string;
|
|
990
1063
|
tag?: string;
|
|
991
|
-
/** @example 50.00 */
|
|
992
|
-
amountUsdt: string;
|
|
993
1064
|
/**
|
|
994
|
-
* @description
|
|
1065
|
+
* @description Amount sent, in `currency`.
|
|
1066
|
+
* @example 50.00
|
|
1067
|
+
*/
|
|
1068
|
+
amount: string;
|
|
1069
|
+
/**
|
|
1070
|
+
* @description Network fee + margin, in `currency` (0 for internal).
|
|
1071
|
+
* @example 0.10
|
|
1072
|
+
*/
|
|
1073
|
+
fee: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* @description USDT only: same as `amount`.
|
|
1076
|
+
* @example 50.00
|
|
1077
|
+
*/
|
|
1078
|
+
amountUsdt?: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* @description USDT only: same as `fee`.
|
|
995
1081
|
* @example 0.10
|
|
996
1082
|
*/
|
|
997
|
-
feeUsdt
|
|
1083
|
+
feeUsdt?: string;
|
|
998
1084
|
customerRef?: string;
|
|
999
1085
|
merchantId?: string;
|
|
1000
1086
|
idempotencyKey: string;
|
|
@@ -1007,6 +1093,94 @@ interface components {
|
|
|
1007
1093
|
/** Format: date-time */
|
|
1008
1094
|
completedAt?: string;
|
|
1009
1095
|
};
|
|
1096
|
+
CreateConversionQuoteDto: {
|
|
1097
|
+
/**
|
|
1098
|
+
* @description VES to spend. Send this or `targetAmountUsdt`, not both.
|
|
1099
|
+
* @example 10000.00
|
|
1100
|
+
*/
|
|
1101
|
+
sourceAmountVes?: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* @description USDT to receive. Send this or `sourceAmountVes`, not both.
|
|
1104
|
+
* @example 50.00
|
|
1105
|
+
*/
|
|
1106
|
+
targetAmountUsdt?: string;
|
|
1107
|
+
};
|
|
1108
|
+
ConversionQuoteDto: {
|
|
1109
|
+
id: string;
|
|
1110
|
+
/** @example conversion_quote */
|
|
1111
|
+
object: string;
|
|
1112
|
+
/**
|
|
1113
|
+
* @description VES per 1 USDT you get: market rate plus your spread.
|
|
1114
|
+
* @example 998.8299
|
|
1115
|
+
*/
|
|
1116
|
+
rate: string;
|
|
1117
|
+
/**
|
|
1118
|
+
* @description Market USDT/VES rate the quote is based on.
|
|
1119
|
+
* @example 979.2450
|
|
1120
|
+
*/
|
|
1121
|
+
marketRate: string;
|
|
1122
|
+
/**
|
|
1123
|
+
* @description Your spread, in percent.
|
|
1124
|
+
* @example 2.0000
|
|
1125
|
+
*/
|
|
1126
|
+
spreadPercent: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* @example market
|
|
1129
|
+
* @enum {string}
|
|
1130
|
+
*/
|
|
1131
|
+
rateSource: "market";
|
|
1132
|
+
/** @example 10000.00 */
|
|
1133
|
+
sourceAmountVes: string;
|
|
1134
|
+
/**
|
|
1135
|
+
* @description Rounded down to the cent.
|
|
1136
|
+
* @example 10.01
|
|
1137
|
+
*/
|
|
1138
|
+
targetAmountUsdt: string;
|
|
1139
|
+
/** @description The quote can be accepted until this time (60 seconds). */
|
|
1140
|
+
expiresAt: string;
|
|
1141
|
+
createdAt: string;
|
|
1142
|
+
};
|
|
1143
|
+
CreateConversionDto: {
|
|
1144
|
+
/** @description A live quote from `POST /v1/conversions/quotes`. Each quote can be used once. */
|
|
1145
|
+
quoteId: string;
|
|
1146
|
+
/**
|
|
1147
|
+
* @description Your reference, echoed on the conversion and its webhooks.
|
|
1148
|
+
* @example treasury-2026-10-03
|
|
1149
|
+
*/
|
|
1150
|
+
reference?: string;
|
|
1151
|
+
};
|
|
1152
|
+
ConversionDto: {
|
|
1153
|
+
id: string;
|
|
1154
|
+
/** @example conversion */
|
|
1155
|
+
object: string;
|
|
1156
|
+
/** @enum {string} */
|
|
1157
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
1158
|
+
reference: string | null;
|
|
1159
|
+
/** @example 998.8299 */
|
|
1160
|
+
rate: string;
|
|
1161
|
+
/** @example 979.2450 */
|
|
1162
|
+
marketRate: string;
|
|
1163
|
+
/** @example 2.0000 */
|
|
1164
|
+
spreadPercent: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* @example market
|
|
1167
|
+
* @enum {string}
|
|
1168
|
+
*/
|
|
1169
|
+
rateSource: "market";
|
|
1170
|
+
/** @example 10000.00 */
|
|
1171
|
+
sourceAmountVes: string;
|
|
1172
|
+
/** @example 10.01 */
|
|
1173
|
+
targetAmountUsdt: string;
|
|
1174
|
+
createdAt: string;
|
|
1175
|
+
completedAt: string | null;
|
|
1176
|
+
canceledAt: string | null;
|
|
1177
|
+
cancelReason: string | null;
|
|
1178
|
+
};
|
|
1179
|
+
ConversionListDto: {
|
|
1180
|
+
items: components["schemas"]["ConversionDto"][];
|
|
1181
|
+
/** @description Pass as `cursor` to get the next page. */
|
|
1182
|
+
nextCursor: string | null;
|
|
1183
|
+
};
|
|
1010
1184
|
BankResponseDto: {
|
|
1011
1185
|
/**
|
|
1012
1186
|
* @description Canonical four-digit SIMF bank code.
|
|
@@ -1091,7 +1265,10 @@ interface components {
|
|
|
1091
1265
|
* @example 50.00
|
|
1092
1266
|
*/
|
|
1093
1267
|
applicationFeeVes?: string;
|
|
1094
|
-
/**
|
|
1268
|
+
/**
|
|
1269
|
+
* @description Optional percent of vesAmount used when applicationFeeVes is omitted. When both are omitted and merchantId is set, the merchant's commission (or the tenant default commission) applies.
|
|
1270
|
+
* @example 10
|
|
1271
|
+
*/
|
|
1095
1272
|
applicationFeePercent?: number;
|
|
1096
1273
|
};
|
|
1097
1274
|
C2pIntentResponseDto: {
|
|
@@ -1213,7 +1390,7 @@ interface components {
|
|
|
1213
1390
|
*/
|
|
1214
1391
|
applicationFeeVes?: string;
|
|
1215
1392
|
/**
|
|
1216
|
-
* @description Optional percent of vesAmount used when applicationFeeVes is omitted.
|
|
1393
|
+
* @description Optional percent of vesAmount used when applicationFeeVes is omitted. When both are omitted and merchantId is set, the merchant's commission (or the tenant default commission) applies.
|
|
1217
1394
|
* @example 10
|
|
1218
1395
|
*/
|
|
1219
1396
|
applicationFeePercent?: number;
|
|
@@ -1347,7 +1524,10 @@ interface components {
|
|
|
1347
1524
|
* @example 50.00
|
|
1348
1525
|
*/
|
|
1349
1526
|
applicationFeeVes?: string;
|
|
1350
|
-
/**
|
|
1527
|
+
/**
|
|
1528
|
+
* @description Optional percent of vesAmount used when applicationFeeVes is omitted. When both are omitted and merchantId is set, the merchant's commission (or the tenant default commission) applies.
|
|
1529
|
+
* @example 10
|
|
1530
|
+
*/
|
|
1351
1531
|
applicationFeePercent?: number;
|
|
1352
1532
|
};
|
|
1353
1533
|
PagoMovilReceivingAccountDto: {
|
|
@@ -1447,6 +1627,11 @@ interface components {
|
|
|
1447
1627
|
isActive: boolean;
|
|
1448
1628
|
/** @description When true, available balance is auto-paid to the default verified method. */
|
|
1449
1629
|
autoPayoutEnabled?: boolean;
|
|
1630
|
+
/**
|
|
1631
|
+
* @description Merchant-specific marketplace commission percent. null = the tenant's default commission applies.
|
|
1632
|
+
* @example 12.5
|
|
1633
|
+
*/
|
|
1634
|
+
applicationFeePercent?: number | null;
|
|
1450
1635
|
/** @description Default method bank code (compat) */
|
|
1451
1636
|
bankCode?: string;
|
|
1452
1637
|
/** @description Masked default method phone (compat) */
|
|
@@ -1626,6 +1811,11 @@ interface components {
|
|
|
1626
1811
|
isActive?: boolean;
|
|
1627
1812
|
/** @description When true, a cron job automatically pays available seller balance to the default verified Pago Móvil method. */
|
|
1628
1813
|
autoPayoutEnabled?: boolean;
|
|
1814
|
+
/**
|
|
1815
|
+
* @description Negotiated marketplace commission (percent of vesAmount) retained from payments tagged with this merchant when the request sends no applicationFeeVes / applicationFeePercent. null clears the override so the tenant's default commission applies.
|
|
1816
|
+
* @example 12.5
|
|
1817
|
+
*/
|
|
1818
|
+
applicationFeePercent?: number | null;
|
|
1629
1819
|
};
|
|
1630
1820
|
CreateCheckoutSessionDto: {
|
|
1631
1821
|
/**
|
|
@@ -1666,7 +1856,7 @@ interface components {
|
|
|
1666
1856
|
*/
|
|
1667
1857
|
allowedOrigins?: string[];
|
|
1668
1858
|
/** @description Payment methods offered. Defaults to every method your account can accept. */
|
|
1669
|
-
methods?: ("c2p" | "vpos" | "usdt")[];
|
|
1859
|
+
methods?: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
1670
1860
|
/**
|
|
1671
1861
|
* @description Up to 20 string key/value pairs (keys ≤ 40 chars, values ≤ 500 chars).
|
|
1672
1862
|
* @example {
|
|
@@ -1702,7 +1892,7 @@ interface components {
|
|
|
1702
1892
|
[key: string]: string;
|
|
1703
1893
|
};
|
|
1704
1894
|
allowedOrigins: string[];
|
|
1705
|
-
methods: ("c2p" | "vpos" | "usdt")[];
|
|
1895
|
+
methods: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
1706
1896
|
successUrl?: string | null;
|
|
1707
1897
|
cancelUrl?: string | null;
|
|
1708
1898
|
/** @description Latest payment for this session, once one exists. */
|
|
@@ -3837,7 +4027,9 @@ interface operations {
|
|
|
3837
4027
|
};
|
|
3838
4028
|
Crypto_getBalance: {
|
|
3839
4029
|
parameters: {
|
|
3840
|
-
query?:
|
|
4030
|
+
query?: {
|
|
4031
|
+
currency?: "USDT" | "USDC";
|
|
4032
|
+
};
|
|
3841
4033
|
header?: never;
|
|
3842
4034
|
path?: never;
|
|
3843
4035
|
cookie?: never;
|
|
@@ -3852,6 +4044,70 @@ interface operations {
|
|
|
3852
4044
|
"application/json": components["schemas"]["CryptoBalanceDto"];
|
|
3853
4045
|
};
|
|
3854
4046
|
};
|
|
4047
|
+
/** @description `unsupported_currency`. */
|
|
4048
|
+
400: {
|
|
4049
|
+
headers: {
|
|
4050
|
+
[name: string]: unknown;
|
|
4051
|
+
};
|
|
4052
|
+
content: {
|
|
4053
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4054
|
+
};
|
|
4055
|
+
};
|
|
4056
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4057
|
+
401: {
|
|
4058
|
+
headers: {
|
|
4059
|
+
[name: string]: unknown;
|
|
4060
|
+
};
|
|
4061
|
+
content: {
|
|
4062
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4063
|
+
};
|
|
4064
|
+
};
|
|
4065
|
+
/** @description `method_not_allowed` — USDC is not enabled for this account. */
|
|
4066
|
+
403: {
|
|
4067
|
+
headers: {
|
|
4068
|
+
[name: string]: unknown;
|
|
4069
|
+
};
|
|
4070
|
+
content: {
|
|
4071
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4072
|
+
};
|
|
4073
|
+
};
|
|
4074
|
+
/** @description Client error. */
|
|
4075
|
+
"4XX": {
|
|
4076
|
+
headers: {
|
|
4077
|
+
[name: string]: unknown;
|
|
4078
|
+
};
|
|
4079
|
+
content: {
|
|
4080
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4081
|
+
};
|
|
4082
|
+
};
|
|
4083
|
+
/** @description Server or upstream bank error. */
|
|
4084
|
+
"5XX": {
|
|
4085
|
+
headers: {
|
|
4086
|
+
[name: string]: unknown;
|
|
4087
|
+
};
|
|
4088
|
+
content: {
|
|
4089
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4090
|
+
};
|
|
4091
|
+
};
|
|
4092
|
+
};
|
|
4093
|
+
};
|
|
4094
|
+
Crypto_getBalances: {
|
|
4095
|
+
parameters: {
|
|
4096
|
+
query?: never;
|
|
4097
|
+
header?: never;
|
|
4098
|
+
path?: never;
|
|
4099
|
+
cookie?: never;
|
|
4100
|
+
};
|
|
4101
|
+
requestBody?: never;
|
|
4102
|
+
responses: {
|
|
4103
|
+
200: {
|
|
4104
|
+
headers: {
|
|
4105
|
+
[name: string]: unknown;
|
|
4106
|
+
};
|
|
4107
|
+
content: {
|
|
4108
|
+
"application/json": components["schemas"]["CryptoBalancesDto"];
|
|
4109
|
+
};
|
|
4110
|
+
};
|
|
3855
4111
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
3856
4112
|
401: {
|
|
3857
4113
|
headers: {
|
|
@@ -3914,7 +4170,7 @@ interface operations {
|
|
|
3914
4170
|
"application/json": components["schemas"]["DepositAddressDto"];
|
|
3915
4171
|
};
|
|
3916
4172
|
};
|
|
3917
|
-
/** @description `unsupported_network` or invalid `customerRef`. */
|
|
4173
|
+
/** @description `unsupported_currency`, `unsupported_network` or invalid `customerRef`. */
|
|
3918
4174
|
400: {
|
|
3919
4175
|
headers: {
|
|
3920
4176
|
[name: string]: unknown;
|
|
@@ -3932,7 +4188,7 @@ interface operations {
|
|
|
3932
4188
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3933
4189
|
};
|
|
3934
4190
|
};
|
|
3935
|
-
/** @description `method_not_allowed` —
|
|
4191
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
3936
4192
|
403: {
|
|
3937
4193
|
headers: {
|
|
3938
4194
|
[name: string]: unknown;
|
|
@@ -3964,7 +4220,10 @@ interface operations {
|
|
|
3964
4220
|
Crypto_listNetworks: {
|
|
3965
4221
|
parameters: {
|
|
3966
4222
|
query?: {
|
|
4223
|
+
/** @description Alias of `amount`. */
|
|
3967
4224
|
amountUsdt?: string;
|
|
4225
|
+
currency?: "USDT" | "USDC";
|
|
4226
|
+
amount?: string;
|
|
3968
4227
|
};
|
|
3969
4228
|
header?: never;
|
|
3970
4229
|
path?: never;
|
|
@@ -3980,6 +4239,15 @@ interface operations {
|
|
|
3980
4239
|
"application/json": components["schemas"]["CryptoNetworkDto"][];
|
|
3981
4240
|
};
|
|
3982
4241
|
};
|
|
4242
|
+
/** @description `unsupported_currency`. */
|
|
4243
|
+
400: {
|
|
4244
|
+
headers: {
|
|
4245
|
+
[name: string]: unknown;
|
|
4246
|
+
};
|
|
4247
|
+
content: {
|
|
4248
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4249
|
+
};
|
|
4250
|
+
};
|
|
3983
4251
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
3984
4252
|
401: {
|
|
3985
4253
|
headers: {
|
|
@@ -3989,7 +4257,7 @@ interface operations {
|
|
|
3989
4257
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3990
4258
|
};
|
|
3991
4259
|
};
|
|
3992
|
-
/** @description `method_not_allowed` —
|
|
4260
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
3993
4261
|
403: {
|
|
3994
4262
|
headers: {
|
|
3995
4263
|
[name: string]: unknown;
|
|
@@ -4052,7 +4320,7 @@ interface operations {
|
|
|
4052
4320
|
"application/json": components["schemas"]["CryptoPayoutDto"];
|
|
4053
4321
|
};
|
|
4054
4322
|
};
|
|
4055
|
-
/** @description `unsupported_network`, `invalid_address` or `invalid_data`. */
|
|
4323
|
+
/** @description `unsupported_currency`, `unsupported_network`, `invalid_address` or `invalid_data`. */
|
|
4056
4324
|
400: {
|
|
4057
4325
|
headers: {
|
|
4058
4326
|
[name: string]: unknown;
|
|
@@ -4070,7 +4338,7 @@ interface operations {
|
|
|
4070
4338
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4071
4339
|
};
|
|
4072
4340
|
};
|
|
4073
|
-
/** @description
|
|
4341
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
4074
4342
|
403: {
|
|
4075
4343
|
headers: {
|
|
4076
4344
|
[name: string]: unknown;
|
|
@@ -4174,24 +4442,31 @@ interface operations {
|
|
|
4174
4442
|
};
|
|
4175
4443
|
};
|
|
4176
4444
|
};
|
|
4177
|
-
|
|
4445
|
+
Conversions_createQuote: {
|
|
4178
4446
|
parameters: {
|
|
4179
4447
|
query?: never;
|
|
4180
|
-
header?:
|
|
4448
|
+
header?: {
|
|
4449
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4450
|
+
"Idempotency-Key"?: string;
|
|
4451
|
+
};
|
|
4181
4452
|
path?: never;
|
|
4182
4453
|
cookie?: never;
|
|
4183
4454
|
};
|
|
4184
|
-
requestBody
|
|
4455
|
+
requestBody: {
|
|
4456
|
+
content: {
|
|
4457
|
+
"application/json": components["schemas"]["CreateConversionQuoteDto"];
|
|
4458
|
+
};
|
|
4459
|
+
};
|
|
4185
4460
|
responses: {
|
|
4186
|
-
|
|
4461
|
+
201: {
|
|
4187
4462
|
headers: {
|
|
4188
4463
|
[name: string]: unknown;
|
|
4189
4464
|
};
|
|
4190
4465
|
content: {
|
|
4191
|
-
"application/json": components["schemas"]["
|
|
4466
|
+
"application/json": components["schemas"]["ConversionQuoteDto"];
|
|
4192
4467
|
};
|
|
4193
4468
|
};
|
|
4194
|
-
/** @description
|
|
4469
|
+
/** @description `invalid_amount` — send exactly one positive amount. */
|
|
4195
4470
|
400: {
|
|
4196
4471
|
headers: {
|
|
4197
4472
|
[name: string]: unknown;
|
|
@@ -4209,7 +4484,7 @@ interface operations {
|
|
|
4209
4484
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4210
4485
|
};
|
|
4211
4486
|
};
|
|
4212
|
-
/** @description
|
|
4487
|
+
/** @description `conversions_not_enabled`. */
|
|
4213
4488
|
403: {
|
|
4214
4489
|
headers: {
|
|
4215
4490
|
[name: string]: unknown;
|
|
@@ -4218,6 +4493,24 @@ interface operations {
|
|
|
4218
4493
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4219
4494
|
};
|
|
4220
4495
|
};
|
|
4496
|
+
/** @description `amount_below_minimum` or `insufficient_balance`. */
|
|
4497
|
+
422: {
|
|
4498
|
+
headers: {
|
|
4499
|
+
[name: string]: unknown;
|
|
4500
|
+
};
|
|
4501
|
+
content: {
|
|
4502
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4503
|
+
};
|
|
4504
|
+
};
|
|
4505
|
+
/** @description `rate_unavailable` — no current market rate; retry shortly. */
|
|
4506
|
+
503: {
|
|
4507
|
+
headers: {
|
|
4508
|
+
[name: string]: unknown;
|
|
4509
|
+
};
|
|
4510
|
+
content: {
|
|
4511
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4512
|
+
};
|
|
4513
|
+
};
|
|
4221
4514
|
/** @description Client error. */
|
|
4222
4515
|
"4XX": {
|
|
4223
4516
|
headers: {
|
|
@@ -4238,11 +4531,12 @@ interface operations {
|
|
|
4238
4531
|
};
|
|
4239
4532
|
};
|
|
4240
4533
|
};
|
|
4241
|
-
|
|
4534
|
+
Conversions_list: {
|
|
4242
4535
|
parameters: {
|
|
4243
|
-
query
|
|
4244
|
-
|
|
4245
|
-
|
|
4536
|
+
query?: {
|
|
4537
|
+
status?: "PENDING" | "COMPLETED" | "CANCELED";
|
|
4538
|
+
cursor?: string;
|
|
4539
|
+
limit?: string;
|
|
4246
4540
|
};
|
|
4247
4541
|
header?: never;
|
|
4248
4542
|
path?: never;
|
|
@@ -4250,22 +4544,12 @@ interface operations {
|
|
|
4250
4544
|
};
|
|
4251
4545
|
requestBody?: never;
|
|
4252
4546
|
responses: {
|
|
4253
|
-
/** @description bcvRate/vesAmount are authoritative for settlement; medianRate/medianVesAmount are for display. sources includes per-source rates or errors. */
|
|
4254
4547
|
200: {
|
|
4255
4548
|
headers: {
|
|
4256
4549
|
[name: string]: unknown;
|
|
4257
4550
|
};
|
|
4258
4551
|
content: {
|
|
4259
|
-
"application/json": components["schemas"]["
|
|
4260
|
-
};
|
|
4261
|
-
};
|
|
4262
|
-
/** @description Invalid request or unsupported operation. */
|
|
4263
|
-
400: {
|
|
4264
|
-
headers: {
|
|
4265
|
-
[name: string]: unknown;
|
|
4266
|
-
};
|
|
4267
|
-
content: {
|
|
4268
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4552
|
+
"application/json": components["schemas"]["ConversionListDto"];
|
|
4269
4553
|
};
|
|
4270
4554
|
};
|
|
4271
4555
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -4306,7 +4590,7 @@ interface operations {
|
|
|
4306
4590
|
};
|
|
4307
4591
|
};
|
|
4308
4592
|
};
|
|
4309
|
-
|
|
4593
|
+
Conversions_create: {
|
|
4310
4594
|
parameters: {
|
|
4311
4595
|
query?: never;
|
|
4312
4596
|
header?: {
|
|
@@ -4318,7 +4602,7 @@ interface operations {
|
|
|
4318
4602
|
};
|
|
4319
4603
|
requestBody: {
|
|
4320
4604
|
content: {
|
|
4321
|
-
"application/json": components["schemas"]["
|
|
4605
|
+
"application/json": components["schemas"]["CreateConversionDto"];
|
|
4322
4606
|
};
|
|
4323
4607
|
};
|
|
4324
4608
|
responses: {
|
|
@@ -4327,11 +4611,11 @@ interface operations {
|
|
|
4327
4611
|
[name: string]: unknown;
|
|
4328
4612
|
};
|
|
4329
4613
|
content: {
|
|
4330
|
-
"application/json": components["schemas"]["
|
|
4614
|
+
"application/json": components["schemas"]["ConversionDto"];
|
|
4331
4615
|
};
|
|
4332
4616
|
};
|
|
4333
|
-
/** @description
|
|
4334
|
-
|
|
4617
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4618
|
+
401: {
|
|
4335
4619
|
headers: {
|
|
4336
4620
|
[name: string]: unknown;
|
|
4337
4621
|
};
|
|
@@ -4339,8 +4623,8 @@ interface operations {
|
|
|
4339
4623
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4340
4624
|
};
|
|
4341
4625
|
};
|
|
4342
|
-
/** @description
|
|
4343
|
-
|
|
4626
|
+
/** @description `conversions_not_enabled` or `live_mode_not_activated`. */
|
|
4627
|
+
403: {
|
|
4344
4628
|
headers: {
|
|
4345
4629
|
[name: string]: unknown;
|
|
4346
4630
|
};
|
|
@@ -4348,8 +4632,8 @@ interface operations {
|
|
|
4348
4632
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4349
4633
|
};
|
|
4350
4634
|
};
|
|
4351
|
-
/** @description
|
|
4352
|
-
|
|
4635
|
+
/** @description Unknown quote. */
|
|
4636
|
+
404: {
|
|
4353
4637
|
headers: {
|
|
4354
4638
|
[name: string]: unknown;
|
|
4355
4639
|
};
|
|
@@ -4357,8 +4641,8 @@ interface operations {
|
|
|
4357
4641
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4358
4642
|
};
|
|
4359
4643
|
};
|
|
4360
|
-
/** @description
|
|
4361
|
-
|
|
4644
|
+
/** @description `quote_used`. */
|
|
4645
|
+
409: {
|
|
4362
4646
|
headers: {
|
|
4363
4647
|
[name: string]: unknown;
|
|
4364
4648
|
};
|
|
@@ -4366,8 +4650,8 @@ interface operations {
|
|
|
4366
4650
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4367
4651
|
};
|
|
4368
4652
|
};
|
|
4369
|
-
/** @description
|
|
4370
|
-
|
|
4653
|
+
/** @description `quote_expired` — request a new quote. */
|
|
4654
|
+
410: {
|
|
4371
4655
|
headers: {
|
|
4372
4656
|
[name: string]: unknown;
|
|
4373
4657
|
};
|
|
@@ -4375,17 +4659,389 @@ interface operations {
|
|
|
4375
4659
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4376
4660
|
};
|
|
4377
4661
|
};
|
|
4378
|
-
|
|
4379
|
-
|
|
4380
|
-
|
|
4381
|
-
|
|
4382
|
-
|
|
4383
|
-
|
|
4384
|
-
|
|
4385
|
-
|
|
4662
|
+
/** @description `insufficient_balance` or `daily_limit_exceeded`. */
|
|
4663
|
+
422: {
|
|
4664
|
+
headers: {
|
|
4665
|
+
[name: string]: unknown;
|
|
4666
|
+
};
|
|
4667
|
+
content: {
|
|
4668
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4669
|
+
};
|
|
4670
|
+
};
|
|
4671
|
+
/** @description Client error. */
|
|
4672
|
+
"4XX": {
|
|
4673
|
+
headers: {
|
|
4674
|
+
[name: string]: unknown;
|
|
4675
|
+
};
|
|
4676
|
+
content: {
|
|
4677
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4678
|
+
};
|
|
4679
|
+
};
|
|
4680
|
+
/** @description Server or upstream bank error. */
|
|
4681
|
+
"5XX": {
|
|
4682
|
+
headers: {
|
|
4683
|
+
[name: string]: unknown;
|
|
4684
|
+
};
|
|
4685
|
+
content: {
|
|
4686
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4687
|
+
};
|
|
4688
|
+
};
|
|
4689
|
+
};
|
|
4690
|
+
};
|
|
4691
|
+
Conversions_get: {
|
|
4692
|
+
parameters: {
|
|
4693
|
+
query?: never;
|
|
4694
|
+
header?: never;
|
|
4695
|
+
path: {
|
|
4696
|
+
id: string;
|
|
4697
|
+
};
|
|
4698
|
+
cookie?: never;
|
|
4699
|
+
};
|
|
4700
|
+
requestBody?: never;
|
|
4701
|
+
responses: {
|
|
4702
|
+
200: {
|
|
4703
|
+
headers: {
|
|
4704
|
+
[name: string]: unknown;
|
|
4705
|
+
};
|
|
4706
|
+
content: {
|
|
4707
|
+
"application/json": components["schemas"]["ConversionDto"];
|
|
4708
|
+
};
|
|
4709
|
+
};
|
|
4710
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4711
|
+
401: {
|
|
4712
|
+
headers: {
|
|
4713
|
+
[name: string]: unknown;
|
|
4714
|
+
};
|
|
4715
|
+
content: {
|
|
4716
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4717
|
+
};
|
|
4718
|
+
};
|
|
4719
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4720
|
+
403: {
|
|
4721
|
+
headers: {
|
|
4722
|
+
[name: string]: unknown;
|
|
4723
|
+
};
|
|
4724
|
+
content: {
|
|
4725
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4726
|
+
};
|
|
4727
|
+
};
|
|
4728
|
+
404: {
|
|
4729
|
+
headers: {
|
|
4730
|
+
[name: string]: unknown;
|
|
4731
|
+
};
|
|
4732
|
+
content: {
|
|
4733
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4734
|
+
};
|
|
4735
|
+
};
|
|
4736
|
+
/** @description Client error. */
|
|
4737
|
+
"4XX": {
|
|
4738
|
+
headers: {
|
|
4739
|
+
[name: string]: unknown;
|
|
4740
|
+
};
|
|
4741
|
+
content: {
|
|
4742
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4743
|
+
};
|
|
4744
|
+
};
|
|
4745
|
+
/** @description Server or upstream bank error. */
|
|
4746
|
+
"5XX": {
|
|
4747
|
+
headers: {
|
|
4748
|
+
[name: string]: unknown;
|
|
4749
|
+
};
|
|
4750
|
+
content: {
|
|
4751
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4752
|
+
};
|
|
4386
4753
|
};
|
|
4387
|
-
|
|
4388
|
-
|
|
4754
|
+
};
|
|
4755
|
+
};
|
|
4756
|
+
Conversions_cancel: {
|
|
4757
|
+
parameters: {
|
|
4758
|
+
query?: never;
|
|
4759
|
+
header?: {
|
|
4760
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4761
|
+
"Idempotency-Key"?: string;
|
|
4762
|
+
};
|
|
4763
|
+
path: {
|
|
4764
|
+
id: string;
|
|
4765
|
+
};
|
|
4766
|
+
cookie?: never;
|
|
4767
|
+
};
|
|
4768
|
+
requestBody?: never;
|
|
4769
|
+
responses: {
|
|
4770
|
+
200: {
|
|
4771
|
+
headers: {
|
|
4772
|
+
[name: string]: unknown;
|
|
4773
|
+
};
|
|
4774
|
+
content: {
|
|
4775
|
+
"application/json": components["schemas"]["ConversionDto"];
|
|
4776
|
+
};
|
|
4777
|
+
};
|
|
4778
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4779
|
+
401: {
|
|
4780
|
+
headers: {
|
|
4781
|
+
[name: string]: unknown;
|
|
4782
|
+
};
|
|
4783
|
+
content: {
|
|
4784
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4785
|
+
};
|
|
4786
|
+
};
|
|
4787
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4788
|
+
403: {
|
|
4789
|
+
headers: {
|
|
4790
|
+
[name: string]: unknown;
|
|
4791
|
+
};
|
|
4792
|
+
content: {
|
|
4793
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4794
|
+
};
|
|
4795
|
+
};
|
|
4796
|
+
404: {
|
|
4797
|
+
headers: {
|
|
4798
|
+
[name: string]: unknown;
|
|
4799
|
+
};
|
|
4800
|
+
content: {
|
|
4801
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4802
|
+
};
|
|
4803
|
+
};
|
|
4804
|
+
/** @description `conversion_not_cancelable` — already completed or canceled. */
|
|
4805
|
+
409: {
|
|
4806
|
+
headers: {
|
|
4807
|
+
[name: string]: unknown;
|
|
4808
|
+
};
|
|
4809
|
+
content: {
|
|
4810
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4811
|
+
};
|
|
4812
|
+
};
|
|
4813
|
+
/** @description Client error. */
|
|
4814
|
+
"4XX": {
|
|
4815
|
+
headers: {
|
|
4816
|
+
[name: string]: unknown;
|
|
4817
|
+
};
|
|
4818
|
+
content: {
|
|
4819
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4820
|
+
};
|
|
4821
|
+
};
|
|
4822
|
+
/** @description Server or upstream bank error. */
|
|
4823
|
+
"5XX": {
|
|
4824
|
+
headers: {
|
|
4825
|
+
[name: string]: unknown;
|
|
4826
|
+
};
|
|
4827
|
+
content: {
|
|
4828
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4829
|
+
};
|
|
4830
|
+
};
|
|
4831
|
+
};
|
|
4832
|
+
};
|
|
4833
|
+
Payments_getBanks: {
|
|
4834
|
+
parameters: {
|
|
4835
|
+
query?: never;
|
|
4836
|
+
header?: never;
|
|
4837
|
+
path?: never;
|
|
4838
|
+
cookie?: never;
|
|
4839
|
+
};
|
|
4840
|
+
requestBody?: never;
|
|
4841
|
+
responses: {
|
|
4842
|
+
200: {
|
|
4843
|
+
headers: {
|
|
4844
|
+
[name: string]: unknown;
|
|
4845
|
+
};
|
|
4846
|
+
content: {
|
|
4847
|
+
"application/json": components["schemas"]["BankResponseDto"][];
|
|
4848
|
+
};
|
|
4849
|
+
};
|
|
4850
|
+
/** @description Invalid request or unsupported operation. */
|
|
4851
|
+
400: {
|
|
4852
|
+
headers: {
|
|
4853
|
+
[name: string]: unknown;
|
|
4854
|
+
};
|
|
4855
|
+
content: {
|
|
4856
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4857
|
+
};
|
|
4858
|
+
};
|
|
4859
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4860
|
+
401: {
|
|
4861
|
+
headers: {
|
|
4862
|
+
[name: string]: unknown;
|
|
4863
|
+
};
|
|
4864
|
+
content: {
|
|
4865
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4866
|
+
};
|
|
4867
|
+
};
|
|
4868
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4869
|
+
403: {
|
|
4870
|
+
headers: {
|
|
4871
|
+
[name: string]: unknown;
|
|
4872
|
+
};
|
|
4873
|
+
content: {
|
|
4874
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4875
|
+
};
|
|
4876
|
+
};
|
|
4877
|
+
/** @description Client error. */
|
|
4878
|
+
"4XX": {
|
|
4879
|
+
headers: {
|
|
4880
|
+
[name: string]: unknown;
|
|
4881
|
+
};
|
|
4882
|
+
content: {
|
|
4883
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4884
|
+
};
|
|
4885
|
+
};
|
|
4886
|
+
/** @description Server or upstream bank error. */
|
|
4887
|
+
"5XX": {
|
|
4888
|
+
headers: {
|
|
4889
|
+
[name: string]: unknown;
|
|
4890
|
+
};
|
|
4891
|
+
content: {
|
|
4892
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4893
|
+
};
|
|
4894
|
+
};
|
|
4895
|
+
};
|
|
4896
|
+
};
|
|
4897
|
+
Payments_getQuote: {
|
|
4898
|
+
parameters: {
|
|
4899
|
+
query: {
|
|
4900
|
+
/** @description Positive USD amount to convert. Must be a finite number greater than zero. */
|
|
4901
|
+
usdAmount: number;
|
|
4902
|
+
};
|
|
4903
|
+
header?: never;
|
|
4904
|
+
path?: never;
|
|
4905
|
+
cookie?: never;
|
|
4906
|
+
};
|
|
4907
|
+
requestBody?: never;
|
|
4908
|
+
responses: {
|
|
4909
|
+
/** @description bcvRate/vesAmount are authoritative for settlement; medianRate/medianVesAmount are for display. sources includes per-source rates or errors. */
|
|
4910
|
+
200: {
|
|
4911
|
+
headers: {
|
|
4912
|
+
[name: string]: unknown;
|
|
4913
|
+
};
|
|
4914
|
+
content: {
|
|
4915
|
+
"application/json": components["schemas"]["QuoteResponseDto"];
|
|
4916
|
+
};
|
|
4917
|
+
};
|
|
4918
|
+
/** @description Invalid request or unsupported operation. */
|
|
4919
|
+
400: {
|
|
4920
|
+
headers: {
|
|
4921
|
+
[name: string]: unknown;
|
|
4922
|
+
};
|
|
4923
|
+
content: {
|
|
4924
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4925
|
+
};
|
|
4926
|
+
};
|
|
4927
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4928
|
+
401: {
|
|
4929
|
+
headers: {
|
|
4930
|
+
[name: string]: unknown;
|
|
4931
|
+
};
|
|
4932
|
+
content: {
|
|
4933
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4934
|
+
};
|
|
4935
|
+
};
|
|
4936
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4937
|
+
403: {
|
|
4938
|
+
headers: {
|
|
4939
|
+
[name: string]: unknown;
|
|
4940
|
+
};
|
|
4941
|
+
content: {
|
|
4942
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4943
|
+
};
|
|
4944
|
+
};
|
|
4945
|
+
/** @description Client error. */
|
|
4946
|
+
"4XX": {
|
|
4947
|
+
headers: {
|
|
4948
|
+
[name: string]: unknown;
|
|
4949
|
+
};
|
|
4950
|
+
content: {
|
|
4951
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4952
|
+
};
|
|
4953
|
+
};
|
|
4954
|
+
/** @description Server or upstream bank error. */
|
|
4955
|
+
"5XX": {
|
|
4956
|
+
headers: {
|
|
4957
|
+
[name: string]: unknown;
|
|
4958
|
+
};
|
|
4959
|
+
content: {
|
|
4960
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4961
|
+
};
|
|
4962
|
+
};
|
|
4963
|
+
};
|
|
4964
|
+
};
|
|
4965
|
+
Payments_requestC2p: {
|
|
4966
|
+
parameters: {
|
|
4967
|
+
query?: never;
|
|
4968
|
+
header?: {
|
|
4969
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4970
|
+
"Idempotency-Key"?: string;
|
|
4971
|
+
};
|
|
4972
|
+
path?: never;
|
|
4973
|
+
cookie?: never;
|
|
4974
|
+
};
|
|
4975
|
+
requestBody: {
|
|
4976
|
+
content: {
|
|
4977
|
+
"application/json": components["schemas"]["C2pRequestDto"];
|
|
4978
|
+
};
|
|
4979
|
+
};
|
|
4980
|
+
responses: {
|
|
4981
|
+
201: {
|
|
4982
|
+
headers: {
|
|
4983
|
+
[name: string]: unknown;
|
|
4984
|
+
};
|
|
4985
|
+
content: {
|
|
4986
|
+
"application/json": components["schemas"]["C2pIntentResponseDto"];
|
|
4987
|
+
};
|
|
4988
|
+
};
|
|
4989
|
+
/** @description Invalid request or unsupported operation. */
|
|
4990
|
+
400: {
|
|
4991
|
+
headers: {
|
|
4992
|
+
[name: string]: unknown;
|
|
4993
|
+
};
|
|
4994
|
+
content: {
|
|
4995
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4996
|
+
};
|
|
4997
|
+
};
|
|
4998
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4999
|
+
401: {
|
|
5000
|
+
headers: {
|
|
5001
|
+
[name: string]: unknown;
|
|
5002
|
+
};
|
|
5003
|
+
content: {
|
|
5004
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5005
|
+
};
|
|
5006
|
+
};
|
|
5007
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5008
|
+
403: {
|
|
5009
|
+
headers: {
|
|
5010
|
+
[name: string]: unknown;
|
|
5011
|
+
};
|
|
5012
|
+
content: {
|
|
5013
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5014
|
+
};
|
|
5015
|
+
};
|
|
5016
|
+
/** @description Client error. */
|
|
5017
|
+
"4XX": {
|
|
5018
|
+
headers: {
|
|
5019
|
+
[name: string]: unknown;
|
|
5020
|
+
};
|
|
5021
|
+
content: {
|
|
5022
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5023
|
+
};
|
|
5024
|
+
};
|
|
5025
|
+
/** @description Server or upstream bank error. */
|
|
5026
|
+
"5XX": {
|
|
5027
|
+
headers: {
|
|
5028
|
+
[name: string]: unknown;
|
|
5029
|
+
};
|
|
5030
|
+
content: {
|
|
5031
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5032
|
+
};
|
|
5033
|
+
};
|
|
5034
|
+
};
|
|
5035
|
+
};
|
|
5036
|
+
Payments_executeC2p: {
|
|
5037
|
+
parameters: {
|
|
5038
|
+
query?: never;
|
|
5039
|
+
header?: {
|
|
5040
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
5041
|
+
"Idempotency-Key"?: string;
|
|
5042
|
+
};
|
|
5043
|
+
path?: never;
|
|
5044
|
+
cookie?: never;
|
|
4389
5045
|
};
|
|
4390
5046
|
requestBody: {
|
|
4391
5047
|
content: {
|
|
@@ -7233,6 +7889,7 @@ declare class Balance extends APIResource {
|
|
|
7233
7889
|
collectedVes: string;
|
|
7234
7890
|
feesVes: string;
|
|
7235
7891
|
paidOutVes: string;
|
|
7892
|
+
convertedVes: string;
|
|
7236
7893
|
reserveVes: string;
|
|
7237
7894
|
ledgerNetVes: string;
|
|
7238
7895
|
availableVes: string;
|
|
@@ -7424,7 +8081,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
7424
8081
|
id: string;
|
|
7425
8082
|
tenantId: string;
|
|
7426
8083
|
url: string;
|
|
7427
|
-
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")[];
|
|
8084
|
+
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" | "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")[];
|
|
7428
8085
|
isActive: boolean;
|
|
7429
8086
|
createdAt: string;
|
|
7430
8087
|
secret?: string;
|
|
@@ -7433,7 +8090,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
7433
8090
|
id: string;
|
|
7434
8091
|
tenantId: string;
|
|
7435
8092
|
url: string;
|
|
7436
|
-
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")[];
|
|
8093
|
+
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" | "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")[];
|
|
7437
8094
|
isActive: boolean;
|
|
7438
8095
|
createdAt: string;
|
|
7439
8096
|
secret?: string;
|
|
@@ -7442,7 +8099,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
7442
8099
|
id: string;
|
|
7443
8100
|
tenantId: string;
|
|
7444
8101
|
url: string;
|
|
7445
|
-
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")[];
|
|
8102
|
+
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" | "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")[];
|
|
7446
8103
|
isActive: boolean;
|
|
7447
8104
|
createdAt: string;
|
|
7448
8105
|
secret?: string;
|
|
@@ -7474,7 +8131,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
7474
8131
|
[key: string]: string;
|
|
7475
8132
|
};
|
|
7476
8133
|
allowedOrigins: string[];
|
|
7477
|
-
methods: ("c2p" | "vpos" | "usdt")[];
|
|
8134
|
+
methods: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
7478
8135
|
successUrl?: string | null;
|
|
7479
8136
|
cancelUrl?: string | null;
|
|
7480
8137
|
paymentId?: string | null;
|
|
@@ -7495,7 +8152,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
7495
8152
|
[key: string]: string;
|
|
7496
8153
|
};
|
|
7497
8154
|
allowedOrigins: string[];
|
|
7498
|
-
methods: ("c2p" | "vpos" | "usdt")[];
|
|
8155
|
+
methods: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
7499
8156
|
successUrl?: string | null;
|
|
7500
8157
|
cancelUrl?: string | null;
|
|
7501
8158
|
paymentId?: string | null;
|
|
@@ -7600,53 +8257,160 @@ declare class PaymentLinks extends APIResource {
|
|
|
7600
8257
|
delete(id: string, options?: RequestOptions): Promise<void>;
|
|
7601
8258
|
}
|
|
7602
8259
|
|
|
7603
|
-
/**
|
|
8260
|
+
/** A rate for converting VES to USDT, locked for 60 seconds. */
|
|
8261
|
+
declare class ConversionQuotes extends APIResource {
|
|
8262
|
+
/** Send `sourceAmountVes` (VES to spend) or `targetAmountUsdt` (USDT to receive) — exactly one. */
|
|
8263
|
+
create(params: RequestBody<'Conversions_createQuote'>, options?: RequestOptions): Promise<{
|
|
8264
|
+
id: string;
|
|
8265
|
+
object: string;
|
|
8266
|
+
rate: string;
|
|
8267
|
+
marketRate: string;
|
|
8268
|
+
spreadPercent: string;
|
|
8269
|
+
rateSource: "market";
|
|
8270
|
+
sourceAmountVes: string;
|
|
8271
|
+
targetAmountUsdt: string;
|
|
8272
|
+
expiresAt: string;
|
|
8273
|
+
createdAt: string;
|
|
8274
|
+
}>;
|
|
8275
|
+
}
|
|
8276
|
+
/**
|
|
8277
|
+
* Convert available VES into your USDT balance. Accepting a quote debits the VES at once; the
|
|
8278
|
+
* conversion is `PENDING` until VEXPay delivers the USDT (`conversion.completed`). Enabled per account.
|
|
8279
|
+
*/
|
|
8280
|
+
declare class Conversions extends APIResource {
|
|
8281
|
+
readonly quotes: ConversionQuotes;
|
|
8282
|
+
/** Accept a quote (`quoteId`). Pass `idempotencyKey` in options to retry safely. */
|
|
8283
|
+
create(params: RequestBody<'Conversions_create'>, options?: RequestOptions): Promise<{
|
|
8284
|
+
id: string;
|
|
8285
|
+
object: string;
|
|
8286
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
8287
|
+
reference: string | null;
|
|
8288
|
+
rate: string;
|
|
8289
|
+
marketRate: string;
|
|
8290
|
+
spreadPercent: string;
|
|
8291
|
+
rateSource: "market";
|
|
8292
|
+
sourceAmountVes: string;
|
|
8293
|
+
targetAmountUsdt: string;
|
|
8294
|
+
createdAt: string;
|
|
8295
|
+
completedAt: string | null;
|
|
8296
|
+
canceledAt: string | null;
|
|
8297
|
+
cancelReason: string | null;
|
|
8298
|
+
}>;
|
|
8299
|
+
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
8300
|
+
id: string;
|
|
8301
|
+
object: string;
|
|
8302
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
8303
|
+
reference: string | null;
|
|
8304
|
+
rate: string;
|
|
8305
|
+
marketRate: string;
|
|
8306
|
+
spreadPercent: string;
|
|
8307
|
+
rateSource: "market";
|
|
8308
|
+
sourceAmountVes: string;
|
|
8309
|
+
targetAmountUsdt: string;
|
|
8310
|
+
createdAt: string;
|
|
8311
|
+
completedAt: string | null;
|
|
8312
|
+
canceledAt: string | null;
|
|
8313
|
+
cancelReason: string | null;
|
|
8314
|
+
}>;
|
|
8315
|
+
/** Await for one page, or `for await` over every conversion (newest first). */
|
|
8316
|
+
list(params?: QueryParams<'Conversions_list'>, options?: RequestOptions): PagePromise<{
|
|
8317
|
+
items: components["schemas"]["ConversionDto"][];
|
|
8318
|
+
nextCursor: string | null;
|
|
8319
|
+
}, {
|
|
8320
|
+
id: string;
|
|
8321
|
+
object: string;
|
|
8322
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
8323
|
+
reference: string | null;
|
|
8324
|
+
rate: string;
|
|
8325
|
+
marketRate: string;
|
|
8326
|
+
spreadPercent: string;
|
|
8327
|
+
rateSource: "market";
|
|
8328
|
+
sourceAmountVes: string;
|
|
8329
|
+
targetAmountUsdt: string;
|
|
8330
|
+
createdAt: string;
|
|
8331
|
+
completedAt: string | null;
|
|
8332
|
+
canceledAt: string | null;
|
|
8333
|
+
cancelReason: string | null;
|
|
8334
|
+
}>;
|
|
8335
|
+
/** Cancel a `PENDING` conversion; the VES returns to your available balance. */
|
|
8336
|
+
cancel(id: string, options?: RequestOptions): Promise<{
|
|
8337
|
+
id: string;
|
|
8338
|
+
object: string;
|
|
8339
|
+
status: "PENDING" | "COMPLETED" | "CANCELED";
|
|
8340
|
+
reference: string | null;
|
|
8341
|
+
rate: string;
|
|
8342
|
+
marketRate: string;
|
|
8343
|
+
spreadPercent: string;
|
|
8344
|
+
rateSource: "market";
|
|
8345
|
+
sourceAmountVes: string;
|
|
8346
|
+
targetAmountUsdt: string;
|
|
8347
|
+
createdAt: string;
|
|
8348
|
+
completedAt: string | null;
|
|
8349
|
+
canceledAt: string | null;
|
|
8350
|
+
cancelReason: string | null;
|
|
8351
|
+
}>;
|
|
8352
|
+
}
|
|
8353
|
+
|
|
8354
|
+
/** One stablecoin balance (`currency`: USDT by default, or USDC). Never converted to VES. */
|
|
7604
8355
|
declare class CryptoBalance extends APIResource {
|
|
7605
|
-
retrieve(options?: RequestOptions): Promise<{
|
|
7606
|
-
currency:
|
|
7607
|
-
|
|
7608
|
-
|
|
8356
|
+
retrieve(params?: QueryParams<'Crypto_getBalance'>, options?: RequestOptions): Promise<{
|
|
8357
|
+
currency: "USDT" | "USDC";
|
|
8358
|
+
available: string;
|
|
8359
|
+
pendingPayout: string;
|
|
8360
|
+
availableUsdt?: string;
|
|
8361
|
+
pendingPayoutUsdt?: string;
|
|
7609
8362
|
asOf: string;
|
|
7610
8363
|
}>;
|
|
7611
8364
|
}
|
|
7612
|
-
/**
|
|
8365
|
+
/** Every stablecoin balance (USDT and USDC). */
|
|
8366
|
+
declare class CryptoBalances extends APIResource {
|
|
8367
|
+
list(options?: RequestOptions): Promise<{
|
|
8368
|
+
data: components["schemas"]["CryptoBalanceDto"][];
|
|
8369
|
+
}>;
|
|
8370
|
+
}
|
|
8371
|
+
/** Static deposit addresses per customer, stablecoin (`currency`) and network. */
|
|
7613
8372
|
declare class DepositAddresses extends APIResource {
|
|
7614
8373
|
/** Get or create — calling again for the same customer and network returns the same address. */
|
|
7615
8374
|
create(params: RequestBody<'Crypto_createDepositAddress'>, options?: RequestOptions): Promise<{
|
|
7616
8375
|
customerRef: string;
|
|
7617
8376
|
network: string;
|
|
7618
|
-
currency:
|
|
8377
|
+
currency: "USDT" | "USDC";
|
|
7619
8378
|
address: string;
|
|
7620
8379
|
tag?: string;
|
|
7621
8380
|
tagRequired: boolean;
|
|
7622
8381
|
createdAt: string;
|
|
7623
8382
|
}>;
|
|
7624
8383
|
}
|
|
7625
|
-
/** Enabled
|
|
8384
|
+
/** Enabled networks for one stablecoin (`currency`) with the payout fee and availability for an amount. */
|
|
7626
8385
|
declare class CryptoNetworks extends APIResource {
|
|
7627
8386
|
list(params?: QueryParams<'Crypto_listNetworks'>, options?: RequestOptions): Promise<{
|
|
8387
|
+
currency: "USDT" | "USDC";
|
|
7628
8388
|
network: string;
|
|
7629
8389
|
displayName: string;
|
|
7630
8390
|
receiveEnabled: boolean;
|
|
7631
8391
|
payoutEnabled: boolean;
|
|
7632
|
-
|
|
7633
|
-
|
|
8392
|
+
payoutFee: string;
|
|
8393
|
+
minPayout: string;
|
|
8394
|
+
payoutFeeUsdt?: string;
|
|
8395
|
+
minPayoutUsdt?: string;
|
|
7634
8396
|
tagRequired: boolean;
|
|
7635
8397
|
available: boolean;
|
|
7636
8398
|
}[]>;
|
|
7637
8399
|
}
|
|
7638
|
-
/**
|
|
8400
|
+
/** Stablecoin payouts to external addresses (`currency`: USDT or USDC). `idempotencyKey` (in the body) makes retries safe. */
|
|
7639
8401
|
declare class CryptoPayouts extends APIResource {
|
|
7640
8402
|
create(params: RequestBody<'Crypto_createPayout'>, options?: RequestOptions): Promise<{
|
|
7641
8403
|
id: string;
|
|
7642
8404
|
object: string;
|
|
7643
|
-
currency:
|
|
8405
|
+
currency: "USDT" | "USDC";
|
|
7644
8406
|
status: "pending" | "processing" | "completed" | "failed";
|
|
7645
8407
|
network: string;
|
|
7646
8408
|
address: string;
|
|
7647
8409
|
tag?: string;
|
|
7648
|
-
|
|
7649
|
-
|
|
8410
|
+
amount: string;
|
|
8411
|
+
fee: string;
|
|
8412
|
+
amountUsdt?: string;
|
|
8413
|
+
feeUsdt?: string;
|
|
7650
8414
|
customerRef?: string;
|
|
7651
8415
|
merchantId?: string;
|
|
7652
8416
|
idempotencyKey: string;
|
|
@@ -7659,13 +8423,15 @@ declare class CryptoPayouts extends APIResource {
|
|
|
7659
8423
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
7660
8424
|
id: string;
|
|
7661
8425
|
object: string;
|
|
7662
|
-
currency:
|
|
8426
|
+
currency: "USDT" | "USDC";
|
|
7663
8427
|
status: "pending" | "processing" | "completed" | "failed";
|
|
7664
8428
|
network: string;
|
|
7665
8429
|
address: string;
|
|
7666
8430
|
tag?: string;
|
|
7667
|
-
|
|
7668
|
-
|
|
8431
|
+
amount: string;
|
|
8432
|
+
fee: string;
|
|
8433
|
+
amountUsdt?: string;
|
|
8434
|
+
feeUsdt?: string;
|
|
7669
8435
|
customerRef?: string;
|
|
7670
8436
|
merchantId?: string;
|
|
7671
8437
|
idempotencyKey: string;
|
|
@@ -7676,9 +8442,10 @@ declare class CryptoPayouts extends APIResource {
|
|
|
7676
8442
|
completedAt?: string;
|
|
7677
8443
|
}>;
|
|
7678
8444
|
}
|
|
7679
|
-
/** USDT: deposit addresses,
|
|
8445
|
+
/** Stablecoins (USDT, USDC): deposit addresses, balances, networks and payouts. */
|
|
7680
8446
|
declare class Crypto extends APIResource {
|
|
7681
8447
|
readonly balance: CryptoBalance;
|
|
8448
|
+
readonly balances: CryptoBalances;
|
|
7682
8449
|
readonly depositAddresses: DepositAddresses;
|
|
7683
8450
|
readonly networks: CryptoNetworks;
|
|
7684
8451
|
readonly payouts: CryptoPayouts;
|
|
@@ -7736,6 +8503,7 @@ declare class Merchants extends APIResource {
|
|
|
7736
8503
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
7737
8504
|
isActive: boolean;
|
|
7738
8505
|
autoPayoutEnabled?: boolean;
|
|
8506
|
+
applicationFeePercent?: number | null;
|
|
7739
8507
|
bankCode?: string;
|
|
7740
8508
|
destination?: string;
|
|
7741
8509
|
payoutMethods?: components["schemas"]["PayoutMethodResponseDto"][];
|
|
@@ -7768,6 +8536,7 @@ declare class Merchants extends APIResource {
|
|
|
7768
8536
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
7769
8537
|
isActive: boolean;
|
|
7770
8538
|
autoPayoutEnabled?: boolean;
|
|
8539
|
+
applicationFeePercent?: number | null;
|
|
7771
8540
|
bankCode?: string;
|
|
7772
8541
|
destination?: string;
|
|
7773
8542
|
payoutMethods?: components["schemas"]["PayoutMethodResponseDto"][];
|
|
@@ -7796,6 +8565,7 @@ declare class Merchants extends APIResource {
|
|
|
7796
8565
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
7797
8566
|
isActive: boolean;
|
|
7798
8567
|
autoPayoutEnabled?: boolean;
|
|
8568
|
+
applicationFeePercent?: number | null;
|
|
7799
8569
|
bankCode?: string;
|
|
7800
8570
|
destination?: string;
|
|
7801
8571
|
payoutMethods?: components["schemas"]["PayoutMethodResponseDto"][];
|
|
@@ -7826,6 +8596,7 @@ declare class Merchants extends APIResource {
|
|
|
7826
8596
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
7827
8597
|
isActive: boolean;
|
|
7828
8598
|
autoPayoutEnabled?: boolean;
|
|
8599
|
+
applicationFeePercent?: number | null;
|
|
7829
8600
|
bankCode?: string;
|
|
7830
8601
|
destination?: string;
|
|
7831
8602
|
payoutMethods?: components["schemas"]["PayoutMethodResponseDto"][];
|
|
@@ -8224,7 +8995,7 @@ declare class Payments extends APIResource {
|
|
|
8224
8995
|
}>;
|
|
8225
8996
|
}
|
|
8226
8997
|
|
|
8227
|
-
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"];
|
|
8998
|
+
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", "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"];
|
|
8228
8999
|
type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];
|
|
8229
9000
|
/** `data` of every `payment.*` event. */
|
|
8230
9001
|
interface PaymentWebhookData {
|
|
@@ -8318,6 +9089,8 @@ declare class VexPay {
|
|
|
8318
9089
|
readonly payouts: Payouts;
|
|
8319
9090
|
/** USDT: deposit addresses, balance, networks and payouts. */
|
|
8320
9091
|
readonly crypto: Crypto;
|
|
9092
|
+
/** Convert available VES to USDT (enabled per account). */
|
|
9093
|
+
readonly conversions: Conversions;
|
|
8321
9094
|
readonly products: Products;
|
|
8322
9095
|
readonly paymentLinks: PaymentLinks;
|
|
8323
9096
|
readonly tenantPayoutAccount: TenantPayoutAccount;
|
|
@@ -8375,6 +9148,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
8375
9148
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
8376
9149
|
}
|
|
8377
9150
|
|
|
8378
|
-
declare const VERSION = "0.
|
|
9151
|
+
declare const VERSION = "0.3.0";
|
|
8379
9152
|
|
|
8380
9153
|
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 };
|