@vexpay/node 0.1.2-rc.0 → 0.2.1
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 +1193 -54
- package/dist/index.d.ts +1193 -54
- 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
|
};
|
|
@@ -712,7 +712,10 @@ interface components {
|
|
|
712
712
|
* @example 50.00
|
|
713
713
|
*/
|
|
714
714
|
applicationFeeVes?: string;
|
|
715
|
-
/**
|
|
715
|
+
/**
|
|
716
|
+
* @description Optional percent of vesAmount used when applicationFeeVes is omitted. When both are omitted and merchantId is set, the merchant's commission (or the tenant default commission) applies.
|
|
717
|
+
* @example 10
|
|
718
|
+
*/
|
|
716
719
|
applicationFeePercent?: number;
|
|
717
720
|
};
|
|
718
721
|
ManualOperationPollDto: {
|
|
@@ -892,6 +895,121 @@ interface components {
|
|
|
892
895
|
*/
|
|
893
896
|
ip?: string;
|
|
894
897
|
};
|
|
898
|
+
CryptoBalanceDto: {
|
|
899
|
+
/** @example USDT */
|
|
900
|
+
currency: string;
|
|
901
|
+
/**
|
|
902
|
+
* @description USDT available for payouts (ledger).
|
|
903
|
+
* @example 97.00
|
|
904
|
+
*/
|
|
905
|
+
availableUsdt: string;
|
|
906
|
+
/**
|
|
907
|
+
* @description USDT reserved by payouts that have not completed yet.
|
|
908
|
+
* @example 50.10
|
|
909
|
+
*/
|
|
910
|
+
pendingPayoutUsdt: string;
|
|
911
|
+
/** Format: date-time */
|
|
912
|
+
asOf: string;
|
|
913
|
+
};
|
|
914
|
+
CreateDepositAddressDto: {
|
|
915
|
+
/**
|
|
916
|
+
* @description Your identifier for the customer this address belongs to (1–128 chars: A–Z a–z 0–9 _ . : @ -).
|
|
917
|
+
* @example user_123
|
|
918
|
+
*/
|
|
919
|
+
customerRef: string;
|
|
920
|
+
/**
|
|
921
|
+
* @example BEP20
|
|
922
|
+
* @enum {string}
|
|
923
|
+
*/
|
|
924
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1";
|
|
925
|
+
};
|
|
926
|
+
DepositAddressDto: {
|
|
927
|
+
/** @example user_123 */
|
|
928
|
+
customerRef: string;
|
|
929
|
+
/** @example BEP20 */
|
|
930
|
+
network: string;
|
|
931
|
+
/** @example USDT */
|
|
932
|
+
currency: string;
|
|
933
|
+
/** @example 0x9f3c… */
|
|
934
|
+
address: string;
|
|
935
|
+
/** @description Destination tag / memo the payer must include (TON). */
|
|
936
|
+
tag?: string;
|
|
937
|
+
/** @description True when the network requires the tag. */
|
|
938
|
+
tagRequired: boolean;
|
|
939
|
+
/** Format: date-time */
|
|
940
|
+
createdAt: string;
|
|
941
|
+
};
|
|
942
|
+
CryptoNetworkDto: {
|
|
943
|
+
/** @example POLYGON */
|
|
944
|
+
network: string;
|
|
945
|
+
/** @example Polygon */
|
|
946
|
+
displayName: string;
|
|
947
|
+
receiveEnabled: boolean;
|
|
948
|
+
payoutEnabled: boolean;
|
|
949
|
+
/** @example 0.10 */
|
|
950
|
+
payoutFeeUsdt: string;
|
|
951
|
+
/** @example 1.00 */
|
|
952
|
+
minPayoutUsdt: string;
|
|
953
|
+
tagRequired: boolean;
|
|
954
|
+
/** @description Whether a payout of the requested amount can be sent on this network now. */
|
|
955
|
+
available: boolean;
|
|
956
|
+
};
|
|
957
|
+
CreateCryptoPayoutDto: {
|
|
958
|
+
/**
|
|
959
|
+
* @example POLYGON
|
|
960
|
+
* @enum {string}
|
|
961
|
+
*/
|
|
962
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1";
|
|
963
|
+
/** @example 0x9f3c4e1b2a7d6c5e4f3a2b1c0d9e8f7a6b5c4d3e */
|
|
964
|
+
address: string;
|
|
965
|
+
/** @description Destination tag / memo (required on TON). */
|
|
966
|
+
tag?: string;
|
|
967
|
+
/**
|
|
968
|
+
* @description Amount the destination receives, in USDT (max 2 decimals).
|
|
969
|
+
* @example 50.00
|
|
970
|
+
*/
|
|
971
|
+
amountUsdt: string;
|
|
972
|
+
/**
|
|
973
|
+
* @description Your customer reference, echoed on webhooks.
|
|
974
|
+
* @example user_123
|
|
975
|
+
*/
|
|
976
|
+
customerRef?: string;
|
|
977
|
+
/**
|
|
978
|
+
* @description Unique per payout. Replays return the same payout (200).
|
|
979
|
+
* @example withdrawal_8812
|
|
980
|
+
*/
|
|
981
|
+
idempotencyKey: string;
|
|
982
|
+
};
|
|
983
|
+
CryptoPayoutDto: {
|
|
984
|
+
id: string;
|
|
985
|
+
/** @example crypto.payout */
|
|
986
|
+
object: string;
|
|
987
|
+
/** @example USDT */
|
|
988
|
+
currency: string;
|
|
989
|
+
/** @enum {string} */
|
|
990
|
+
status: "pending" | "processing" | "completed" | "failed";
|
|
991
|
+
network: string;
|
|
992
|
+
address: string;
|
|
993
|
+
tag?: string;
|
|
994
|
+
/** @example 50.00 */
|
|
995
|
+
amountUsdt: string;
|
|
996
|
+
/**
|
|
997
|
+
* @description Network fee + margin (0 for internal).
|
|
998
|
+
* @example 0.10
|
|
999
|
+
*/
|
|
1000
|
+
feeUsdt: string;
|
|
1001
|
+
customerRef?: string;
|
|
1002
|
+
merchantId?: string;
|
|
1003
|
+
idempotencyKey: string;
|
|
1004
|
+
txHash?: string;
|
|
1005
|
+
/** @description Settled inside VEXPay (destination is one of your own deposit addresses). */
|
|
1006
|
+
internal: boolean;
|
|
1007
|
+
failureReason?: string;
|
|
1008
|
+
/** Format: date-time */
|
|
1009
|
+
createdAt: string;
|
|
1010
|
+
/** Format: date-time */
|
|
1011
|
+
completedAt?: string;
|
|
1012
|
+
};
|
|
895
1013
|
BankResponseDto: {
|
|
896
1014
|
/**
|
|
897
1015
|
* @description Canonical four-digit SIMF bank code.
|
|
@@ -933,7 +1051,7 @@ interface components {
|
|
|
933
1051
|
/** Format: date-time */
|
|
934
1052
|
fetchedAt: string;
|
|
935
1053
|
/**
|
|
936
|
-
* @description Per-source BCV rates or error objects (e.g. `{ error: "BANK_NOT_CONFIGURED" }`). Keys typically include `vexFx` and `bank`. `sources.bank`
|
|
1054
|
+
* @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
1055
|
* @example {
|
|
938
1056
|
* "vexFx": {
|
|
939
1057
|
* "rate": 36.5,
|
|
@@ -976,7 +1094,10 @@ interface components {
|
|
|
976
1094
|
* @example 50.00
|
|
977
1095
|
*/
|
|
978
1096
|
applicationFeeVes?: string;
|
|
979
|
-
/**
|
|
1097
|
+
/**
|
|
1098
|
+
* @description Optional percent of vesAmount used when applicationFeeVes is omitted. When both are omitted and merchantId is set, the merchant's commission (or the tenant default commission) applies.
|
|
1099
|
+
* @example 10
|
|
1100
|
+
*/
|
|
980
1101
|
applicationFeePercent?: number;
|
|
981
1102
|
};
|
|
982
1103
|
C2pIntentResponseDto: {
|
|
@@ -1057,7 +1178,7 @@ interface components {
|
|
|
1057
1178
|
* @description Use this value as intentId when executing the C2P charge.
|
|
1058
1179
|
*/
|
|
1059
1180
|
intentId: string;
|
|
1060
|
-
/** @description true when the provider instructed the payer bank to SMS an OTP to the customer
|
|
1181
|
+
/** @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
1182
|
otpRequested: boolean;
|
|
1062
1183
|
};
|
|
1063
1184
|
C2pPaymentDto: {
|
|
@@ -1098,7 +1219,7 @@ interface components {
|
|
|
1098
1219
|
*/
|
|
1099
1220
|
applicationFeeVes?: string;
|
|
1100
1221
|
/**
|
|
1101
|
-
* @description Optional percent of vesAmount used when applicationFeeVes is omitted.
|
|
1222
|
+
* @description Optional percent of vesAmount used when applicationFeeVes is omitted. When both are omitted and merchantId is set, the merchant's commission (or the tenant default commission) applies.
|
|
1102
1223
|
* @example 10
|
|
1103
1224
|
*/
|
|
1104
1225
|
applicationFeePercent?: number;
|
|
@@ -1232,7 +1353,10 @@ interface components {
|
|
|
1232
1353
|
* @example 50.00
|
|
1233
1354
|
*/
|
|
1234
1355
|
applicationFeeVes?: string;
|
|
1235
|
-
/**
|
|
1356
|
+
/**
|
|
1357
|
+
* @description Optional percent of vesAmount used when applicationFeeVes is omitted. When both are omitted and merchantId is set, the merchant's commission (or the tenant default commission) applies.
|
|
1358
|
+
* @example 10
|
|
1359
|
+
*/
|
|
1236
1360
|
applicationFeePercent?: number;
|
|
1237
1361
|
};
|
|
1238
1362
|
PagoMovilReceivingAccountDto: {
|
|
@@ -1285,18 +1409,18 @@ interface components {
|
|
|
1285
1409
|
*/
|
|
1286
1410
|
externalRef?: string;
|
|
1287
1411
|
/**
|
|
1288
|
-
* @description Payer bank SIMF code. Required
|
|
1412
|
+
* @description Payer bank SIMF code. Required for some receiving banks — send it whenever you have it.
|
|
1289
1413
|
* @example 0102
|
|
1290
1414
|
*/
|
|
1291
1415
|
debtorBankCode?: string;
|
|
1292
1416
|
/**
|
|
1293
|
-
* @description Instrument type
|
|
1417
|
+
* @description Instrument type, required by some receiving banks. Defaults to transferencia.
|
|
1294
1418
|
* @example transferencia
|
|
1295
1419
|
* @enum {string}
|
|
1296
1420
|
*/
|
|
1297
1421
|
txType?: "pago_movil" | "transferencia" | "debito_inmediato";
|
|
1298
1422
|
/**
|
|
1299
|
-
* @description Payer Pago Móvil phone
|
|
1423
|
+
* @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
1424
|
* @example 04149333844
|
|
1301
1425
|
*/
|
|
1302
1426
|
debtorCellPhone?: string;
|
|
@@ -1332,6 +1456,11 @@ interface components {
|
|
|
1332
1456
|
isActive: boolean;
|
|
1333
1457
|
/** @description When true, available balance is auto-paid to the default verified method. */
|
|
1334
1458
|
autoPayoutEnabled?: boolean;
|
|
1459
|
+
/**
|
|
1460
|
+
* @description Merchant-specific marketplace commission percent. null = the tenant's default commission applies.
|
|
1461
|
+
* @example 12.5
|
|
1462
|
+
*/
|
|
1463
|
+
applicationFeePercent?: number | null;
|
|
1335
1464
|
/** @description Default method bank code (compat) */
|
|
1336
1465
|
bankCode?: string;
|
|
1337
1466
|
/** @description Masked default method phone (compat) */
|
|
@@ -1511,6 +1640,11 @@ interface components {
|
|
|
1511
1640
|
isActive?: boolean;
|
|
1512
1641
|
/** @description When true, a cron job automatically pays available seller balance to the default verified Pago Móvil method. */
|
|
1513
1642
|
autoPayoutEnabled?: boolean;
|
|
1643
|
+
/**
|
|
1644
|
+
* @description Negotiated marketplace commission (percent of vesAmount) retained from payments tagged with this merchant when the request sends no applicationFeeVes / applicationFeePercent. null clears the override so the tenant's default commission applies.
|
|
1645
|
+
* @example 12.5
|
|
1646
|
+
*/
|
|
1647
|
+
applicationFeePercent?: number | null;
|
|
1514
1648
|
};
|
|
1515
1649
|
CreateCheckoutSessionDto: {
|
|
1516
1650
|
/**
|
|
@@ -1551,7 +1685,7 @@ interface components {
|
|
|
1551
1685
|
*/
|
|
1552
1686
|
allowedOrigins?: string[];
|
|
1553
1687
|
/** @description Payment methods offered. Defaults to every method your account can accept. */
|
|
1554
|
-
methods?: ("c2p" | "vpos")[];
|
|
1688
|
+
methods?: ("c2p" | "vpos" | "usdt")[];
|
|
1555
1689
|
/**
|
|
1556
1690
|
* @description Up to 20 string key/value pairs (keys ≤ 40 chars, values ≤ 500 chars).
|
|
1557
1691
|
* @example {
|
|
@@ -1587,7 +1721,7 @@ interface components {
|
|
|
1587
1721
|
[key: string]: string;
|
|
1588
1722
|
};
|
|
1589
1723
|
allowedOrigins: string[];
|
|
1590
|
-
methods: ("c2p" | "vpos")[];
|
|
1724
|
+
methods: ("c2p" | "vpos" | "usdt")[];
|
|
1591
1725
|
successUrl?: string | null;
|
|
1592
1726
|
cancelUrl?: string | null;
|
|
1593
1727
|
/** @description Latest payment for this session, once one exists. */
|
|
@@ -1728,6 +1862,15 @@ interface operations {
|
|
|
1728
1862
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1729
1863
|
};
|
|
1730
1864
|
};
|
|
1865
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
1866
|
+
403: {
|
|
1867
|
+
headers: {
|
|
1868
|
+
[name: string]: unknown;
|
|
1869
|
+
};
|
|
1870
|
+
content: {
|
|
1871
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1731
1874
|
/** @description Client error. */
|
|
1732
1875
|
"4XX": {
|
|
1733
1876
|
headers: {
|
|
@@ -1774,6 +1917,15 @@ interface operations {
|
|
|
1774
1917
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1775
1918
|
};
|
|
1776
1919
|
};
|
|
1920
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
1921
|
+
403: {
|
|
1922
|
+
headers: {
|
|
1923
|
+
[name: string]: unknown;
|
|
1924
|
+
};
|
|
1925
|
+
content: {
|
|
1926
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1927
|
+
};
|
|
1928
|
+
};
|
|
1777
1929
|
/** @description Client error. */
|
|
1778
1930
|
"4XX": {
|
|
1779
1931
|
headers: {
|
|
@@ -1827,6 +1979,15 @@ interface operations {
|
|
|
1827
1979
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1828
1980
|
};
|
|
1829
1981
|
};
|
|
1982
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
1983
|
+
403: {
|
|
1984
|
+
headers: {
|
|
1985
|
+
[name: string]: unknown;
|
|
1986
|
+
};
|
|
1987
|
+
content: {
|
|
1988
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1989
|
+
};
|
|
1990
|
+
};
|
|
1830
1991
|
/** @description Client error. */
|
|
1831
1992
|
"4XX": {
|
|
1832
1993
|
headers: {
|
|
@@ -1875,6 +2036,15 @@ interface operations {
|
|
|
1875
2036
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1876
2037
|
};
|
|
1877
2038
|
};
|
|
2039
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2040
|
+
403: {
|
|
2041
|
+
headers: {
|
|
2042
|
+
[name: string]: unknown;
|
|
2043
|
+
};
|
|
2044
|
+
content: {
|
|
2045
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2046
|
+
};
|
|
2047
|
+
};
|
|
1878
2048
|
404: {
|
|
1879
2049
|
headers: {
|
|
1880
2050
|
[name: string]: unknown;
|
|
@@ -1943,6 +2113,15 @@ interface operations {
|
|
|
1943
2113
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
1944
2114
|
};
|
|
1945
2115
|
};
|
|
2116
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2117
|
+
403: {
|
|
2118
|
+
headers: {
|
|
2119
|
+
[name: string]: unknown;
|
|
2120
|
+
};
|
|
2121
|
+
content: {
|
|
2122
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
1946
2125
|
404: {
|
|
1947
2126
|
headers: {
|
|
1948
2127
|
[name: string]: unknown;
|
|
@@ -2013,6 +2192,15 @@ interface operations {
|
|
|
2013
2192
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2014
2193
|
};
|
|
2015
2194
|
};
|
|
2195
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2196
|
+
403: {
|
|
2197
|
+
headers: {
|
|
2198
|
+
[name: string]: unknown;
|
|
2199
|
+
};
|
|
2200
|
+
content: {
|
|
2201
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2202
|
+
};
|
|
2203
|
+
};
|
|
2016
2204
|
/** @description Client error. */
|
|
2017
2205
|
"4XX": {
|
|
2018
2206
|
headers: {
|
|
@@ -2085,6 +2273,15 @@ interface operations {
|
|
|
2085
2273
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2086
2274
|
};
|
|
2087
2275
|
};
|
|
2276
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2277
|
+
403: {
|
|
2278
|
+
headers: {
|
|
2279
|
+
[name: string]: unknown;
|
|
2280
|
+
};
|
|
2281
|
+
content: {
|
|
2282
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2283
|
+
};
|
|
2284
|
+
};
|
|
2088
2285
|
/** @description external_ref_conflict, merchant_inactive, or related business conflict. */
|
|
2089
2286
|
409: {
|
|
2090
2287
|
headers: {
|
|
@@ -2166,6 +2363,15 @@ interface operations {
|
|
|
2166
2363
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2167
2364
|
};
|
|
2168
2365
|
};
|
|
2366
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2367
|
+
403: {
|
|
2368
|
+
headers: {
|
|
2369
|
+
[name: string]: unknown;
|
|
2370
|
+
};
|
|
2371
|
+
content: {
|
|
2372
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2373
|
+
};
|
|
2374
|
+
};
|
|
2169
2375
|
/** @description external_ref_conflict when the same key is reused with a different payload. */
|
|
2170
2376
|
409: {
|
|
2171
2377
|
headers: {
|
|
@@ -2247,6 +2453,15 @@ interface operations {
|
|
|
2247
2453
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2248
2454
|
};
|
|
2249
2455
|
};
|
|
2456
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2457
|
+
403: {
|
|
2458
|
+
headers: {
|
|
2459
|
+
[name: string]: unknown;
|
|
2460
|
+
};
|
|
2461
|
+
content: {
|
|
2462
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2463
|
+
};
|
|
2464
|
+
};
|
|
2250
2465
|
/** @description Batch external_ref_conflict when the same batch key is reused with a different payload. */
|
|
2251
2466
|
409: {
|
|
2252
2467
|
headers: {
|
|
@@ -2313,6 +2528,15 @@ interface operations {
|
|
|
2313
2528
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2314
2529
|
};
|
|
2315
2530
|
};
|
|
2531
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2532
|
+
403: {
|
|
2533
|
+
headers: {
|
|
2534
|
+
[name: string]: unknown;
|
|
2535
|
+
};
|
|
2536
|
+
content: {
|
|
2537
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2538
|
+
};
|
|
2539
|
+
};
|
|
2316
2540
|
/** @description No payout with that externalRef for this tenant. */
|
|
2317
2541
|
404: {
|
|
2318
2542
|
headers: {
|
|
@@ -2379,6 +2603,15 @@ interface operations {
|
|
|
2379
2603
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2380
2604
|
};
|
|
2381
2605
|
};
|
|
2606
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2607
|
+
403: {
|
|
2608
|
+
headers: {
|
|
2609
|
+
[name: string]: unknown;
|
|
2610
|
+
};
|
|
2611
|
+
content: {
|
|
2612
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2613
|
+
};
|
|
2614
|
+
};
|
|
2382
2615
|
404: {
|
|
2383
2616
|
headers: {
|
|
2384
2617
|
[name: string]: unknown;
|
|
@@ -2443,6 +2676,15 @@ interface operations {
|
|
|
2443
2676
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2444
2677
|
};
|
|
2445
2678
|
};
|
|
2679
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2680
|
+
403: {
|
|
2681
|
+
headers: {
|
|
2682
|
+
[name: string]: unknown;
|
|
2683
|
+
};
|
|
2684
|
+
content: {
|
|
2685
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2686
|
+
};
|
|
2687
|
+
};
|
|
2446
2688
|
/** @description Client error. */
|
|
2447
2689
|
"4XX": {
|
|
2448
2690
|
headers: {
|
|
@@ -2502,6 +2744,15 @@ interface operations {
|
|
|
2502
2744
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2503
2745
|
};
|
|
2504
2746
|
};
|
|
2747
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2748
|
+
403: {
|
|
2749
|
+
headers: {
|
|
2750
|
+
[name: string]: unknown;
|
|
2751
|
+
};
|
|
2752
|
+
content: {
|
|
2753
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2754
|
+
};
|
|
2755
|
+
};
|
|
2505
2756
|
/** @description Client error. */
|
|
2506
2757
|
"4XX": {
|
|
2507
2758
|
headers: {
|
|
@@ -2564,6 +2815,15 @@ interface operations {
|
|
|
2564
2815
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2565
2816
|
};
|
|
2566
2817
|
};
|
|
2818
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2819
|
+
403: {
|
|
2820
|
+
headers: {
|
|
2821
|
+
[name: string]: unknown;
|
|
2822
|
+
};
|
|
2823
|
+
content: {
|
|
2824
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2825
|
+
};
|
|
2826
|
+
};
|
|
2567
2827
|
/** @description Client error. */
|
|
2568
2828
|
"4XX": {
|
|
2569
2829
|
headers: {
|
|
@@ -2622,6 +2882,15 @@ interface operations {
|
|
|
2622
2882
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2623
2883
|
};
|
|
2624
2884
|
};
|
|
2885
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2886
|
+
403: {
|
|
2887
|
+
headers: {
|
|
2888
|
+
[name: string]: unknown;
|
|
2889
|
+
};
|
|
2890
|
+
content: {
|
|
2891
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2892
|
+
};
|
|
2893
|
+
};
|
|
2625
2894
|
/** @description already_verified or locked. */
|
|
2626
2895
|
409: {
|
|
2627
2896
|
headers: {
|
|
@@ -2702,6 +2971,15 @@ interface operations {
|
|
|
2702
2971
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2703
2972
|
};
|
|
2704
2973
|
};
|
|
2974
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
2975
|
+
403: {
|
|
2976
|
+
headers: {
|
|
2977
|
+
[name: string]: unknown;
|
|
2978
|
+
};
|
|
2979
|
+
content: {
|
|
2980
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2981
|
+
};
|
|
2982
|
+
};
|
|
2705
2983
|
/** @description amounts_mismatch. */
|
|
2706
2984
|
409: {
|
|
2707
2985
|
headers: {
|
|
@@ -2792,6 +3070,15 @@ interface operations {
|
|
|
2792
3070
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2793
3071
|
};
|
|
2794
3072
|
};
|
|
3073
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3074
|
+
403: {
|
|
3075
|
+
headers: {
|
|
3076
|
+
[name: string]: unknown;
|
|
3077
|
+
};
|
|
3078
|
+
content: {
|
|
3079
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3080
|
+
};
|
|
3081
|
+
};
|
|
2795
3082
|
/** @description The banking network rejected the operation. */
|
|
2796
3083
|
422: {
|
|
2797
3084
|
headers: {
|
|
@@ -2801,7 +3088,7 @@ interface operations {
|
|
|
2801
3088
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2802
3089
|
};
|
|
2803
3090
|
};
|
|
2804
|
-
/** @description Advanced payments
|
|
3091
|
+
/** @description Advanced payments are not available in this environment. */
|
|
2805
3092
|
503: {
|
|
2806
3093
|
headers: {
|
|
2807
3094
|
[name: string]: unknown;
|
|
@@ -2873,6 +3160,15 @@ interface operations {
|
|
|
2873
3160
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2874
3161
|
};
|
|
2875
3162
|
};
|
|
3163
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3164
|
+
403: {
|
|
3165
|
+
headers: {
|
|
3166
|
+
[name: string]: unknown;
|
|
3167
|
+
};
|
|
3168
|
+
content: {
|
|
3169
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3170
|
+
};
|
|
3171
|
+
};
|
|
2876
3172
|
/** @description The banking network rejected the operation. */
|
|
2877
3173
|
422: {
|
|
2878
3174
|
headers: {
|
|
@@ -2882,7 +3178,7 @@ interface operations {
|
|
|
2882
3178
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2883
3179
|
};
|
|
2884
3180
|
};
|
|
2885
|
-
/** @description Advanced payments
|
|
3181
|
+
/** @description Advanced payments are not available in this environment. */
|
|
2886
3182
|
503: {
|
|
2887
3183
|
headers: {
|
|
2888
3184
|
[name: string]: unknown;
|
|
@@ -2950,6 +3246,15 @@ interface operations {
|
|
|
2950
3246
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2951
3247
|
};
|
|
2952
3248
|
};
|
|
3249
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3250
|
+
403: {
|
|
3251
|
+
headers: {
|
|
3252
|
+
[name: string]: unknown;
|
|
3253
|
+
};
|
|
3254
|
+
content: {
|
|
3255
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3256
|
+
};
|
|
3257
|
+
};
|
|
2953
3258
|
/** @description The banking network rejected the operation. */
|
|
2954
3259
|
422: {
|
|
2955
3260
|
headers: {
|
|
@@ -2959,7 +3264,7 @@ interface operations {
|
|
|
2959
3264
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
2960
3265
|
};
|
|
2961
3266
|
};
|
|
2962
|
-
/** @description Advanced payments
|
|
3267
|
+
/** @description Advanced payments are not available in this environment. */
|
|
2963
3268
|
503: {
|
|
2964
3269
|
headers: {
|
|
2965
3270
|
[name: string]: unknown;
|
|
@@ -3030,6 +3335,15 @@ interface operations {
|
|
|
3030
3335
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3031
3336
|
};
|
|
3032
3337
|
};
|
|
3338
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3339
|
+
403: {
|
|
3340
|
+
headers: {
|
|
3341
|
+
[name: string]: unknown;
|
|
3342
|
+
};
|
|
3343
|
+
content: {
|
|
3344
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3345
|
+
};
|
|
3346
|
+
};
|
|
3033
3347
|
/** @description Entity not found for this tenant, or missing operation id. */
|
|
3034
3348
|
404: {
|
|
3035
3349
|
headers: {
|
|
@@ -3048,7 +3362,7 @@ interface operations {
|
|
|
3048
3362
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3049
3363
|
};
|
|
3050
3364
|
};
|
|
3051
|
-
/** @description Advanced payments
|
|
3365
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3052
3366
|
503: {
|
|
3053
3367
|
headers: {
|
|
3054
3368
|
[name: string]: unknown;
|
|
@@ -3119,6 +3433,15 @@ interface operations {
|
|
|
3119
3433
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3120
3434
|
};
|
|
3121
3435
|
};
|
|
3436
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3437
|
+
403: {
|
|
3438
|
+
headers: {
|
|
3439
|
+
[name: string]: unknown;
|
|
3440
|
+
};
|
|
3441
|
+
content: {
|
|
3442
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3443
|
+
};
|
|
3444
|
+
};
|
|
3122
3445
|
/** @description The banking network rejected the operation. */
|
|
3123
3446
|
422: {
|
|
3124
3447
|
headers: {
|
|
@@ -3128,7 +3451,7 @@ interface operations {
|
|
|
3128
3451
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3129
3452
|
};
|
|
3130
3453
|
};
|
|
3131
|
-
/** @description Advanced payments
|
|
3454
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3132
3455
|
503: {
|
|
3133
3456
|
headers: {
|
|
3134
3457
|
[name: string]: unknown;
|
|
@@ -3199,6 +3522,15 @@ interface operations {
|
|
|
3199
3522
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3200
3523
|
};
|
|
3201
3524
|
};
|
|
3525
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3526
|
+
403: {
|
|
3527
|
+
headers: {
|
|
3528
|
+
[name: string]: unknown;
|
|
3529
|
+
};
|
|
3530
|
+
content: {
|
|
3531
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3532
|
+
};
|
|
3533
|
+
};
|
|
3202
3534
|
/** @description The banking network rejected the operation. */
|
|
3203
3535
|
422: {
|
|
3204
3536
|
headers: {
|
|
@@ -3208,7 +3540,7 @@ interface operations {
|
|
|
3208
3540
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3209
3541
|
};
|
|
3210
3542
|
};
|
|
3211
|
-
/** @description Advanced payments
|
|
3543
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3212
3544
|
503: {
|
|
3213
3545
|
headers: {
|
|
3214
3546
|
[name: string]: unknown;
|
|
@@ -3279,6 +3611,15 @@ interface operations {
|
|
|
3279
3611
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3280
3612
|
};
|
|
3281
3613
|
};
|
|
3614
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3615
|
+
403: {
|
|
3616
|
+
headers: {
|
|
3617
|
+
[name: string]: unknown;
|
|
3618
|
+
};
|
|
3619
|
+
content: {
|
|
3620
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3621
|
+
};
|
|
3622
|
+
};
|
|
3282
3623
|
/** @description No completed PAGO_MOVIL payment found for the given referencia. */
|
|
3283
3624
|
404: {
|
|
3284
3625
|
headers: {
|
|
@@ -3306,7 +3647,7 @@ interface operations {
|
|
|
3306
3647
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3307
3648
|
};
|
|
3308
3649
|
};
|
|
3309
|
-
/** @description Advanced payments
|
|
3650
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3310
3651
|
503: {
|
|
3311
3652
|
headers: {
|
|
3312
3653
|
[name: string]: unknown;
|
|
@@ -3377,6 +3718,15 @@ interface operations {
|
|
|
3377
3718
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3378
3719
|
};
|
|
3379
3720
|
};
|
|
3721
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3722
|
+
403: {
|
|
3723
|
+
headers: {
|
|
3724
|
+
[name: string]: unknown;
|
|
3725
|
+
};
|
|
3726
|
+
content: {
|
|
3727
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3728
|
+
};
|
|
3729
|
+
};
|
|
3380
3730
|
/** @description The banking network rejected the operation. */
|
|
3381
3731
|
422: {
|
|
3382
3732
|
headers: {
|
|
@@ -3386,7 +3736,7 @@ interface operations {
|
|
|
3386
3736
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3387
3737
|
};
|
|
3388
3738
|
};
|
|
3389
|
-
/** @description Advanced payments
|
|
3739
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3390
3740
|
503: {
|
|
3391
3741
|
headers: {
|
|
3392
3742
|
[name: string]: unknown;
|
|
@@ -3457,6 +3807,15 @@ interface operations {
|
|
|
3457
3807
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3458
3808
|
};
|
|
3459
3809
|
};
|
|
3810
|
+
/** @description This method (débito or crédito) is not enabled on this account, or live mode is not activated (`live_mode_not_activated`). */
|
|
3811
|
+
403: {
|
|
3812
|
+
headers: {
|
|
3813
|
+
[name: string]: unknown;
|
|
3814
|
+
};
|
|
3815
|
+
content: {
|
|
3816
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3817
|
+
};
|
|
3818
|
+
};
|
|
3460
3819
|
/** @description The banking network rejected the operation. */
|
|
3461
3820
|
422: {
|
|
3462
3821
|
headers: {
|
|
@@ -3466,7 +3825,7 @@ interface operations {
|
|
|
3466
3825
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3467
3826
|
};
|
|
3468
3827
|
};
|
|
3469
|
-
/** @description Advanced payments
|
|
3828
|
+
/** @description Advanced payments are not available in this environment. */
|
|
3470
3829
|
503: {
|
|
3471
3830
|
headers: {
|
|
3472
3831
|
[name: string]: unknown;
|
|
@@ -3495,7 +3854,7 @@ interface operations {
|
|
|
3495
3854
|
};
|
|
3496
3855
|
};
|
|
3497
3856
|
};
|
|
3498
|
-
|
|
3857
|
+
Crypto_getBalance: {
|
|
3499
3858
|
parameters: {
|
|
3500
3859
|
query?: never;
|
|
3501
3860
|
header?: never;
|
|
@@ -3509,11 +3868,11 @@ interface operations {
|
|
|
3509
3868
|
[name: string]: unknown;
|
|
3510
3869
|
};
|
|
3511
3870
|
content: {
|
|
3512
|
-
"application/json": components["schemas"]["
|
|
3871
|
+
"application/json": components["schemas"]["CryptoBalanceDto"];
|
|
3513
3872
|
};
|
|
3514
3873
|
};
|
|
3515
|
-
/** @description
|
|
3516
|
-
|
|
3874
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
3875
|
+
401: {
|
|
3517
3876
|
headers: {
|
|
3518
3877
|
[name: string]: unknown;
|
|
3519
3878
|
};
|
|
@@ -3521,8 +3880,8 @@ interface operations {
|
|
|
3521
3880
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3522
3881
|
};
|
|
3523
3882
|
};
|
|
3524
|
-
/** @description
|
|
3525
|
-
|
|
3883
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
3884
|
+
403: {
|
|
3526
3885
|
headers: {
|
|
3527
3886
|
[name: string]: unknown;
|
|
3528
3887
|
};
|
|
@@ -3550,28 +3909,31 @@ interface operations {
|
|
|
3550
3909
|
};
|
|
3551
3910
|
};
|
|
3552
3911
|
};
|
|
3553
|
-
|
|
3912
|
+
Crypto_createDepositAddress: {
|
|
3554
3913
|
parameters: {
|
|
3555
|
-
query
|
|
3556
|
-
|
|
3557
|
-
|
|
3914
|
+
query?: never;
|
|
3915
|
+
header?: {
|
|
3916
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
3917
|
+
"Idempotency-Key"?: string;
|
|
3558
3918
|
};
|
|
3559
|
-
header?: never;
|
|
3560
3919
|
path?: never;
|
|
3561
3920
|
cookie?: never;
|
|
3562
3921
|
};
|
|
3563
|
-
requestBody
|
|
3922
|
+
requestBody: {
|
|
3923
|
+
content: {
|
|
3924
|
+
"application/json": components["schemas"]["CreateDepositAddressDto"];
|
|
3925
|
+
};
|
|
3926
|
+
};
|
|
3564
3927
|
responses: {
|
|
3565
|
-
/** @description bcvRate/vesAmount are authoritative for settlement; medianRate/medianVesAmount are for display. sources includes per-source rates or errors. */
|
|
3566
3928
|
200: {
|
|
3567
3929
|
headers: {
|
|
3568
3930
|
[name: string]: unknown;
|
|
3569
3931
|
};
|
|
3570
3932
|
content: {
|
|
3571
|
-
"application/json": components["schemas"]["
|
|
3933
|
+
"application/json": components["schemas"]["DepositAddressDto"];
|
|
3572
3934
|
};
|
|
3573
3935
|
};
|
|
3574
|
-
/** @description
|
|
3936
|
+
/** @description `unsupported_network` or invalid `customerRef`. */
|
|
3575
3937
|
400: {
|
|
3576
3938
|
headers: {
|
|
3577
3939
|
[name: string]: unknown;
|
|
@@ -3589,6 +3951,15 @@ interface operations {
|
|
|
3589
3951
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3590
3952
|
};
|
|
3591
3953
|
};
|
|
3954
|
+
/** @description `method_not_allowed` — USDT is not enabled for this account. */
|
|
3955
|
+
403: {
|
|
3956
|
+
headers: {
|
|
3957
|
+
[name: string]: unknown;
|
|
3958
|
+
};
|
|
3959
|
+
content: {
|
|
3960
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3961
|
+
};
|
|
3962
|
+
};
|
|
3592
3963
|
/** @description Client error. */
|
|
3593
3964
|
"4XX": {
|
|
3594
3965
|
headers: {
|
|
@@ -3609,9 +3980,354 @@ interface operations {
|
|
|
3609
3980
|
};
|
|
3610
3981
|
};
|
|
3611
3982
|
};
|
|
3612
|
-
|
|
3983
|
+
Crypto_listNetworks: {
|
|
3613
3984
|
parameters: {
|
|
3614
|
-
query?:
|
|
3985
|
+
query?: {
|
|
3986
|
+
amountUsdt?: string;
|
|
3987
|
+
};
|
|
3988
|
+
header?: never;
|
|
3989
|
+
path?: never;
|
|
3990
|
+
cookie?: never;
|
|
3991
|
+
};
|
|
3992
|
+
requestBody?: never;
|
|
3993
|
+
responses: {
|
|
3994
|
+
200: {
|
|
3995
|
+
headers: {
|
|
3996
|
+
[name: string]: unknown;
|
|
3997
|
+
};
|
|
3998
|
+
content: {
|
|
3999
|
+
"application/json": components["schemas"]["CryptoNetworkDto"][];
|
|
4000
|
+
};
|
|
4001
|
+
};
|
|
4002
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4003
|
+
401: {
|
|
4004
|
+
headers: {
|
|
4005
|
+
[name: string]: unknown;
|
|
4006
|
+
};
|
|
4007
|
+
content: {
|
|
4008
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4009
|
+
};
|
|
4010
|
+
};
|
|
4011
|
+
/** @description `method_not_allowed` — USDT is not enabled for this account. */
|
|
4012
|
+
403: {
|
|
4013
|
+
headers: {
|
|
4014
|
+
[name: string]: unknown;
|
|
4015
|
+
};
|
|
4016
|
+
content: {
|
|
4017
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4018
|
+
};
|
|
4019
|
+
};
|
|
4020
|
+
/** @description Client error. */
|
|
4021
|
+
"4XX": {
|
|
4022
|
+
headers: {
|
|
4023
|
+
[name: string]: unknown;
|
|
4024
|
+
};
|
|
4025
|
+
content: {
|
|
4026
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4027
|
+
};
|
|
4028
|
+
};
|
|
4029
|
+
/** @description Server or upstream bank error. */
|
|
4030
|
+
"5XX": {
|
|
4031
|
+
headers: {
|
|
4032
|
+
[name: string]: unknown;
|
|
4033
|
+
};
|
|
4034
|
+
content: {
|
|
4035
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4036
|
+
};
|
|
4037
|
+
};
|
|
4038
|
+
};
|
|
4039
|
+
};
|
|
4040
|
+
Crypto_createPayout: {
|
|
4041
|
+
parameters: {
|
|
4042
|
+
query?: never;
|
|
4043
|
+
header?: {
|
|
4044
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
4045
|
+
"Idempotency-Key"?: string;
|
|
4046
|
+
};
|
|
4047
|
+
path?: never;
|
|
4048
|
+
cookie?: never;
|
|
4049
|
+
};
|
|
4050
|
+
requestBody: {
|
|
4051
|
+
content: {
|
|
4052
|
+
"application/json": components["schemas"]["CreateCryptoPayoutDto"];
|
|
4053
|
+
};
|
|
4054
|
+
};
|
|
4055
|
+
responses: {
|
|
4056
|
+
/** @description Idempotent replay of an existing payout. */
|
|
4057
|
+
200: {
|
|
4058
|
+
headers: {
|
|
4059
|
+
[name: string]: unknown;
|
|
4060
|
+
};
|
|
4061
|
+
content: {
|
|
4062
|
+
"application/json": components["schemas"]["CryptoPayoutDto"];
|
|
4063
|
+
};
|
|
4064
|
+
};
|
|
4065
|
+
/** @description Payout created. */
|
|
4066
|
+
201: {
|
|
4067
|
+
headers: {
|
|
4068
|
+
[name: string]: unknown;
|
|
4069
|
+
};
|
|
4070
|
+
content: {
|
|
4071
|
+
"application/json": components["schemas"]["CryptoPayoutDto"];
|
|
4072
|
+
};
|
|
4073
|
+
};
|
|
4074
|
+
/** @description `unsupported_network`, `invalid_address` or `invalid_data`. */
|
|
4075
|
+
400: {
|
|
4076
|
+
headers: {
|
|
4077
|
+
[name: string]: unknown;
|
|
4078
|
+
};
|
|
4079
|
+
content: {
|
|
4080
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4081
|
+
};
|
|
4082
|
+
};
|
|
4083
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4084
|
+
401: {
|
|
4085
|
+
headers: {
|
|
4086
|
+
[name: string]: unknown;
|
|
4087
|
+
};
|
|
4088
|
+
content: {
|
|
4089
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4090
|
+
};
|
|
4091
|
+
};
|
|
4092
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4093
|
+
403: {
|
|
4094
|
+
headers: {
|
|
4095
|
+
[name: string]: unknown;
|
|
4096
|
+
};
|
|
4097
|
+
content: {
|
|
4098
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4099
|
+
};
|
|
4100
|
+
};
|
|
4101
|
+
/** @description `idempotency_key_reused` with a different request. */
|
|
4102
|
+
409: {
|
|
4103
|
+
headers: {
|
|
4104
|
+
[name: string]: unknown;
|
|
4105
|
+
};
|
|
4106
|
+
content: {
|
|
4107
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4108
|
+
};
|
|
4109
|
+
};
|
|
4110
|
+
/** @description `insufficient_balance` or `amount_below_minimum`. */
|
|
4111
|
+
422: {
|
|
4112
|
+
headers: {
|
|
4113
|
+
[name: string]: unknown;
|
|
4114
|
+
};
|
|
4115
|
+
content: {
|
|
4116
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4117
|
+
};
|
|
4118
|
+
};
|
|
4119
|
+
/** @description Client error. */
|
|
4120
|
+
"4XX": {
|
|
4121
|
+
headers: {
|
|
4122
|
+
[name: string]: unknown;
|
|
4123
|
+
};
|
|
4124
|
+
content: {
|
|
4125
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4126
|
+
};
|
|
4127
|
+
};
|
|
4128
|
+
/** @description Server or upstream bank error. */
|
|
4129
|
+
"5XX": {
|
|
4130
|
+
headers: {
|
|
4131
|
+
[name: string]: unknown;
|
|
4132
|
+
};
|
|
4133
|
+
content: {
|
|
4134
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4135
|
+
};
|
|
4136
|
+
};
|
|
4137
|
+
};
|
|
4138
|
+
};
|
|
4139
|
+
Crypto_getPayout: {
|
|
4140
|
+
parameters: {
|
|
4141
|
+
query?: never;
|
|
4142
|
+
header?: never;
|
|
4143
|
+
path: {
|
|
4144
|
+
id: string;
|
|
4145
|
+
};
|
|
4146
|
+
cookie?: never;
|
|
4147
|
+
};
|
|
4148
|
+
requestBody?: never;
|
|
4149
|
+
responses: {
|
|
4150
|
+
200: {
|
|
4151
|
+
headers: {
|
|
4152
|
+
[name: string]: unknown;
|
|
4153
|
+
};
|
|
4154
|
+
content: {
|
|
4155
|
+
"application/json": components["schemas"]["CryptoPayoutDto"];
|
|
4156
|
+
};
|
|
4157
|
+
};
|
|
4158
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4159
|
+
401: {
|
|
4160
|
+
headers: {
|
|
4161
|
+
[name: string]: unknown;
|
|
4162
|
+
};
|
|
4163
|
+
content: {
|
|
4164
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4165
|
+
};
|
|
4166
|
+
};
|
|
4167
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4168
|
+
403: {
|
|
4169
|
+
headers: {
|
|
4170
|
+
[name: string]: unknown;
|
|
4171
|
+
};
|
|
4172
|
+
content: {
|
|
4173
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4174
|
+
};
|
|
4175
|
+
};
|
|
4176
|
+
/** @description Client error. */
|
|
4177
|
+
"4XX": {
|
|
4178
|
+
headers: {
|
|
4179
|
+
[name: string]: unknown;
|
|
4180
|
+
};
|
|
4181
|
+
content: {
|
|
4182
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4183
|
+
};
|
|
4184
|
+
};
|
|
4185
|
+
/** @description Server or upstream bank error. */
|
|
4186
|
+
"5XX": {
|
|
4187
|
+
headers: {
|
|
4188
|
+
[name: string]: unknown;
|
|
4189
|
+
};
|
|
4190
|
+
content: {
|
|
4191
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4192
|
+
};
|
|
4193
|
+
};
|
|
4194
|
+
};
|
|
4195
|
+
};
|
|
4196
|
+
Payments_getBanks: {
|
|
4197
|
+
parameters: {
|
|
4198
|
+
query?: never;
|
|
4199
|
+
header?: never;
|
|
4200
|
+
path?: never;
|
|
4201
|
+
cookie?: never;
|
|
4202
|
+
};
|
|
4203
|
+
requestBody?: never;
|
|
4204
|
+
responses: {
|
|
4205
|
+
200: {
|
|
4206
|
+
headers: {
|
|
4207
|
+
[name: string]: unknown;
|
|
4208
|
+
};
|
|
4209
|
+
content: {
|
|
4210
|
+
"application/json": components["schemas"]["BankResponseDto"][];
|
|
4211
|
+
};
|
|
4212
|
+
};
|
|
4213
|
+
/** @description Invalid request or unsupported operation. */
|
|
4214
|
+
400: {
|
|
4215
|
+
headers: {
|
|
4216
|
+
[name: string]: unknown;
|
|
4217
|
+
};
|
|
4218
|
+
content: {
|
|
4219
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4220
|
+
};
|
|
4221
|
+
};
|
|
4222
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4223
|
+
401: {
|
|
4224
|
+
headers: {
|
|
4225
|
+
[name: string]: unknown;
|
|
4226
|
+
};
|
|
4227
|
+
content: {
|
|
4228
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4229
|
+
};
|
|
4230
|
+
};
|
|
4231
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4232
|
+
403: {
|
|
4233
|
+
headers: {
|
|
4234
|
+
[name: string]: unknown;
|
|
4235
|
+
};
|
|
4236
|
+
content: {
|
|
4237
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4238
|
+
};
|
|
4239
|
+
};
|
|
4240
|
+
/** @description Client error. */
|
|
4241
|
+
"4XX": {
|
|
4242
|
+
headers: {
|
|
4243
|
+
[name: string]: unknown;
|
|
4244
|
+
};
|
|
4245
|
+
content: {
|
|
4246
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4247
|
+
};
|
|
4248
|
+
};
|
|
4249
|
+
/** @description Server or upstream bank error. */
|
|
4250
|
+
"5XX": {
|
|
4251
|
+
headers: {
|
|
4252
|
+
[name: string]: unknown;
|
|
4253
|
+
};
|
|
4254
|
+
content: {
|
|
4255
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4256
|
+
};
|
|
4257
|
+
};
|
|
4258
|
+
};
|
|
4259
|
+
};
|
|
4260
|
+
Payments_getQuote: {
|
|
4261
|
+
parameters: {
|
|
4262
|
+
query: {
|
|
4263
|
+
/** @description Positive USD amount to convert. Must be a finite number greater than zero. */
|
|
4264
|
+
usdAmount: number;
|
|
4265
|
+
};
|
|
4266
|
+
header?: never;
|
|
4267
|
+
path?: never;
|
|
4268
|
+
cookie?: never;
|
|
4269
|
+
};
|
|
4270
|
+
requestBody?: never;
|
|
4271
|
+
responses: {
|
|
4272
|
+
/** @description bcvRate/vesAmount are authoritative for settlement; medianRate/medianVesAmount are for display. sources includes per-source rates or errors. */
|
|
4273
|
+
200: {
|
|
4274
|
+
headers: {
|
|
4275
|
+
[name: string]: unknown;
|
|
4276
|
+
};
|
|
4277
|
+
content: {
|
|
4278
|
+
"application/json": components["schemas"]["QuoteResponseDto"];
|
|
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"];
|
|
4288
|
+
};
|
|
4289
|
+
};
|
|
4290
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
4291
|
+
401: {
|
|
4292
|
+
headers: {
|
|
4293
|
+
[name: string]: unknown;
|
|
4294
|
+
};
|
|
4295
|
+
content: {
|
|
4296
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4297
|
+
};
|
|
4298
|
+
};
|
|
4299
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4300
|
+
403: {
|
|
4301
|
+
headers: {
|
|
4302
|
+
[name: string]: unknown;
|
|
4303
|
+
};
|
|
4304
|
+
content: {
|
|
4305
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4306
|
+
};
|
|
4307
|
+
};
|
|
4308
|
+
/** @description Client error. */
|
|
4309
|
+
"4XX": {
|
|
4310
|
+
headers: {
|
|
4311
|
+
[name: string]: unknown;
|
|
4312
|
+
};
|
|
4313
|
+
content: {
|
|
4314
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4315
|
+
};
|
|
4316
|
+
};
|
|
4317
|
+
/** @description Server or upstream bank error. */
|
|
4318
|
+
"5XX": {
|
|
4319
|
+
headers: {
|
|
4320
|
+
[name: string]: unknown;
|
|
4321
|
+
};
|
|
4322
|
+
content: {
|
|
4323
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4324
|
+
};
|
|
4325
|
+
};
|
|
4326
|
+
};
|
|
4327
|
+
};
|
|
4328
|
+
Payments_requestC2p: {
|
|
4329
|
+
parameters: {
|
|
4330
|
+
query?: never;
|
|
3615
4331
|
header?: {
|
|
3616
4332
|
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
3617
4333
|
"Idempotency-Key"?: string;
|
|
@@ -3651,6 +4367,15 @@ interface operations {
|
|
|
3651
4367
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3652
4368
|
};
|
|
3653
4369
|
};
|
|
4370
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4371
|
+
403: {
|
|
4372
|
+
headers: {
|
|
4373
|
+
[name: string]: unknown;
|
|
4374
|
+
};
|
|
4375
|
+
content: {
|
|
4376
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4377
|
+
};
|
|
4378
|
+
};
|
|
3654
4379
|
/** @description Client error. */
|
|
3655
4380
|
"4XX": {
|
|
3656
4381
|
headers: {
|
|
@@ -3714,6 +4439,15 @@ interface operations {
|
|
|
3714
4439
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3715
4440
|
};
|
|
3716
4441
|
};
|
|
4442
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4443
|
+
403: {
|
|
4444
|
+
headers: {
|
|
4445
|
+
[name: string]: unknown;
|
|
4446
|
+
};
|
|
4447
|
+
content: {
|
|
4448
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4449
|
+
};
|
|
4450
|
+
};
|
|
3717
4451
|
/** @description The supplied intent does not exist or is no longer pending. */
|
|
3718
4452
|
404: {
|
|
3719
4453
|
headers: {
|
|
@@ -3794,6 +4528,15 @@ interface operations {
|
|
|
3794
4528
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3795
4529
|
};
|
|
3796
4530
|
};
|
|
4531
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4532
|
+
403: {
|
|
4533
|
+
headers: {
|
|
4534
|
+
[name: string]: unknown;
|
|
4535
|
+
};
|
|
4536
|
+
content: {
|
|
4537
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4538
|
+
};
|
|
4539
|
+
};
|
|
3797
4540
|
/** @description The provider rejected the charge. */
|
|
3798
4541
|
422: {
|
|
3799
4542
|
headers: {
|
|
@@ -3867,6 +4610,15 @@ interface operations {
|
|
|
3867
4610
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3868
4611
|
};
|
|
3869
4612
|
};
|
|
4613
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4614
|
+
403: {
|
|
4615
|
+
headers: {
|
|
4616
|
+
[name: string]: unknown;
|
|
4617
|
+
};
|
|
4618
|
+
content: {
|
|
4619
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4620
|
+
};
|
|
4621
|
+
};
|
|
3870
4622
|
/** @description Client error. */
|
|
3871
4623
|
"4XX": {
|
|
3872
4624
|
headers: {
|
|
@@ -3929,6 +4681,15 @@ interface operations {
|
|
|
3929
4681
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3930
4682
|
};
|
|
3931
4683
|
};
|
|
4684
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4685
|
+
403: {
|
|
4686
|
+
headers: {
|
|
4687
|
+
[name: string]: unknown;
|
|
4688
|
+
};
|
|
4689
|
+
content: {
|
|
4690
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4691
|
+
};
|
|
4692
|
+
};
|
|
3932
4693
|
/** @description Client error. */
|
|
3933
4694
|
"4XX": {
|
|
3934
4695
|
headers: {
|
|
@@ -3986,6 +4747,15 @@ interface operations {
|
|
|
3986
4747
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3987
4748
|
};
|
|
3988
4749
|
};
|
|
4750
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4751
|
+
403: {
|
|
4752
|
+
headers: {
|
|
4753
|
+
[name: string]: unknown;
|
|
4754
|
+
};
|
|
4755
|
+
content: {
|
|
4756
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4757
|
+
};
|
|
4758
|
+
};
|
|
3989
4759
|
404: {
|
|
3990
4760
|
headers: {
|
|
3991
4761
|
[name: string]: unknown;
|
|
@@ -4051,6 +4821,15 @@ interface operations {
|
|
|
4051
4821
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4052
4822
|
};
|
|
4053
4823
|
};
|
|
4824
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4825
|
+
403: {
|
|
4826
|
+
headers: {
|
|
4827
|
+
[name: string]: unknown;
|
|
4828
|
+
};
|
|
4829
|
+
content: {
|
|
4830
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4831
|
+
};
|
|
4832
|
+
};
|
|
4054
4833
|
404: {
|
|
4055
4834
|
headers: {
|
|
4056
4835
|
[name: string]: unknown;
|
|
@@ -4119,6 +4898,15 @@ interface operations {
|
|
|
4119
4898
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4120
4899
|
};
|
|
4121
4900
|
};
|
|
4901
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4902
|
+
403: {
|
|
4903
|
+
headers: {
|
|
4904
|
+
[name: string]: unknown;
|
|
4905
|
+
};
|
|
4906
|
+
content: {
|
|
4907
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4908
|
+
};
|
|
4909
|
+
};
|
|
4122
4910
|
404: {
|
|
4123
4911
|
headers: {
|
|
4124
4912
|
[name: string]: unknown;
|
|
@@ -4194,6 +4982,15 @@ interface operations {
|
|
|
4194
4982
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4195
4983
|
};
|
|
4196
4984
|
};
|
|
4985
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
4986
|
+
403: {
|
|
4987
|
+
headers: {
|
|
4988
|
+
[name: string]: unknown;
|
|
4989
|
+
};
|
|
4990
|
+
content: {
|
|
4991
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4992
|
+
};
|
|
4993
|
+
};
|
|
4197
4994
|
/** @description Returned when externalRef is set and no merchant matches. */
|
|
4198
4995
|
404: {
|
|
4199
4996
|
headers: {
|
|
@@ -4275,6 +5072,15 @@ interface operations {
|
|
|
4275
5072
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4276
5073
|
};
|
|
4277
5074
|
};
|
|
5075
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5076
|
+
403: {
|
|
5077
|
+
headers: {
|
|
5078
|
+
[name: string]: unknown;
|
|
5079
|
+
};
|
|
5080
|
+
content: {
|
|
5081
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5082
|
+
};
|
|
5083
|
+
};
|
|
4278
5084
|
/** @description external_ref_conflict when the same key is reused with a different payload. */
|
|
4279
5085
|
409: {
|
|
4280
5086
|
headers: {
|
|
@@ -4342,6 +5148,15 @@ interface operations {
|
|
|
4342
5148
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4343
5149
|
};
|
|
4344
5150
|
};
|
|
5151
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5152
|
+
403: {
|
|
5153
|
+
headers: {
|
|
5154
|
+
[name: string]: unknown;
|
|
5155
|
+
};
|
|
5156
|
+
content: {
|
|
5157
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5158
|
+
};
|
|
5159
|
+
};
|
|
4345
5160
|
404: {
|
|
4346
5161
|
headers: {
|
|
4347
5162
|
[name: string]: unknown;
|
|
@@ -4414,6 +5229,15 @@ interface operations {
|
|
|
4414
5229
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4415
5230
|
};
|
|
4416
5231
|
};
|
|
5232
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5233
|
+
403: {
|
|
5234
|
+
headers: {
|
|
5235
|
+
[name: string]: unknown;
|
|
5236
|
+
};
|
|
5237
|
+
content: {
|
|
5238
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5239
|
+
};
|
|
5240
|
+
};
|
|
4417
5241
|
404: {
|
|
4418
5242
|
headers: {
|
|
4419
5243
|
[name: string]: unknown;
|
|
@@ -4483,6 +5307,15 @@ interface operations {
|
|
|
4483
5307
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4484
5308
|
};
|
|
4485
5309
|
};
|
|
5310
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5311
|
+
403: {
|
|
5312
|
+
headers: {
|
|
5313
|
+
[name: string]: unknown;
|
|
5314
|
+
};
|
|
5315
|
+
content: {
|
|
5316
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5317
|
+
};
|
|
5318
|
+
};
|
|
4486
5319
|
404: {
|
|
4487
5320
|
headers: {
|
|
4488
5321
|
[name: string]: unknown;
|
|
@@ -4548,6 +5381,15 @@ interface operations {
|
|
|
4548
5381
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4549
5382
|
};
|
|
4550
5383
|
};
|
|
5384
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5385
|
+
403: {
|
|
5386
|
+
headers: {
|
|
5387
|
+
[name: string]: unknown;
|
|
5388
|
+
};
|
|
5389
|
+
content: {
|
|
5390
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5391
|
+
};
|
|
5392
|
+
};
|
|
4551
5393
|
404: {
|
|
4552
5394
|
headers: {
|
|
4553
5395
|
[name: string]: unknown;
|
|
@@ -4618,6 +5460,15 @@ interface operations {
|
|
|
4618
5460
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4619
5461
|
};
|
|
4620
5462
|
};
|
|
5463
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5464
|
+
403: {
|
|
5465
|
+
headers: {
|
|
5466
|
+
[name: string]: unknown;
|
|
5467
|
+
};
|
|
5468
|
+
content: {
|
|
5469
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5470
|
+
};
|
|
5471
|
+
};
|
|
4621
5472
|
404: {
|
|
4622
5473
|
headers: {
|
|
4623
5474
|
[name: string]: unknown;
|
|
@@ -4700,6 +5551,15 @@ interface operations {
|
|
|
4700
5551
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4701
5552
|
};
|
|
4702
5553
|
};
|
|
5554
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5555
|
+
403: {
|
|
5556
|
+
headers: {
|
|
5557
|
+
[name: string]: unknown;
|
|
5558
|
+
};
|
|
5559
|
+
content: {
|
|
5560
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5561
|
+
};
|
|
5562
|
+
};
|
|
4703
5563
|
404: {
|
|
4704
5564
|
headers: {
|
|
4705
5565
|
[name: string]: unknown;
|
|
@@ -4774,6 +5634,15 @@ interface operations {
|
|
|
4774
5634
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4775
5635
|
};
|
|
4776
5636
|
};
|
|
5637
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5638
|
+
403: {
|
|
5639
|
+
headers: {
|
|
5640
|
+
[name: string]: unknown;
|
|
5641
|
+
};
|
|
5642
|
+
content: {
|
|
5643
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5644
|
+
};
|
|
5645
|
+
};
|
|
4777
5646
|
404: {
|
|
4778
5647
|
headers: {
|
|
4779
5648
|
[name: string]: unknown;
|
|
@@ -4846,6 +5715,15 @@ interface operations {
|
|
|
4846
5715
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4847
5716
|
};
|
|
4848
5717
|
};
|
|
5718
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5719
|
+
403: {
|
|
5720
|
+
headers: {
|
|
5721
|
+
[name: string]: unknown;
|
|
5722
|
+
};
|
|
5723
|
+
content: {
|
|
5724
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5725
|
+
};
|
|
5726
|
+
};
|
|
4849
5727
|
404: {
|
|
4850
5728
|
headers: {
|
|
4851
5729
|
[name: string]: unknown;
|
|
@@ -4911,6 +5789,15 @@ interface operations {
|
|
|
4911
5789
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4912
5790
|
};
|
|
4913
5791
|
};
|
|
5792
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5793
|
+
403: {
|
|
5794
|
+
headers: {
|
|
5795
|
+
[name: string]: unknown;
|
|
5796
|
+
};
|
|
5797
|
+
content: {
|
|
5798
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5799
|
+
};
|
|
5800
|
+
};
|
|
4914
5801
|
404: {
|
|
4915
5802
|
headers: {
|
|
4916
5803
|
[name: string]: unknown;
|
|
@@ -4976,6 +5863,15 @@ interface operations {
|
|
|
4976
5863
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4977
5864
|
};
|
|
4978
5865
|
};
|
|
5866
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5867
|
+
403: {
|
|
5868
|
+
headers: {
|
|
5869
|
+
[name: string]: unknown;
|
|
5870
|
+
};
|
|
5871
|
+
content: {
|
|
5872
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5873
|
+
};
|
|
5874
|
+
};
|
|
4979
5875
|
/** @description Merchant not found for this tenant. */
|
|
4980
5876
|
404: {
|
|
4981
5877
|
headers: {
|
|
@@ -5055,6 +5951,15 @@ interface operations {
|
|
|
5055
5951
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5056
5952
|
};
|
|
5057
5953
|
};
|
|
5954
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
5955
|
+
403: {
|
|
5956
|
+
headers: {
|
|
5957
|
+
[name: string]: unknown;
|
|
5958
|
+
};
|
|
5959
|
+
content: {
|
|
5960
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5961
|
+
};
|
|
5962
|
+
};
|
|
5058
5963
|
404: {
|
|
5059
5964
|
headers: {
|
|
5060
5965
|
[name: string]: unknown;
|
|
@@ -5120,6 +6025,15 @@ interface operations {
|
|
|
5120
6025
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5121
6026
|
};
|
|
5122
6027
|
};
|
|
6028
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6029
|
+
403: {
|
|
6030
|
+
headers: {
|
|
6031
|
+
[name: string]: unknown;
|
|
6032
|
+
};
|
|
6033
|
+
content: {
|
|
6034
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6035
|
+
};
|
|
6036
|
+
};
|
|
5123
6037
|
404: {
|
|
5124
6038
|
headers: {
|
|
5125
6039
|
[name: string]: unknown;
|
|
@@ -5188,6 +6102,15 @@ interface operations {
|
|
|
5188
6102
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5189
6103
|
};
|
|
5190
6104
|
};
|
|
6105
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6106
|
+
403: {
|
|
6107
|
+
headers: {
|
|
6108
|
+
[name: string]: unknown;
|
|
6109
|
+
};
|
|
6110
|
+
content: {
|
|
6111
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6112
|
+
};
|
|
6113
|
+
};
|
|
5191
6114
|
404: {
|
|
5192
6115
|
headers: {
|
|
5193
6116
|
[name: string]: unknown;
|
|
@@ -5260,6 +6183,15 @@ interface operations {
|
|
|
5260
6183
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5261
6184
|
};
|
|
5262
6185
|
};
|
|
6186
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6187
|
+
403: {
|
|
6188
|
+
headers: {
|
|
6189
|
+
[name: string]: unknown;
|
|
6190
|
+
};
|
|
6191
|
+
content: {
|
|
6192
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6193
|
+
};
|
|
6194
|
+
};
|
|
5263
6195
|
404: {
|
|
5264
6196
|
headers: {
|
|
5265
6197
|
[name: string]: unknown;
|
|
@@ -5330,6 +6262,15 @@ interface operations {
|
|
|
5330
6262
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5331
6263
|
};
|
|
5332
6264
|
};
|
|
6265
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6266
|
+
403: {
|
|
6267
|
+
headers: {
|
|
6268
|
+
[name: string]: unknown;
|
|
6269
|
+
};
|
|
6270
|
+
content: {
|
|
6271
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6272
|
+
};
|
|
6273
|
+
};
|
|
5333
6274
|
/** @description amount_below_minimum */
|
|
5334
6275
|
422: {
|
|
5335
6276
|
headers: {
|
|
@@ -5387,6 +6328,15 @@ interface operations {
|
|
|
5387
6328
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5388
6329
|
};
|
|
5389
6330
|
};
|
|
6331
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6332
|
+
403: {
|
|
6333
|
+
headers: {
|
|
6334
|
+
[name: string]: unknown;
|
|
6335
|
+
};
|
|
6336
|
+
content: {
|
|
6337
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6338
|
+
};
|
|
6339
|
+
};
|
|
5390
6340
|
404: {
|
|
5391
6341
|
headers: {
|
|
5392
6342
|
[name: string]: unknown;
|
|
@@ -5454,6 +6404,15 @@ interface operations {
|
|
|
5454
6404
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5455
6405
|
};
|
|
5456
6406
|
};
|
|
6407
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6408
|
+
403: {
|
|
6409
|
+
headers: {
|
|
6410
|
+
[name: string]: unknown;
|
|
6411
|
+
};
|
|
6412
|
+
content: {
|
|
6413
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6414
|
+
};
|
|
6415
|
+
};
|
|
5457
6416
|
/** @description Client error. */
|
|
5458
6417
|
"4XX": {
|
|
5459
6418
|
headers: {
|
|
@@ -5516,6 +6475,15 @@ interface operations {
|
|
|
5516
6475
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5517
6476
|
};
|
|
5518
6477
|
};
|
|
6478
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6479
|
+
403: {
|
|
6480
|
+
headers: {
|
|
6481
|
+
[name: string]: unknown;
|
|
6482
|
+
};
|
|
6483
|
+
content: {
|
|
6484
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6485
|
+
};
|
|
6486
|
+
};
|
|
5519
6487
|
/** @description Client error. */
|
|
5520
6488
|
"4XX": {
|
|
5521
6489
|
headers: {
|
|
@@ -5573,6 +6541,15 @@ interface operations {
|
|
|
5573
6541
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5574
6542
|
};
|
|
5575
6543
|
};
|
|
6544
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6545
|
+
403: {
|
|
6546
|
+
headers: {
|
|
6547
|
+
[name: string]: unknown;
|
|
6548
|
+
};
|
|
6549
|
+
content: {
|
|
6550
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6551
|
+
};
|
|
6552
|
+
};
|
|
5576
6553
|
404: {
|
|
5577
6554
|
headers: {
|
|
5578
6555
|
[name: string]: unknown;
|
|
@@ -5630,6 +6607,15 @@ interface operations {
|
|
|
5630
6607
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5631
6608
|
};
|
|
5632
6609
|
};
|
|
6610
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6611
|
+
403: {
|
|
6612
|
+
headers: {
|
|
6613
|
+
[name: string]: unknown;
|
|
6614
|
+
};
|
|
6615
|
+
content: {
|
|
6616
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6617
|
+
};
|
|
6618
|
+
};
|
|
5633
6619
|
404: {
|
|
5634
6620
|
headers: {
|
|
5635
6621
|
[name: string]: unknown;
|
|
@@ -5708,6 +6694,15 @@ interface operations {
|
|
|
5708
6694
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5709
6695
|
};
|
|
5710
6696
|
};
|
|
6697
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6698
|
+
403: {
|
|
6699
|
+
headers: {
|
|
6700
|
+
[name: string]: unknown;
|
|
6701
|
+
};
|
|
6702
|
+
content: {
|
|
6703
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6704
|
+
};
|
|
6705
|
+
};
|
|
5711
6706
|
404: {
|
|
5712
6707
|
headers: {
|
|
5713
6708
|
[name: string]: unknown;
|
|
@@ -5773,6 +6768,15 @@ interface operations {
|
|
|
5773
6768
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5774
6769
|
};
|
|
5775
6770
|
};
|
|
6771
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6772
|
+
403: {
|
|
6773
|
+
headers: {
|
|
6774
|
+
[name: string]: unknown;
|
|
6775
|
+
};
|
|
6776
|
+
content: {
|
|
6777
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6778
|
+
};
|
|
6779
|
+
};
|
|
5776
6780
|
404: {
|
|
5777
6781
|
headers: {
|
|
5778
6782
|
[name: string]: unknown;
|
|
@@ -5845,6 +6849,15 @@ interface operations {
|
|
|
5845
6849
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5846
6850
|
};
|
|
5847
6851
|
};
|
|
6852
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6853
|
+
403: {
|
|
6854
|
+
headers: {
|
|
6855
|
+
[name: string]: unknown;
|
|
6856
|
+
};
|
|
6857
|
+
content: {
|
|
6858
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6859
|
+
};
|
|
6860
|
+
};
|
|
5848
6861
|
404: {
|
|
5849
6862
|
headers: {
|
|
5850
6863
|
[name: string]: unknown;
|
|
@@ -5910,6 +6923,15 @@ interface operations {
|
|
|
5910
6923
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5911
6924
|
};
|
|
5912
6925
|
};
|
|
6926
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6927
|
+
403: {
|
|
6928
|
+
headers: {
|
|
6929
|
+
[name: string]: unknown;
|
|
6930
|
+
};
|
|
6931
|
+
content: {
|
|
6932
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6933
|
+
};
|
|
6934
|
+
};
|
|
5913
6935
|
404: {
|
|
5914
6936
|
headers: {
|
|
5915
6937
|
[name: string]: unknown;
|
|
@@ -5958,6 +6980,15 @@ interface operations {
|
|
|
5958
6980
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5959
6981
|
};
|
|
5960
6982
|
};
|
|
6983
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
6984
|
+
403: {
|
|
6985
|
+
headers: {
|
|
6986
|
+
[name: string]: unknown;
|
|
6987
|
+
};
|
|
6988
|
+
content: {
|
|
6989
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6990
|
+
};
|
|
6991
|
+
};
|
|
5961
6992
|
404: {
|
|
5962
6993
|
headers: {
|
|
5963
6994
|
[name: string]: unknown;
|
|
@@ -6027,6 +7058,15 @@ interface operations {
|
|
|
6027
7058
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6028
7059
|
};
|
|
6029
7060
|
};
|
|
7061
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
7062
|
+
403: {
|
|
7063
|
+
headers: {
|
|
7064
|
+
[name: string]: unknown;
|
|
7065
|
+
};
|
|
7066
|
+
content: {
|
|
7067
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
7068
|
+
};
|
|
7069
|
+
};
|
|
6030
7070
|
404: {
|
|
6031
7071
|
headers: {
|
|
6032
7072
|
[name: string]: unknown;
|
|
@@ -6085,6 +7125,15 @@ interface operations {
|
|
|
6085
7125
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6086
7126
|
};
|
|
6087
7127
|
};
|
|
7128
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
7129
|
+
403: {
|
|
7130
|
+
headers: {
|
|
7131
|
+
[name: string]: unknown;
|
|
7132
|
+
};
|
|
7133
|
+
content: {
|
|
7134
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
7135
|
+
};
|
|
7136
|
+
};
|
|
6088
7137
|
/** @description Client error. */
|
|
6089
7138
|
"4XX": {
|
|
6090
7139
|
headers: {
|
|
@@ -6394,7 +7443,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
6394
7443
|
id: string;
|
|
6395
7444
|
tenantId: string;
|
|
6396
7445
|
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")[];
|
|
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")[];
|
|
6398
7447
|
isActive: boolean;
|
|
6399
7448
|
createdAt: string;
|
|
6400
7449
|
secret?: string;
|
|
@@ -6403,7 +7452,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
6403
7452
|
id: string;
|
|
6404
7453
|
tenantId: string;
|
|
6405
7454
|
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")[];
|
|
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")[];
|
|
6407
7456
|
isActive: boolean;
|
|
6408
7457
|
createdAt: string;
|
|
6409
7458
|
secret?: string;
|
|
@@ -6412,7 +7461,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
6412
7461
|
id: string;
|
|
6413
7462
|
tenantId: string;
|
|
6414
7463
|
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")[];
|
|
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")[];
|
|
6416
7465
|
isActive: boolean;
|
|
6417
7466
|
createdAt: string;
|
|
6418
7467
|
secret?: string;
|
|
@@ -6444,7 +7493,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
6444
7493
|
[key: string]: string;
|
|
6445
7494
|
};
|
|
6446
7495
|
allowedOrigins: string[];
|
|
6447
|
-
methods: ("c2p" | "vpos")[];
|
|
7496
|
+
methods: ("c2p" | "vpos" | "usdt")[];
|
|
6448
7497
|
successUrl?: string | null;
|
|
6449
7498
|
cancelUrl?: string | null;
|
|
6450
7499
|
paymentId?: string | null;
|
|
@@ -6465,7 +7514,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
6465
7514
|
[key: string]: string;
|
|
6466
7515
|
};
|
|
6467
7516
|
allowedOrigins: string[];
|
|
6468
|
-
methods: ("c2p" | "vpos")[];
|
|
7517
|
+
methods: ("c2p" | "vpos" | "usdt")[];
|
|
6469
7518
|
successUrl?: string | null;
|
|
6470
7519
|
cancelUrl?: string | null;
|
|
6471
7520
|
paymentId?: string | null;
|
|
@@ -6570,6 +7619,90 @@ declare class PaymentLinks extends APIResource {
|
|
|
6570
7619
|
delete(id: string, options?: RequestOptions): Promise<void>;
|
|
6571
7620
|
}
|
|
6572
7621
|
|
|
7622
|
+
/** Your USDT balance (USDT settles in USDT, never converted to VES). */
|
|
7623
|
+
declare class CryptoBalance extends APIResource {
|
|
7624
|
+
retrieve(options?: RequestOptions): Promise<{
|
|
7625
|
+
currency: string;
|
|
7626
|
+
availableUsdt: string;
|
|
7627
|
+
pendingPayoutUsdt: string;
|
|
7628
|
+
asOf: string;
|
|
7629
|
+
}>;
|
|
7630
|
+
}
|
|
7631
|
+
/** Static USDT deposit addresses per customer and network. */
|
|
7632
|
+
declare class DepositAddresses extends APIResource {
|
|
7633
|
+
/** Get or create — calling again for the same customer and network returns the same address. */
|
|
7634
|
+
create(params: RequestBody<'Crypto_createDepositAddress'>, options?: RequestOptions): Promise<{
|
|
7635
|
+
customerRef: string;
|
|
7636
|
+
network: string;
|
|
7637
|
+
currency: string;
|
|
7638
|
+
address: string;
|
|
7639
|
+
tag?: string;
|
|
7640
|
+
tagRequired: boolean;
|
|
7641
|
+
createdAt: string;
|
|
7642
|
+
}>;
|
|
7643
|
+
}
|
|
7644
|
+
/** Enabled USDT networks with the payout fee and availability for an amount. */
|
|
7645
|
+
declare class CryptoNetworks extends APIResource {
|
|
7646
|
+
list(params?: QueryParams<'Crypto_listNetworks'>, options?: RequestOptions): Promise<{
|
|
7647
|
+
network: string;
|
|
7648
|
+
displayName: string;
|
|
7649
|
+
receiveEnabled: boolean;
|
|
7650
|
+
payoutEnabled: boolean;
|
|
7651
|
+
payoutFeeUsdt: string;
|
|
7652
|
+
minPayoutUsdt: string;
|
|
7653
|
+
tagRequired: boolean;
|
|
7654
|
+
available: boolean;
|
|
7655
|
+
}[]>;
|
|
7656
|
+
}
|
|
7657
|
+
/** USDT payouts to external addresses. `idempotencyKey` (in the body) makes retries safe. */
|
|
7658
|
+
declare class CryptoPayouts extends APIResource {
|
|
7659
|
+
create(params: RequestBody<'Crypto_createPayout'>, 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
|
+
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
7679
|
+
id: string;
|
|
7680
|
+
object: string;
|
|
7681
|
+
currency: string;
|
|
7682
|
+
status: "pending" | "processing" | "completed" | "failed";
|
|
7683
|
+
network: string;
|
|
7684
|
+
address: string;
|
|
7685
|
+
tag?: string;
|
|
7686
|
+
amountUsdt: string;
|
|
7687
|
+
feeUsdt: string;
|
|
7688
|
+
customerRef?: string;
|
|
7689
|
+
merchantId?: string;
|
|
7690
|
+
idempotencyKey: string;
|
|
7691
|
+
txHash?: string;
|
|
7692
|
+
internal: boolean;
|
|
7693
|
+
failureReason?: string;
|
|
7694
|
+
createdAt: string;
|
|
7695
|
+
completedAt?: string;
|
|
7696
|
+
}>;
|
|
7697
|
+
}
|
|
7698
|
+
/** USDT: deposit addresses, balance, networks and payouts. */
|
|
7699
|
+
declare class Crypto extends APIResource {
|
|
7700
|
+
readonly balance: CryptoBalance;
|
|
7701
|
+
readonly depositAddresses: DepositAddresses;
|
|
7702
|
+
readonly networks: CryptoNetworks;
|
|
7703
|
+
readonly payouts: CryptoPayouts;
|
|
7704
|
+
}
|
|
7705
|
+
|
|
6573
7706
|
type MerchantListParams = Omit<QueryParams<'Merchants_listOrGetByRef'>, 'externalRef'>;
|
|
6574
7707
|
/** Where a merchant gets paid (bank account or Pago Móvil). */
|
|
6575
7708
|
declare class PayoutMethods extends APIResource {
|
|
@@ -6622,6 +7755,7 @@ declare class Merchants extends APIResource {
|
|
|
6622
7755
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
6623
7756
|
isActive: boolean;
|
|
6624
7757
|
autoPayoutEnabled?: boolean;
|
|
7758
|
+
applicationFeePercent?: number | null;
|
|
6625
7759
|
bankCode?: string;
|
|
6626
7760
|
destination?: string;
|
|
6627
7761
|
payoutMethods?: components["schemas"]["PayoutMethodResponseDto"][];
|
|
@@ -6654,6 +7788,7 @@ declare class Merchants extends APIResource {
|
|
|
6654
7788
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
6655
7789
|
isActive: boolean;
|
|
6656
7790
|
autoPayoutEnabled?: boolean;
|
|
7791
|
+
applicationFeePercent?: number | null;
|
|
6657
7792
|
bankCode?: string;
|
|
6658
7793
|
destination?: string;
|
|
6659
7794
|
payoutMethods?: components["schemas"]["PayoutMethodResponseDto"][];
|
|
@@ -6682,6 +7817,7 @@ declare class Merchants extends APIResource {
|
|
|
6682
7817
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
6683
7818
|
isActive: boolean;
|
|
6684
7819
|
autoPayoutEnabled?: boolean;
|
|
7820
|
+
applicationFeePercent?: number | null;
|
|
6685
7821
|
bankCode?: string;
|
|
6686
7822
|
destination?: string;
|
|
6687
7823
|
payoutMethods?: components["schemas"]["PayoutMethodResponseDto"][];
|
|
@@ -6712,6 +7848,7 @@ declare class Merchants extends APIResource {
|
|
|
6712
7848
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
6713
7849
|
isActive: boolean;
|
|
6714
7850
|
autoPayoutEnabled?: boolean;
|
|
7851
|
+
applicationFeePercent?: number | null;
|
|
6715
7852
|
bankCode?: string;
|
|
6716
7853
|
destination?: string;
|
|
6717
7854
|
payoutMethods?: components["schemas"]["PayoutMethodResponseDto"][];
|
|
@@ -6773,7 +7910,7 @@ declare class Merchants extends APIResource {
|
|
|
6773
7910
|
|
|
6774
7911
|
/** Pago Móvil C2P: request the bank OTP, then charge with the customer's token. */
|
|
6775
7912
|
declare class C2p extends APIResource {
|
|
6776
|
-
/** Create a C2P intent; the payer's bank sends them a token (
|
|
7913
|
+
/** Create a C2P intent; the payer's bank sends them a token (see `otpRequested`). */
|
|
6777
7914
|
request(params: RequestBody<'Payments_requestC2p'>, options?: RequestOptions): Promise<{
|
|
6778
7915
|
paymentId: string;
|
|
6779
7916
|
externalRef?: string;
|
|
@@ -6914,7 +8051,7 @@ declare class PagoMovil extends APIResource {
|
|
|
6914
8051
|
reversalTxId?: number;
|
|
6915
8052
|
}>;
|
|
6916
8053
|
}
|
|
6917
|
-
/** Débito inmediato (
|
|
8054
|
+
/** Débito inmediato (advanced payments, enabled per account). */
|
|
6918
8055
|
declare class Debit extends APIResource {
|
|
6919
8056
|
requestOtp(params: RequestBody<'R4Operations_generarOtp'>, options?: RequestOptions): Promise<{
|
|
6920
8057
|
code: string;
|
|
@@ -6935,7 +8072,7 @@ declare class Debit extends APIResource {
|
|
|
6935
8072
|
externalRef?: string;
|
|
6936
8073
|
}>;
|
|
6937
8074
|
}
|
|
6938
|
-
/** Crédito inmediato and disbursements (
|
|
8075
|
+
/** Crédito inmediato and disbursements (advanced payments, enabled per account). */
|
|
6939
8076
|
declare class Credit extends APIResource {
|
|
6940
8077
|
/** Instant credit to a Pago Móvil phone. */
|
|
6941
8078
|
create(params: RequestBody<'R4Operations_creditoInmediato'>, options?: RequestOptions): Promise<{
|
|
@@ -6967,7 +8104,7 @@ declare class Credit extends APIResource {
|
|
|
6967
8104
|
}[];
|
|
6968
8105
|
}>;
|
|
6969
8106
|
}
|
|
6970
|
-
/** Bank operation status for débito/crédito (
|
|
8107
|
+
/** Bank operation status for débito/crédito (advanced payments, enabled per account). */
|
|
6971
8108
|
declare class Operations extends APIResource {
|
|
6972
8109
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
6973
8110
|
code: string;
|
|
@@ -6990,7 +8127,7 @@ declare class Operations extends APIResource {
|
|
|
6990
8127
|
reference?: string;
|
|
6991
8128
|
}>;
|
|
6992
8129
|
}
|
|
6993
|
-
/** Account payout dispersion (
|
|
8130
|
+
/** Account payout dispersion (advanced payments, enabled per account). */
|
|
6994
8131
|
declare class Dispersals extends APIResource {
|
|
6995
8132
|
create(params: RequestBody<'R4Operations_dispersarPagos'>, options?: RequestOptions): Promise<{
|
|
6996
8133
|
success: boolean;
|
|
@@ -6999,7 +8136,7 @@ declare class Dispersals extends APIResource {
|
|
|
6999
8136
|
referencia: string;
|
|
7000
8137
|
}>;
|
|
7001
8138
|
}
|
|
7002
|
-
/** Vuelto / change payments (
|
|
8139
|
+
/** Vuelto / change payments (advanced payments, enabled per account). */
|
|
7003
8140
|
declare class Change extends APIResource {
|
|
7004
8141
|
create(params: RequestBody<'R4Operations_ejecutarVuelto'>, options?: RequestOptions): Promise<{
|
|
7005
8142
|
code: string;
|
|
@@ -7110,7 +8247,7 @@ declare class Payments extends APIResource {
|
|
|
7110
8247
|
}>;
|
|
7111
8248
|
}
|
|
7112
8249
|
|
|
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"];
|
|
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"];
|
|
7114
8251
|
type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];
|
|
7115
8252
|
/** `data` of every `payment.*` event. */
|
|
7116
8253
|
interface PaymentWebhookData {
|
|
@@ -7202,6 +8339,8 @@ declare class VexPay {
|
|
|
7202
8339
|
readonly checkout: Checkout;
|
|
7203
8340
|
readonly merchants: Merchants;
|
|
7204
8341
|
readonly payouts: Payouts;
|
|
8342
|
+
/** USDT: deposit addresses, balance, networks and payouts. */
|
|
8343
|
+
readonly crypto: Crypto;
|
|
7205
8344
|
readonly products: Products;
|
|
7206
8345
|
readonly paymentLinks: PaymentLinks;
|
|
7207
8346
|
readonly tenantPayoutAccount: TenantPayoutAccount;
|
|
@@ -7259,6 +8398,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
7259
8398
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
7260
8399
|
}
|
|
7261
8400
|
|
|
7262
|
-
declare const VERSION = "0.
|
|
8401
|
+
declare const VERSION = "0.2.1";
|
|
7263
8402
|
|
|
7264
8403
|
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 };
|