@vexpay/node 0.2.1 → 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 +872 -122
- package/dist/index.d.ts +872 -122
- package/dist/index.js +49 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
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
|
};
|
|
@@ -896,21 +901,38 @@ interface components {
|
|
|
896
901
|
ip?: string;
|
|
897
902
|
};
|
|
898
903
|
CryptoBalanceDto: {
|
|
899
|
-
/** @example USDT */
|
|
900
|
-
currency: string;
|
|
901
904
|
/**
|
|
902
|
-
* @
|
|
905
|
+
* @example USDT
|
|
906
|
+
* @enum {string}
|
|
907
|
+
*/
|
|
908
|
+
currency: "USDT" | "USDC";
|
|
909
|
+
/**
|
|
910
|
+
* @description Available for payouts, in `currency` (ledger).
|
|
911
|
+
* @example 97.00
|
|
912
|
+
*/
|
|
913
|
+
available: string;
|
|
914
|
+
/**
|
|
915
|
+
* @description Reserved by payouts that have not completed yet, in `currency`.
|
|
916
|
+
* @example 50.10
|
|
917
|
+
*/
|
|
918
|
+
pendingPayout: string;
|
|
919
|
+
/**
|
|
920
|
+
* @description USDT only: same as `available`.
|
|
903
921
|
* @example 97.00
|
|
904
922
|
*/
|
|
905
|
-
availableUsdt
|
|
923
|
+
availableUsdt?: string;
|
|
906
924
|
/**
|
|
907
|
-
* @description USDT
|
|
925
|
+
* @description USDT only: same as `pendingPayout`.
|
|
908
926
|
* @example 50.10
|
|
909
927
|
*/
|
|
910
|
-
pendingPayoutUsdt
|
|
928
|
+
pendingPayoutUsdt?: string;
|
|
911
929
|
/** Format: date-time */
|
|
912
930
|
asOf: string;
|
|
913
931
|
};
|
|
932
|
+
CryptoBalancesDto: {
|
|
933
|
+
/** @description One balance per stablecoin (USDT, USDC). */
|
|
934
|
+
data: components["schemas"]["CryptoBalanceDto"][];
|
|
935
|
+
};
|
|
914
936
|
CreateDepositAddressDto: {
|
|
915
937
|
/**
|
|
916
938
|
* @description Your identifier for the customer this address belongs to (1–128 chars: A–Z a–z 0–9 _ . : @ -).
|
|
@@ -918,18 +940,29 @@ interface components {
|
|
|
918
940
|
*/
|
|
919
941
|
customerRef: string;
|
|
920
942
|
/**
|
|
943
|
+
* @description USDT: TRC20, BEP20, POLYGON, SOL, TON, ARB1. USDC: POLYGON, BASE.
|
|
921
944
|
* @example BEP20
|
|
922
945
|
* @enum {string}
|
|
923
946
|
*/
|
|
924
|
-
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";
|
|
925
955
|
};
|
|
926
956
|
DepositAddressDto: {
|
|
927
957
|
/** @example user_123 */
|
|
928
958
|
customerRef: string;
|
|
929
959
|
/** @example BEP20 */
|
|
930
960
|
network: string;
|
|
931
|
-
/**
|
|
932
|
-
|
|
961
|
+
/**
|
|
962
|
+
* @example USDT
|
|
963
|
+
* @enum {string}
|
|
964
|
+
*/
|
|
965
|
+
currency: "USDT" | "USDC";
|
|
933
966
|
/** @example 0x9f3c… */
|
|
934
967
|
address: string;
|
|
935
968
|
/** @description Destination tag / memo the payer must include (TON). */
|
|
@@ -940,35 +973,69 @@ interface components {
|
|
|
940
973
|
createdAt: string;
|
|
941
974
|
};
|
|
942
975
|
CryptoNetworkDto: {
|
|
976
|
+
/**
|
|
977
|
+
* @example USDT
|
|
978
|
+
* @enum {string}
|
|
979
|
+
*/
|
|
980
|
+
currency: "USDT" | "USDC";
|
|
943
981
|
/** @example POLYGON */
|
|
944
982
|
network: string;
|
|
945
983
|
/** @example Polygon */
|
|
946
984
|
displayName: string;
|
|
947
985
|
receiveEnabled: boolean;
|
|
948
986
|
payoutEnabled: boolean;
|
|
949
|
-
/**
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
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;
|
|
953
1007
|
tagRequired: boolean;
|
|
954
1008
|
/** @description Whether a payout of the requested amount can be sent on this network now. */
|
|
955
1009
|
available: boolean;
|
|
956
1010
|
};
|
|
957
1011
|
CreateCryptoPayoutDto: {
|
|
958
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.
|
|
959
1021
|
* @example POLYGON
|
|
960
1022
|
* @enum {string}
|
|
961
1023
|
*/
|
|
962
|
-
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1";
|
|
1024
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1" | "BASE";
|
|
963
1025
|
/** @example 0x9f3c4e1b2a7d6c5e4f3a2b1c0d9e8f7a6b5c4d3e */
|
|
964
1026
|
address: string;
|
|
965
1027
|
/** @description Destination tag / memo (required on TON). */
|
|
966
1028
|
tag?: string;
|
|
967
1029
|
/**
|
|
968
|
-
* @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`.
|
|
969
1036
|
* @example 50.00
|
|
970
1037
|
*/
|
|
971
|
-
amountUsdt
|
|
1038
|
+
amountUsdt?: string;
|
|
972
1039
|
/**
|
|
973
1040
|
* @description Your customer reference, echoed on webhooks.
|
|
974
1041
|
* @example user_123
|
|
@@ -984,20 +1051,36 @@ interface components {
|
|
|
984
1051
|
id: string;
|
|
985
1052
|
/** @example crypto.payout */
|
|
986
1053
|
object: string;
|
|
987
|
-
/**
|
|
988
|
-
|
|
1054
|
+
/**
|
|
1055
|
+
* @example USDT
|
|
1056
|
+
* @enum {string}
|
|
1057
|
+
*/
|
|
1058
|
+
currency: "USDT" | "USDC";
|
|
989
1059
|
/** @enum {string} */
|
|
990
1060
|
status: "pending" | "processing" | "completed" | "failed";
|
|
991
1061
|
network: string;
|
|
992
1062
|
address: string;
|
|
993
1063
|
tag?: string;
|
|
994
|
-
/** @example 50.00 */
|
|
995
|
-
amountUsdt: string;
|
|
996
1064
|
/**
|
|
997
|
-
* @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`.
|
|
998
1081
|
* @example 0.10
|
|
999
1082
|
*/
|
|
1000
|
-
feeUsdt
|
|
1083
|
+
feeUsdt?: string;
|
|
1001
1084
|
customerRef?: string;
|
|
1002
1085
|
merchantId?: string;
|
|
1003
1086
|
idempotencyKey: string;
|
|
@@ -1010,6 +1093,94 @@ interface components {
|
|
|
1010
1093
|
/** Format: date-time */
|
|
1011
1094
|
completedAt?: string;
|
|
1012
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
|
+
};
|
|
1013
1184
|
BankResponseDto: {
|
|
1014
1185
|
/**
|
|
1015
1186
|
* @description Canonical four-digit SIMF bank code.
|
|
@@ -1685,7 +1856,7 @@ interface components {
|
|
|
1685
1856
|
*/
|
|
1686
1857
|
allowedOrigins?: string[];
|
|
1687
1858
|
/** @description Payment methods offered. Defaults to every method your account can accept. */
|
|
1688
|
-
methods?: ("c2p" | "vpos" | "usdt")[];
|
|
1859
|
+
methods?: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
1689
1860
|
/**
|
|
1690
1861
|
* @description Up to 20 string key/value pairs (keys ≤ 40 chars, values ≤ 500 chars).
|
|
1691
1862
|
* @example {
|
|
@@ -1721,7 +1892,7 @@ interface components {
|
|
|
1721
1892
|
[key: string]: string;
|
|
1722
1893
|
};
|
|
1723
1894
|
allowedOrigins: string[];
|
|
1724
|
-
methods: ("c2p" | "vpos" | "usdt")[];
|
|
1895
|
+
methods: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
1725
1896
|
successUrl?: string | null;
|
|
1726
1897
|
cancelUrl?: string | null;
|
|
1727
1898
|
/** @description Latest payment for this session, once one exists. */
|
|
@@ -3856,7 +4027,9 @@ interface operations {
|
|
|
3856
4027
|
};
|
|
3857
4028
|
Crypto_getBalance: {
|
|
3858
4029
|
parameters: {
|
|
3859
|
-
query?:
|
|
4030
|
+
query?: {
|
|
4031
|
+
currency?: "USDT" | "USDC";
|
|
4032
|
+
};
|
|
3860
4033
|
header?: never;
|
|
3861
4034
|
path?: never;
|
|
3862
4035
|
cookie?: never;
|
|
@@ -3871,6 +4044,70 @@ interface operations {
|
|
|
3871
4044
|
"application/json": components["schemas"]["CryptoBalanceDto"];
|
|
3872
4045
|
};
|
|
3873
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
|
+
};
|
|
3874
4111
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
3875
4112
|
401: {
|
|
3876
4113
|
headers: {
|
|
@@ -3933,7 +4170,7 @@ interface operations {
|
|
|
3933
4170
|
"application/json": components["schemas"]["DepositAddressDto"];
|
|
3934
4171
|
};
|
|
3935
4172
|
};
|
|
3936
|
-
/** @description `unsupported_network` or invalid `customerRef`. */
|
|
4173
|
+
/** @description `unsupported_currency`, `unsupported_network` or invalid `customerRef`. */
|
|
3937
4174
|
400: {
|
|
3938
4175
|
headers: {
|
|
3939
4176
|
[name: string]: unknown;
|
|
@@ -3951,7 +4188,7 @@ interface operations {
|
|
|
3951
4188
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3952
4189
|
};
|
|
3953
4190
|
};
|
|
3954
|
-
/** @description `method_not_allowed` —
|
|
4191
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
3955
4192
|
403: {
|
|
3956
4193
|
headers: {
|
|
3957
4194
|
[name: string]: unknown;
|
|
@@ -3983,7 +4220,10 @@ interface operations {
|
|
|
3983
4220
|
Crypto_listNetworks: {
|
|
3984
4221
|
parameters: {
|
|
3985
4222
|
query?: {
|
|
4223
|
+
/** @description Alias of `amount`. */
|
|
3986
4224
|
amountUsdt?: string;
|
|
4225
|
+
currency?: "USDT" | "USDC";
|
|
4226
|
+
amount?: string;
|
|
3987
4227
|
};
|
|
3988
4228
|
header?: never;
|
|
3989
4229
|
path?: never;
|
|
@@ -3999,6 +4239,15 @@ interface operations {
|
|
|
3999
4239
|
"application/json": components["schemas"]["CryptoNetworkDto"][];
|
|
4000
4240
|
};
|
|
4001
4241
|
};
|
|
4242
|
+
/** @description `unsupported_currency`. */
|
|
4243
|
+
400: {
|
|
4244
|
+
headers: {
|
|
4245
|
+
[name: string]: unknown;
|
|
4246
|
+
};
|
|
4247
|
+
content: {
|
|
4248
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4249
|
+
};
|
|
4250
|
+
};
|
|
4002
4251
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4003
4252
|
401: {
|
|
4004
4253
|
headers: {
|
|
@@ -4008,7 +4257,7 @@ interface operations {
|
|
|
4008
4257
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4009
4258
|
};
|
|
4010
4259
|
};
|
|
4011
|
-
/** @description `method_not_allowed` —
|
|
4260
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
4012
4261
|
403: {
|
|
4013
4262
|
headers: {
|
|
4014
4263
|
[name: string]: unknown;
|
|
@@ -4071,7 +4320,7 @@ interface operations {
|
|
|
4071
4320
|
"application/json": components["schemas"]["CryptoPayoutDto"];
|
|
4072
4321
|
};
|
|
4073
4322
|
};
|
|
4074
|
-
/** @description `unsupported_network`, `invalid_address` or `invalid_data`. */
|
|
4323
|
+
/** @description `unsupported_currency`, `unsupported_network`, `invalid_address` or `invalid_data`. */
|
|
4075
4324
|
400: {
|
|
4076
4325
|
headers: {
|
|
4077
4326
|
[name: string]: unknown;
|
|
@@ -4089,7 +4338,7 @@ interface operations {
|
|
|
4089
4338
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4090
4339
|
};
|
|
4091
4340
|
};
|
|
4092
|
-
/** @description
|
|
4341
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
4093
4342
|
403: {
|
|
4094
4343
|
headers: {
|
|
4095
4344
|
[name: string]: unknown;
|
|
@@ -4193,24 +4442,31 @@ interface operations {
|
|
|
4193
4442
|
};
|
|
4194
4443
|
};
|
|
4195
4444
|
};
|
|
4196
|
-
|
|
4445
|
+
Conversions_createQuote: {
|
|
4197
4446
|
parameters: {
|
|
4198
4447
|
query?: never;
|
|
4199
|
-
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
|
+
};
|
|
4200
4452
|
path?: never;
|
|
4201
4453
|
cookie?: never;
|
|
4202
4454
|
};
|
|
4203
|
-
requestBody
|
|
4455
|
+
requestBody: {
|
|
4456
|
+
content: {
|
|
4457
|
+
"application/json": components["schemas"]["CreateConversionQuoteDto"];
|
|
4458
|
+
};
|
|
4459
|
+
};
|
|
4204
4460
|
responses: {
|
|
4205
|
-
|
|
4461
|
+
201: {
|
|
4206
4462
|
headers: {
|
|
4207
4463
|
[name: string]: unknown;
|
|
4208
4464
|
};
|
|
4209
4465
|
content: {
|
|
4210
|
-
"application/json": components["schemas"]["
|
|
4466
|
+
"application/json": components["schemas"]["ConversionQuoteDto"];
|
|
4211
4467
|
};
|
|
4212
4468
|
};
|
|
4213
|
-
/** @description
|
|
4469
|
+
/** @description `invalid_amount` — send exactly one positive amount. */
|
|
4214
4470
|
400: {
|
|
4215
4471
|
headers: {
|
|
4216
4472
|
[name: string]: unknown;
|
|
@@ -4228,7 +4484,7 @@ interface operations {
|
|
|
4228
4484
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4229
4485
|
};
|
|
4230
4486
|
};
|
|
4231
|
-
/** @description
|
|
4487
|
+
/** @description `conversions_not_enabled`. */
|
|
4232
4488
|
403: {
|
|
4233
4489
|
headers: {
|
|
4234
4490
|
[name: string]: unknown;
|
|
@@ -4237,6 +4493,24 @@ interface operations {
|
|
|
4237
4493
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4238
4494
|
};
|
|
4239
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
|
+
};
|
|
4240
4514
|
/** @description Client error. */
|
|
4241
4515
|
"4XX": {
|
|
4242
4516
|
headers: {
|
|
@@ -4257,11 +4531,12 @@ interface operations {
|
|
|
4257
4531
|
};
|
|
4258
4532
|
};
|
|
4259
4533
|
};
|
|
4260
|
-
|
|
4534
|
+
Conversions_list: {
|
|
4261
4535
|
parameters: {
|
|
4262
|
-
query
|
|
4263
|
-
|
|
4264
|
-
|
|
4536
|
+
query?: {
|
|
4537
|
+
status?: "PENDING" | "COMPLETED" | "CANCELED";
|
|
4538
|
+
cursor?: string;
|
|
4539
|
+
limit?: string;
|
|
4265
4540
|
};
|
|
4266
4541
|
header?: never;
|
|
4267
4542
|
path?: never;
|
|
@@ -4269,22 +4544,12 @@ interface operations {
|
|
|
4269
4544
|
};
|
|
4270
4545
|
requestBody?: never;
|
|
4271
4546
|
responses: {
|
|
4272
|
-
/** @description bcvRate/vesAmount are authoritative for settlement; medianRate/medianVesAmount are for display. sources includes per-source rates or errors. */
|
|
4273
4547
|
200: {
|
|
4274
4548
|
headers: {
|
|
4275
4549
|
[name: string]: unknown;
|
|
4276
4550
|
};
|
|
4277
4551
|
content: {
|
|
4278
|
-
"application/json": components["schemas"]["
|
|
4279
|
-
};
|
|
4280
|
-
};
|
|
4281
|
-
/** @description Invalid request or unsupported operation. */
|
|
4282
|
-
400: {
|
|
4283
|
-
headers: {
|
|
4284
|
-
[name: string]: unknown;
|
|
4285
|
-
};
|
|
4286
|
-
content: {
|
|
4287
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4552
|
+
"application/json": components["schemas"]["ConversionListDto"];
|
|
4288
4553
|
};
|
|
4289
4554
|
};
|
|
4290
4555
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -4325,7 +4590,7 @@ interface operations {
|
|
|
4325
4590
|
};
|
|
4326
4591
|
};
|
|
4327
4592
|
};
|
|
4328
|
-
|
|
4593
|
+
Conversions_create: {
|
|
4329
4594
|
parameters: {
|
|
4330
4595
|
query?: never;
|
|
4331
4596
|
header?: {
|
|
@@ -4337,7 +4602,7 @@ interface operations {
|
|
|
4337
4602
|
};
|
|
4338
4603
|
requestBody: {
|
|
4339
4604
|
content: {
|
|
4340
|
-
"application/json": components["schemas"]["
|
|
4605
|
+
"application/json": components["schemas"]["CreateConversionDto"];
|
|
4341
4606
|
};
|
|
4342
4607
|
};
|
|
4343
4608
|
responses: {
|
|
@@ -4346,16 +4611,7 @@ interface operations {
|
|
|
4346
4611
|
[name: string]: unknown;
|
|
4347
4612
|
};
|
|
4348
4613
|
content: {
|
|
4349
|
-
"application/json": components["schemas"]["
|
|
4350
|
-
};
|
|
4351
|
-
};
|
|
4352
|
-
/** @description Invalid request or unsupported operation. */
|
|
4353
|
-
400: {
|
|
4354
|
-
headers: {
|
|
4355
|
-
[name: string]: unknown;
|
|
4356
|
-
};
|
|
4357
|
-
content: {
|
|
4358
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4614
|
+
"application/json": components["schemas"]["ConversionDto"];
|
|
4359
4615
|
};
|
|
4360
4616
|
};
|
|
4361
4617
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -4367,7 +4623,7 @@ interface operations {
|
|
|
4367
4623
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4368
4624
|
};
|
|
4369
4625
|
};
|
|
4370
|
-
/** @description
|
|
4626
|
+
/** @description `conversions_not_enabled` or `live_mode_not_activated`. */
|
|
4371
4627
|
403: {
|
|
4372
4628
|
headers: {
|
|
4373
4629
|
[name: string]: unknown;
|
|
@@ -4376,8 +4632,8 @@ interface operations {
|
|
|
4376
4632
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4377
4633
|
};
|
|
4378
4634
|
};
|
|
4379
|
-
/** @description
|
|
4380
|
-
|
|
4635
|
+
/** @description Unknown quote. */
|
|
4636
|
+
404: {
|
|
4381
4637
|
headers: {
|
|
4382
4638
|
[name: string]: unknown;
|
|
4383
4639
|
};
|
|
@@ -4385,8 +4641,8 @@ interface operations {
|
|
|
4385
4641
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4386
4642
|
};
|
|
4387
4643
|
};
|
|
4388
|
-
/** @description
|
|
4389
|
-
|
|
4644
|
+
/** @description `quote_used`. */
|
|
4645
|
+
409: {
|
|
4390
4646
|
headers: {
|
|
4391
4647
|
[name: string]: unknown;
|
|
4392
4648
|
};
|
|
@@ -4394,35 +4650,17 @@ interface operations {
|
|
|
4394
4650
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4395
4651
|
};
|
|
4396
4652
|
};
|
|
4397
|
-
|
|
4398
|
-
|
|
4399
|
-
Payments_executeC2p: {
|
|
4400
|
-
parameters: {
|
|
4401
|
-
query?: never;
|
|
4402
|
-
header?: {
|
|
4403
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4404
|
-
"Idempotency-Key"?: string;
|
|
4405
|
-
};
|
|
4406
|
-
path?: never;
|
|
4407
|
-
cookie?: never;
|
|
4408
|
-
};
|
|
4409
|
-
requestBody: {
|
|
4410
|
-
content: {
|
|
4411
|
-
"application/json": components["schemas"]["C2pPaymentDto"];
|
|
4412
|
-
};
|
|
4413
|
-
};
|
|
4414
|
-
responses: {
|
|
4415
|
-
/** @description Payment receipt (status PENDING or COMPLETED). */
|
|
4416
|
-
201: {
|
|
4653
|
+
/** @description `quote_expired` — request a new quote. */
|
|
4654
|
+
410: {
|
|
4417
4655
|
headers: {
|
|
4418
4656
|
[name: string]: unknown;
|
|
4419
4657
|
};
|
|
4420
4658
|
content: {
|
|
4421
|
-
"application/json": components["schemas"]["
|
|
4659
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4422
4660
|
};
|
|
4423
4661
|
};
|
|
4424
|
-
/** @description
|
|
4425
|
-
|
|
4662
|
+
/** @description `insufficient_balance` or `daily_limit_exceeded`. */
|
|
4663
|
+
422: {
|
|
4426
4664
|
headers: {
|
|
4427
4665
|
[name: string]: unknown;
|
|
4428
4666
|
};
|
|
@@ -4430,8 +4668,407 @@ interface operations {
|
|
|
4430
4668
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4431
4669
|
};
|
|
4432
4670
|
};
|
|
4433
|
-
/** @description
|
|
4434
|
-
|
|
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
|
+
};
|
|
4753
|
+
};
|
|
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;
|
|
5045
|
+
};
|
|
5046
|
+
requestBody: {
|
|
5047
|
+
content: {
|
|
5048
|
+
"application/json": components["schemas"]["C2pPaymentDto"];
|
|
5049
|
+
};
|
|
5050
|
+
};
|
|
5051
|
+
responses: {
|
|
5052
|
+
/** @description Payment receipt (status PENDING or COMPLETED). */
|
|
5053
|
+
201: {
|
|
5054
|
+
headers: {
|
|
5055
|
+
[name: string]: unknown;
|
|
5056
|
+
};
|
|
5057
|
+
content: {
|
|
5058
|
+
"application/json": components["schemas"]["PaymentReceiptDto"];
|
|
5059
|
+
};
|
|
5060
|
+
};
|
|
5061
|
+
/** @description Invalid request or unsupported operation. */
|
|
5062
|
+
400: {
|
|
5063
|
+
headers: {
|
|
5064
|
+
[name: string]: unknown;
|
|
5065
|
+
};
|
|
5066
|
+
content: {
|
|
5067
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5068
|
+
};
|
|
5069
|
+
};
|
|
5070
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
5071
|
+
401: {
|
|
4435
5072
|
headers: {
|
|
4436
5073
|
[name: string]: unknown;
|
|
4437
5074
|
};
|
|
@@ -7252,6 +7889,7 @@ declare class Balance extends APIResource {
|
|
|
7252
7889
|
collectedVes: string;
|
|
7253
7890
|
feesVes: string;
|
|
7254
7891
|
paidOutVes: string;
|
|
7892
|
+
convertedVes: string;
|
|
7255
7893
|
reserveVes: string;
|
|
7256
7894
|
ledgerNetVes: string;
|
|
7257
7895
|
availableVes: string;
|
|
@@ -7443,7 +8081,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
7443
8081
|
id: string;
|
|
7444
8082
|
tenantId: string;
|
|
7445
8083
|
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")[];
|
|
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")[];
|
|
7447
8085
|
isActive: boolean;
|
|
7448
8086
|
createdAt: string;
|
|
7449
8087
|
secret?: string;
|
|
@@ -7452,7 +8090,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
7452
8090
|
id: string;
|
|
7453
8091
|
tenantId: string;
|
|
7454
8092
|
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")[];
|
|
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")[];
|
|
7456
8094
|
isActive: boolean;
|
|
7457
8095
|
createdAt: string;
|
|
7458
8096
|
secret?: string;
|
|
@@ -7461,7 +8099,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
7461
8099
|
id: string;
|
|
7462
8100
|
tenantId: string;
|
|
7463
8101
|
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")[];
|
|
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")[];
|
|
7465
8103
|
isActive: boolean;
|
|
7466
8104
|
createdAt: string;
|
|
7467
8105
|
secret?: string;
|
|
@@ -7493,7 +8131,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
7493
8131
|
[key: string]: string;
|
|
7494
8132
|
};
|
|
7495
8133
|
allowedOrigins: string[];
|
|
7496
|
-
methods: ("c2p" | "vpos" | "usdt")[];
|
|
8134
|
+
methods: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
7497
8135
|
successUrl?: string | null;
|
|
7498
8136
|
cancelUrl?: string | null;
|
|
7499
8137
|
paymentId?: string | null;
|
|
@@ -7514,7 +8152,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
7514
8152
|
[key: string]: string;
|
|
7515
8153
|
};
|
|
7516
8154
|
allowedOrigins: string[];
|
|
7517
|
-
methods: ("c2p" | "vpos" | "usdt")[];
|
|
8155
|
+
methods: ("c2p" | "vpos" | "usdt" | "usdc")[];
|
|
7518
8156
|
successUrl?: string | null;
|
|
7519
8157
|
cancelUrl?: string | null;
|
|
7520
8158
|
paymentId?: string | null;
|
|
@@ -7619,53 +8257,160 @@ declare class PaymentLinks extends APIResource {
|
|
|
7619
8257
|
delete(id: string, options?: RequestOptions): Promise<void>;
|
|
7620
8258
|
}
|
|
7621
8259
|
|
|
7622
|
-
/**
|
|
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. */
|
|
7623
8355
|
declare class CryptoBalance extends APIResource {
|
|
7624
|
-
retrieve(options?: RequestOptions): Promise<{
|
|
7625
|
-
currency:
|
|
7626
|
-
|
|
7627
|
-
|
|
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;
|
|
7628
8362
|
asOf: string;
|
|
7629
8363
|
}>;
|
|
7630
8364
|
}
|
|
7631
|
-
/**
|
|
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. */
|
|
7632
8372
|
declare class DepositAddresses extends APIResource {
|
|
7633
8373
|
/** Get or create — calling again for the same customer and network returns the same address. */
|
|
7634
8374
|
create(params: RequestBody<'Crypto_createDepositAddress'>, options?: RequestOptions): Promise<{
|
|
7635
8375
|
customerRef: string;
|
|
7636
8376
|
network: string;
|
|
7637
|
-
currency:
|
|
8377
|
+
currency: "USDT" | "USDC";
|
|
7638
8378
|
address: string;
|
|
7639
8379
|
tag?: string;
|
|
7640
8380
|
tagRequired: boolean;
|
|
7641
8381
|
createdAt: string;
|
|
7642
8382
|
}>;
|
|
7643
8383
|
}
|
|
7644
|
-
/** Enabled
|
|
8384
|
+
/** Enabled networks for one stablecoin (`currency`) with the payout fee and availability for an amount. */
|
|
7645
8385
|
declare class CryptoNetworks extends APIResource {
|
|
7646
8386
|
list(params?: QueryParams<'Crypto_listNetworks'>, options?: RequestOptions): Promise<{
|
|
8387
|
+
currency: "USDT" | "USDC";
|
|
7647
8388
|
network: string;
|
|
7648
8389
|
displayName: string;
|
|
7649
8390
|
receiveEnabled: boolean;
|
|
7650
8391
|
payoutEnabled: boolean;
|
|
7651
|
-
|
|
7652
|
-
|
|
8392
|
+
payoutFee: string;
|
|
8393
|
+
minPayout: string;
|
|
8394
|
+
payoutFeeUsdt?: string;
|
|
8395
|
+
minPayoutUsdt?: string;
|
|
7653
8396
|
tagRequired: boolean;
|
|
7654
8397
|
available: boolean;
|
|
7655
8398
|
}[]>;
|
|
7656
8399
|
}
|
|
7657
|
-
/**
|
|
8400
|
+
/** Stablecoin payouts to external addresses (`currency`: USDT or USDC). `idempotencyKey` (in the body) makes retries safe. */
|
|
7658
8401
|
declare class CryptoPayouts extends APIResource {
|
|
7659
8402
|
create(params: RequestBody<'Crypto_createPayout'>, options?: RequestOptions): Promise<{
|
|
7660
8403
|
id: string;
|
|
7661
8404
|
object: string;
|
|
7662
|
-
currency:
|
|
8405
|
+
currency: "USDT" | "USDC";
|
|
7663
8406
|
status: "pending" | "processing" | "completed" | "failed";
|
|
7664
8407
|
network: string;
|
|
7665
8408
|
address: string;
|
|
7666
8409
|
tag?: string;
|
|
7667
|
-
|
|
7668
|
-
|
|
8410
|
+
amount: string;
|
|
8411
|
+
fee: string;
|
|
8412
|
+
amountUsdt?: string;
|
|
8413
|
+
feeUsdt?: string;
|
|
7669
8414
|
customerRef?: string;
|
|
7670
8415
|
merchantId?: string;
|
|
7671
8416
|
idempotencyKey: string;
|
|
@@ -7678,13 +8423,15 @@ declare class CryptoPayouts extends APIResource {
|
|
|
7678
8423
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
7679
8424
|
id: string;
|
|
7680
8425
|
object: string;
|
|
7681
|
-
currency:
|
|
8426
|
+
currency: "USDT" | "USDC";
|
|
7682
8427
|
status: "pending" | "processing" | "completed" | "failed";
|
|
7683
8428
|
network: string;
|
|
7684
8429
|
address: string;
|
|
7685
8430
|
tag?: string;
|
|
7686
|
-
|
|
7687
|
-
|
|
8431
|
+
amount: string;
|
|
8432
|
+
fee: string;
|
|
8433
|
+
amountUsdt?: string;
|
|
8434
|
+
feeUsdt?: string;
|
|
7688
8435
|
customerRef?: string;
|
|
7689
8436
|
merchantId?: string;
|
|
7690
8437
|
idempotencyKey: string;
|
|
@@ -7695,9 +8442,10 @@ declare class CryptoPayouts extends APIResource {
|
|
|
7695
8442
|
completedAt?: string;
|
|
7696
8443
|
}>;
|
|
7697
8444
|
}
|
|
7698
|
-
/** USDT: deposit addresses,
|
|
8445
|
+
/** Stablecoins (USDT, USDC): deposit addresses, balances, networks and payouts. */
|
|
7699
8446
|
declare class Crypto extends APIResource {
|
|
7700
8447
|
readonly balance: CryptoBalance;
|
|
8448
|
+
readonly balances: CryptoBalances;
|
|
7701
8449
|
readonly depositAddresses: DepositAddresses;
|
|
7702
8450
|
readonly networks: CryptoNetworks;
|
|
7703
8451
|
readonly payouts: CryptoPayouts;
|
|
@@ -8247,7 +8995,7 @@ declare class Payments extends APIResource {
|
|
|
8247
8995
|
}>;
|
|
8248
8996
|
}
|
|
8249
8997
|
|
|
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"];
|
|
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"];
|
|
8251
8999
|
type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];
|
|
8252
9000
|
/** `data` of every `payment.*` event. */
|
|
8253
9001
|
interface PaymentWebhookData {
|
|
@@ -8341,6 +9089,8 @@ declare class VexPay {
|
|
|
8341
9089
|
readonly payouts: Payouts;
|
|
8342
9090
|
/** USDT: deposit addresses, balance, networks and payouts. */
|
|
8343
9091
|
readonly crypto: Crypto;
|
|
9092
|
+
/** Convert available VES to USDT (enabled per account). */
|
|
9093
|
+
readonly conversions: Conversions;
|
|
8344
9094
|
readonly products: Products;
|
|
8345
9095
|
readonly paymentLinks: PaymentLinks;
|
|
8346
9096
|
readonly tenantPayoutAccount: TenantPayoutAccount;
|
|
@@ -8398,6 +9148,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
8398
9148
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
8399
9149
|
}
|
|
8400
9150
|
|
|
8401
|
-
declare const VERSION = "0.
|
|
9151
|
+
declare const VERSION = "0.3.0";
|
|
8402
9152
|
|
|
8403
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 };
|