@vexpay/node 0.1.1 → 0.2.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 +39 -1
- package/dist/index.cjs +43 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1175 -59
- package/dist/index.d.ts +1175 -59
- package/dist/index.js +43 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -45,7 +45,7 @@ interface components {
|
|
|
45
45
|
*/
|
|
46
46
|
message?: string | string[];
|
|
47
47
|
/**
|
|
48
|
-
* @description Machine-readable error code (e.g. `external_ref_conflict`, `insufficient_balance`, `idempotency_key_reused`) or, for Nest default errors, a short label such as `Bad Request`. Domain errors may include extra route-specific fields.
|
|
48
|
+
* @description Machine-readable error code (e.g. `external_ref_conflict`, `insufficient_balance`, `idempotency_key_reused`, `live_mode_not_activated`) or, for Nest default errors, a short label such as `Bad Request`. Domain errors may include extra route-specific fields.
|
|
49
49
|
* @example insufficient_balance
|
|
50
50
|
*/
|
|
51
51
|
error?: string;
|
|
@@ -103,7 +103,7 @@ interface components {
|
|
|
103
103
|
* "payment.failed"
|
|
104
104
|
* ]
|
|
105
105
|
*/
|
|
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" | "notification.test")[];
|
|
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")[];
|
|
107
107
|
};
|
|
108
108
|
WebhookEndpointDto: {
|
|
109
109
|
/** Format: uuid */
|
|
@@ -112,7 +112,7 @@ interface components {
|
|
|
112
112
|
tenantId: string;
|
|
113
113
|
/** Format: uri */
|
|
114
114
|
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" | "notification.test")[];
|
|
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")[];
|
|
116
116
|
isActive: boolean;
|
|
117
117
|
/** Format: date-time */
|
|
118
118
|
createdAt: string;
|
|
@@ -133,7 +133,7 @@ interface components {
|
|
|
133
133
|
* "payout.completed"
|
|
134
134
|
* ]
|
|
135
135
|
*/
|
|
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" | "notification.test")[];
|
|
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")[];
|
|
137
137
|
/** @example true */
|
|
138
138
|
isActive?: boolean;
|
|
139
139
|
};
|
|
@@ -892,6 +892,121 @@ interface components {
|
|
|
892
892
|
*/
|
|
893
893
|
ip?: string;
|
|
894
894
|
};
|
|
895
|
+
CryptoBalanceDto: {
|
|
896
|
+
/** @example USDT */
|
|
897
|
+
currency: string;
|
|
898
|
+
/**
|
|
899
|
+
* @description USDT available for payouts (ledger).
|
|
900
|
+
* @example 97.00
|
|
901
|
+
*/
|
|
902
|
+
availableUsdt: string;
|
|
903
|
+
/**
|
|
904
|
+
* @description USDT reserved by payouts that have not completed yet.
|
|
905
|
+
* @example 50.10
|
|
906
|
+
*/
|
|
907
|
+
pendingPayoutUsdt: string;
|
|
908
|
+
/** Format: date-time */
|
|
909
|
+
asOf: string;
|
|
910
|
+
};
|
|
911
|
+
CreateDepositAddressDto: {
|
|
912
|
+
/**
|
|
913
|
+
* @description Your identifier for the customer this address belongs to (1–128 chars: A–Z a–z 0–9 _ . : @ -).
|
|
914
|
+
* @example user_123
|
|
915
|
+
*/
|
|
916
|
+
customerRef: string;
|
|
917
|
+
/**
|
|
918
|
+
* @example BEP20
|
|
919
|
+
* @enum {string}
|
|
920
|
+
*/
|
|
921
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1";
|
|
922
|
+
};
|
|
923
|
+
DepositAddressDto: {
|
|
924
|
+
/** @example user_123 */
|
|
925
|
+
customerRef: string;
|
|
926
|
+
/** @example BEP20 */
|
|
927
|
+
network: string;
|
|
928
|
+
/** @example USDT */
|
|
929
|
+
currency: string;
|
|
930
|
+
/** @example 0x9f3c… */
|
|
931
|
+
address: string;
|
|
932
|
+
/** @description Destination tag / memo the payer must include (TON). */
|
|
933
|
+
tag?: string;
|
|
934
|
+
/** @description True when the network requires the tag. */
|
|
935
|
+
tagRequired: boolean;
|
|
936
|
+
/** Format: date-time */
|
|
937
|
+
createdAt: string;
|
|
938
|
+
};
|
|
939
|
+
CryptoNetworkDto: {
|
|
940
|
+
/** @example POLYGON */
|
|
941
|
+
network: string;
|
|
942
|
+
/** @example Polygon */
|
|
943
|
+
displayName: string;
|
|
944
|
+
receiveEnabled: boolean;
|
|
945
|
+
payoutEnabled: boolean;
|
|
946
|
+
/** @example 0.10 */
|
|
947
|
+
payoutFeeUsdt: string;
|
|
948
|
+
/** @example 1.00 */
|
|
949
|
+
minPayoutUsdt: string;
|
|
950
|
+
tagRequired: boolean;
|
|
951
|
+
/** @description Whether a payout of the requested amount can be sent on this network now. */
|
|
952
|
+
available: boolean;
|
|
953
|
+
};
|
|
954
|
+
CreateCryptoPayoutDto: {
|
|
955
|
+
/**
|
|
956
|
+
* @example POLYGON
|
|
957
|
+
* @enum {string}
|
|
958
|
+
*/
|
|
959
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1";
|
|
960
|
+
/** @example 0x9f3c4e1b2a7d6c5e4f3a2b1c0d9e8f7a6b5c4d3e */
|
|
961
|
+
address: string;
|
|
962
|
+
/** @description Destination tag / memo (required on TON). */
|
|
963
|
+
tag?: string;
|
|
964
|
+
/**
|
|
965
|
+
* @description Amount the destination receives, in USDT (max 2 decimals).
|
|
966
|
+
* @example 50.00
|
|
967
|
+
*/
|
|
968
|
+
amountUsdt: string;
|
|
969
|
+
/**
|
|
970
|
+
* @description Your customer reference, echoed on webhooks.
|
|
971
|
+
* @example user_123
|
|
972
|
+
*/
|
|
973
|
+
customerRef?: string;
|
|
974
|
+
/**
|
|
975
|
+
* @description Unique per payout. Replays return the same payout (200).
|
|
976
|
+
* @example withdrawal_8812
|
|
977
|
+
*/
|
|
978
|
+
idempotencyKey: string;
|
|
979
|
+
};
|
|
980
|
+
CryptoPayoutDto: {
|
|
981
|
+
id: string;
|
|
982
|
+
/** @example crypto.payout */
|
|
983
|
+
object: string;
|
|
984
|
+
/** @example USDT */
|
|
985
|
+
currency: string;
|
|
986
|
+
/** @enum {string} */
|
|
987
|
+
status: "pending" | "processing" | "completed" | "failed";
|
|
988
|
+
network: string;
|
|
989
|
+
address: string;
|
|
990
|
+
tag?: string;
|
|
991
|
+
/** @example 50.00 */
|
|
992
|
+
amountUsdt: string;
|
|
993
|
+
/**
|
|
994
|
+
* @description Network fee + margin (0 for internal).
|
|
995
|
+
* @example 0.10
|
|
996
|
+
*/
|
|
997
|
+
feeUsdt: string;
|
|
998
|
+
customerRef?: string;
|
|
999
|
+
merchantId?: string;
|
|
1000
|
+
idempotencyKey: string;
|
|
1001
|
+
txHash?: string;
|
|
1002
|
+
/** @description Settled inside VEXPay (destination is one of your own deposit addresses). */
|
|
1003
|
+
internal: boolean;
|
|
1004
|
+
failureReason?: string;
|
|
1005
|
+
/** Format: date-time */
|
|
1006
|
+
createdAt: string;
|
|
1007
|
+
/** Format: date-time */
|
|
1008
|
+
completedAt?: string;
|
|
1009
|
+
};
|
|
895
1010
|
BankResponseDto: {
|
|
896
1011
|
/**
|
|
897
1012
|
* @description Canonical four-digit SIMF bank code.
|
|
@@ -933,7 +1048,7 @@ interface components {
|
|
|
933
1048
|
/** Format: date-time */
|
|
934
1049
|
fetchedAt: string;
|
|
935
1050
|
/**
|
|
936
|
-
* @description Per-source BCV rates or error objects (e.g. `{ error: "BANK_NOT_CONFIGURED" }`). Keys typically include `vexFx` and `bank`. `sources.bank`
|
|
1051
|
+
* @description Per-source BCV rates or error objects (e.g. `{ error: "BANK_NOT_CONFIGURED" }`). Keys typically include `vexFx` and `bank`. `sources.bank` is the partner-bank BCV rate when available.
|
|
937
1052
|
* @example {
|
|
938
1053
|
* "vexFx": {
|
|
939
1054
|
* "rate": 36.5,
|
|
@@ -1057,7 +1172,7 @@ interface components {
|
|
|
1057
1172
|
* @description Use this value as intentId when executing the C2P charge.
|
|
1058
1173
|
*/
|
|
1059
1174
|
intentId: string;
|
|
1060
|
-
/** @description true when the provider instructed the payer bank to SMS an OTP to the customer
|
|
1175
|
+
/** @description true when the provider instructed the payer bank to SMS an OTP to the customer. false when the customer must generate the token in their bank app. */
|
|
1061
1176
|
otpRequested: boolean;
|
|
1062
1177
|
};
|
|
1063
1178
|
C2pPaymentDto: {
|
|
@@ -1285,18 +1400,18 @@ interface components {
|
|
|
1285
1400
|
*/
|
|
1286
1401
|
externalRef?: string;
|
|
1287
1402
|
/**
|
|
1288
|
-
* @description Payer bank SIMF code. Required
|
|
1403
|
+
* @description Payer bank SIMF code. Required for some receiving banks — send it whenever you have it.
|
|
1289
1404
|
* @example 0102
|
|
1290
1405
|
*/
|
|
1291
1406
|
debtorBankCode?: string;
|
|
1292
1407
|
/**
|
|
1293
|
-
* @description Instrument type
|
|
1408
|
+
* @description Instrument type, required by some receiving banks. Defaults to transferencia.
|
|
1294
1409
|
* @example transferencia
|
|
1295
1410
|
* @enum {string}
|
|
1296
1411
|
*/
|
|
1297
1412
|
txType?: "pago_movil" | "transferencia" | "debito_inmediato";
|
|
1298
1413
|
/**
|
|
1299
|
-
* @description Payer Pago Móvil phone
|
|
1414
|
+
* @description Payer Pago Móvil phone (11-digit local, e.g. 04149333844). Required by some receiving banks when txType is pago_movil — send it whenever you have it.
|
|
1300
1415
|
* @example 04149333844
|
|
1301
1416
|
*/
|
|
1302
1417
|
debtorCellPhone?: string;
|
|
@@ -1551,7 +1666,7 @@ interface components {
|
|
|
1551
1666
|
*/
|
|
1552
1667
|
allowedOrigins?: string[];
|
|
1553
1668
|
/** @description Payment methods offered. Defaults to every method your account can accept. */
|
|
1554
|
-
methods?: ("c2p" | "vpos")[];
|
|
1669
|
+
methods?: ("c2p" | "vpos" | "usdt")[];
|
|
1555
1670
|
/**
|
|
1556
1671
|
* @description Up to 20 string key/value pairs (keys ≤ 40 chars, values ≤ 500 chars).
|
|
1557
1672
|
* @example {
|
|
@@ -1587,7 +1702,7 @@ interface components {
|
|
|
1587
1702
|
[key: string]: string;
|
|
1588
1703
|
};
|
|
1589
1704
|
allowedOrigins: string[];
|
|
1590
|
-
methods: ("c2p" | "vpos")[];
|
|
1705
|
+
methods: ("c2p" | "vpos" | "usdt")[];
|
|
1591
1706
|
successUrl?: string | null;
|
|
1592
1707
|
cancelUrl?: string | null;
|
|
1593
1708
|
/** @description Latest payment for this session, once one exists. */
|
|
@@ -1728,6 +1843,15 @@ interface operations {
|
|
|
1728
1843
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1729
1844
|
};
|
|
1730
1845
|
};
|
|
1846
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
1847
|
+
403: {
|
|
1848
|
+
headers: {
|
|
1849
|
+
[name: string]: unknown;
|
|
1850
|
+
};
|
|
1851
|
+
content: {
|
|
1852
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1853
|
+
};
|
|
1854
|
+
};
|
|
1731
1855
|
/** @description Client error. */
|
|
1732
1856
|
"4XX": {
|
|
1733
1857
|
headers: {
|
|
@@ -1774,6 +1898,15 @@ interface operations {
|
|
|
1774
1898
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1775
1899
|
};
|
|
1776
1900
|
};
|
|
1901
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
1902
|
+
403: {
|
|
1903
|
+
headers: {
|
|
1904
|
+
[name: string]: unknown;
|
|
1905
|
+
};
|
|
1906
|
+
content: {
|
|
1907
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1908
|
+
};
|
|
1909
|
+
};
|
|
1777
1910
|
/** @description Client error. */
|
|
1778
1911
|
"4XX": {
|
|
1779
1912
|
headers: {
|
|
@@ -1827,6 +1960,15 @@ interface operations {
|
|
|
1827
1960
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1828
1961
|
};
|
|
1829
1962
|
};
|
|
1963
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
1964
|
+
403: {
|
|
1965
|
+
headers: {
|
|
1966
|
+
[name: string]: unknown;
|
|
1967
|
+
};
|
|
1968
|
+
content: {
|
|
1969
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1970
|
+
};
|
|
1971
|
+
};
|
|
1830
1972
|
/** @description Client error. */
|
|
1831
1973
|
"4XX": {
|
|
1832
1974
|
headers: {
|
|
@@ -1875,6 +2017,15 @@ interface operations {
|
|
|
1875
2017
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1876
2018
|
};
|
|
1877
2019
|
};
|
|
2020
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2021
|
+
403: {
|
|
2022
|
+
headers: {
|
|
2023
|
+
[name: string]: unknown;
|
|
2024
|
+
};
|
|
2025
|
+
content: {
|
|
2026
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2027
|
+
};
|
|
2028
|
+
};
|
|
1878
2029
|
404: {
|
|
1879
2030
|
headers: {
|
|
1880
2031
|
[name: string]: unknown;
|
|
@@ -1943,6 +2094,15 @@ interface operations {
|
|
|
1943
2094
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1944
2095
|
};
|
|
1945
2096
|
};
|
|
2097
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2098
|
+
403: {
|
|
2099
|
+
headers: {
|
|
2100
|
+
[name: string]: unknown;
|
|
2101
|
+
};
|
|
2102
|
+
content: {
|
|
2103
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2104
|
+
};
|
|
2105
|
+
};
|
|
1946
2106
|
404: {
|
|
1947
2107
|
headers: {
|
|
1948
2108
|
[name: string]: unknown;
|
|
@@ -2013,6 +2173,15 @@ interface operations {
|
|
|
2013
2173
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2014
2174
|
};
|
|
2015
2175
|
};
|
|
2176
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2177
|
+
403: {
|
|
2178
|
+
headers: {
|
|
2179
|
+
[name: string]: unknown;
|
|
2180
|
+
};
|
|
2181
|
+
content: {
|
|
2182
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2183
|
+
};
|
|
2184
|
+
};
|
|
2016
2185
|
/** @description Client error. */
|
|
2017
2186
|
"4XX": {
|
|
2018
2187
|
headers: {
|
|
@@ -2085,6 +2254,15 @@ interface operations {
|
|
|
2085
2254
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2086
2255
|
};
|
|
2087
2256
|
};
|
|
2257
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2258
|
+
403: {
|
|
2259
|
+
headers: {
|
|
2260
|
+
[name: string]: unknown;
|
|
2261
|
+
};
|
|
2262
|
+
content: {
|
|
2263
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2264
|
+
};
|
|
2265
|
+
};
|
|
2088
2266
|
/** @description external_ref_conflict, merchant_inactive, or related business conflict. */
|
|
2089
2267
|
409: {
|
|
2090
2268
|
headers: {
|
|
@@ -2166,6 +2344,15 @@ interface operations {
|
|
|
2166
2344
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2167
2345
|
};
|
|
2168
2346
|
};
|
|
2347
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2348
|
+
403: {
|
|
2349
|
+
headers: {
|
|
2350
|
+
[name: string]: unknown;
|
|
2351
|
+
};
|
|
2352
|
+
content: {
|
|
2353
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2354
|
+
};
|
|
2355
|
+
};
|
|
2169
2356
|
/** @description external_ref_conflict when the same key is reused with a different payload. */
|
|
2170
2357
|
409: {
|
|
2171
2358
|
headers: {
|
|
@@ -2247,6 +2434,15 @@ interface operations {
|
|
|
2247
2434
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2248
2435
|
};
|
|
2249
2436
|
};
|
|
2437
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2438
|
+
403: {
|
|
2439
|
+
headers: {
|
|
2440
|
+
[name: string]: unknown;
|
|
2441
|
+
};
|
|
2442
|
+
content: {
|
|
2443
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2444
|
+
};
|
|
2445
|
+
};
|
|
2250
2446
|
/** @description Batch external_ref_conflict when the same batch key is reused with a different payload. */
|
|
2251
2447
|
409: {
|
|
2252
2448
|
headers: {
|
|
@@ -2313,6 +2509,15 @@ interface operations {
|
|
|
2313
2509
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2314
2510
|
};
|
|
2315
2511
|
};
|
|
2512
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2513
|
+
403: {
|
|
2514
|
+
headers: {
|
|
2515
|
+
[name: string]: unknown;
|
|
2516
|
+
};
|
|
2517
|
+
content: {
|
|
2518
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2519
|
+
};
|
|
2520
|
+
};
|
|
2316
2521
|
/** @description No payout with that externalRef for this tenant. */
|
|
2317
2522
|
404: {
|
|
2318
2523
|
headers: {
|
|
@@ -2379,6 +2584,15 @@ interface operations {
|
|
|
2379
2584
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2380
2585
|
};
|
|
2381
2586
|
};
|
|
2587
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2588
|
+
403: {
|
|
2589
|
+
headers: {
|
|
2590
|
+
[name: string]: unknown;
|
|
2591
|
+
};
|
|
2592
|
+
content: {
|
|
2593
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2594
|
+
};
|
|
2595
|
+
};
|
|
2382
2596
|
404: {
|
|
2383
2597
|
headers: {
|
|
2384
2598
|
[name: string]: unknown;
|
|
@@ -2443,6 +2657,15 @@ interface operations {
|
|
|
2443
2657
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2444
2658
|
};
|
|
2445
2659
|
};
|
|
2660
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2661
|
+
403: {
|
|
2662
|
+
headers: {
|
|
2663
|
+
[name: string]: unknown;
|
|
2664
|
+
};
|
|
2665
|
+
content: {
|
|
2666
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2667
|
+
};
|
|
2668
|
+
};
|
|
2446
2669
|
/** @description Client error. */
|
|
2447
2670
|
"4XX": {
|
|
2448
2671
|
headers: {
|
|
@@ -2502,6 +2725,15 @@ interface operations {
|
|
|
2502
2725
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2503
2726
|
};
|
|
2504
2727
|
};
|
|
2728
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2729
|
+
403: {
|
|
2730
|
+
headers: {
|
|
2731
|
+
[name: string]: unknown;
|
|
2732
|
+
};
|
|
2733
|
+
content: {
|
|
2734
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2735
|
+
};
|
|
2736
|
+
};
|
|
2505
2737
|
/** @description Client error. */
|
|
2506
2738
|
"4XX": {
|
|
2507
2739
|
headers: {
|
|
@@ -2564,6 +2796,15 @@ interface operations {
|
|
|
2564
2796
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2565
2797
|
};
|
|
2566
2798
|
};
|
|
2799
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2800
|
+
403: {
|
|
2801
|
+
headers: {
|
|
2802
|
+
[name: string]: unknown;
|
|
2803
|
+
};
|
|
2804
|
+
content: {
|
|
2805
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2806
|
+
};
|
|
2807
|
+
};
|
|
2567
2808
|
/** @description Client error. */
|
|
2568
2809
|
"4XX": {
|
|
2569
2810
|
headers: {
|
|
@@ -2622,6 +2863,15 @@ interface operations {
|
|
|
2622
2863
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2623
2864
|
};
|
|
2624
2865
|
};
|
|
2866
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2867
|
+
403: {
|
|
2868
|
+
headers: {
|
|
2869
|
+
[name: string]: unknown;
|
|
2870
|
+
};
|
|
2871
|
+
content: {
|
|
2872
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2873
|
+
};
|
|
2874
|
+
};
|
|
2625
2875
|
/** @description already_verified or locked. */
|
|
2626
2876
|
409: {
|
|
2627
2877
|
headers: {
|
|
@@ -2702,6 +2952,15 @@ interface operations {
|
|
|
2702
2952
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2703
2953
|
};
|
|
2704
2954
|
};
|
|
2955
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2956
|
+
403: {
|
|
2957
|
+
headers: {
|
|
2958
|
+
[name: string]: unknown;
|
|
2959
|
+
};
|
|
2960
|
+
content: {
|
|
2961
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2962
|
+
};
|
|
2963
|
+
};
|
|
2705
2964
|
/** @description amounts_mismatch. */
|
|
2706
2965
|
409: {
|
|
2707
2966
|
headers: {
|
|
@@ -2792,6 +3051,15 @@ interface operations {
|
|
|
2792
3051
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2793
3052
|
};
|
|
2794
3053
|
};
|
|
3054
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3055
|
+
403: {
|
|
3056
|
+
headers: {
|
|
3057
|
+
[name: string]: unknown;
|
|
3058
|
+
};
|
|
3059
|
+
content: {
|
|
3060
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3061
|
+
};
|
|
3062
|
+
};
|
|
2795
3063
|
/** @description The banking network rejected the operation. */
|
|
2796
3064
|
422: {
|
|
2797
3065
|
headers: {
|
|
@@ -2801,7 +3069,7 @@ interface operations {
|
|
|
2801
3069
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2802
3070
|
};
|
|
2803
3071
|
};
|
|
2804
|
-
/** @description Advanced payments
|
|
3072
|
+
/** @description Advanced payments are not available in this environment. */
|
|
2805
3073
|
503: {
|
|
2806
3074
|
headers: {
|
|
2807
3075
|
[name: string]: unknown;
|
|
@@ -2873,6 +3141,15 @@ interface operations {
|
|
|
2873
3141
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2874
3142
|
};
|
|
2875
3143
|
};
|
|
3144
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3145
|
+
403: {
|
|
3146
|
+
headers: {
|
|
3147
|
+
[name: string]: unknown;
|
|
3148
|
+
};
|
|
3149
|
+
content: {
|
|
3150
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3151
|
+
};
|
|
3152
|
+
};
|
|
2876
3153
|
/** @description The banking network rejected the operation. */
|
|
2877
3154
|
422: {
|
|
2878
3155
|
headers: {
|
|
@@ -2882,7 +3159,7 @@ interface operations {
|
|
|
2882
3159
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2883
3160
|
};
|
|
2884
3161
|
};
|
|
2885
|
-
/** @description Advanced payments
|
|
3162
|
+
/** @description Advanced payments are not available in this environment. */
|
|
2886
3163
|
503: {
|
|
2887
3164
|
headers: {
|
|
2888
3165
|
[name: string]: unknown;
|
|
@@ -2950,6 +3227,15 @@ interface operations {
|
|
|
2950
3227
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2951
3228
|
};
|
|
2952
3229
|
};
|
|
3230
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3231
|
+
403: {
|
|
3232
|
+
headers: {
|
|
3233
|
+
[name: string]: unknown;
|
|
3234
|
+
};
|
|
3235
|
+
content: {
|
|
3236
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3237
|
+
};
|
|
3238
|
+
};
|
|
2953
3239
|
/** @description The banking network rejected the operation. */
|
|
2954
3240
|
422: {
|
|
2955
3241
|
headers: {
|
|
@@ -2959,7 +3245,7 @@ interface operations {
|
|
|
2959
3245
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2960
3246
|
};
|
|
2961
3247
|
};
|
|
2962
|
-
/** @description Advanced payments
|
|
3248
|
+
/** @description Advanced payments are not available in this environment. */
|
|
2963
3249
|
503: {
|
|
2964
3250
|
headers: {
|
|
2965
3251
|
[name: string]: unknown;
|
|
@@ -3030,6 +3316,15 @@ interface operations {
|
|
|
3030
3316
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3031
3317
|
};
|
|
3032
3318
|
};
|
|
3319
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3320
|
+
403: {
|
|
3321
|
+
headers: {
|
|
3322
|
+
[name: string]: unknown;
|
|
3323
|
+
};
|
|
3324
|
+
content: {
|
|
3325
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3326
|
+
};
|
|
3327
|
+
};
|
|
3033
3328
|
/** @description Entity not found for this tenant, or missing operation id. */
|
|
3034
3329
|
404: {
|
|
3035
3330
|
headers: {
|
|
@@ -3048,7 +3343,7 @@ interface operations {
|
|
|
3048
3343
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3049
3344
|
};
|
|
3050
3345
|
};
|
|
3051
|
-
/** @description Advanced payments
|
|
3346
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3052
3347
|
503: {
|
|
3053
3348
|
headers: {
|
|
3054
3349
|
[name: string]: unknown;
|
|
@@ -3119,6 +3414,15 @@ interface operations {
|
|
|
3119
3414
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3120
3415
|
};
|
|
3121
3416
|
};
|
|
3417
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3418
|
+
403: {
|
|
3419
|
+
headers: {
|
|
3420
|
+
[name: string]: unknown;
|
|
3421
|
+
};
|
|
3422
|
+
content: {
|
|
3423
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3424
|
+
};
|
|
3425
|
+
};
|
|
3122
3426
|
/** @description The banking network rejected the operation. */
|
|
3123
3427
|
422: {
|
|
3124
3428
|
headers: {
|
|
@@ -3128,7 +3432,7 @@ interface operations {
|
|
|
3128
3432
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3129
3433
|
};
|
|
3130
3434
|
};
|
|
3131
|
-
/** @description Advanced payments
|
|
3435
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3132
3436
|
503: {
|
|
3133
3437
|
headers: {
|
|
3134
3438
|
[name: string]: unknown;
|
|
@@ -3199,6 +3503,15 @@ interface operations {
|
|
|
3199
3503
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3200
3504
|
};
|
|
3201
3505
|
};
|
|
3506
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3507
|
+
403: {
|
|
3508
|
+
headers: {
|
|
3509
|
+
[name: string]: unknown;
|
|
3510
|
+
};
|
|
3511
|
+
content: {
|
|
3512
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3513
|
+
};
|
|
3514
|
+
};
|
|
3202
3515
|
/** @description The banking network rejected the operation. */
|
|
3203
3516
|
422: {
|
|
3204
3517
|
headers: {
|
|
@@ -3208,7 +3521,7 @@ interface operations {
|
|
|
3208
3521
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3209
3522
|
};
|
|
3210
3523
|
};
|
|
3211
|
-
/** @description Advanced payments
|
|
3524
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3212
3525
|
503: {
|
|
3213
3526
|
headers: {
|
|
3214
3527
|
[name: string]: unknown;
|
|
@@ -3279,6 +3592,15 @@ interface operations {
|
|
|
3279
3592
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3280
3593
|
};
|
|
3281
3594
|
};
|
|
3595
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3596
|
+
403: {
|
|
3597
|
+
headers: {
|
|
3598
|
+
[name: string]: unknown;
|
|
3599
|
+
};
|
|
3600
|
+
content: {
|
|
3601
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3602
|
+
};
|
|
3603
|
+
};
|
|
3282
3604
|
/** @description No completed PAGO_MOVIL payment found for the given referencia. */
|
|
3283
3605
|
404: {
|
|
3284
3606
|
headers: {
|
|
@@ -3306,7 +3628,7 @@ interface operations {
|
|
|
3306
3628
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3307
3629
|
};
|
|
3308
3630
|
};
|
|
3309
|
-
/** @description Advanced payments
|
|
3631
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3310
3632
|
503: {
|
|
3311
3633
|
headers: {
|
|
3312
3634
|
[name: string]: unknown;
|
|
@@ -3377,6 +3699,15 @@ interface operations {
|
|
|
3377
3699
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3378
3700
|
};
|
|
3379
3701
|
};
|
|
3702
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3703
|
+
403: {
|
|
3704
|
+
headers: {
|
|
3705
|
+
[name: string]: unknown;
|
|
3706
|
+
};
|
|
3707
|
+
content: {
|
|
3708
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3709
|
+
};
|
|
3710
|
+
};
|
|
3380
3711
|
/** @description The banking network rejected the operation. */
|
|
3381
3712
|
422: {
|
|
3382
3713
|
headers: {
|
|
@@ -3386,7 +3717,7 @@ interface operations {
|
|
|
3386
3717
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3387
3718
|
};
|
|
3388
3719
|
};
|
|
3389
|
-
/** @description Advanced payments
|
|
3720
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3390
3721
|
503: {
|
|
3391
3722
|
headers: {
|
|
3392
3723
|
[name: string]: unknown;
|
|
@@ -3457,6 +3788,15 @@ interface operations {
|
|
|
3457
3788
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3458
3789
|
};
|
|
3459
3790
|
};
|
|
3791
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3792
|
+
403: {
|
|
3793
|
+
headers: {
|
|
3794
|
+
[name: string]: unknown;
|
|
3795
|
+
};
|
|
3796
|
+
content: {
|
|
3797
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3798
|
+
};
|
|
3799
|
+
};
|
|
3460
3800
|
/** @description The banking network rejected the operation. */
|
|
3461
3801
|
422: {
|
|
3462
3802
|
headers: {
|
|
@@ -3466,7 +3806,7 @@ interface operations {
|
|
|
3466
3806
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3467
3807
|
};
|
|
3468
3808
|
};
|
|
3469
|
-
/** @description Advanced payments
|
|
3809
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3470
3810
|
503: {
|
|
3471
3811
|
headers: {
|
|
3472
3812
|
[name: string]: unknown;
|
|
@@ -3495,7 +3835,7 @@ interface operations {
|
|
|
3495
3835
|
};
|
|
3496
3836
|
};
|
|
3497
3837
|
};
|
|
3498
|
-
|
|
3838
|
+
Crypto_getBalance: {
|
|
3499
3839
|
parameters: {
|
|
3500
3840
|
query?: never;
|
|
3501
3841
|
header?: never;
|
|
@@ -3509,11 +3849,11 @@ interface operations {
|
|
|
3509
3849
|
[name: string]: unknown;
|
|
3510
3850
|
};
|
|
3511
3851
|
content: {
|
|
3512
|
-
"application/json": components["schemas"]["
|
|
3852
|
+
"application/json": components["schemas"]["CryptoBalanceDto"];
|
|
3513
3853
|
};
|
|
3514
3854
|
};
|
|
3515
|
-
/** @description
|
|
3516
|
-
|
|
3855
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
3856
|
+
401: {
|
|
3517
3857
|
headers: {
|
|
3518
3858
|
[name: string]: unknown;
|
|
3519
3859
|
};
|
|
@@ -3521,8 +3861,8 @@ interface operations {
|
|
|
3521
3861
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3522
3862
|
};
|
|
3523
3863
|
};
|
|
3524
|
-
/** @description
|
|
3525
|
-
|
|
3864
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
3865
|
+
403: {
|
|
3526
3866
|
headers: {
|
|
3527
3867
|
[name: string]: unknown;
|
|
3528
3868
|
};
|
|
@@ -3550,28 +3890,31 @@ interface operations {
|
|
|
3550
3890
|
};
|
|
3551
3891
|
};
|
|
3552
3892
|
};
|
|
3553
|
-
|
|
3893
|
+
Crypto_createDepositAddress: {
|
|
3554
3894
|
parameters: {
|
|
3555
|
-
query
|
|
3556
|
-
|
|
3557
|
-
|
|
3895
|
+
query?: never;
|
|
3896
|
+
header?: {
|
|
3897
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
3898
|
+
"Idempotency-Key"?: string;
|
|
3558
3899
|
};
|
|
3559
|
-
header?: never;
|
|
3560
3900
|
path?: never;
|
|
3561
3901
|
cookie?: never;
|
|
3562
3902
|
};
|
|
3563
|
-
requestBody
|
|
3903
|
+
requestBody: {
|
|
3904
|
+
content: {
|
|
3905
|
+
"application/json": components["schemas"]["CreateDepositAddressDto"];
|
|
3906
|
+
};
|
|
3907
|
+
};
|
|
3564
3908
|
responses: {
|
|
3565
|
-
/** @description bcvRate/vesAmount are authoritative for settlement; medianRate/medianVesAmount are for display. sources includes per-source rates or errors. */
|
|
3566
3909
|
200: {
|
|
3567
3910
|
headers: {
|
|
3568
3911
|
[name: string]: unknown;
|
|
3569
3912
|
};
|
|
3570
3913
|
content: {
|
|
3571
|
-
"application/json": components["schemas"]["
|
|
3914
|
+
"application/json": components["schemas"]["DepositAddressDto"];
|
|
3572
3915
|
};
|
|
3573
3916
|
};
|
|
3574
|
-
/** @description
|
|
3917
|
+
/** @description `unsupported_network` or invalid `customerRef`. */
|
|
3575
3918
|
400: {
|
|
3576
3919
|
headers: {
|
|
3577
3920
|
[name: string]: unknown;
|
|
@@ -3589,6 +3932,15 @@ interface operations {
|
|
|
3589
3932
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3590
3933
|
};
|
|
3591
3934
|
};
|
|
3935
|
+
/** @description `method_not_allowed` — USDT is not enabled for this account. */
|
|
3936
|
+
403: {
|
|
3937
|
+
headers: {
|
|
3938
|
+
[name: string]: unknown;
|
|
3939
|
+
};
|
|
3940
|
+
content: {
|
|
3941
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3942
|
+
};
|
|
3943
|
+
};
|
|
3592
3944
|
/** @description Client error. */
|
|
3593
3945
|
"4XX": {
|
|
3594
3946
|
headers: {
|
|
@@ -3609,23 +3961,368 @@ interface operations {
|
|
|
3609
3961
|
};
|
|
3610
3962
|
};
|
|
3611
3963
|
};
|
|
3612
|
-
|
|
3964
|
+
Crypto_listNetworks: {
|
|
3613
3965
|
parameters: {
|
|
3614
|
-
query?:
|
|
3615
|
-
|
|
3616
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
3617
|
-
"Idempotency-Key"?: string;
|
|
3966
|
+
query?: {
|
|
3967
|
+
amountUsdt?: string;
|
|
3618
3968
|
};
|
|
3969
|
+
header?: never;
|
|
3619
3970
|
path?: never;
|
|
3620
3971
|
cookie?: never;
|
|
3621
3972
|
};
|
|
3622
|
-
requestBody
|
|
3623
|
-
content: {
|
|
3624
|
-
"application/json": components["schemas"]["C2pRequestDto"];
|
|
3625
|
-
};
|
|
3626
|
-
};
|
|
3973
|
+
requestBody?: never;
|
|
3627
3974
|
responses: {
|
|
3628
|
-
|
|
3975
|
+
200: {
|
|
3976
|
+
headers: {
|
|
3977
|
+
[name: string]: unknown;
|
|
3978
|
+
};
|
|
3979
|
+
content: {
|
|
3980
|
+
"application/json": components["schemas"]["CryptoNetworkDto"][];
|
|
3981
|
+
};
|
|
3982
|
+
};
|
|
3983
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
3984
|
+
401: {
|
|
3985
|
+
headers: {
|
|
3986
|
+
[name: string]: unknown;
|
|
3987
|
+
};
|
|
3988
|
+
content: {
|
|
3989
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3990
|
+
};
|
|
3991
|
+
};
|
|
3992
|
+
/** @description `method_not_allowed` — USDT is not enabled for this account. */
|
|
3993
|
+
403: {
|
|
3994
|
+
headers: {
|
|
3995
|
+
[name: string]: unknown;
|
|
3996
|
+
};
|
|
3997
|
+
content: {
|
|
3998
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3999
|
+
};
|
|
4000
|
+
};
|
|
4001
|
+
/** @description Client error. */
|
|
4002
|
+
"4XX": {
|
|
4003
|
+
headers: {
|
|
4004
|
+
[name: string]: unknown;
|
|
4005
|
+
};
|
|
4006
|
+
content: {
|
|
4007
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4008
|
+
};
|
|
4009
|
+
};
|
|
4010
|
+
/** @description Server or upstream bank error. */
|
|
4011
|
+
"5XX": {
|
|
4012
|
+
headers: {
|
|
4013
|
+
[name: string]: unknown;
|
|
4014
|
+
};
|
|
4015
|
+
content: {
|
|
4016
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4017
|
+
};
|
|
4018
|
+
};
|
|
4019
|
+
};
|
|
4020
|
+
};
|
|
4021
|
+
Crypto_createPayout: {
|
|
4022
|
+
parameters: {
|
|
4023
|
+
query?: never;
|
|
4024
|
+
header?: {
|
|
4025
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4026
|
+
"Idempotency-Key"?: string;
|
|
4027
|
+
};
|
|
4028
|
+
path?: never;
|
|
4029
|
+
cookie?: never;
|
|
4030
|
+
};
|
|
4031
|
+
requestBody: {
|
|
4032
|
+
content: {
|
|
4033
|
+
"application/json": components["schemas"]["CreateCryptoPayoutDto"];
|
|
4034
|
+
};
|
|
4035
|
+
};
|
|
4036
|
+
responses: {
|
|
4037
|
+
/** @description Idempotent replay of an existing payout. */
|
|
4038
|
+
200: {
|
|
4039
|
+
headers: {
|
|
4040
|
+
[name: string]: unknown;
|
|
4041
|
+
};
|
|
4042
|
+
content: {
|
|
4043
|
+
"application/json": components["schemas"]["CryptoPayoutDto"];
|
|
4044
|
+
};
|
|
4045
|
+
};
|
|
4046
|
+
/** @description Payout created. */
|
|
4047
|
+
201: {
|
|
4048
|
+
headers: {
|
|
4049
|
+
[name: string]: unknown;
|
|
4050
|
+
};
|
|
4051
|
+
content: {
|
|
4052
|
+
"application/json": components["schemas"]["CryptoPayoutDto"];
|
|
4053
|
+
};
|
|
4054
|
+
};
|
|
4055
|
+
/** @description `unsupported_network`, `invalid_address` or `invalid_data`. */
|
|
4056
|
+
400: {
|
|
4057
|
+
headers: {
|
|
4058
|
+
[name: string]: unknown;
|
|
4059
|
+
};
|
|
4060
|
+
content: {
|
|
4061
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4062
|
+
};
|
|
4063
|
+
};
|
|
4064
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4065
|
+
401: {
|
|
4066
|
+
headers: {
|
|
4067
|
+
[name: string]: unknown;
|
|
4068
|
+
};
|
|
4069
|
+
content: {
|
|
4070
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4071
|
+
};
|
|
4072
|
+
};
|
|
4073
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4074
|
+
403: {
|
|
4075
|
+
headers: {
|
|
4076
|
+
[name: string]: unknown;
|
|
4077
|
+
};
|
|
4078
|
+
content: {
|
|
4079
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4080
|
+
};
|
|
4081
|
+
};
|
|
4082
|
+
/** @description `idempotency_key_reused` with a different request. */
|
|
4083
|
+
409: {
|
|
4084
|
+
headers: {
|
|
4085
|
+
[name: string]: unknown;
|
|
4086
|
+
};
|
|
4087
|
+
content: {
|
|
4088
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4089
|
+
};
|
|
4090
|
+
};
|
|
4091
|
+
/** @description `insufficient_balance` or `amount_below_minimum`. */
|
|
4092
|
+
422: {
|
|
4093
|
+
headers: {
|
|
4094
|
+
[name: string]: unknown;
|
|
4095
|
+
};
|
|
4096
|
+
content: {
|
|
4097
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4098
|
+
};
|
|
4099
|
+
};
|
|
4100
|
+
/** @description Client error. */
|
|
4101
|
+
"4XX": {
|
|
4102
|
+
headers: {
|
|
4103
|
+
[name: string]: unknown;
|
|
4104
|
+
};
|
|
4105
|
+
content: {
|
|
4106
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4107
|
+
};
|
|
4108
|
+
};
|
|
4109
|
+
/** @description Server or upstream bank error. */
|
|
4110
|
+
"5XX": {
|
|
4111
|
+
headers: {
|
|
4112
|
+
[name: string]: unknown;
|
|
4113
|
+
};
|
|
4114
|
+
content: {
|
|
4115
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4116
|
+
};
|
|
4117
|
+
};
|
|
4118
|
+
};
|
|
4119
|
+
};
|
|
4120
|
+
Crypto_getPayout: {
|
|
4121
|
+
parameters: {
|
|
4122
|
+
query?: never;
|
|
4123
|
+
header?: never;
|
|
4124
|
+
path: {
|
|
4125
|
+
id: string;
|
|
4126
|
+
};
|
|
4127
|
+
cookie?: never;
|
|
4128
|
+
};
|
|
4129
|
+
requestBody?: never;
|
|
4130
|
+
responses: {
|
|
4131
|
+
200: {
|
|
4132
|
+
headers: {
|
|
4133
|
+
[name: string]: unknown;
|
|
4134
|
+
};
|
|
4135
|
+
content: {
|
|
4136
|
+
"application/json": components["schemas"]["CryptoPayoutDto"];
|
|
4137
|
+
};
|
|
4138
|
+
};
|
|
4139
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4140
|
+
401: {
|
|
4141
|
+
headers: {
|
|
4142
|
+
[name: string]: unknown;
|
|
4143
|
+
};
|
|
4144
|
+
content: {
|
|
4145
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4146
|
+
};
|
|
4147
|
+
};
|
|
4148
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4149
|
+
403: {
|
|
4150
|
+
headers: {
|
|
4151
|
+
[name: string]: unknown;
|
|
4152
|
+
};
|
|
4153
|
+
content: {
|
|
4154
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4155
|
+
};
|
|
4156
|
+
};
|
|
4157
|
+
/** @description Client error. */
|
|
4158
|
+
"4XX": {
|
|
4159
|
+
headers: {
|
|
4160
|
+
[name: string]: unknown;
|
|
4161
|
+
};
|
|
4162
|
+
content: {
|
|
4163
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4164
|
+
};
|
|
4165
|
+
};
|
|
4166
|
+
/** @description Server or upstream bank error. */
|
|
4167
|
+
"5XX": {
|
|
4168
|
+
headers: {
|
|
4169
|
+
[name: string]: unknown;
|
|
4170
|
+
};
|
|
4171
|
+
content: {
|
|
4172
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4173
|
+
};
|
|
4174
|
+
};
|
|
4175
|
+
};
|
|
4176
|
+
};
|
|
4177
|
+
Payments_getBanks: {
|
|
4178
|
+
parameters: {
|
|
4179
|
+
query?: never;
|
|
4180
|
+
header?: never;
|
|
4181
|
+
path?: never;
|
|
4182
|
+
cookie?: never;
|
|
4183
|
+
};
|
|
4184
|
+
requestBody?: never;
|
|
4185
|
+
responses: {
|
|
4186
|
+
200: {
|
|
4187
|
+
headers: {
|
|
4188
|
+
[name: string]: unknown;
|
|
4189
|
+
};
|
|
4190
|
+
content: {
|
|
4191
|
+
"application/json": components["schemas"]["BankResponseDto"][];
|
|
4192
|
+
};
|
|
4193
|
+
};
|
|
4194
|
+
/** @description Invalid request or unsupported operation. */
|
|
4195
|
+
400: {
|
|
4196
|
+
headers: {
|
|
4197
|
+
[name: string]: unknown;
|
|
4198
|
+
};
|
|
4199
|
+
content: {
|
|
4200
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4201
|
+
};
|
|
4202
|
+
};
|
|
4203
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4204
|
+
401: {
|
|
4205
|
+
headers: {
|
|
4206
|
+
[name: string]: unknown;
|
|
4207
|
+
};
|
|
4208
|
+
content: {
|
|
4209
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4210
|
+
};
|
|
4211
|
+
};
|
|
4212
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4213
|
+
403: {
|
|
4214
|
+
headers: {
|
|
4215
|
+
[name: string]: unknown;
|
|
4216
|
+
};
|
|
4217
|
+
content: {
|
|
4218
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4219
|
+
};
|
|
4220
|
+
};
|
|
4221
|
+
/** @description Client error. */
|
|
4222
|
+
"4XX": {
|
|
4223
|
+
headers: {
|
|
4224
|
+
[name: string]: unknown;
|
|
4225
|
+
};
|
|
4226
|
+
content: {
|
|
4227
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4228
|
+
};
|
|
4229
|
+
};
|
|
4230
|
+
/** @description Server or upstream bank error. */
|
|
4231
|
+
"5XX": {
|
|
4232
|
+
headers: {
|
|
4233
|
+
[name: string]: unknown;
|
|
4234
|
+
};
|
|
4235
|
+
content: {
|
|
4236
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4237
|
+
};
|
|
4238
|
+
};
|
|
4239
|
+
};
|
|
4240
|
+
};
|
|
4241
|
+
Payments_getQuote: {
|
|
4242
|
+
parameters: {
|
|
4243
|
+
query: {
|
|
4244
|
+
/** @description Positive USD amount to convert. Must be a finite number greater than zero. */
|
|
4245
|
+
usdAmount: number;
|
|
4246
|
+
};
|
|
4247
|
+
header?: never;
|
|
4248
|
+
path?: never;
|
|
4249
|
+
cookie?: never;
|
|
4250
|
+
};
|
|
4251
|
+
requestBody?: never;
|
|
4252
|
+
responses: {
|
|
4253
|
+
/** @description bcvRate/vesAmount are authoritative for settlement; medianRate/medianVesAmount are for display. sources includes per-source rates or errors. */
|
|
4254
|
+
200: {
|
|
4255
|
+
headers: {
|
|
4256
|
+
[name: string]: unknown;
|
|
4257
|
+
};
|
|
4258
|
+
content: {
|
|
4259
|
+
"application/json": components["schemas"]["QuoteResponseDto"];
|
|
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"];
|
|
4269
|
+
};
|
|
4270
|
+
};
|
|
4271
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4272
|
+
401: {
|
|
4273
|
+
headers: {
|
|
4274
|
+
[name: string]: unknown;
|
|
4275
|
+
};
|
|
4276
|
+
content: {
|
|
4277
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4278
|
+
};
|
|
4279
|
+
};
|
|
4280
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4281
|
+
403: {
|
|
4282
|
+
headers: {
|
|
4283
|
+
[name: string]: unknown;
|
|
4284
|
+
};
|
|
4285
|
+
content: {
|
|
4286
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4287
|
+
};
|
|
4288
|
+
};
|
|
4289
|
+
/** @description Client error. */
|
|
4290
|
+
"4XX": {
|
|
4291
|
+
headers: {
|
|
4292
|
+
[name: string]: unknown;
|
|
4293
|
+
};
|
|
4294
|
+
content: {
|
|
4295
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4296
|
+
};
|
|
4297
|
+
};
|
|
4298
|
+
/** @description Server or upstream bank error. */
|
|
4299
|
+
"5XX": {
|
|
4300
|
+
headers: {
|
|
4301
|
+
[name: string]: unknown;
|
|
4302
|
+
};
|
|
4303
|
+
content: {
|
|
4304
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4305
|
+
};
|
|
4306
|
+
};
|
|
4307
|
+
};
|
|
4308
|
+
};
|
|
4309
|
+
Payments_requestC2p: {
|
|
4310
|
+
parameters: {
|
|
4311
|
+
query?: never;
|
|
4312
|
+
header?: {
|
|
4313
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4314
|
+
"Idempotency-Key"?: string;
|
|
4315
|
+
};
|
|
4316
|
+
path?: never;
|
|
4317
|
+
cookie?: never;
|
|
4318
|
+
};
|
|
4319
|
+
requestBody: {
|
|
4320
|
+
content: {
|
|
4321
|
+
"application/json": components["schemas"]["C2pRequestDto"];
|
|
4322
|
+
};
|
|
4323
|
+
};
|
|
4324
|
+
responses: {
|
|
4325
|
+
201: {
|
|
3629
4326
|
headers: {
|
|
3630
4327
|
[name: string]: unknown;
|
|
3631
4328
|
};
|
|
@@ -3651,6 +4348,15 @@ interface operations {
|
|
|
3651
4348
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3652
4349
|
};
|
|
3653
4350
|
};
|
|
4351
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4352
|
+
403: {
|
|
4353
|
+
headers: {
|
|
4354
|
+
[name: string]: unknown;
|
|
4355
|
+
};
|
|
4356
|
+
content: {
|
|
4357
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4358
|
+
};
|
|
4359
|
+
};
|
|
3654
4360
|
/** @description Client error. */
|
|
3655
4361
|
"4XX": {
|
|
3656
4362
|
headers: {
|
|
@@ -3714,6 +4420,15 @@ interface operations {
|
|
|
3714
4420
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3715
4421
|
};
|
|
3716
4422
|
};
|
|
4423
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4424
|
+
403: {
|
|
4425
|
+
headers: {
|
|
4426
|
+
[name: string]: unknown;
|
|
4427
|
+
};
|
|
4428
|
+
content: {
|
|
4429
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4430
|
+
};
|
|
4431
|
+
};
|
|
3717
4432
|
/** @description The supplied intent does not exist or is no longer pending. */
|
|
3718
4433
|
404: {
|
|
3719
4434
|
headers: {
|
|
@@ -3794,6 +4509,15 @@ interface operations {
|
|
|
3794
4509
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3795
4510
|
};
|
|
3796
4511
|
};
|
|
4512
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4513
|
+
403: {
|
|
4514
|
+
headers: {
|
|
4515
|
+
[name: string]: unknown;
|
|
4516
|
+
};
|
|
4517
|
+
content: {
|
|
4518
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4519
|
+
};
|
|
4520
|
+
};
|
|
3797
4521
|
/** @description The provider rejected the charge. */
|
|
3798
4522
|
422: {
|
|
3799
4523
|
headers: {
|
|
@@ -3867,6 +4591,15 @@ interface operations {
|
|
|
3867
4591
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3868
4592
|
};
|
|
3869
4593
|
};
|
|
4594
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4595
|
+
403: {
|
|
4596
|
+
headers: {
|
|
4597
|
+
[name: string]: unknown;
|
|
4598
|
+
};
|
|
4599
|
+
content: {
|
|
4600
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4601
|
+
};
|
|
4602
|
+
};
|
|
3870
4603
|
/** @description Client error. */
|
|
3871
4604
|
"4XX": {
|
|
3872
4605
|
headers: {
|
|
@@ -3929,6 +4662,15 @@ interface operations {
|
|
|
3929
4662
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3930
4663
|
};
|
|
3931
4664
|
};
|
|
4665
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4666
|
+
403: {
|
|
4667
|
+
headers: {
|
|
4668
|
+
[name: string]: unknown;
|
|
4669
|
+
};
|
|
4670
|
+
content: {
|
|
4671
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4672
|
+
};
|
|
4673
|
+
};
|
|
3932
4674
|
/** @description Client error. */
|
|
3933
4675
|
"4XX": {
|
|
3934
4676
|
headers: {
|
|
@@ -3986,6 +4728,15 @@ interface operations {
|
|
|
3986
4728
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3987
4729
|
};
|
|
3988
4730
|
};
|
|
4731
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4732
|
+
403: {
|
|
4733
|
+
headers: {
|
|
4734
|
+
[name: string]: unknown;
|
|
4735
|
+
};
|
|
4736
|
+
content: {
|
|
4737
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4738
|
+
};
|
|
4739
|
+
};
|
|
3989
4740
|
404: {
|
|
3990
4741
|
headers: {
|
|
3991
4742
|
[name: string]: unknown;
|
|
@@ -4051,6 +4802,15 @@ interface operations {
|
|
|
4051
4802
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4052
4803
|
};
|
|
4053
4804
|
};
|
|
4805
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4806
|
+
403: {
|
|
4807
|
+
headers: {
|
|
4808
|
+
[name: string]: unknown;
|
|
4809
|
+
};
|
|
4810
|
+
content: {
|
|
4811
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4812
|
+
};
|
|
4813
|
+
};
|
|
4054
4814
|
404: {
|
|
4055
4815
|
headers: {
|
|
4056
4816
|
[name: string]: unknown;
|
|
@@ -4119,6 +4879,15 @@ interface operations {
|
|
|
4119
4879
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4120
4880
|
};
|
|
4121
4881
|
};
|
|
4882
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4883
|
+
403: {
|
|
4884
|
+
headers: {
|
|
4885
|
+
[name: string]: unknown;
|
|
4886
|
+
};
|
|
4887
|
+
content: {
|
|
4888
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4889
|
+
};
|
|
4890
|
+
};
|
|
4122
4891
|
404: {
|
|
4123
4892
|
headers: {
|
|
4124
4893
|
[name: string]: unknown;
|
|
@@ -4194,6 +4963,15 @@ interface operations {
|
|
|
4194
4963
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4195
4964
|
};
|
|
4196
4965
|
};
|
|
4966
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4967
|
+
403: {
|
|
4968
|
+
headers: {
|
|
4969
|
+
[name: string]: unknown;
|
|
4970
|
+
};
|
|
4971
|
+
content: {
|
|
4972
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4973
|
+
};
|
|
4974
|
+
};
|
|
4197
4975
|
/** @description Returned when externalRef is set and no merchant matches. */
|
|
4198
4976
|
404: {
|
|
4199
4977
|
headers: {
|
|
@@ -4275,6 +5053,15 @@ interface operations {
|
|
|
4275
5053
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4276
5054
|
};
|
|
4277
5055
|
};
|
|
5056
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5057
|
+
403: {
|
|
5058
|
+
headers: {
|
|
5059
|
+
[name: string]: unknown;
|
|
5060
|
+
};
|
|
5061
|
+
content: {
|
|
5062
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5063
|
+
};
|
|
5064
|
+
};
|
|
4278
5065
|
/** @description external_ref_conflict when the same key is reused with a different payload. */
|
|
4279
5066
|
409: {
|
|
4280
5067
|
headers: {
|
|
@@ -4342,6 +5129,15 @@ interface operations {
|
|
|
4342
5129
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4343
5130
|
};
|
|
4344
5131
|
};
|
|
5132
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5133
|
+
403: {
|
|
5134
|
+
headers: {
|
|
5135
|
+
[name: string]: unknown;
|
|
5136
|
+
};
|
|
5137
|
+
content: {
|
|
5138
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5139
|
+
};
|
|
5140
|
+
};
|
|
4345
5141
|
404: {
|
|
4346
5142
|
headers: {
|
|
4347
5143
|
[name: string]: unknown;
|
|
@@ -4414,6 +5210,15 @@ interface operations {
|
|
|
4414
5210
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4415
5211
|
};
|
|
4416
5212
|
};
|
|
5213
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5214
|
+
403: {
|
|
5215
|
+
headers: {
|
|
5216
|
+
[name: string]: unknown;
|
|
5217
|
+
};
|
|
5218
|
+
content: {
|
|
5219
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5220
|
+
};
|
|
5221
|
+
};
|
|
4417
5222
|
404: {
|
|
4418
5223
|
headers: {
|
|
4419
5224
|
[name: string]: unknown;
|
|
@@ -4483,6 +5288,15 @@ interface operations {
|
|
|
4483
5288
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4484
5289
|
};
|
|
4485
5290
|
};
|
|
5291
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5292
|
+
403: {
|
|
5293
|
+
headers: {
|
|
5294
|
+
[name: string]: unknown;
|
|
5295
|
+
};
|
|
5296
|
+
content: {
|
|
5297
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5298
|
+
};
|
|
5299
|
+
};
|
|
4486
5300
|
404: {
|
|
4487
5301
|
headers: {
|
|
4488
5302
|
[name: string]: unknown;
|
|
@@ -4548,6 +5362,15 @@ interface operations {
|
|
|
4548
5362
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4549
5363
|
};
|
|
4550
5364
|
};
|
|
5365
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5366
|
+
403: {
|
|
5367
|
+
headers: {
|
|
5368
|
+
[name: string]: unknown;
|
|
5369
|
+
};
|
|
5370
|
+
content: {
|
|
5371
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5372
|
+
};
|
|
5373
|
+
};
|
|
4551
5374
|
404: {
|
|
4552
5375
|
headers: {
|
|
4553
5376
|
[name: string]: unknown;
|
|
@@ -4618,6 +5441,15 @@ interface operations {
|
|
|
4618
5441
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4619
5442
|
};
|
|
4620
5443
|
};
|
|
5444
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5445
|
+
403: {
|
|
5446
|
+
headers: {
|
|
5447
|
+
[name: string]: unknown;
|
|
5448
|
+
};
|
|
5449
|
+
content: {
|
|
5450
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5451
|
+
};
|
|
5452
|
+
};
|
|
4621
5453
|
404: {
|
|
4622
5454
|
headers: {
|
|
4623
5455
|
[name: string]: unknown;
|
|
@@ -4700,6 +5532,15 @@ interface operations {
|
|
|
4700
5532
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4701
5533
|
};
|
|
4702
5534
|
};
|
|
5535
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5536
|
+
403: {
|
|
5537
|
+
headers: {
|
|
5538
|
+
[name: string]: unknown;
|
|
5539
|
+
};
|
|
5540
|
+
content: {
|
|
5541
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5542
|
+
};
|
|
5543
|
+
};
|
|
4703
5544
|
404: {
|
|
4704
5545
|
headers: {
|
|
4705
5546
|
[name: string]: unknown;
|
|
@@ -4774,6 +5615,15 @@ interface operations {
|
|
|
4774
5615
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4775
5616
|
};
|
|
4776
5617
|
};
|
|
5618
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5619
|
+
403: {
|
|
5620
|
+
headers: {
|
|
5621
|
+
[name: string]: unknown;
|
|
5622
|
+
};
|
|
5623
|
+
content: {
|
|
5624
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5625
|
+
};
|
|
5626
|
+
};
|
|
4777
5627
|
404: {
|
|
4778
5628
|
headers: {
|
|
4779
5629
|
[name: string]: unknown;
|
|
@@ -4846,6 +5696,15 @@ interface operations {
|
|
|
4846
5696
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4847
5697
|
};
|
|
4848
5698
|
};
|
|
5699
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5700
|
+
403: {
|
|
5701
|
+
headers: {
|
|
5702
|
+
[name: string]: unknown;
|
|
5703
|
+
};
|
|
5704
|
+
content: {
|
|
5705
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5706
|
+
};
|
|
5707
|
+
};
|
|
4849
5708
|
404: {
|
|
4850
5709
|
headers: {
|
|
4851
5710
|
[name: string]: unknown;
|
|
@@ -4911,6 +5770,15 @@ interface operations {
|
|
|
4911
5770
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4912
5771
|
};
|
|
4913
5772
|
};
|
|
5773
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5774
|
+
403: {
|
|
5775
|
+
headers: {
|
|
5776
|
+
[name: string]: unknown;
|
|
5777
|
+
};
|
|
5778
|
+
content: {
|
|
5779
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5780
|
+
};
|
|
5781
|
+
};
|
|
4914
5782
|
404: {
|
|
4915
5783
|
headers: {
|
|
4916
5784
|
[name: string]: unknown;
|
|
@@ -4976,6 +5844,15 @@ interface operations {
|
|
|
4976
5844
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4977
5845
|
};
|
|
4978
5846
|
};
|
|
5847
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5848
|
+
403: {
|
|
5849
|
+
headers: {
|
|
5850
|
+
[name: string]: unknown;
|
|
5851
|
+
};
|
|
5852
|
+
content: {
|
|
5853
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5854
|
+
};
|
|
5855
|
+
};
|
|
4979
5856
|
/** @description Merchant not found for this tenant. */
|
|
4980
5857
|
404: {
|
|
4981
5858
|
headers: {
|
|
@@ -5055,6 +5932,15 @@ interface operations {
|
|
|
5055
5932
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5056
5933
|
};
|
|
5057
5934
|
};
|
|
5935
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5936
|
+
403: {
|
|
5937
|
+
headers: {
|
|
5938
|
+
[name: string]: unknown;
|
|
5939
|
+
};
|
|
5940
|
+
content: {
|
|
5941
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5942
|
+
};
|
|
5943
|
+
};
|
|
5058
5944
|
404: {
|
|
5059
5945
|
headers: {
|
|
5060
5946
|
[name: string]: unknown;
|
|
@@ -5120,6 +6006,15 @@ interface operations {
|
|
|
5120
6006
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5121
6007
|
};
|
|
5122
6008
|
};
|
|
6009
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6010
|
+
403: {
|
|
6011
|
+
headers: {
|
|
6012
|
+
[name: string]: unknown;
|
|
6013
|
+
};
|
|
6014
|
+
content: {
|
|
6015
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6016
|
+
};
|
|
6017
|
+
};
|
|
5123
6018
|
404: {
|
|
5124
6019
|
headers: {
|
|
5125
6020
|
[name: string]: unknown;
|
|
@@ -5188,6 +6083,15 @@ interface operations {
|
|
|
5188
6083
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5189
6084
|
};
|
|
5190
6085
|
};
|
|
6086
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6087
|
+
403: {
|
|
6088
|
+
headers: {
|
|
6089
|
+
[name: string]: unknown;
|
|
6090
|
+
};
|
|
6091
|
+
content: {
|
|
6092
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6093
|
+
};
|
|
6094
|
+
};
|
|
5191
6095
|
404: {
|
|
5192
6096
|
headers: {
|
|
5193
6097
|
[name: string]: unknown;
|
|
@@ -5260,6 +6164,15 @@ interface operations {
|
|
|
5260
6164
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5261
6165
|
};
|
|
5262
6166
|
};
|
|
6167
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6168
|
+
403: {
|
|
6169
|
+
headers: {
|
|
6170
|
+
[name: string]: unknown;
|
|
6171
|
+
};
|
|
6172
|
+
content: {
|
|
6173
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6174
|
+
};
|
|
6175
|
+
};
|
|
5263
6176
|
404: {
|
|
5264
6177
|
headers: {
|
|
5265
6178
|
[name: string]: unknown;
|
|
@@ -5330,6 +6243,15 @@ interface operations {
|
|
|
5330
6243
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5331
6244
|
};
|
|
5332
6245
|
};
|
|
6246
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6247
|
+
403: {
|
|
6248
|
+
headers: {
|
|
6249
|
+
[name: string]: unknown;
|
|
6250
|
+
};
|
|
6251
|
+
content: {
|
|
6252
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6253
|
+
};
|
|
6254
|
+
};
|
|
5333
6255
|
/** @description amount_below_minimum */
|
|
5334
6256
|
422: {
|
|
5335
6257
|
headers: {
|
|
@@ -5387,6 +6309,15 @@ interface operations {
|
|
|
5387
6309
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5388
6310
|
};
|
|
5389
6311
|
};
|
|
6312
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6313
|
+
403: {
|
|
6314
|
+
headers: {
|
|
6315
|
+
[name: string]: unknown;
|
|
6316
|
+
};
|
|
6317
|
+
content: {
|
|
6318
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6319
|
+
};
|
|
6320
|
+
};
|
|
5390
6321
|
404: {
|
|
5391
6322
|
headers: {
|
|
5392
6323
|
[name: string]: unknown;
|
|
@@ -5454,6 +6385,15 @@ interface operations {
|
|
|
5454
6385
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5455
6386
|
};
|
|
5456
6387
|
};
|
|
6388
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6389
|
+
403: {
|
|
6390
|
+
headers: {
|
|
6391
|
+
[name: string]: unknown;
|
|
6392
|
+
};
|
|
6393
|
+
content: {
|
|
6394
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6395
|
+
};
|
|
6396
|
+
};
|
|
5457
6397
|
/** @description Client error. */
|
|
5458
6398
|
"4XX": {
|
|
5459
6399
|
headers: {
|
|
@@ -5516,6 +6456,15 @@ interface operations {
|
|
|
5516
6456
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5517
6457
|
};
|
|
5518
6458
|
};
|
|
6459
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6460
|
+
403: {
|
|
6461
|
+
headers: {
|
|
6462
|
+
[name: string]: unknown;
|
|
6463
|
+
};
|
|
6464
|
+
content: {
|
|
6465
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6466
|
+
};
|
|
6467
|
+
};
|
|
5519
6468
|
/** @description Client error. */
|
|
5520
6469
|
"4XX": {
|
|
5521
6470
|
headers: {
|
|
@@ -5573,6 +6522,15 @@ interface operations {
|
|
|
5573
6522
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5574
6523
|
};
|
|
5575
6524
|
};
|
|
6525
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6526
|
+
403: {
|
|
6527
|
+
headers: {
|
|
6528
|
+
[name: string]: unknown;
|
|
6529
|
+
};
|
|
6530
|
+
content: {
|
|
6531
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6532
|
+
};
|
|
6533
|
+
};
|
|
5576
6534
|
404: {
|
|
5577
6535
|
headers: {
|
|
5578
6536
|
[name: string]: unknown;
|
|
@@ -5630,6 +6588,15 @@ interface operations {
|
|
|
5630
6588
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5631
6589
|
};
|
|
5632
6590
|
};
|
|
6591
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6592
|
+
403: {
|
|
6593
|
+
headers: {
|
|
6594
|
+
[name: string]: unknown;
|
|
6595
|
+
};
|
|
6596
|
+
content: {
|
|
6597
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6598
|
+
};
|
|
6599
|
+
};
|
|
5633
6600
|
404: {
|
|
5634
6601
|
headers: {
|
|
5635
6602
|
[name: string]: unknown;
|
|
@@ -5708,6 +6675,15 @@ interface operations {
|
|
|
5708
6675
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5709
6676
|
};
|
|
5710
6677
|
};
|
|
6678
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6679
|
+
403: {
|
|
6680
|
+
headers: {
|
|
6681
|
+
[name: string]: unknown;
|
|
6682
|
+
};
|
|
6683
|
+
content: {
|
|
6684
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6685
|
+
};
|
|
6686
|
+
};
|
|
5711
6687
|
404: {
|
|
5712
6688
|
headers: {
|
|
5713
6689
|
[name: string]: unknown;
|
|
@@ -5773,6 +6749,15 @@ interface operations {
|
|
|
5773
6749
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5774
6750
|
};
|
|
5775
6751
|
};
|
|
6752
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6753
|
+
403: {
|
|
6754
|
+
headers: {
|
|
6755
|
+
[name: string]: unknown;
|
|
6756
|
+
};
|
|
6757
|
+
content: {
|
|
6758
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6759
|
+
};
|
|
6760
|
+
};
|
|
5776
6761
|
404: {
|
|
5777
6762
|
headers: {
|
|
5778
6763
|
[name: string]: unknown;
|
|
@@ -5845,6 +6830,15 @@ interface operations {
|
|
|
5845
6830
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5846
6831
|
};
|
|
5847
6832
|
};
|
|
6833
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6834
|
+
403: {
|
|
6835
|
+
headers: {
|
|
6836
|
+
[name: string]: unknown;
|
|
6837
|
+
};
|
|
6838
|
+
content: {
|
|
6839
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6840
|
+
};
|
|
6841
|
+
};
|
|
5848
6842
|
404: {
|
|
5849
6843
|
headers: {
|
|
5850
6844
|
[name: string]: unknown;
|
|
@@ -5910,6 +6904,15 @@ interface operations {
|
|
|
5910
6904
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5911
6905
|
};
|
|
5912
6906
|
};
|
|
6907
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6908
|
+
403: {
|
|
6909
|
+
headers: {
|
|
6910
|
+
[name: string]: unknown;
|
|
6911
|
+
};
|
|
6912
|
+
content: {
|
|
6913
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6914
|
+
};
|
|
6915
|
+
};
|
|
5913
6916
|
404: {
|
|
5914
6917
|
headers: {
|
|
5915
6918
|
[name: string]: unknown;
|
|
@@ -5958,6 +6961,15 @@ interface operations {
|
|
|
5958
6961
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5959
6962
|
};
|
|
5960
6963
|
};
|
|
6964
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6965
|
+
403: {
|
|
6966
|
+
headers: {
|
|
6967
|
+
[name: string]: unknown;
|
|
6968
|
+
};
|
|
6969
|
+
content: {
|
|
6970
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6971
|
+
};
|
|
6972
|
+
};
|
|
5961
6973
|
404: {
|
|
5962
6974
|
headers: {
|
|
5963
6975
|
[name: string]: unknown;
|
|
@@ -6027,6 +7039,15 @@ interface operations {
|
|
|
6027
7039
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6028
7040
|
};
|
|
6029
7041
|
};
|
|
7042
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
7043
|
+
403: {
|
|
7044
|
+
headers: {
|
|
7045
|
+
[name: string]: unknown;
|
|
7046
|
+
};
|
|
7047
|
+
content: {
|
|
7048
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
7049
|
+
};
|
|
7050
|
+
};
|
|
6030
7051
|
404: {
|
|
6031
7052
|
headers: {
|
|
6032
7053
|
[name: string]: unknown;
|
|
@@ -6085,6 +7106,15 @@ interface operations {
|
|
|
6085
7106
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6086
7107
|
};
|
|
6087
7108
|
};
|
|
7109
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
7110
|
+
403: {
|
|
7111
|
+
headers: {
|
|
7112
|
+
[name: string]: unknown;
|
|
7113
|
+
};
|
|
7114
|
+
content: {
|
|
7115
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
7116
|
+
};
|
|
7117
|
+
};
|
|
6088
7118
|
/** @description Client error. */
|
|
6089
7119
|
"4XX": {
|
|
6090
7120
|
headers: {
|
|
@@ -6394,7 +7424,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
6394
7424
|
id: string;
|
|
6395
7425
|
tenantId: string;
|
|
6396
7426
|
url: string;
|
|
6397
|
-
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" | "notification.test")[];
|
|
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")[];
|
|
6398
7428
|
isActive: boolean;
|
|
6399
7429
|
createdAt: string;
|
|
6400
7430
|
secret?: string;
|
|
@@ -6403,7 +7433,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
6403
7433
|
id: string;
|
|
6404
7434
|
tenantId: string;
|
|
6405
7435
|
url: string;
|
|
6406
|
-
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" | "notification.test")[];
|
|
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")[];
|
|
6407
7437
|
isActive: boolean;
|
|
6408
7438
|
createdAt: string;
|
|
6409
7439
|
secret?: string;
|
|
@@ -6412,7 +7442,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
6412
7442
|
id: string;
|
|
6413
7443
|
tenantId: string;
|
|
6414
7444
|
url: string;
|
|
6415
|
-
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" | "notification.test")[];
|
|
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")[];
|
|
6416
7446
|
isActive: boolean;
|
|
6417
7447
|
createdAt: string;
|
|
6418
7448
|
secret?: string;
|
|
@@ -6444,7 +7474,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
6444
7474
|
[key: string]: string;
|
|
6445
7475
|
};
|
|
6446
7476
|
allowedOrigins: string[];
|
|
6447
|
-
methods: ("c2p" | "vpos")[];
|
|
7477
|
+
methods: ("c2p" | "vpos" | "usdt")[];
|
|
6448
7478
|
successUrl?: string | null;
|
|
6449
7479
|
cancelUrl?: string | null;
|
|
6450
7480
|
paymentId?: string | null;
|
|
@@ -6465,7 +7495,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
6465
7495
|
[key: string]: string;
|
|
6466
7496
|
};
|
|
6467
7497
|
allowedOrigins: string[];
|
|
6468
|
-
methods: ("c2p" | "vpos")[];
|
|
7498
|
+
methods: ("c2p" | "vpos" | "usdt")[];
|
|
6469
7499
|
successUrl?: string | null;
|
|
6470
7500
|
cancelUrl?: string | null;
|
|
6471
7501
|
paymentId?: string | null;
|
|
@@ -6570,6 +7600,90 @@ declare class PaymentLinks extends APIResource {
|
|
|
6570
7600
|
delete(id: string, options?: RequestOptions): Promise<void>;
|
|
6571
7601
|
}
|
|
6572
7602
|
|
|
7603
|
+
/** Your USDT balance (USDT settles in USDT, never converted to VES). */
|
|
7604
|
+
declare class CryptoBalance extends APIResource {
|
|
7605
|
+
retrieve(options?: RequestOptions): Promise<{
|
|
7606
|
+
currency: string;
|
|
7607
|
+
availableUsdt: string;
|
|
7608
|
+
pendingPayoutUsdt: string;
|
|
7609
|
+
asOf: string;
|
|
7610
|
+
}>;
|
|
7611
|
+
}
|
|
7612
|
+
/** Static USDT deposit addresses per customer and network. */
|
|
7613
|
+
declare class DepositAddresses extends APIResource {
|
|
7614
|
+
/** Get or create — calling again for the same customer and network returns the same address. */
|
|
7615
|
+
create(params: RequestBody<'Crypto_createDepositAddress'>, options?: RequestOptions): Promise<{
|
|
7616
|
+
customerRef: string;
|
|
7617
|
+
network: string;
|
|
7618
|
+
currency: string;
|
|
7619
|
+
address: string;
|
|
7620
|
+
tag?: string;
|
|
7621
|
+
tagRequired: boolean;
|
|
7622
|
+
createdAt: string;
|
|
7623
|
+
}>;
|
|
7624
|
+
}
|
|
7625
|
+
/** Enabled USDT networks with the payout fee and availability for an amount. */
|
|
7626
|
+
declare class CryptoNetworks extends APIResource {
|
|
7627
|
+
list(params?: QueryParams<'Crypto_listNetworks'>, options?: RequestOptions): Promise<{
|
|
7628
|
+
network: string;
|
|
7629
|
+
displayName: string;
|
|
7630
|
+
receiveEnabled: boolean;
|
|
7631
|
+
payoutEnabled: boolean;
|
|
7632
|
+
payoutFeeUsdt: string;
|
|
7633
|
+
minPayoutUsdt: string;
|
|
7634
|
+
tagRequired: boolean;
|
|
7635
|
+
available: boolean;
|
|
7636
|
+
}[]>;
|
|
7637
|
+
}
|
|
7638
|
+
/** USDT payouts to external addresses. `idempotencyKey` (in the body) makes retries safe. */
|
|
7639
|
+
declare class CryptoPayouts extends APIResource {
|
|
7640
|
+
create(params: RequestBody<'Crypto_createPayout'>, options?: RequestOptions): Promise<{
|
|
7641
|
+
id: string;
|
|
7642
|
+
object: string;
|
|
7643
|
+
currency: string;
|
|
7644
|
+
status: "pending" | "processing" | "completed" | "failed";
|
|
7645
|
+
network: string;
|
|
7646
|
+
address: string;
|
|
7647
|
+
tag?: string;
|
|
7648
|
+
amountUsdt: string;
|
|
7649
|
+
feeUsdt: string;
|
|
7650
|
+
customerRef?: string;
|
|
7651
|
+
merchantId?: string;
|
|
7652
|
+
idempotencyKey: string;
|
|
7653
|
+
txHash?: string;
|
|
7654
|
+
internal: boolean;
|
|
7655
|
+
failureReason?: string;
|
|
7656
|
+
createdAt: string;
|
|
7657
|
+
completedAt?: string;
|
|
7658
|
+
}>;
|
|
7659
|
+
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
7660
|
+
id: string;
|
|
7661
|
+
object: string;
|
|
7662
|
+
currency: string;
|
|
7663
|
+
status: "pending" | "processing" | "completed" | "failed";
|
|
7664
|
+
network: string;
|
|
7665
|
+
address: string;
|
|
7666
|
+
tag?: string;
|
|
7667
|
+
amountUsdt: string;
|
|
7668
|
+
feeUsdt: string;
|
|
7669
|
+
customerRef?: string;
|
|
7670
|
+
merchantId?: string;
|
|
7671
|
+
idempotencyKey: string;
|
|
7672
|
+
txHash?: string;
|
|
7673
|
+
internal: boolean;
|
|
7674
|
+
failureReason?: string;
|
|
7675
|
+
createdAt: string;
|
|
7676
|
+
completedAt?: string;
|
|
7677
|
+
}>;
|
|
7678
|
+
}
|
|
7679
|
+
/** USDT: deposit addresses, balance, networks and payouts. */
|
|
7680
|
+
declare class Crypto extends APIResource {
|
|
7681
|
+
readonly balance: CryptoBalance;
|
|
7682
|
+
readonly depositAddresses: DepositAddresses;
|
|
7683
|
+
readonly networks: CryptoNetworks;
|
|
7684
|
+
readonly payouts: CryptoPayouts;
|
|
7685
|
+
}
|
|
7686
|
+
|
|
6573
7687
|
type MerchantListParams = Omit<QueryParams<'Merchants_listOrGetByRef'>, 'externalRef'>;
|
|
6574
7688
|
/** Where a merchant gets paid (bank account or Pago Móvil). */
|
|
6575
7689
|
declare class PayoutMethods extends APIResource {
|
|
@@ -6773,7 +7887,7 @@ declare class Merchants extends APIResource {
|
|
|
6773
7887
|
|
|
6774
7888
|
/** Pago Móvil C2P: request the bank OTP, then charge with the customer's token. */
|
|
6775
7889
|
declare class C2p extends APIResource {
|
|
6776
|
-
/** Create a C2P intent; the payer's bank sends them a token (
|
|
7890
|
+
/** Create a C2P intent; the payer's bank sends them a token (see `otpRequested`). */
|
|
6777
7891
|
request(params: RequestBody<'Payments_requestC2p'>, options?: RequestOptions): Promise<{
|
|
6778
7892
|
paymentId: string;
|
|
6779
7893
|
externalRef?: string;
|
|
@@ -6914,7 +8028,7 @@ declare class PagoMovil extends APIResource {
|
|
|
6914
8028
|
reversalTxId?: number;
|
|
6915
8029
|
}>;
|
|
6916
8030
|
}
|
|
6917
|
-
/** Débito inmediato (
|
|
8031
|
+
/** Débito inmediato (advanced payments, enabled per account). */
|
|
6918
8032
|
declare class Debit extends APIResource {
|
|
6919
8033
|
requestOtp(params: RequestBody<'R4Operations_generarOtp'>, options?: RequestOptions): Promise<{
|
|
6920
8034
|
code: string;
|
|
@@ -6935,7 +8049,7 @@ declare class Debit extends APIResource {
|
|
|
6935
8049
|
externalRef?: string;
|
|
6936
8050
|
}>;
|
|
6937
8051
|
}
|
|
6938
|
-
/** Crédito inmediato and disbursements (
|
|
8052
|
+
/** Crédito inmediato and disbursements (advanced payments, enabled per account). */
|
|
6939
8053
|
declare class Credit extends APIResource {
|
|
6940
8054
|
/** Instant credit to a Pago Móvil phone. */
|
|
6941
8055
|
create(params: RequestBody<'R4Operations_creditoInmediato'>, options?: RequestOptions): Promise<{
|
|
@@ -6967,7 +8081,7 @@ declare class Credit extends APIResource {
|
|
|
6967
8081
|
}[];
|
|
6968
8082
|
}>;
|
|
6969
8083
|
}
|
|
6970
|
-
/** Bank operation status for débito/crédito (
|
|
8084
|
+
/** Bank operation status for débito/crédito (advanced payments, enabled per account). */
|
|
6971
8085
|
declare class Operations extends APIResource {
|
|
6972
8086
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
6973
8087
|
code: string;
|
|
@@ -6990,7 +8104,7 @@ declare class Operations extends APIResource {
|
|
|
6990
8104
|
reference?: string;
|
|
6991
8105
|
}>;
|
|
6992
8106
|
}
|
|
6993
|
-
/** Account payout dispersion (
|
|
8107
|
+
/** Account payout dispersion (advanced payments, enabled per account). */
|
|
6994
8108
|
declare class Dispersals extends APIResource {
|
|
6995
8109
|
create(params: RequestBody<'R4Operations_dispersarPagos'>, options?: RequestOptions): Promise<{
|
|
6996
8110
|
success: boolean;
|
|
@@ -6999,7 +8113,7 @@ declare class Dispersals extends APIResource {
|
|
|
6999
8113
|
referencia: string;
|
|
7000
8114
|
}>;
|
|
7001
8115
|
}
|
|
7002
|
-
/** Vuelto / change payments (
|
|
8116
|
+
/** Vuelto / change payments (advanced payments, enabled per account). */
|
|
7003
8117
|
declare class Change extends APIResource {
|
|
7004
8118
|
create(params: RequestBody<'R4Operations_ejecutarVuelto'>, options?: RequestOptions): Promise<{
|
|
7005
8119
|
code: string;
|
|
@@ -7110,7 +8224,7 @@ declare class Payments extends APIResource {
|
|
|
7110
8224
|
}>;
|
|
7111
8225
|
}
|
|
7112
8226
|
|
|
7113
|
-
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", "notification.test"];
|
|
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"];
|
|
7114
8228
|
type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];
|
|
7115
8229
|
/** `data` of every `payment.*` event. */
|
|
7116
8230
|
interface PaymentWebhookData {
|
|
@@ -7202,6 +8316,8 @@ declare class VexPay {
|
|
|
7202
8316
|
readonly checkout: Checkout;
|
|
7203
8317
|
readonly merchants: Merchants;
|
|
7204
8318
|
readonly payouts: Payouts;
|
|
8319
|
+
/** USDT: deposit addresses, balance, networks and payouts. */
|
|
8320
|
+
readonly crypto: Crypto;
|
|
7205
8321
|
readonly products: Products;
|
|
7206
8322
|
readonly paymentLinks: PaymentLinks;
|
|
7207
8323
|
readonly tenantPayoutAccount: TenantPayoutAccount;
|
|
@@ -7259,6 +8375,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
7259
8375
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
7260
8376
|
}
|
|
7261
8377
|
|
|
7262
|
-
declare const VERSION = "0.
|
|
8378
|
+
declare const VERSION = "0.2.0";
|
|
7263
8379
|
|
|
7264
8380
|
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 };
|