@vexpay/node 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +82 -7
- package/dist/index.cjs +78 -6
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1475 -243
- package/dist/index.d.ts +1475 -243
- package/dist/index.js +78 -6
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -122,7 +122,7 @@ interface components {
|
|
|
122
122
|
* @example chargeback
|
|
123
123
|
* @enum {string}
|
|
124
124
|
*/
|
|
125
|
-
type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee";
|
|
125
|
+
type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee" | "disbursement_payout_fee" | "disbursement_payout_fee_reversal" | "topup" | "topup_fee" | "topup_instant_release" | "topup_instant_fee";
|
|
126
126
|
/**
|
|
127
127
|
* @description Signed VES amount (negative = money out of your balance).
|
|
128
128
|
* @example -4000.00
|
|
@@ -262,10 +262,16 @@ interface components {
|
|
|
262
262
|
*/
|
|
263
263
|
feePercent?: string;
|
|
264
264
|
/**
|
|
265
|
-
* @description Platform fee in VES retained on instant tenant credits.
|
|
265
|
+
* @description Platform fee in VES: retained on instant tenant credits, or the end-user withdrawal fee on a disbursement payout (see feePayer).
|
|
266
266
|
* @example 2.50
|
|
267
267
|
*/
|
|
268
268
|
feeVes?: string;
|
|
269
|
+
/**
|
|
270
|
+
* @description Set to "tenant" when your balance paid feeVes (disbursement withdrawal fee): the end user was debited only monto.
|
|
271
|
+
* @example tenant
|
|
272
|
+
* @enum {string}
|
|
273
|
+
*/
|
|
274
|
+
feePayer?: "tenant";
|
|
269
275
|
concepto?: string;
|
|
270
276
|
/**
|
|
271
277
|
* @description Destination bank SIMF code.
|
|
@@ -334,10 +340,16 @@ interface components {
|
|
|
334
340
|
*/
|
|
335
341
|
feePercent?: string;
|
|
336
342
|
/**
|
|
337
|
-
* @description Platform fee in VES retained on instant tenant credits.
|
|
343
|
+
* @description Platform fee in VES: retained on instant tenant credits, or the end-user withdrawal fee on a disbursement payout (see feePayer).
|
|
338
344
|
* @example 2.50
|
|
339
345
|
*/
|
|
340
346
|
feeVes?: string;
|
|
347
|
+
/**
|
|
348
|
+
* @description Set to "tenant" when your balance paid feeVes (disbursement withdrawal fee): the end user was debited only monto.
|
|
349
|
+
* @example tenant
|
|
350
|
+
* @enum {string}
|
|
351
|
+
*/
|
|
352
|
+
feePayer?: "tenant";
|
|
341
353
|
concepto?: string;
|
|
342
354
|
/**
|
|
343
355
|
* @description Destination bank SIMF code.
|
|
@@ -1065,6 +1077,88 @@ interface components {
|
|
|
1065
1077
|
/** Format: date-time */
|
|
1066
1078
|
createdAt: string;
|
|
1067
1079
|
};
|
|
1080
|
+
SimulateDepositDto: {
|
|
1081
|
+
/**
|
|
1082
|
+
* @description The `customerRef` of a deposit address you already requested.
|
|
1083
|
+
* @example user_123
|
|
1084
|
+
*/
|
|
1085
|
+
customerRef: string;
|
|
1086
|
+
/**
|
|
1087
|
+
* @description Network of that deposit address.
|
|
1088
|
+
* @example TRC20
|
|
1089
|
+
* @enum {string}
|
|
1090
|
+
*/
|
|
1091
|
+
network: "TRC20" | "BEP20" | "POLYGON" | "SOL" | "TON" | "ARB1" | "BASE";
|
|
1092
|
+
/**
|
|
1093
|
+
* @description Stablecoin of that deposit address.
|
|
1094
|
+
* @default USDT
|
|
1095
|
+
* @example USDT
|
|
1096
|
+
* @enum {string}
|
|
1097
|
+
*/
|
|
1098
|
+
currency?: "USDT" | "USDC";
|
|
1099
|
+
/**
|
|
1100
|
+
* @description Amount that "arrives", in `currency`: greater than 0, at most 10,000, at most 2 decimals.
|
|
1101
|
+
* @example 40.00
|
|
1102
|
+
*/
|
|
1103
|
+
amount: string | number;
|
|
1104
|
+
};
|
|
1105
|
+
SimulatedDepositDto: {
|
|
1106
|
+
/** Format: uuid */
|
|
1107
|
+
paymentId: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* @example COMPLETED
|
|
1110
|
+
* @enum {string}
|
|
1111
|
+
*/
|
|
1112
|
+
status: "COMPLETED";
|
|
1113
|
+
/**
|
|
1114
|
+
* @example USDT
|
|
1115
|
+
* @enum {string}
|
|
1116
|
+
*/
|
|
1117
|
+
method: "USDT" | "USDC";
|
|
1118
|
+
/**
|
|
1119
|
+
* @example USDT
|
|
1120
|
+
* @enum {string}
|
|
1121
|
+
*/
|
|
1122
|
+
currency: "USDT" | "USDC";
|
|
1123
|
+
/**
|
|
1124
|
+
* @description Amount received, in `currency`.
|
|
1125
|
+
* @example 40.00
|
|
1126
|
+
*/
|
|
1127
|
+
amount: string;
|
|
1128
|
+
/**
|
|
1129
|
+
* @description Your stablecoin fee, in `currency`. The balance is credited `amount` − `fee`.
|
|
1130
|
+
* @example 1.50
|
|
1131
|
+
*/
|
|
1132
|
+
fee: string;
|
|
1133
|
+
/**
|
|
1134
|
+
* @description USDT only: same as `amount`.
|
|
1135
|
+
* @example 40.00
|
|
1136
|
+
*/
|
|
1137
|
+
amountUsdt?: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* @description USDT only: same as `fee`.
|
|
1140
|
+
* @example 1.50
|
|
1141
|
+
*/
|
|
1142
|
+
feeUsdt?: string;
|
|
1143
|
+
/** @example TRC20 */
|
|
1144
|
+
network: string;
|
|
1145
|
+
/** @example user_123 */
|
|
1146
|
+
customerRef: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* @description Always empty: nothing moved on chain.
|
|
1149
|
+
* @example []
|
|
1150
|
+
*/
|
|
1151
|
+
txHashes: string[];
|
|
1152
|
+
/**
|
|
1153
|
+
* @description Always false: simulated deposits exist in Test mode only.
|
|
1154
|
+
* @example false
|
|
1155
|
+
*/
|
|
1156
|
+
livemode: boolean;
|
|
1157
|
+
/** @example true */
|
|
1158
|
+
simulated: boolean;
|
|
1159
|
+
/** Format: date-time */
|
|
1160
|
+
createdAt: string;
|
|
1161
|
+
};
|
|
1068
1162
|
CryptoNetworkDto: {
|
|
1069
1163
|
/**
|
|
1070
1164
|
* @example USDT
|
|
@@ -1186,13 +1280,61 @@ interface components {
|
|
|
1186
1280
|
/** Format: date-time */
|
|
1187
1281
|
completedAt?: string;
|
|
1188
1282
|
};
|
|
1283
|
+
CopChannelDto: {
|
|
1284
|
+
/**
|
|
1285
|
+
* @example pse
|
|
1286
|
+
* @enum {string}
|
|
1287
|
+
*/
|
|
1288
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
1289
|
+
/**
|
|
1290
|
+
* @description Buyer-facing name (Spanish).
|
|
1291
|
+
* @example PSE
|
|
1292
|
+
*/
|
|
1293
|
+
label: string;
|
|
1294
|
+
/**
|
|
1295
|
+
* @description A `buyer` object is required.
|
|
1296
|
+
* @example true
|
|
1297
|
+
*/
|
|
1298
|
+
needsBuyer: boolean;
|
|
1299
|
+
/**
|
|
1300
|
+
* @description Show the buyer the `terms` links and send `buyer.termsAccepted: true`.
|
|
1301
|
+
* @example true
|
|
1302
|
+
*/
|
|
1303
|
+
needsTermsAcceptance: boolean;
|
|
1304
|
+
/**
|
|
1305
|
+
* @description Only through the hosted checkout (checkout sessions or payment links), never `POST /v1/cop/payments`.
|
|
1306
|
+
* @example false
|
|
1307
|
+
*/
|
|
1308
|
+
checkoutOnly: boolean;
|
|
1309
|
+
/** @example 20000 */
|
|
1310
|
+
minAmountCop: number;
|
|
1311
|
+
};
|
|
1312
|
+
CopPseBankDto: {
|
|
1313
|
+
/** @example 1007 */
|
|
1314
|
+
code: string;
|
|
1315
|
+
/** @example Bancolombia */
|
|
1316
|
+
name: string;
|
|
1317
|
+
};
|
|
1318
|
+
CopTermsDto: {
|
|
1319
|
+
/** @description Terms and conditions the buyer accepts. */
|
|
1320
|
+
termsUrl: string;
|
|
1321
|
+
/** @description Personal data processing authorization the buyer accepts. */
|
|
1322
|
+
personalDataUrl: string;
|
|
1323
|
+
};
|
|
1324
|
+
CopChannelsDto: {
|
|
1325
|
+
channels: components["schemas"]["CopChannelDto"][];
|
|
1326
|
+
/** @description Present when `pse` is listed: banks for `pse.bankCode`. */
|
|
1327
|
+
pseBanks?: components["schemas"]["CopPseBankDto"][];
|
|
1328
|
+
/** @description Present when a listed channel needs terms acceptance. */
|
|
1329
|
+
terms?: components["schemas"]["CopTermsDto"];
|
|
1330
|
+
};
|
|
1189
1331
|
CopBuyerDto: {
|
|
1190
1332
|
/** @example Juan */
|
|
1191
1333
|
firstName?: string;
|
|
1192
1334
|
/** @example Pérez */
|
|
1193
1335
|
lastName?: string;
|
|
1194
1336
|
/**
|
|
1195
|
-
* @description Required for
|
|
1337
|
+
* @description Required for every channel except `breb`.
|
|
1196
1338
|
* @example juan@example.com
|
|
1197
1339
|
*/
|
|
1198
1340
|
email?: string;
|
|
@@ -1208,10 +1350,28 @@ interface components {
|
|
|
1208
1350
|
*/
|
|
1209
1351
|
documentType?: "CC" | "CE" | "TI" | "NIT" | "PP";
|
|
1210
1352
|
/**
|
|
1211
|
-
* @description National document number. Required for
|
|
1353
|
+
* @description National document number. Required for every channel except `breb`.
|
|
1212
1354
|
* @example 1234567890
|
|
1213
1355
|
*/
|
|
1214
1356
|
documentNumber?: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* @description PSE only (required): `natural` person or `juridica` (company).
|
|
1359
|
+
* @example natural
|
|
1360
|
+
* @enum {string}
|
|
1361
|
+
*/
|
|
1362
|
+
personType?: "natural" | "juridica";
|
|
1363
|
+
/**
|
|
1364
|
+
* @description Required (`true`) for channels the channel catalog marks `needsTermsAcceptance`: confirms you showed the buyer the catalog `terms` links.
|
|
1365
|
+
* @example true
|
|
1366
|
+
*/
|
|
1367
|
+
termsAccepted?: boolean;
|
|
1368
|
+
};
|
|
1369
|
+
CopPseDto: {
|
|
1370
|
+
/**
|
|
1371
|
+
* @description Bank code from `GET /v1/cop/channels` → `pseBanks`.
|
|
1372
|
+
* @example 1007
|
|
1373
|
+
*/
|
|
1374
|
+
bankCode: string;
|
|
1215
1375
|
};
|
|
1216
1376
|
CreateCopPaymentDto: {
|
|
1217
1377
|
/**
|
|
@@ -1220,11 +1380,11 @@ interface components {
|
|
|
1220
1380
|
*/
|
|
1221
1381
|
amountCop: number;
|
|
1222
1382
|
/**
|
|
1223
|
-
* @description `breb`: QR code / transfer key the buyer pays from any Colombian bank app. `nequi`: push to the buyer's Nequi app. `daviplata`: SMS code the buyer reads to you.
|
|
1383
|
+
* @description `breb`: QR code / transfer key the buyer pays from any Colombian bank app. `nequi`: push to the buyer's Nequi app. `daviplata`: SMS code the buyer reads to you, or a redirect. `pse` and `bancolombia_transfer`: redirect to the buyer's bank. `bancolombia_qr`: QR the buyer scans in the Bancolombia app. `card`: hosted checkout only (`channel_requires_checkout`).
|
|
1224
1384
|
* @example breb
|
|
1225
1385
|
* @enum {string}
|
|
1226
1386
|
*/
|
|
1227
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
1387
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
1228
1388
|
/**
|
|
1229
1389
|
* @description Shown to the buyer.
|
|
1230
1390
|
* @example Order 1042
|
|
@@ -1244,14 +1404,26 @@ interface components {
|
|
|
1244
1404
|
metadata?: {
|
|
1245
1405
|
[key: string]: string;
|
|
1246
1406
|
};
|
|
1247
|
-
/** @description Required for
|
|
1407
|
+
/** @description Required for every channel except `breb`. */
|
|
1248
1408
|
buyer?: components["schemas"]["CopBuyerDto"];
|
|
1409
|
+
/** @description Required for `pse`. */
|
|
1410
|
+
pse?: components["schemas"]["CopPseDto"];
|
|
1249
1411
|
};
|
|
1250
1412
|
CopNextActionDto: {
|
|
1251
|
-
/**
|
|
1252
|
-
|
|
1413
|
+
/**
|
|
1414
|
+
* @description `redirect`: send the buyer to `url` to authorize at their bank. `redirect_pending`: the URL is not ready yet — read the payment again. `processing`: nothing to do, the outcome follows.
|
|
1415
|
+
* @enum {string}
|
|
1416
|
+
*/
|
|
1417
|
+
type: "show_qr" | "approve_in_app" | "submit_otp" | "redirect" | "redirect_pending" | "processing";
|
|
1253
1418
|
/** @description Bre-B: base64 PNG of the payment QR. Returned only when the payment is created. */
|
|
1254
1419
|
qrPngBase64?: string;
|
|
1420
|
+
/** @description Bancolombia QR: base64 SVG of the payment QR. */
|
|
1421
|
+
qrSvgBase64?: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* @description `redirect`: where the buyer authorizes the payment.
|
|
1424
|
+
* @example https://…
|
|
1425
|
+
*/
|
|
1426
|
+
url?: string;
|
|
1255
1427
|
/** @description Bre-B: transfer key the buyer can enter instead of scanning. */
|
|
1256
1428
|
transferKey?: string;
|
|
1257
1429
|
/**
|
|
@@ -1268,7 +1440,7 @@ interface components {
|
|
|
1268
1440
|
/** @enum {string} */
|
|
1269
1441
|
method: "COP";
|
|
1270
1442
|
/** @enum {string} */
|
|
1271
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
1443
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
1272
1444
|
/** @example 100000 */
|
|
1273
1445
|
amountCop: number;
|
|
1274
1446
|
/**
|
|
@@ -1291,16 +1463,27 @@ interface components {
|
|
|
1291
1463
|
metadata: {
|
|
1292
1464
|
[key: string]: string;
|
|
1293
1465
|
};
|
|
1294
|
-
/**
|
|
1295
|
-
|
|
1466
|
+
/**
|
|
1467
|
+
* @description `chargeback`: a refunded card payment the buyer disputed with their bank.
|
|
1468
|
+
* @enum {string}
|
|
1469
|
+
*/
|
|
1470
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
1296
1471
|
/** Format: date-time */
|
|
1297
1472
|
expiresAt?: string;
|
|
1298
1473
|
/** Format: date-time */
|
|
1299
1474
|
createdAt: string;
|
|
1300
1475
|
/** Format: date-time */
|
|
1301
1476
|
completedAt?: string;
|
|
1302
|
-
/** @description What the buyer must do next. Returned when the payment is created. */
|
|
1477
|
+
/** @description What the buyer must do next. Returned when the payment is created, and on reads while a bank redirect or QR is pending. */
|
|
1303
1478
|
next?: components["schemas"]["CopNextActionDto"];
|
|
1479
|
+
/**
|
|
1480
|
+
* @description Card payments: brand and last 4 digits, once known.
|
|
1481
|
+
* @example {
|
|
1482
|
+
* "brand": "VISA",
|
|
1483
|
+
* "last4": "4242"
|
|
1484
|
+
* }
|
|
1485
|
+
*/
|
|
1486
|
+
card?: Record<string, never>;
|
|
1304
1487
|
};
|
|
1305
1488
|
SubmitCopOtpDto: {
|
|
1306
1489
|
/**
|
|
@@ -2310,10 +2493,15 @@ interface components {
|
|
|
2310
2493
|
};
|
|
2311
2494
|
CreateMerchantTransferDto: {
|
|
2312
2495
|
/**
|
|
2313
|
-
* @description Exact two-decimal VES amount to move from platform float → seller pending.
|
|
2496
|
+
* @description Exact two-decimal VES amount to move from platform float → seller pending. Send this or `amountUsd`, not both.
|
|
2314
2497
|
* @example 1523.40
|
|
2315
2498
|
*/
|
|
2316
|
-
amountVes
|
|
2499
|
+
amountVes?: string;
|
|
2500
|
+
/**
|
|
2501
|
+
* @description Exact two-decimal USD amount, converted to VES at the official BCV rate at the time of the request (regardless of your account’s Bolívar rate setting). The rate is saved with the transfer and a replay returns it. Send this or `amountVes`, not both.
|
|
2502
|
+
* @example 100.00
|
|
2503
|
+
*/
|
|
2504
|
+
amountUsd?: string;
|
|
2317
2505
|
/**
|
|
2318
2506
|
* @description Idempotency key for this transfer under the merchant.
|
|
2319
2507
|
* @example xfer_bid_1042
|
|
@@ -2325,6 +2513,136 @@ interface components {
|
|
|
2325
2513
|
*/
|
|
2326
2514
|
paymentId?: string;
|
|
2327
2515
|
};
|
|
2516
|
+
MerchantTransferSnapshotDto: {
|
|
2517
|
+
/** @example q1-nov-2026-u123 */
|
|
2518
|
+
transferKey: string;
|
|
2519
|
+
/**
|
|
2520
|
+
* @description VES credited to the merchant.
|
|
2521
|
+
* @example 21540.00
|
|
2522
|
+
*/
|
|
2523
|
+
amountVes: string;
|
|
2524
|
+
/**
|
|
2525
|
+
* @description USD transfers only: the USD amount requested.
|
|
2526
|
+
* @example 100.00
|
|
2527
|
+
*/
|
|
2528
|
+
amountUsd?: string;
|
|
2529
|
+
/**
|
|
2530
|
+
* @description USD transfers only: the BCV rate used.
|
|
2531
|
+
* @example 215.4000
|
|
2532
|
+
*/
|
|
2533
|
+
rate?: string;
|
|
2534
|
+
/**
|
|
2535
|
+
* @description USD transfers only: always `bcv`.
|
|
2536
|
+
* @example bcv
|
|
2537
|
+
*/
|
|
2538
|
+
rateSource?: string;
|
|
2539
|
+
/**
|
|
2540
|
+
* Format: date-time
|
|
2541
|
+
* @description USD transfers only: when the rate was read.
|
|
2542
|
+
*/
|
|
2543
|
+
rateAsOf?: string;
|
|
2544
|
+
};
|
|
2545
|
+
MerchantTransferResponseDto: {
|
|
2546
|
+
/** Format: uuid */
|
|
2547
|
+
merchantId: string;
|
|
2548
|
+
/** @example acct_3fd84b2d9ad14f74a2d90f2f56984db5 */
|
|
2549
|
+
accountId: string;
|
|
2550
|
+
/** Format: uuid */
|
|
2551
|
+
tenantId: string;
|
|
2552
|
+
/** @example 100.00 */
|
|
2553
|
+
pendingVes: string;
|
|
2554
|
+
/** @example 250.00 */
|
|
2555
|
+
availableVes: string;
|
|
2556
|
+
/** @example 50.00 */
|
|
2557
|
+
paidOutVes: string;
|
|
2558
|
+
/** @example 350.00 */
|
|
2559
|
+
ledgerNetVes: string;
|
|
2560
|
+
/** @description COP balances from COP sales on seller links. Present only once the seller has COP activity. */
|
|
2561
|
+
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
2562
|
+
/** @description What this transfer credited (the original values on a replay). */
|
|
2563
|
+
transfer: components["schemas"]["MerchantTransferSnapshotDto"];
|
|
2564
|
+
};
|
|
2565
|
+
MerchantMovementDto: {
|
|
2566
|
+
/** Format: uuid */
|
|
2567
|
+
id: string;
|
|
2568
|
+
/**
|
|
2569
|
+
* @example credit
|
|
2570
|
+
* @enum {string}
|
|
2571
|
+
*/
|
|
2572
|
+
type: "credit" | "release" | "reversal" | "payout" | "payout_reversal" | "payout_fee" | "payout_fee_reversal" | "adjustment";
|
|
2573
|
+
/**
|
|
2574
|
+
* @description Signed change of the total balance (pending + available). A `release` row is 0.00.
|
|
2575
|
+
* @example 21540.00
|
|
2576
|
+
*/
|
|
2577
|
+
amountVes: string;
|
|
2578
|
+
/**
|
|
2579
|
+
* @description `release` rows only: VES moved from pending to available (negative = put back on hold).
|
|
2580
|
+
* @example 21540.00
|
|
2581
|
+
*/
|
|
2582
|
+
releasedVes?: string;
|
|
2583
|
+
/** @example Credit */
|
|
2584
|
+
description: string;
|
|
2585
|
+
/**
|
|
2586
|
+
* @description `credit` rows: the transferKey you sent.
|
|
2587
|
+
* @example q1-nov-u1
|
|
2588
|
+
*/
|
|
2589
|
+
transferKey?: string;
|
|
2590
|
+
/** Format: uuid */
|
|
2591
|
+
paymentId?: string | null;
|
|
2592
|
+
/** Format: uuid */
|
|
2593
|
+
payoutId?: string | null;
|
|
2594
|
+
/**
|
|
2595
|
+
* Format: date-time
|
|
2596
|
+
* @description `credit` rows: when the credit becomes withdrawable.
|
|
2597
|
+
*/
|
|
2598
|
+
availableAt?: string | null;
|
|
2599
|
+
/**
|
|
2600
|
+
* @description Credits sent with `amountUsd`: the USD amount.
|
|
2601
|
+
* @example 100.00
|
|
2602
|
+
*/
|
|
2603
|
+
amountUsd?: string;
|
|
2604
|
+
/**
|
|
2605
|
+
* @description Credits sent with `amountUsd`: the rate used.
|
|
2606
|
+
* @example 215.4000
|
|
2607
|
+
*/
|
|
2608
|
+
rate?: string;
|
|
2609
|
+
/** @example bcv */
|
|
2610
|
+
rateSource?: string;
|
|
2611
|
+
/** Format: date-time */
|
|
2612
|
+
createdAt: string;
|
|
2613
|
+
};
|
|
2614
|
+
MerchantMovementListDto: {
|
|
2615
|
+
items: components["schemas"]["MerchantMovementDto"][];
|
|
2616
|
+
/** @description Pass as `cursor` for the next (older) page; null on the last page. */
|
|
2617
|
+
nextCursor: string | null;
|
|
2618
|
+
};
|
|
2619
|
+
MerchantStatementDto: {
|
|
2620
|
+
/** Format: uuid */
|
|
2621
|
+
merchantId: string;
|
|
2622
|
+
/** @example 2026-11 */
|
|
2623
|
+
month: string;
|
|
2624
|
+
/**
|
|
2625
|
+
* Format: date-time
|
|
2626
|
+
* @description Month start, America/Caracas.
|
|
2627
|
+
* @example 2026-11-01T04:00:00.000Z
|
|
2628
|
+
*/
|
|
2629
|
+
from: string;
|
|
2630
|
+
/**
|
|
2631
|
+
* Format: date-time
|
|
2632
|
+
* @description Month end (exclusive), America/Caracas.
|
|
2633
|
+
* @example 2026-12-01T04:00:00.000Z
|
|
2634
|
+
*/
|
|
2635
|
+
to: string;
|
|
2636
|
+
/** @example 0.00 */
|
|
2637
|
+
openingVes: string;
|
|
2638
|
+
/**
|
|
2639
|
+
* @description openingVes + Σ movements[].amountVes.
|
|
2640
|
+
* @example 21800.00
|
|
2641
|
+
*/
|
|
2642
|
+
closingVes: string;
|
|
2643
|
+
/** @description Oldest first. */
|
|
2644
|
+
movements: components["schemas"]["MerchantMovementDto"][];
|
|
2645
|
+
};
|
|
2328
2646
|
UpdateMerchantDto: {
|
|
2329
2647
|
/** @description Soft off-switch for payouts. false = deactivated (history kept). */
|
|
2330
2648
|
isActive?: boolean;
|
|
@@ -2527,6 +2845,104 @@ interface components {
|
|
|
2527
2845
|
maxQuantity?: number | null;
|
|
2528
2846
|
redirectUrl?: string | null;
|
|
2529
2847
|
};
|
|
2848
|
+
CreateTopupDto: {
|
|
2849
|
+
/**
|
|
2850
|
+
* @description Bs to load, two decimals, above 0.
|
|
2851
|
+
* @example 100000.00
|
|
2852
|
+
*/
|
|
2853
|
+
amountVes: string;
|
|
2854
|
+
/**
|
|
2855
|
+
* @description Phone the Pago Móvil is sent from (Venezuelan mobile, 04XXXXXXXXX).
|
|
2856
|
+
* @example 04121234567
|
|
2857
|
+
*/
|
|
2858
|
+
payerPhone: string;
|
|
2859
|
+
/**
|
|
2860
|
+
* @description Cédula or RIF of the payer.
|
|
2861
|
+
* @example V12345678
|
|
2862
|
+
*/
|
|
2863
|
+
payerCedula: string;
|
|
2864
|
+
/**
|
|
2865
|
+
* @description Where the money comes from (10–500 characters). Visible to VEX Pay ops.
|
|
2866
|
+
* @example Ingresos de publicidad, quincena 2
|
|
2867
|
+
*/
|
|
2868
|
+
sourceNote: string;
|
|
2869
|
+
};
|
|
2870
|
+
TopupReceiverDto: {
|
|
2871
|
+
/**
|
|
2872
|
+
* @description Bank code to pick in your bank app. The bank name is not shown.
|
|
2873
|
+
* @example 0169
|
|
2874
|
+
*/
|
|
2875
|
+
bankCode: string;
|
|
2876
|
+
/** @example 04140000000 */
|
|
2877
|
+
phone: string;
|
|
2878
|
+
/** @example J-000000000 */
|
|
2879
|
+
identification: string;
|
|
2880
|
+
};
|
|
2881
|
+
TopupDto: {
|
|
2882
|
+
id: string;
|
|
2883
|
+
/** @enum {string} */
|
|
2884
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
2885
|
+
/** @example 100000.00 */
|
|
2886
|
+
amountVes: string;
|
|
2887
|
+
/**
|
|
2888
|
+
* @description USD at the BCV rate snapshotted at creation.
|
|
2889
|
+
* @example 500.00
|
|
2890
|
+
*/
|
|
2891
|
+
amountUsd: string;
|
|
2892
|
+
/** @example 200.0000 */
|
|
2893
|
+
bcvRate: string;
|
|
2894
|
+
/** @example 3.5000 */
|
|
2895
|
+
feePercent: string;
|
|
2896
|
+
/** @example 0.25 */
|
|
2897
|
+
feeFixedUsd: string;
|
|
2898
|
+
/**
|
|
2899
|
+
* @description Charged when the top-up completes.
|
|
2900
|
+
* @example 3550.00
|
|
2901
|
+
*/
|
|
2902
|
+
feeVes?: string;
|
|
2903
|
+
/**
|
|
2904
|
+
* @description Credited to your balance (amount − fee).
|
|
2905
|
+
* @example 96450.00
|
|
2906
|
+
*/
|
|
2907
|
+
creditedVes?: string;
|
|
2908
|
+
sourceNote: string;
|
|
2909
|
+
payerPhone: string;
|
|
2910
|
+
bankReference?: string;
|
|
2911
|
+
expiresAt: string;
|
|
2912
|
+
completedAt?: string;
|
|
2913
|
+
/** @description When the credit becomes available on its own (null = available). */
|
|
2914
|
+
availableAt?: string;
|
|
2915
|
+
/**
|
|
2916
|
+
* @description Part of this top-up still held.
|
|
2917
|
+
* @example 96450.00
|
|
2918
|
+
*/
|
|
2919
|
+
heldVes: string;
|
|
2920
|
+
/**
|
|
2921
|
+
* @description Instant availability fee percent.
|
|
2922
|
+
* @example 1.5000
|
|
2923
|
+
*/
|
|
2924
|
+
instantFeePercent: string;
|
|
2925
|
+
/**
|
|
2926
|
+
* @description Fee to release heldVes now.
|
|
2927
|
+
* @example 1446.75
|
|
2928
|
+
*/
|
|
2929
|
+
instantFeeVes: string;
|
|
2930
|
+
/** @description When the held part was released early with the instant fee. */
|
|
2931
|
+
instantReleasedAt?: string;
|
|
2932
|
+
/** @description Where to send the Pago Móvil (pending only). */
|
|
2933
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
2934
|
+
test: boolean;
|
|
2935
|
+
createdAt: string;
|
|
2936
|
+
};
|
|
2937
|
+
TopupListDto: {
|
|
2938
|
+
data: components["schemas"]["TopupDto"][];
|
|
2939
|
+
/** @example 3000.00 */
|
|
2940
|
+
monthlyCapUsd: string | null;
|
|
2941
|
+
/** @example 500.00 */
|
|
2942
|
+
monthUsedUsd: string;
|
|
2943
|
+
/** @example 2500.00 */
|
|
2944
|
+
monthRemainingUsd: string;
|
|
2945
|
+
};
|
|
2530
2946
|
NotificationTestResponseDto: {
|
|
2531
2947
|
/** @example true */
|
|
2532
2948
|
sent: boolean;
|
|
@@ -2930,7 +3346,7 @@ interface operations {
|
|
|
2930
3346
|
/** @description Only movements of this payment. */
|
|
2931
3347
|
paymentId?: string;
|
|
2932
3348
|
/** @description One or more types (repeat or comma-separate). */
|
|
2933
|
-
type?: ("payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee")[];
|
|
3349
|
+
type?: ("payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee" | "disbursement_payout_fee" | "disbursement_payout_fee_reversal" | "topup" | "topup_fee" | "topup_instant_release" | "topup_instant_fee")[];
|
|
2934
3350
|
/** @description `nextCursor` from the previous page. */
|
|
2935
3351
|
cursor?: string;
|
|
2936
3352
|
/** @description 1–100, default 50. */
|
|
@@ -5161,29 +5577,32 @@ interface operations {
|
|
|
5161
5577
|
};
|
|
5162
5578
|
};
|
|
5163
5579
|
};
|
|
5164
|
-
|
|
5580
|
+
Crypto_simulateDeposit: {
|
|
5165
5581
|
parameters: {
|
|
5166
|
-
query?:
|
|
5167
|
-
|
|
5168
|
-
|
|
5169
|
-
|
|
5170
|
-
amount?: string;
|
|
5582
|
+
query?: never;
|
|
5583
|
+
header?: {
|
|
5584
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
5585
|
+
"Idempotency-Key"?: string;
|
|
5171
5586
|
};
|
|
5172
|
-
header?: never;
|
|
5173
5587
|
path?: never;
|
|
5174
5588
|
cookie?: never;
|
|
5175
5589
|
};
|
|
5176
|
-
requestBody
|
|
5590
|
+
requestBody: {
|
|
5591
|
+
content: {
|
|
5592
|
+
"application/json": components["schemas"]["SimulateDepositDto"];
|
|
5593
|
+
};
|
|
5594
|
+
};
|
|
5177
5595
|
responses: {
|
|
5178
|
-
|
|
5596
|
+
/** @description Deposit credited. */
|
|
5597
|
+
201: {
|
|
5179
5598
|
headers: {
|
|
5180
5599
|
[name: string]: unknown;
|
|
5181
5600
|
};
|
|
5182
5601
|
content: {
|
|
5183
|
-
"application/json": components["schemas"]["
|
|
5602
|
+
"application/json": components["schemas"]["SimulatedDepositDto"];
|
|
5184
5603
|
};
|
|
5185
5604
|
};
|
|
5186
|
-
/** @description `unsupported_currency`. */
|
|
5605
|
+
/** @description `invalid_data` (amount missing, not above 0, above 10,000 or with more than 2 decimals) or `unsupported_currency`. */
|
|
5187
5606
|
400: {
|
|
5188
5607
|
headers: {
|
|
5189
5608
|
[name: string]: unknown;
|
|
@@ -5201,7 +5620,7 @@ interface operations {
|
|
|
5201
5620
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5202
5621
|
};
|
|
5203
5622
|
};
|
|
5204
|
-
/** @description `
|
|
5623
|
+
/** @description `test_mode_only` — called with a Live key; or `method_not_allowed`. */
|
|
5205
5624
|
403: {
|
|
5206
5625
|
headers: {
|
|
5207
5626
|
[name: string]: unknown;
|
|
@@ -5210,7 +5629,85 @@ interface operations {
|
|
|
5210
5629
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5211
5630
|
};
|
|
5212
5631
|
};
|
|
5213
|
-
/** @description
|
|
5632
|
+
/** @description `not_found` — no deposit address was requested for that `customerRef`, `currency` and `network`. */
|
|
5633
|
+
404: {
|
|
5634
|
+
headers: {
|
|
5635
|
+
[name: string]: unknown;
|
|
5636
|
+
};
|
|
5637
|
+
content: {
|
|
5638
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5639
|
+
};
|
|
5640
|
+
};
|
|
5641
|
+
/** @description Client error. */
|
|
5642
|
+
"4XX": {
|
|
5643
|
+
headers: {
|
|
5644
|
+
[name: string]: unknown;
|
|
5645
|
+
};
|
|
5646
|
+
content: {
|
|
5647
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5648
|
+
};
|
|
5649
|
+
};
|
|
5650
|
+
/** @description Server or upstream bank error. */
|
|
5651
|
+
"5XX": {
|
|
5652
|
+
headers: {
|
|
5653
|
+
[name: string]: unknown;
|
|
5654
|
+
};
|
|
5655
|
+
content: {
|
|
5656
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5657
|
+
};
|
|
5658
|
+
};
|
|
5659
|
+
};
|
|
5660
|
+
};
|
|
5661
|
+
Crypto_listNetworks: {
|
|
5662
|
+
parameters: {
|
|
5663
|
+
query?: {
|
|
5664
|
+
/** @description Alias of `amount`. */
|
|
5665
|
+
amountUsdt?: string;
|
|
5666
|
+
currency?: "USDT" | "USDC";
|
|
5667
|
+
amount?: string;
|
|
5668
|
+
};
|
|
5669
|
+
header?: never;
|
|
5670
|
+
path?: never;
|
|
5671
|
+
cookie?: never;
|
|
5672
|
+
};
|
|
5673
|
+
requestBody?: never;
|
|
5674
|
+
responses: {
|
|
5675
|
+
200: {
|
|
5676
|
+
headers: {
|
|
5677
|
+
[name: string]: unknown;
|
|
5678
|
+
};
|
|
5679
|
+
content: {
|
|
5680
|
+
"application/json": components["schemas"]["CryptoNetworkDto"][];
|
|
5681
|
+
};
|
|
5682
|
+
};
|
|
5683
|
+
/** @description `unsupported_currency`. */
|
|
5684
|
+
400: {
|
|
5685
|
+
headers: {
|
|
5686
|
+
[name: string]: unknown;
|
|
5687
|
+
};
|
|
5688
|
+
content: {
|
|
5689
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5690
|
+
};
|
|
5691
|
+
};
|
|
5692
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
5693
|
+
401: {
|
|
5694
|
+
headers: {
|
|
5695
|
+
[name: string]: unknown;
|
|
5696
|
+
};
|
|
5697
|
+
content: {
|
|
5698
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5699
|
+
};
|
|
5700
|
+
};
|
|
5701
|
+
/** @description `method_not_allowed` — that stablecoin is not enabled for this account. */
|
|
5702
|
+
403: {
|
|
5703
|
+
headers: {
|
|
5704
|
+
[name: string]: unknown;
|
|
5705
|
+
};
|
|
5706
|
+
content: {
|
|
5707
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5708
|
+
};
|
|
5709
|
+
};
|
|
5710
|
+
/** @description Client error. */
|
|
5214
5711
|
"4XX": {
|
|
5215
5712
|
headers: {
|
|
5216
5713
|
[name: string]: unknown;
|
|
@@ -5386,6 +5883,61 @@ interface operations {
|
|
|
5386
5883
|
};
|
|
5387
5884
|
};
|
|
5388
5885
|
};
|
|
5886
|
+
CopPayments_channels: {
|
|
5887
|
+
parameters: {
|
|
5888
|
+
query?: never;
|
|
5889
|
+
header?: never;
|
|
5890
|
+
path?: never;
|
|
5891
|
+
cookie?: never;
|
|
5892
|
+
};
|
|
5893
|
+
requestBody?: never;
|
|
5894
|
+
responses: {
|
|
5895
|
+
200: {
|
|
5896
|
+
headers: {
|
|
5897
|
+
[name: string]: unknown;
|
|
5898
|
+
};
|
|
5899
|
+
content: {
|
|
5900
|
+
"application/json": components["schemas"]["CopChannelsDto"];
|
|
5901
|
+
};
|
|
5902
|
+
};
|
|
5903
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
5904
|
+
401: {
|
|
5905
|
+
headers: {
|
|
5906
|
+
[name: string]: unknown;
|
|
5907
|
+
};
|
|
5908
|
+
content: {
|
|
5909
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5910
|
+
};
|
|
5911
|
+
};
|
|
5912
|
+
/** @description `method_not_allowed` — COP is not enabled for this account. */
|
|
5913
|
+
403: {
|
|
5914
|
+
headers: {
|
|
5915
|
+
[name: string]: unknown;
|
|
5916
|
+
};
|
|
5917
|
+
content: {
|
|
5918
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5919
|
+
};
|
|
5920
|
+
};
|
|
5921
|
+
/** @description Client error. */
|
|
5922
|
+
"4XX": {
|
|
5923
|
+
headers: {
|
|
5924
|
+
[name: string]: unknown;
|
|
5925
|
+
};
|
|
5926
|
+
content: {
|
|
5927
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5928
|
+
};
|
|
5929
|
+
};
|
|
5930
|
+
/** @description Server or upstream bank error. */
|
|
5931
|
+
"5XX": {
|
|
5932
|
+
headers: {
|
|
5933
|
+
[name: string]: unknown;
|
|
5934
|
+
};
|
|
5935
|
+
content: {
|
|
5936
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5937
|
+
};
|
|
5938
|
+
};
|
|
5939
|
+
};
|
|
5940
|
+
};
|
|
5389
5941
|
CopPayments_create: {
|
|
5390
5942
|
parameters: {
|
|
5391
5943
|
query?: never;
|
|
@@ -5410,7 +5962,7 @@ interface operations {
|
|
|
5410
5962
|
"application/json": components["schemas"]["CopPaymentDto"];
|
|
5411
5963
|
};
|
|
5412
5964
|
};
|
|
5413
|
-
/** @description `invalid_data` (names the field)
|
|
5965
|
+
/** @description `invalid_data` (names the field), `amount_below_minimum`, `amount_out_of_range`, or `channel_requires_checkout` (card). */
|
|
5414
5966
|
400: {
|
|
5415
5967
|
headers: {
|
|
5416
5968
|
[name: string]: unknown;
|
|
@@ -5755,7 +6307,7 @@ interface operations {
|
|
|
5755
6307
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5756
6308
|
};
|
|
5757
6309
|
};
|
|
5758
|
-
/** @description `invalid_state`, `refund_window_expired` or `insufficient_balance`. */
|
|
6310
|
+
/** @description `invalid_state`, `refund_not_supported` (the channel has no refunds), `refund_window_expired` or `insufficient_balance`. */
|
|
5759
6311
|
409: {
|
|
5760
6312
|
headers: {
|
|
5761
6313
|
[name: string]: unknown;
|
|
@@ -7943,7 +8495,7 @@ interface operations {
|
|
|
7943
8495
|
[name: string]: unknown;
|
|
7944
8496
|
};
|
|
7945
8497
|
content: {
|
|
7946
|
-
"application/json": components["schemas"]["
|
|
8498
|
+
"application/json": components["schemas"]["MerchantTransferResponseDto"];
|
|
7947
8499
|
};
|
|
7948
8500
|
};
|
|
7949
8501
|
/** @description Validation failure. */
|
|
@@ -8001,9 +8553,18 @@ interface operations {
|
|
|
8001
8553
|
};
|
|
8002
8554
|
};
|
|
8003
8555
|
};
|
|
8004
|
-
|
|
8556
|
+
Merchants_listTransactions: {
|
|
8005
8557
|
parameters: {
|
|
8006
|
-
query?:
|
|
8558
|
+
query?: {
|
|
8559
|
+
/** @description ISO 8601, exclusive (createdAt). */
|
|
8560
|
+
to?: string;
|
|
8561
|
+
/** @description ISO 8601, inclusive (createdAt). */
|
|
8562
|
+
from?: string;
|
|
8563
|
+
/** @description `nextCursor` from the previous page. */
|
|
8564
|
+
cursor?: string;
|
|
8565
|
+
/** @description 1–100, default 50. */
|
|
8566
|
+
limit?: number;
|
|
8567
|
+
};
|
|
8007
8568
|
header?: never;
|
|
8008
8569
|
path: {
|
|
8009
8570
|
id: string;
|
|
@@ -8017,7 +8578,7 @@ interface operations {
|
|
|
8017
8578
|
[name: string]: unknown;
|
|
8018
8579
|
};
|
|
8019
8580
|
content: {
|
|
8020
|
-
"application/json": components["schemas"]["
|
|
8581
|
+
"application/json": components["schemas"]["MerchantMovementListDto"];
|
|
8021
8582
|
};
|
|
8022
8583
|
};
|
|
8023
8584
|
/** @description Validation failure. */
|
|
@@ -8075,9 +8636,14 @@ interface operations {
|
|
|
8075
8636
|
};
|
|
8076
8637
|
};
|
|
8077
8638
|
};
|
|
8078
|
-
|
|
8639
|
+
Merchants_statement: {
|
|
8079
8640
|
parameters: {
|
|
8080
|
-
query
|
|
8641
|
+
query: {
|
|
8642
|
+
/** @description YYYY-MM. */
|
|
8643
|
+
month: string;
|
|
8644
|
+
/** @description Default json. */
|
|
8645
|
+
format?: "json" | "csv";
|
|
8646
|
+
};
|
|
8081
8647
|
header?: never;
|
|
8082
8648
|
path: {
|
|
8083
8649
|
id: string;
|
|
@@ -8091,7 +8657,7 @@ interface operations {
|
|
|
8091
8657
|
[name: string]: unknown;
|
|
8092
8658
|
};
|
|
8093
8659
|
content: {
|
|
8094
|
-
"application/json": components["schemas"]["
|
|
8660
|
+
"application/json": components["schemas"]["MerchantStatementDto"];
|
|
8095
8661
|
};
|
|
8096
8662
|
};
|
|
8097
8663
|
/** @description Validation failure. */
|
|
@@ -8121,7 +8687,6 @@ interface operations {
|
|
|
8121
8687
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8122
8688
|
};
|
|
8123
8689
|
};
|
|
8124
|
-
/** @description Merchant not found for this tenant. */
|
|
8125
8690
|
404: {
|
|
8126
8691
|
headers: {
|
|
8127
8692
|
[name: string]: unknown;
|
|
@@ -8130,15 +8695,6 @@ interface operations {
|
|
|
8130
8695
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8131
8696
|
};
|
|
8132
8697
|
};
|
|
8133
|
-
/** @description merchant_has_payouts — merchant has payout history; deactivate instead. */
|
|
8134
|
-
409: {
|
|
8135
|
-
headers: {
|
|
8136
|
-
[name: string]: unknown;
|
|
8137
|
-
};
|
|
8138
|
-
content: {
|
|
8139
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8140
|
-
};
|
|
8141
|
-
};
|
|
8142
8698
|
/** @description Client error. */
|
|
8143
8699
|
"4XX": {
|
|
8144
8700
|
headers: {
|
|
@@ -8159,7 +8715,7 @@ interface operations {
|
|
|
8159
8715
|
};
|
|
8160
8716
|
};
|
|
8161
8717
|
};
|
|
8162
|
-
|
|
8718
|
+
Merchants_getById: {
|
|
8163
8719
|
parameters: {
|
|
8164
8720
|
query?: never;
|
|
8165
8721
|
header?: never;
|
|
@@ -8168,11 +8724,7 @@ interface operations {
|
|
|
8168
8724
|
};
|
|
8169
8725
|
cookie?: never;
|
|
8170
8726
|
};
|
|
8171
|
-
requestBody
|
|
8172
|
-
content: {
|
|
8173
|
-
"application/json": components["schemas"]["UpdateMerchantDto"];
|
|
8174
|
-
};
|
|
8175
|
-
};
|
|
8727
|
+
requestBody?: never;
|
|
8176
8728
|
responses: {
|
|
8177
8729
|
200: {
|
|
8178
8730
|
headers: {
|
|
@@ -8237,7 +8789,7 @@ interface operations {
|
|
|
8237
8789
|
};
|
|
8238
8790
|
};
|
|
8239
8791
|
};
|
|
8240
|
-
|
|
8792
|
+
Merchants_remove: {
|
|
8241
8793
|
parameters: {
|
|
8242
8794
|
query?: never;
|
|
8243
8795
|
header?: never;
|
|
@@ -8253,7 +8805,7 @@ interface operations {
|
|
|
8253
8805
|
[name: string]: unknown;
|
|
8254
8806
|
};
|
|
8255
8807
|
content: {
|
|
8256
|
-
"application/json": components["schemas"]["
|
|
8808
|
+
"application/json": components["schemas"]["DeleteMerchantResponseDto"];
|
|
8257
8809
|
};
|
|
8258
8810
|
};
|
|
8259
8811
|
/** @description Validation failure. */
|
|
@@ -8283,6 +8835,7 @@ interface operations {
|
|
|
8283
8835
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8284
8836
|
};
|
|
8285
8837
|
};
|
|
8838
|
+
/** @description Merchant not found for this tenant. */
|
|
8286
8839
|
404: {
|
|
8287
8840
|
headers: {
|
|
8288
8841
|
[name: string]: unknown;
|
|
@@ -8291,6 +8844,15 @@ interface operations {
|
|
|
8291
8844
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8292
8845
|
};
|
|
8293
8846
|
};
|
|
8847
|
+
/** @description merchant_has_payouts — merchant has payout history; deactivate instead. */
|
|
8848
|
+
409: {
|
|
8849
|
+
headers: {
|
|
8850
|
+
[name: string]: unknown;
|
|
8851
|
+
};
|
|
8852
|
+
content: {
|
|
8853
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8854
|
+
};
|
|
8855
|
+
};
|
|
8294
8856
|
/** @description Client error. */
|
|
8295
8857
|
"4XX": {
|
|
8296
8858
|
headers: {
|
|
@@ -8311,26 +8873,27 @@ interface operations {
|
|
|
8311
8873
|
};
|
|
8312
8874
|
};
|
|
8313
8875
|
};
|
|
8314
|
-
|
|
8876
|
+
Merchants_update: {
|
|
8315
8877
|
parameters: {
|
|
8316
8878
|
query?: never;
|
|
8317
|
-
header?:
|
|
8318
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
8319
|
-
"Idempotency-Key"?: string;
|
|
8320
|
-
};
|
|
8879
|
+
header?: never;
|
|
8321
8880
|
path: {
|
|
8322
8881
|
id: string;
|
|
8323
8882
|
};
|
|
8324
8883
|
cookie?: never;
|
|
8325
8884
|
};
|
|
8326
|
-
requestBody
|
|
8885
|
+
requestBody: {
|
|
8886
|
+
content: {
|
|
8887
|
+
"application/json": components["schemas"]["UpdateMerchantDto"];
|
|
8888
|
+
};
|
|
8889
|
+
};
|
|
8327
8890
|
responses: {
|
|
8328
|
-
|
|
8891
|
+
200: {
|
|
8329
8892
|
headers: {
|
|
8330
8893
|
[name: string]: unknown;
|
|
8331
8894
|
};
|
|
8332
8895
|
content: {
|
|
8333
|
-
"application/json": components["schemas"]["
|
|
8896
|
+
"application/json": components["schemas"]["MerchantResponseDto"];
|
|
8334
8897
|
};
|
|
8335
8898
|
};
|
|
8336
8899
|
/** @description Validation failure. */
|
|
@@ -8388,30 +8951,23 @@ interface operations {
|
|
|
8388
8951
|
};
|
|
8389
8952
|
};
|
|
8390
8953
|
};
|
|
8391
|
-
|
|
8954
|
+
Merchants_listAuditEvents: {
|
|
8392
8955
|
parameters: {
|
|
8393
8956
|
query?: never;
|
|
8394
|
-
header?:
|
|
8395
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
8396
|
-
"Idempotency-Key"?: string;
|
|
8397
|
-
};
|
|
8957
|
+
header?: never;
|
|
8398
8958
|
path: {
|
|
8399
8959
|
id: string;
|
|
8400
8960
|
};
|
|
8401
8961
|
cookie?: never;
|
|
8402
8962
|
};
|
|
8403
|
-
requestBody
|
|
8404
|
-
content: {
|
|
8405
|
-
"application/json": components["schemas"]["ConfirmMerchantVerifyDto"];
|
|
8406
|
-
};
|
|
8407
|
-
};
|
|
8963
|
+
requestBody?: never;
|
|
8408
8964
|
responses: {
|
|
8409
8965
|
200: {
|
|
8410
8966
|
headers: {
|
|
8411
8967
|
[name: string]: unknown;
|
|
8412
8968
|
};
|
|
8413
8969
|
content: {
|
|
8414
|
-
"application/json": components["schemas"]["
|
|
8970
|
+
"application/json": components["schemas"]["MerchantAuditEventListDto"];
|
|
8415
8971
|
};
|
|
8416
8972
|
};
|
|
8417
8973
|
/** @description Validation failure. */
|
|
@@ -8469,31 +9025,29 @@ interface operations {
|
|
|
8469
9025
|
};
|
|
8470
9026
|
};
|
|
8471
9027
|
};
|
|
8472
|
-
|
|
9028
|
+
Merchants_startVerify: {
|
|
8473
9029
|
parameters: {
|
|
8474
9030
|
query?: never;
|
|
8475
9031
|
header?: {
|
|
8476
9032
|
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
8477
9033
|
"Idempotency-Key"?: string;
|
|
8478
9034
|
};
|
|
8479
|
-
path
|
|
8480
|
-
|
|
8481
|
-
};
|
|
8482
|
-
requestBody: {
|
|
8483
|
-
content: {
|
|
8484
|
-
"application/json": components["schemas"]["CreateCheckoutSessionDto"];
|
|
9035
|
+
path: {
|
|
9036
|
+
id: string;
|
|
8485
9037
|
};
|
|
9038
|
+
cookie?: never;
|
|
8486
9039
|
};
|
|
9040
|
+
requestBody?: never;
|
|
8487
9041
|
responses: {
|
|
8488
|
-
|
|
9042
|
+
202: {
|
|
8489
9043
|
headers: {
|
|
8490
9044
|
[name: string]: unknown;
|
|
8491
9045
|
};
|
|
8492
9046
|
content: {
|
|
8493
|
-
"application/json": components["schemas"]["
|
|
9047
|
+
"application/json": components["schemas"]["VerifyStartResponseDto"];
|
|
8494
9048
|
};
|
|
8495
9049
|
};
|
|
8496
|
-
/** @description
|
|
9050
|
+
/** @description Validation failure. */
|
|
8497
9051
|
400: {
|
|
8498
9052
|
headers: {
|
|
8499
9053
|
[name: string]: unknown;
|
|
@@ -8502,7 +9056,7 @@ interface operations {
|
|
|
8502
9056
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8503
9057
|
};
|
|
8504
9058
|
};
|
|
8505
|
-
/** @description Missing or
|
|
9059
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
8506
9060
|
401: {
|
|
8507
9061
|
headers: {
|
|
8508
9062
|
[name: string]: unknown;
|
|
@@ -8520,8 +9074,7 @@ interface operations {
|
|
|
8520
9074
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8521
9075
|
};
|
|
8522
9076
|
};
|
|
8523
|
-
|
|
8524
|
-
422: {
|
|
9077
|
+
404: {
|
|
8525
9078
|
headers: {
|
|
8526
9079
|
[name: string]: unknown;
|
|
8527
9080
|
};
|
|
@@ -8549,27 +9102,188 @@ interface operations {
|
|
|
8549
9102
|
};
|
|
8550
9103
|
};
|
|
8551
9104
|
};
|
|
8552
|
-
|
|
9105
|
+
Merchants_confirmVerify: {
|
|
8553
9106
|
parameters: {
|
|
8554
9107
|
query?: never;
|
|
8555
|
-
header?:
|
|
9108
|
+
header?: {
|
|
9109
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9110
|
+
"Idempotency-Key"?: string;
|
|
9111
|
+
};
|
|
8556
9112
|
path: {
|
|
8557
9113
|
id: string;
|
|
8558
9114
|
};
|
|
8559
9115
|
cookie?: never;
|
|
8560
9116
|
};
|
|
8561
|
-
requestBody
|
|
9117
|
+
requestBody: {
|
|
9118
|
+
content: {
|
|
9119
|
+
"application/json": components["schemas"]["ConfirmMerchantVerifyDto"];
|
|
9120
|
+
};
|
|
9121
|
+
};
|
|
8562
9122
|
responses: {
|
|
8563
9123
|
200: {
|
|
8564
9124
|
headers: {
|
|
8565
9125
|
[name: string]: unknown;
|
|
8566
9126
|
};
|
|
8567
9127
|
content: {
|
|
8568
|
-
"application/json": components["schemas"]["
|
|
9128
|
+
"application/json": components["schemas"]["VerifyConfirmResponseDto"];
|
|
8569
9129
|
};
|
|
8570
9130
|
};
|
|
8571
|
-
/** @description
|
|
8572
|
-
|
|
9131
|
+
/** @description Validation failure. */
|
|
9132
|
+
400: {
|
|
9133
|
+
headers: {
|
|
9134
|
+
[name: string]: unknown;
|
|
9135
|
+
};
|
|
9136
|
+
content: {
|
|
9137
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9138
|
+
};
|
|
9139
|
+
};
|
|
9140
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9141
|
+
401: {
|
|
9142
|
+
headers: {
|
|
9143
|
+
[name: string]: unknown;
|
|
9144
|
+
};
|
|
9145
|
+
content: {
|
|
9146
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9147
|
+
};
|
|
9148
|
+
};
|
|
9149
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9150
|
+
403: {
|
|
9151
|
+
headers: {
|
|
9152
|
+
[name: string]: unknown;
|
|
9153
|
+
};
|
|
9154
|
+
content: {
|
|
9155
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9156
|
+
};
|
|
9157
|
+
};
|
|
9158
|
+
404: {
|
|
9159
|
+
headers: {
|
|
9160
|
+
[name: string]: unknown;
|
|
9161
|
+
};
|
|
9162
|
+
content: {
|
|
9163
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9164
|
+
};
|
|
9165
|
+
};
|
|
9166
|
+
/** @description Client error. */
|
|
9167
|
+
"4XX": {
|
|
9168
|
+
headers: {
|
|
9169
|
+
[name: string]: unknown;
|
|
9170
|
+
};
|
|
9171
|
+
content: {
|
|
9172
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9173
|
+
};
|
|
9174
|
+
};
|
|
9175
|
+
/** @description Server or upstream bank error. */
|
|
9176
|
+
"5XX": {
|
|
9177
|
+
headers: {
|
|
9178
|
+
[name: string]: unknown;
|
|
9179
|
+
};
|
|
9180
|
+
content: {
|
|
9181
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9182
|
+
};
|
|
9183
|
+
};
|
|
9184
|
+
};
|
|
9185
|
+
};
|
|
9186
|
+
CheckoutSessions_create: {
|
|
9187
|
+
parameters: {
|
|
9188
|
+
query?: never;
|
|
9189
|
+
header?: {
|
|
9190
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9191
|
+
"Idempotency-Key"?: string;
|
|
9192
|
+
};
|
|
9193
|
+
path?: never;
|
|
9194
|
+
cookie?: never;
|
|
9195
|
+
};
|
|
9196
|
+
requestBody: {
|
|
9197
|
+
content: {
|
|
9198
|
+
"application/json": components["schemas"]["CreateCheckoutSessionDto"];
|
|
9199
|
+
};
|
|
9200
|
+
};
|
|
9201
|
+
responses: {
|
|
9202
|
+
201: {
|
|
9203
|
+
headers: {
|
|
9204
|
+
[name: string]: unknown;
|
|
9205
|
+
};
|
|
9206
|
+
content: {
|
|
9207
|
+
"application/json": components["schemas"]["CheckoutSessionResponseDto"];
|
|
9208
|
+
};
|
|
9209
|
+
};
|
|
9210
|
+
/** @description invalid_data (e.g. a non-https origin on a live tenant). */
|
|
9211
|
+
400: {
|
|
9212
|
+
headers: {
|
|
9213
|
+
[name: string]: unknown;
|
|
9214
|
+
};
|
|
9215
|
+
content: {
|
|
9216
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9217
|
+
};
|
|
9218
|
+
};
|
|
9219
|
+
/** @description Missing or invalid tenant API key. */
|
|
9220
|
+
401: {
|
|
9221
|
+
headers: {
|
|
9222
|
+
[name: string]: unknown;
|
|
9223
|
+
};
|
|
9224
|
+
content: {
|
|
9225
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9226
|
+
};
|
|
9227
|
+
};
|
|
9228
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9229
|
+
403: {
|
|
9230
|
+
headers: {
|
|
9231
|
+
[name: string]: unknown;
|
|
9232
|
+
};
|
|
9233
|
+
content: {
|
|
9234
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9235
|
+
};
|
|
9236
|
+
};
|
|
9237
|
+
/** @description amount_below_minimum */
|
|
9238
|
+
422: {
|
|
9239
|
+
headers: {
|
|
9240
|
+
[name: string]: unknown;
|
|
9241
|
+
};
|
|
9242
|
+
content: {
|
|
9243
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9244
|
+
};
|
|
9245
|
+
};
|
|
9246
|
+
/** @description Client error. */
|
|
9247
|
+
"4XX": {
|
|
9248
|
+
headers: {
|
|
9249
|
+
[name: string]: unknown;
|
|
9250
|
+
};
|
|
9251
|
+
content: {
|
|
9252
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9253
|
+
};
|
|
9254
|
+
};
|
|
9255
|
+
/** @description Server or upstream bank error. */
|
|
9256
|
+
"5XX": {
|
|
9257
|
+
headers: {
|
|
9258
|
+
[name: string]: unknown;
|
|
9259
|
+
};
|
|
9260
|
+
content: {
|
|
9261
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9262
|
+
};
|
|
9263
|
+
};
|
|
9264
|
+
};
|
|
9265
|
+
};
|
|
9266
|
+
CheckoutSessions_retrieve: {
|
|
9267
|
+
parameters: {
|
|
9268
|
+
query?: never;
|
|
9269
|
+
header?: never;
|
|
9270
|
+
path: {
|
|
9271
|
+
id: string;
|
|
9272
|
+
};
|
|
9273
|
+
cookie?: never;
|
|
9274
|
+
};
|
|
9275
|
+
requestBody?: never;
|
|
9276
|
+
responses: {
|
|
9277
|
+
200: {
|
|
9278
|
+
headers: {
|
|
9279
|
+
[name: string]: unknown;
|
|
9280
|
+
};
|
|
9281
|
+
content: {
|
|
9282
|
+
"application/json": components["schemas"]["CheckoutSessionResponseDto"];
|
|
9283
|
+
};
|
|
9284
|
+
};
|
|
9285
|
+
/** @description Missing or invalid tenant API key. */
|
|
9286
|
+
401: {
|
|
8573
9287
|
headers: {
|
|
8574
9288
|
[name: string]: unknown;
|
|
8575
9289
|
};
|
|
@@ -8703,7 +9417,381 @@ interface operations {
|
|
|
8703
9417
|
[name: string]: unknown;
|
|
8704
9418
|
};
|
|
8705
9419
|
content: {
|
|
8706
|
-
"application/json": components["schemas"]["ProductResponseDto"];
|
|
9420
|
+
"application/json": components["schemas"]["ProductResponseDto"];
|
|
9421
|
+
};
|
|
9422
|
+
};
|
|
9423
|
+
/** @description Validation failure. */
|
|
9424
|
+
400: {
|
|
9425
|
+
headers: {
|
|
9426
|
+
[name: string]: unknown;
|
|
9427
|
+
};
|
|
9428
|
+
content: {
|
|
9429
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9430
|
+
};
|
|
9431
|
+
};
|
|
9432
|
+
/** @description Missing or invalid tenant API key. */
|
|
9433
|
+
401: {
|
|
9434
|
+
headers: {
|
|
9435
|
+
[name: string]: unknown;
|
|
9436
|
+
};
|
|
9437
|
+
content: {
|
|
9438
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9439
|
+
};
|
|
9440
|
+
};
|
|
9441
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9442
|
+
403: {
|
|
9443
|
+
headers: {
|
|
9444
|
+
[name: string]: unknown;
|
|
9445
|
+
};
|
|
9446
|
+
content: {
|
|
9447
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9448
|
+
};
|
|
9449
|
+
};
|
|
9450
|
+
/** @description Client error. */
|
|
9451
|
+
"4XX": {
|
|
9452
|
+
headers: {
|
|
9453
|
+
[name: string]: unknown;
|
|
9454
|
+
};
|
|
9455
|
+
content: {
|
|
9456
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9457
|
+
};
|
|
9458
|
+
};
|
|
9459
|
+
/** @description Server or upstream bank error. */
|
|
9460
|
+
"5XX": {
|
|
9461
|
+
headers: {
|
|
9462
|
+
[name: string]: unknown;
|
|
9463
|
+
};
|
|
9464
|
+
content: {
|
|
9465
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9466
|
+
};
|
|
9467
|
+
};
|
|
9468
|
+
};
|
|
9469
|
+
};
|
|
9470
|
+
Products_get: {
|
|
9471
|
+
parameters: {
|
|
9472
|
+
query?: never;
|
|
9473
|
+
header?: never;
|
|
9474
|
+
path: {
|
|
9475
|
+
id: string;
|
|
9476
|
+
};
|
|
9477
|
+
cookie?: never;
|
|
9478
|
+
};
|
|
9479
|
+
requestBody?: never;
|
|
9480
|
+
responses: {
|
|
9481
|
+
200: {
|
|
9482
|
+
headers: {
|
|
9483
|
+
[name: string]: unknown;
|
|
9484
|
+
};
|
|
9485
|
+
content: {
|
|
9486
|
+
"application/json": components["schemas"]["ProductResponseDto"];
|
|
9487
|
+
};
|
|
9488
|
+
};
|
|
9489
|
+
/** @description Validation failure. */
|
|
9490
|
+
400: {
|
|
9491
|
+
headers: {
|
|
9492
|
+
[name: string]: unknown;
|
|
9493
|
+
};
|
|
9494
|
+
content: {
|
|
9495
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9496
|
+
};
|
|
9497
|
+
};
|
|
9498
|
+
/** @description Missing or invalid tenant API key. */
|
|
9499
|
+
401: {
|
|
9500
|
+
headers: {
|
|
9501
|
+
[name: string]: unknown;
|
|
9502
|
+
};
|
|
9503
|
+
content: {
|
|
9504
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9505
|
+
};
|
|
9506
|
+
};
|
|
9507
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9508
|
+
403: {
|
|
9509
|
+
headers: {
|
|
9510
|
+
[name: string]: unknown;
|
|
9511
|
+
};
|
|
9512
|
+
content: {
|
|
9513
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9514
|
+
};
|
|
9515
|
+
};
|
|
9516
|
+
404: {
|
|
9517
|
+
headers: {
|
|
9518
|
+
[name: string]: unknown;
|
|
9519
|
+
};
|
|
9520
|
+
content: {
|
|
9521
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9522
|
+
};
|
|
9523
|
+
};
|
|
9524
|
+
/** @description Client error. */
|
|
9525
|
+
"4XX": {
|
|
9526
|
+
headers: {
|
|
9527
|
+
[name: string]: unknown;
|
|
9528
|
+
};
|
|
9529
|
+
content: {
|
|
9530
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9531
|
+
};
|
|
9532
|
+
};
|
|
9533
|
+
/** @description Server or upstream bank error. */
|
|
9534
|
+
"5XX": {
|
|
9535
|
+
headers: {
|
|
9536
|
+
[name: string]: unknown;
|
|
9537
|
+
};
|
|
9538
|
+
content: {
|
|
9539
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9540
|
+
};
|
|
9541
|
+
};
|
|
9542
|
+
};
|
|
9543
|
+
};
|
|
9544
|
+
Products_remove: {
|
|
9545
|
+
parameters: {
|
|
9546
|
+
query?: never;
|
|
9547
|
+
header?: never;
|
|
9548
|
+
path: {
|
|
9549
|
+
id: string;
|
|
9550
|
+
};
|
|
9551
|
+
cookie?: never;
|
|
9552
|
+
};
|
|
9553
|
+
requestBody?: never;
|
|
9554
|
+
responses: {
|
|
9555
|
+
/** @description Validation failure. */
|
|
9556
|
+
400: {
|
|
9557
|
+
headers: {
|
|
9558
|
+
[name: string]: unknown;
|
|
9559
|
+
};
|
|
9560
|
+
content: {
|
|
9561
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9562
|
+
};
|
|
9563
|
+
};
|
|
9564
|
+
/** @description Missing or invalid tenant API key. */
|
|
9565
|
+
401: {
|
|
9566
|
+
headers: {
|
|
9567
|
+
[name: string]: unknown;
|
|
9568
|
+
};
|
|
9569
|
+
content: {
|
|
9570
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9571
|
+
};
|
|
9572
|
+
};
|
|
9573
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9574
|
+
403: {
|
|
9575
|
+
headers: {
|
|
9576
|
+
[name: string]: unknown;
|
|
9577
|
+
};
|
|
9578
|
+
content: {
|
|
9579
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9580
|
+
};
|
|
9581
|
+
};
|
|
9582
|
+
404: {
|
|
9583
|
+
headers: {
|
|
9584
|
+
[name: string]: unknown;
|
|
9585
|
+
};
|
|
9586
|
+
content: {
|
|
9587
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9588
|
+
};
|
|
9589
|
+
};
|
|
9590
|
+
/** @description product_has_sales */
|
|
9591
|
+
409: {
|
|
9592
|
+
headers: {
|
|
9593
|
+
[name: string]: unknown;
|
|
9594
|
+
};
|
|
9595
|
+
content: {
|
|
9596
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9597
|
+
};
|
|
9598
|
+
};
|
|
9599
|
+
/** @description Client error. */
|
|
9600
|
+
"4XX": {
|
|
9601
|
+
headers: {
|
|
9602
|
+
[name: string]: unknown;
|
|
9603
|
+
};
|
|
9604
|
+
content: {
|
|
9605
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9606
|
+
};
|
|
9607
|
+
};
|
|
9608
|
+
/** @description Server or upstream bank error. */
|
|
9609
|
+
"5XX": {
|
|
9610
|
+
headers: {
|
|
9611
|
+
[name: string]: unknown;
|
|
9612
|
+
};
|
|
9613
|
+
content: {
|
|
9614
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9615
|
+
};
|
|
9616
|
+
};
|
|
9617
|
+
};
|
|
9618
|
+
};
|
|
9619
|
+
Products_update: {
|
|
9620
|
+
parameters: {
|
|
9621
|
+
query?: never;
|
|
9622
|
+
header?: never;
|
|
9623
|
+
path: {
|
|
9624
|
+
id: string;
|
|
9625
|
+
};
|
|
9626
|
+
cookie?: never;
|
|
9627
|
+
};
|
|
9628
|
+
requestBody: {
|
|
9629
|
+
content: {
|
|
9630
|
+
"application/json": components["schemas"]["UpdateProductDto"];
|
|
9631
|
+
};
|
|
9632
|
+
};
|
|
9633
|
+
responses: {
|
|
9634
|
+
200: {
|
|
9635
|
+
headers: {
|
|
9636
|
+
[name: string]: unknown;
|
|
9637
|
+
};
|
|
9638
|
+
content: {
|
|
9639
|
+
"application/json": components["schemas"]["ProductResponseDto"];
|
|
9640
|
+
};
|
|
9641
|
+
};
|
|
9642
|
+
/** @description Validation failure. */
|
|
9643
|
+
400: {
|
|
9644
|
+
headers: {
|
|
9645
|
+
[name: string]: unknown;
|
|
9646
|
+
};
|
|
9647
|
+
content: {
|
|
9648
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9649
|
+
};
|
|
9650
|
+
};
|
|
9651
|
+
/** @description Missing or invalid tenant API key. */
|
|
9652
|
+
401: {
|
|
9653
|
+
headers: {
|
|
9654
|
+
[name: string]: unknown;
|
|
9655
|
+
};
|
|
9656
|
+
content: {
|
|
9657
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9658
|
+
};
|
|
9659
|
+
};
|
|
9660
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9661
|
+
403: {
|
|
9662
|
+
headers: {
|
|
9663
|
+
[name: string]: unknown;
|
|
9664
|
+
};
|
|
9665
|
+
content: {
|
|
9666
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9667
|
+
};
|
|
9668
|
+
};
|
|
9669
|
+
404: {
|
|
9670
|
+
headers: {
|
|
9671
|
+
[name: string]: unknown;
|
|
9672
|
+
};
|
|
9673
|
+
content: {
|
|
9674
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9675
|
+
};
|
|
9676
|
+
};
|
|
9677
|
+
/** @description Client error. */
|
|
9678
|
+
"4XX": {
|
|
9679
|
+
headers: {
|
|
9680
|
+
[name: string]: unknown;
|
|
9681
|
+
};
|
|
9682
|
+
content: {
|
|
9683
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9684
|
+
};
|
|
9685
|
+
};
|
|
9686
|
+
/** @description Server or upstream bank error. */
|
|
9687
|
+
"5XX": {
|
|
9688
|
+
headers: {
|
|
9689
|
+
[name: string]: unknown;
|
|
9690
|
+
};
|
|
9691
|
+
content: {
|
|
9692
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9693
|
+
};
|
|
9694
|
+
};
|
|
9695
|
+
};
|
|
9696
|
+
};
|
|
9697
|
+
Products_listLinks: {
|
|
9698
|
+
parameters: {
|
|
9699
|
+
query?: never;
|
|
9700
|
+
header?: never;
|
|
9701
|
+
path: {
|
|
9702
|
+
id: string;
|
|
9703
|
+
};
|
|
9704
|
+
cookie?: never;
|
|
9705
|
+
};
|
|
9706
|
+
requestBody?: never;
|
|
9707
|
+
responses: {
|
|
9708
|
+
200: {
|
|
9709
|
+
headers: {
|
|
9710
|
+
[name: string]: unknown;
|
|
9711
|
+
};
|
|
9712
|
+
content: {
|
|
9713
|
+
"application/json": components["schemas"]["PaymentLinkListResponseDto"];
|
|
9714
|
+
};
|
|
9715
|
+
};
|
|
9716
|
+
/** @description Validation failure. */
|
|
9717
|
+
400: {
|
|
9718
|
+
headers: {
|
|
9719
|
+
[name: string]: unknown;
|
|
9720
|
+
};
|
|
9721
|
+
content: {
|
|
9722
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9723
|
+
};
|
|
9724
|
+
};
|
|
9725
|
+
/** @description Missing or invalid tenant API key. */
|
|
9726
|
+
401: {
|
|
9727
|
+
headers: {
|
|
9728
|
+
[name: string]: unknown;
|
|
9729
|
+
};
|
|
9730
|
+
content: {
|
|
9731
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9732
|
+
};
|
|
9733
|
+
};
|
|
9734
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9735
|
+
403: {
|
|
9736
|
+
headers: {
|
|
9737
|
+
[name: string]: unknown;
|
|
9738
|
+
};
|
|
9739
|
+
content: {
|
|
9740
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9741
|
+
};
|
|
9742
|
+
};
|
|
9743
|
+
404: {
|
|
9744
|
+
headers: {
|
|
9745
|
+
[name: string]: unknown;
|
|
9746
|
+
};
|
|
9747
|
+
content: {
|
|
9748
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9749
|
+
};
|
|
9750
|
+
};
|
|
9751
|
+
/** @description Client error. */
|
|
9752
|
+
"4XX": {
|
|
9753
|
+
headers: {
|
|
9754
|
+
[name: string]: unknown;
|
|
9755
|
+
};
|
|
9756
|
+
content: {
|
|
9757
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9758
|
+
};
|
|
9759
|
+
};
|
|
9760
|
+
/** @description Server or upstream bank error. */
|
|
9761
|
+
"5XX": {
|
|
9762
|
+
headers: {
|
|
9763
|
+
[name: string]: unknown;
|
|
9764
|
+
};
|
|
9765
|
+
content: {
|
|
9766
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9767
|
+
};
|
|
9768
|
+
};
|
|
9769
|
+
};
|
|
9770
|
+
};
|
|
9771
|
+
Products_createLink: {
|
|
9772
|
+
parameters: {
|
|
9773
|
+
query?: never;
|
|
9774
|
+
header?: {
|
|
9775
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9776
|
+
"Idempotency-Key"?: string;
|
|
9777
|
+
};
|
|
9778
|
+
path: {
|
|
9779
|
+
id: string;
|
|
9780
|
+
};
|
|
9781
|
+
cookie?: never;
|
|
9782
|
+
};
|
|
9783
|
+
requestBody: {
|
|
9784
|
+
content: {
|
|
9785
|
+
"application/json": components["schemas"]["CreatePaymentLinkDto"];
|
|
9786
|
+
};
|
|
9787
|
+
};
|
|
9788
|
+
responses: {
|
|
9789
|
+
201: {
|
|
9790
|
+
headers: {
|
|
9791
|
+
[name: string]: unknown;
|
|
9792
|
+
};
|
|
9793
|
+
content: {
|
|
9794
|
+
"application/json": components["schemas"]["PaymentLinkResponseDto"];
|
|
8707
9795
|
};
|
|
8708
9796
|
};
|
|
8709
9797
|
/** @description Validation failure. */
|
|
@@ -8733,6 +9821,23 @@ interface operations {
|
|
|
8733
9821
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8734
9822
|
};
|
|
8735
9823
|
};
|
|
9824
|
+
404: {
|
|
9825
|
+
headers: {
|
|
9826
|
+
[name: string]: unknown;
|
|
9827
|
+
};
|
|
9828
|
+
content: {
|
|
9829
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9830
|
+
};
|
|
9831
|
+
};
|
|
9832
|
+
/** @description slug_taken */
|
|
9833
|
+
409: {
|
|
9834
|
+
headers: {
|
|
9835
|
+
[name: string]: unknown;
|
|
9836
|
+
};
|
|
9837
|
+
content: {
|
|
9838
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9839
|
+
};
|
|
9840
|
+
};
|
|
8736
9841
|
/** @description Client error. */
|
|
8737
9842
|
"4XX": {
|
|
8738
9843
|
headers: {
|
|
@@ -8753,7 +9858,7 @@ interface operations {
|
|
|
8753
9858
|
};
|
|
8754
9859
|
};
|
|
8755
9860
|
};
|
|
8756
|
-
|
|
9861
|
+
PaymentLinks_get: {
|
|
8757
9862
|
parameters: {
|
|
8758
9863
|
query?: never;
|
|
8759
9864
|
header?: never;
|
|
@@ -8769,16 +9874,7 @@ interface operations {
|
|
|
8769
9874
|
[name: string]: unknown;
|
|
8770
9875
|
};
|
|
8771
9876
|
content: {
|
|
8772
|
-
"application/json": components["schemas"]["
|
|
8773
|
-
};
|
|
8774
|
-
};
|
|
8775
|
-
/** @description Validation failure. */
|
|
8776
|
-
400: {
|
|
8777
|
-
headers: {
|
|
8778
|
-
[name: string]: unknown;
|
|
8779
|
-
};
|
|
8780
|
-
content: {
|
|
8781
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9877
|
+
"application/json": components["schemas"]["PaymentLinkResponseDto"];
|
|
8782
9878
|
};
|
|
8783
9879
|
};
|
|
8784
9880
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -8827,7 +9923,7 @@ interface operations {
|
|
|
8827
9923
|
};
|
|
8828
9924
|
};
|
|
8829
9925
|
};
|
|
8830
|
-
|
|
9926
|
+
PaymentLinks_remove: {
|
|
8831
9927
|
parameters: {
|
|
8832
9928
|
query?: never;
|
|
8833
9929
|
header?: never;
|
|
@@ -8838,15 +9934,6 @@ interface operations {
|
|
|
8838
9934
|
};
|
|
8839
9935
|
requestBody?: never;
|
|
8840
9936
|
responses: {
|
|
8841
|
-
/** @description Validation failure. */
|
|
8842
|
-
400: {
|
|
8843
|
-
headers: {
|
|
8844
|
-
[name: string]: unknown;
|
|
8845
|
-
};
|
|
8846
|
-
content: {
|
|
8847
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8848
|
-
};
|
|
8849
|
-
};
|
|
8850
9937
|
/** @description Missing or invalid tenant API key. */
|
|
8851
9938
|
401: {
|
|
8852
9939
|
headers: {
|
|
@@ -8902,7 +9989,7 @@ interface operations {
|
|
|
8902
9989
|
};
|
|
8903
9990
|
};
|
|
8904
9991
|
};
|
|
8905
|
-
|
|
9992
|
+
PaymentLinks_update: {
|
|
8906
9993
|
parameters: {
|
|
8907
9994
|
query?: never;
|
|
8908
9995
|
header?: never;
|
|
@@ -8913,7 +10000,7 @@ interface operations {
|
|
|
8913
10000
|
};
|
|
8914
10001
|
requestBody: {
|
|
8915
10002
|
content: {
|
|
8916
|
-
"application/json": components["schemas"]["
|
|
10003
|
+
"application/json": components["schemas"]["UpdatePaymentLinkDto"];
|
|
8917
10004
|
};
|
|
8918
10005
|
};
|
|
8919
10006
|
responses: {
|
|
@@ -8922,16 +10009,7 @@ interface operations {
|
|
|
8922
10009
|
[name: string]: unknown;
|
|
8923
10010
|
};
|
|
8924
10011
|
content: {
|
|
8925
|
-
"application/json": components["schemas"]["
|
|
8926
|
-
};
|
|
8927
|
-
};
|
|
8928
|
-
/** @description Validation failure. */
|
|
8929
|
-
400: {
|
|
8930
|
-
headers: {
|
|
8931
|
-
[name: string]: unknown;
|
|
8932
|
-
};
|
|
8933
|
-
content: {
|
|
8934
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10012
|
+
"application/json": components["schemas"]["PaymentLinkResponseDto"];
|
|
8935
10013
|
};
|
|
8936
10014
|
};
|
|
8937
10015
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -8980,13 +10058,14 @@ interface operations {
|
|
|
8980
10058
|
};
|
|
8981
10059
|
};
|
|
8982
10060
|
};
|
|
8983
|
-
|
|
10061
|
+
Topups_list: {
|
|
8984
10062
|
parameters: {
|
|
8985
|
-
query?:
|
|
8986
|
-
|
|
8987
|
-
|
|
8988
|
-
id: string;
|
|
10063
|
+
query?: {
|
|
10064
|
+
/** @description 1–100, default 20. */
|
|
10065
|
+
limit?: number;
|
|
8989
10066
|
};
|
|
10067
|
+
header?: never;
|
|
10068
|
+
path?: never;
|
|
8990
10069
|
cookie?: never;
|
|
8991
10070
|
};
|
|
8992
10071
|
requestBody?: never;
|
|
@@ -8996,19 +10075,10 @@ interface operations {
|
|
|
8996
10075
|
[name: string]: unknown;
|
|
8997
10076
|
};
|
|
8998
10077
|
content: {
|
|
8999
|
-
"application/json": components["schemas"]["
|
|
9000
|
-
};
|
|
9001
|
-
};
|
|
9002
|
-
/** @description Validation failure. */
|
|
9003
|
-
400: {
|
|
9004
|
-
headers: {
|
|
9005
|
-
[name: string]: unknown;
|
|
9006
|
-
};
|
|
9007
|
-
content: {
|
|
9008
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10078
|
+
"application/json": components["schemas"]["TopupListDto"];
|
|
9009
10079
|
};
|
|
9010
10080
|
};
|
|
9011
|
-
/** @description Missing or
|
|
10081
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9012
10082
|
401: {
|
|
9013
10083
|
headers: {
|
|
9014
10084
|
[name: string]: unknown;
|
|
@@ -9017,7 +10087,7 @@ interface operations {
|
|
|
9017
10087
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9018
10088
|
};
|
|
9019
10089
|
};
|
|
9020
|
-
/** @description
|
|
10090
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
9021
10091
|
403: {
|
|
9022
10092
|
headers: {
|
|
9023
10093
|
[name: string]: unknown;
|
|
@@ -9026,14 +10096,6 @@ interface operations {
|
|
|
9026
10096
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9027
10097
|
};
|
|
9028
10098
|
};
|
|
9029
|
-
404: {
|
|
9030
|
-
headers: {
|
|
9031
|
-
[name: string]: unknown;
|
|
9032
|
-
};
|
|
9033
|
-
content: {
|
|
9034
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9035
|
-
};
|
|
9036
|
-
};
|
|
9037
10099
|
/** @description Client error. */
|
|
9038
10100
|
"4XX": {
|
|
9039
10101
|
headers: {
|
|
@@ -9054,21 +10116,19 @@ interface operations {
|
|
|
9054
10116
|
};
|
|
9055
10117
|
};
|
|
9056
10118
|
};
|
|
9057
|
-
|
|
10119
|
+
Topups_create: {
|
|
9058
10120
|
parameters: {
|
|
9059
10121
|
query?: never;
|
|
9060
10122
|
header?: {
|
|
9061
10123
|
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9062
10124
|
"Idempotency-Key"?: string;
|
|
9063
10125
|
};
|
|
9064
|
-
path
|
|
9065
|
-
id: string;
|
|
9066
|
-
};
|
|
10126
|
+
path?: never;
|
|
9067
10127
|
cookie?: never;
|
|
9068
10128
|
};
|
|
9069
10129
|
requestBody: {
|
|
9070
10130
|
content: {
|
|
9071
|
-
"application/json": components["schemas"]["
|
|
10131
|
+
"application/json": components["schemas"]["CreateTopupDto"];
|
|
9072
10132
|
};
|
|
9073
10133
|
};
|
|
9074
10134
|
responses: {
|
|
@@ -9077,19 +10137,10 @@ interface operations {
|
|
|
9077
10137
|
[name: string]: unknown;
|
|
9078
10138
|
};
|
|
9079
10139
|
content: {
|
|
9080
|
-
"application/json": components["schemas"]["
|
|
9081
|
-
};
|
|
9082
|
-
};
|
|
9083
|
-
/** @description Validation failure. */
|
|
9084
|
-
400: {
|
|
9085
|
-
headers: {
|
|
9086
|
-
[name: string]: unknown;
|
|
9087
|
-
};
|
|
9088
|
-
content: {
|
|
9089
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10140
|
+
"application/json": components["schemas"]["TopupDto"];
|
|
9090
10141
|
};
|
|
9091
10142
|
};
|
|
9092
|
-
/** @description Missing or
|
|
10143
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9093
10144
|
401: {
|
|
9094
10145
|
headers: {
|
|
9095
10146
|
[name: string]: unknown;
|
|
@@ -9098,7 +10149,7 @@ interface operations {
|
|
|
9098
10149
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9099
10150
|
};
|
|
9100
10151
|
};
|
|
9101
|
-
/** @description
|
|
10152
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
9102
10153
|
403: {
|
|
9103
10154
|
headers: {
|
|
9104
10155
|
[name: string]: unknown;
|
|
@@ -9107,16 +10158,8 @@ interface operations {
|
|
|
9107
10158
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9108
10159
|
};
|
|
9109
10160
|
};
|
|
9110
|
-
|
|
9111
|
-
|
|
9112
|
-
[name: string]: unknown;
|
|
9113
|
-
};
|
|
9114
|
-
content: {
|
|
9115
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9116
|
-
};
|
|
9117
|
-
};
|
|
9118
|
-
/** @description slug_taken */
|
|
9119
|
-
409: {
|
|
10161
|
+
/** @description `topup_cap_exceeded` — over the monthly limit (includes `remainingUsd` / `remainingVes`). */
|
|
10162
|
+
422: {
|
|
9120
10163
|
headers: {
|
|
9121
10164
|
[name: string]: unknown;
|
|
9122
10165
|
};
|
|
@@ -9144,7 +10187,7 @@ interface operations {
|
|
|
9144
10187
|
};
|
|
9145
10188
|
};
|
|
9146
10189
|
};
|
|
9147
|
-
|
|
10190
|
+
Topups_get: {
|
|
9148
10191
|
parameters: {
|
|
9149
10192
|
query?: never;
|
|
9150
10193
|
header?: never;
|
|
@@ -9160,10 +10203,10 @@ interface operations {
|
|
|
9160
10203
|
[name: string]: unknown;
|
|
9161
10204
|
};
|
|
9162
10205
|
content: {
|
|
9163
|
-
"application/json": components["schemas"]["
|
|
10206
|
+
"application/json": components["schemas"]["TopupDto"];
|
|
9164
10207
|
};
|
|
9165
10208
|
};
|
|
9166
|
-
/** @description Missing or
|
|
10209
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9167
10210
|
401: {
|
|
9168
10211
|
headers: {
|
|
9169
10212
|
[name: string]: unknown;
|
|
@@ -9172,7 +10215,7 @@ interface operations {
|
|
|
9172
10215
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9173
10216
|
};
|
|
9174
10217
|
};
|
|
9175
|
-
/** @description
|
|
10218
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
9176
10219
|
403: {
|
|
9177
10220
|
headers: {
|
|
9178
10221
|
[name: string]: unknown;
|
|
@@ -9181,14 +10224,6 @@ interface operations {
|
|
|
9181
10224
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9182
10225
|
};
|
|
9183
10226
|
};
|
|
9184
|
-
404: {
|
|
9185
|
-
headers: {
|
|
9186
|
-
[name: string]: unknown;
|
|
9187
|
-
};
|
|
9188
|
-
content: {
|
|
9189
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9190
|
-
};
|
|
9191
|
-
};
|
|
9192
10227
|
/** @description Client error. */
|
|
9193
10228
|
"4XX": {
|
|
9194
10229
|
headers: {
|
|
@@ -9209,10 +10244,13 @@ interface operations {
|
|
|
9209
10244
|
};
|
|
9210
10245
|
};
|
|
9211
10246
|
};
|
|
9212
|
-
|
|
10247
|
+
Topups_instant: {
|
|
9213
10248
|
parameters: {
|
|
9214
10249
|
query?: never;
|
|
9215
|
-
header?:
|
|
10250
|
+
header?: {
|
|
10251
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
10252
|
+
"Idempotency-Key"?: string;
|
|
10253
|
+
};
|
|
9216
10254
|
path: {
|
|
9217
10255
|
id: string;
|
|
9218
10256
|
};
|
|
@@ -9220,17 +10258,16 @@ interface operations {
|
|
|
9220
10258
|
};
|
|
9221
10259
|
requestBody?: never;
|
|
9222
10260
|
responses: {
|
|
9223
|
-
|
|
9224
|
-
401: {
|
|
10261
|
+
200: {
|
|
9225
10262
|
headers: {
|
|
9226
10263
|
[name: string]: unknown;
|
|
9227
10264
|
};
|
|
9228
10265
|
content: {
|
|
9229
|
-
"application/json": components["schemas"]["
|
|
10266
|
+
"application/json": components["schemas"]["TopupDto"];
|
|
9230
10267
|
};
|
|
9231
10268
|
};
|
|
9232
|
-
/** @description
|
|
9233
|
-
|
|
10269
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
10270
|
+
401: {
|
|
9234
10271
|
headers: {
|
|
9235
10272
|
[name: string]: unknown;
|
|
9236
10273
|
};
|
|
@@ -9238,7 +10275,8 @@ interface operations {
|
|
|
9238
10275
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9239
10276
|
};
|
|
9240
10277
|
};
|
|
9241
|
-
|
|
10278
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
10279
|
+
403: {
|
|
9242
10280
|
headers: {
|
|
9243
10281
|
[name: string]: unknown;
|
|
9244
10282
|
};
|
|
@@ -9246,7 +10284,7 @@ interface operations {
|
|
|
9246
10284
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9247
10285
|
};
|
|
9248
10286
|
};
|
|
9249
|
-
/** @description
|
|
10287
|
+
/** @description `not_held` — nothing of this top-up is still held. */
|
|
9250
10288
|
409: {
|
|
9251
10289
|
headers: {
|
|
9252
10290
|
[name: string]: unknown;
|
|
@@ -9275,30 +10313,29 @@ interface operations {
|
|
|
9275
10313
|
};
|
|
9276
10314
|
};
|
|
9277
10315
|
};
|
|
9278
|
-
|
|
10316
|
+
Topups_simulate: {
|
|
9279
10317
|
parameters: {
|
|
9280
10318
|
query?: never;
|
|
9281
|
-
header?:
|
|
10319
|
+
header?: {
|
|
10320
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
10321
|
+
"Idempotency-Key"?: string;
|
|
10322
|
+
};
|
|
9282
10323
|
path: {
|
|
9283
10324
|
id: string;
|
|
9284
10325
|
};
|
|
9285
10326
|
cookie?: never;
|
|
9286
10327
|
};
|
|
9287
|
-
requestBody
|
|
9288
|
-
content: {
|
|
9289
|
-
"application/json": components["schemas"]["UpdatePaymentLinkDto"];
|
|
9290
|
-
};
|
|
9291
|
-
};
|
|
10328
|
+
requestBody?: never;
|
|
9292
10329
|
responses: {
|
|
9293
10330
|
200: {
|
|
9294
10331
|
headers: {
|
|
9295
10332
|
[name: string]: unknown;
|
|
9296
10333
|
};
|
|
9297
10334
|
content: {
|
|
9298
|
-
"application/json": components["schemas"]["
|
|
10335
|
+
"application/json": components["schemas"]["TopupDto"];
|
|
9299
10336
|
};
|
|
9300
10337
|
};
|
|
9301
|
-
/** @description Missing or
|
|
10338
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9302
10339
|
401: {
|
|
9303
10340
|
headers: {
|
|
9304
10341
|
[name: string]: unknown;
|
|
@@ -9307,7 +10344,7 @@ interface operations {
|
|
|
9307
10344
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9308
10345
|
};
|
|
9309
10346
|
};
|
|
9310
|
-
/** @description
|
|
10347
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
9311
10348
|
403: {
|
|
9312
10349
|
headers: {
|
|
9313
10350
|
[name: string]: unknown;
|
|
@@ -9316,14 +10353,6 @@ interface operations {
|
|
|
9316
10353
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9317
10354
|
};
|
|
9318
10355
|
};
|
|
9319
|
-
404: {
|
|
9320
|
-
headers: {
|
|
9321
|
-
[name: string]: unknown;
|
|
9322
|
-
};
|
|
9323
|
-
content: {
|
|
9324
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9325
|
-
};
|
|
9326
|
-
};
|
|
9327
10356
|
/** @description Client error. */
|
|
9328
10357
|
"4XX": {
|
|
9329
10358
|
headers: {
|
|
@@ -11309,7 +12338,7 @@ declare class BalanceTransactions extends APIResource {
|
|
|
11309
12338
|
nextCursor: string | null;
|
|
11310
12339
|
}, {
|
|
11311
12340
|
id: string;
|
|
11312
|
-
type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee";
|
|
12341
|
+
type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee" | "disbursement_payout_fee" | "disbursement_payout_fee_reversal" | "topup" | "topup_fee" | "topup_instant_release" | "topup_instant_fee";
|
|
11313
12342
|
amountVes: string;
|
|
11314
12343
|
paymentId?: string;
|
|
11315
12344
|
payoutId?: string;
|
|
@@ -11321,9 +12350,124 @@ declare class BalanceTransactions extends APIResource {
|
|
|
11321
12350
|
createdAt: string;
|
|
11322
12351
|
}>;
|
|
11323
12352
|
}
|
|
12353
|
+
/**
|
|
12354
|
+
* Load your own Bs balance by Pago Móvil (money that is not a sale). Send the exact `amountVes` from
|
|
12355
|
+
* `payerPhone` to the returned `receiver` before `expiresAt`; the top-up completes when the transfer
|
|
12356
|
+
* arrives. Each top-up needs a `sourceNote` and counts against your monthly limit. Enabled per account
|
|
12357
|
+
* (`topups_not_enabled`, 403).
|
|
12358
|
+
*/
|
|
12359
|
+
declare class BalanceTopups extends APIResource {
|
|
12360
|
+
/** Start a top-up. Over the monthly limit fails with `topup_cap_exceeded` (422). */
|
|
12361
|
+
create(params: RequestBody<'Topups_create'>, options?: RequestOptions): Promise<{
|
|
12362
|
+
id: string;
|
|
12363
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
12364
|
+
amountVes: string;
|
|
12365
|
+
amountUsd: string;
|
|
12366
|
+
bcvRate: string;
|
|
12367
|
+
feePercent: string;
|
|
12368
|
+
feeFixedUsd: string;
|
|
12369
|
+
feeVes?: string;
|
|
12370
|
+
creditedVes?: string;
|
|
12371
|
+
sourceNote: string;
|
|
12372
|
+
payerPhone: string;
|
|
12373
|
+
bankReference?: string;
|
|
12374
|
+
expiresAt: string;
|
|
12375
|
+
completedAt?: string;
|
|
12376
|
+
availableAt?: string;
|
|
12377
|
+
heldVes: string;
|
|
12378
|
+
instantFeePercent: string;
|
|
12379
|
+
instantFeeVes: string;
|
|
12380
|
+
instantReleasedAt?: string;
|
|
12381
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
12382
|
+
test: boolean;
|
|
12383
|
+
createdAt: string;
|
|
12384
|
+
}>;
|
|
12385
|
+
/** Your latest top-ups (newest first, `limit` 1–100) plus this month's limit usage. */
|
|
12386
|
+
list(params?: QueryParams<'Topups_list'>, options?: RequestOptions): Promise<{
|
|
12387
|
+
data: components["schemas"]["TopupDto"][];
|
|
12388
|
+
monthlyCapUsd: string | null;
|
|
12389
|
+
monthUsedUsd: string;
|
|
12390
|
+
monthRemainingUsd: string;
|
|
12391
|
+
}>;
|
|
12392
|
+
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
12393
|
+
id: string;
|
|
12394
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
12395
|
+
amountVes: string;
|
|
12396
|
+
amountUsd: string;
|
|
12397
|
+
bcvRate: string;
|
|
12398
|
+
feePercent: string;
|
|
12399
|
+
feeFixedUsd: string;
|
|
12400
|
+
feeVes?: string;
|
|
12401
|
+
creditedVes?: string;
|
|
12402
|
+
sourceNote: string;
|
|
12403
|
+
payerPhone: string;
|
|
12404
|
+
bankReference?: string;
|
|
12405
|
+
expiresAt: string;
|
|
12406
|
+
completedAt?: string;
|
|
12407
|
+
availableAt?: string;
|
|
12408
|
+
heldVes: string;
|
|
12409
|
+
instantFeePercent: string;
|
|
12410
|
+
instantFeeVes: string;
|
|
12411
|
+
instantReleasedAt?: string;
|
|
12412
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
12413
|
+
test: boolean;
|
|
12414
|
+
createdAt: string;
|
|
12415
|
+
}>;
|
|
12416
|
+
/** Release the still-held part of a completed top-up now, for `instantFeeVes`. Idempotent; `not_held` (409) if nothing is held. */
|
|
12417
|
+
instant(id: string, options?: RequestOptions): Promise<{
|
|
12418
|
+
id: string;
|
|
12419
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
12420
|
+
amountVes: string;
|
|
12421
|
+
amountUsd: string;
|
|
12422
|
+
bcvRate: string;
|
|
12423
|
+
feePercent: string;
|
|
12424
|
+
feeFixedUsd: string;
|
|
12425
|
+
feeVes?: string;
|
|
12426
|
+
creditedVes?: string;
|
|
12427
|
+
sourceNote: string;
|
|
12428
|
+
payerPhone: string;
|
|
12429
|
+
bankReference?: string;
|
|
12430
|
+
expiresAt: string;
|
|
12431
|
+
completedAt?: string;
|
|
12432
|
+
availableAt?: string;
|
|
12433
|
+
heldVes: string;
|
|
12434
|
+
instantFeePercent: string;
|
|
12435
|
+
instantFeeVes: string;
|
|
12436
|
+
instantReleasedAt?: string;
|
|
12437
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
12438
|
+
test: boolean;
|
|
12439
|
+
createdAt: string;
|
|
12440
|
+
}>;
|
|
12441
|
+
/** Test mode only: complete the top-up as if the Pago Móvil arrived. */
|
|
12442
|
+
simulate(id: string, options?: RequestOptions): Promise<{
|
|
12443
|
+
id: string;
|
|
12444
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
12445
|
+
amountVes: string;
|
|
12446
|
+
amountUsd: string;
|
|
12447
|
+
bcvRate: string;
|
|
12448
|
+
feePercent: string;
|
|
12449
|
+
feeFixedUsd: string;
|
|
12450
|
+
feeVes?: string;
|
|
12451
|
+
creditedVes?: string;
|
|
12452
|
+
sourceNote: string;
|
|
12453
|
+
payerPhone: string;
|
|
12454
|
+
bankReference?: string;
|
|
12455
|
+
expiresAt: string;
|
|
12456
|
+
completedAt?: string;
|
|
12457
|
+
availableAt?: string;
|
|
12458
|
+
heldVes: string;
|
|
12459
|
+
instantFeePercent: string;
|
|
12460
|
+
instantFeeVes: string;
|
|
12461
|
+
instantReleasedAt?: string;
|
|
12462
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
12463
|
+
test: boolean;
|
|
12464
|
+
createdAt: string;
|
|
12465
|
+
}>;
|
|
12466
|
+
}
|
|
11324
12467
|
/** Your platform balance. */
|
|
11325
12468
|
declare class Balance extends APIResource {
|
|
11326
12469
|
readonly transactions: BalanceTransactions;
|
|
12470
|
+
readonly topups: BalanceTopups;
|
|
11327
12471
|
retrieve(options?: RequestOptions): Promise<{
|
|
11328
12472
|
tenantId: string;
|
|
11329
12473
|
platformId: string;
|
|
@@ -11363,6 +12507,7 @@ declare class Payouts extends APIResource {
|
|
|
11363
12507
|
grossMonto?: string;
|
|
11364
12508
|
feePercent?: string;
|
|
11365
12509
|
feeVes?: string;
|
|
12510
|
+
feePayer?: "tenant";
|
|
11366
12511
|
concepto?: string;
|
|
11367
12512
|
bankCode?: string;
|
|
11368
12513
|
destination?: string;
|
|
@@ -11386,6 +12531,7 @@ declare class Payouts extends APIResource {
|
|
|
11386
12531
|
grossMonto?: string;
|
|
11387
12532
|
feePercent?: string;
|
|
11388
12533
|
feeVes?: string;
|
|
12534
|
+
feePayer?: "tenant";
|
|
11389
12535
|
concepto?: string;
|
|
11390
12536
|
bankCode?: string;
|
|
11391
12537
|
destination?: string;
|
|
@@ -11418,6 +12564,7 @@ declare class Payouts extends APIResource {
|
|
|
11418
12564
|
grossMonto?: string;
|
|
11419
12565
|
feePercent?: string;
|
|
11420
12566
|
feeVes?: string;
|
|
12567
|
+
feePayer?: "tenant";
|
|
11421
12568
|
concepto?: string;
|
|
11422
12569
|
bankCode?: string;
|
|
11423
12570
|
destination?: string;
|
|
@@ -11440,6 +12587,7 @@ declare class Payouts extends APIResource {
|
|
|
11440
12587
|
grossMonto?: string;
|
|
11441
12588
|
feePercent?: string;
|
|
11442
12589
|
feeVes?: string;
|
|
12590
|
+
feePayer?: "tenant";
|
|
11443
12591
|
concepto?: string;
|
|
11444
12592
|
bankCode?: string;
|
|
11445
12593
|
destination?: string;
|
|
@@ -11462,6 +12610,7 @@ declare class Payouts extends APIResource {
|
|
|
11462
12610
|
grossMonto?: string;
|
|
11463
12611
|
feePercent?: string;
|
|
11464
12612
|
feeVes?: string;
|
|
12613
|
+
feePayer?: "tenant";
|
|
11465
12614
|
concepto?: string;
|
|
11466
12615
|
bankCode?: string;
|
|
11467
12616
|
destination?: string;
|
|
@@ -12344,21 +13493,24 @@ declare class Conversions extends APIResource {
|
|
|
12344
13493
|
}
|
|
12345
13494
|
|
|
12346
13495
|
/**
|
|
12347
|
-
* Colombian peso payments:
|
|
12348
|
-
*
|
|
12349
|
-
*
|
|
13496
|
+
* Colombian peso payments: PSE and Bancolombia (bank redirect), Bancolombia QR, Bre-B (QR /
|
|
13497
|
+
* transfer key), Nequi (push approval) or Daviplata (SMS code or redirect). Cards are taken only on
|
|
13498
|
+
* the hosted checkout. Payments complete asynchronously — listen for `payment.completed` /
|
|
13499
|
+
* `payment.failed`. COP must be enabled on your account (403 `method_not_allowed` otherwise).
|
|
12350
13500
|
*/
|
|
12351
13501
|
declare class CopPayments extends APIResource {
|
|
12352
13502
|
/**
|
|
12353
|
-
* Create a payment in whole pesos. `buyer` is required for
|
|
12354
|
-
* `
|
|
13503
|
+
* Create a payment in whole pesos. `buyer` is required for every channel except `breb`, with
|
|
13504
|
+
* `termsAccepted: true` when {@link Cop.channels} says `needsTermsAcceptance`; `pse` also needs
|
|
13505
|
+
* `pse.bankCode`. The response `next` says what the buyer does: `show_qr`, `approve_in_app`,
|
|
13506
|
+
* `submit_otp`, `redirect` (send them to `next.url`) or `redirect_pending` (retrieve again shortly).
|
|
12355
13507
|
* Pass `idempotencyKey` in options to retry safely.
|
|
12356
13508
|
*/
|
|
12357
13509
|
create(params: RequestBody<'CopPayments_create'>, options?: RequestOptions): Promise<{
|
|
12358
13510
|
id: string;
|
|
12359
13511
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12360
13512
|
method: "COP";
|
|
12361
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13513
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12362
13514
|
amountCop: number;
|
|
12363
13515
|
feeCop?: number;
|
|
12364
13516
|
amountUsd?: string;
|
|
@@ -12367,17 +13519,18 @@ declare class CopPayments extends APIResource {
|
|
|
12367
13519
|
metadata: {
|
|
12368
13520
|
[key: string]: string;
|
|
12369
13521
|
};
|
|
12370
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13522
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12371
13523
|
expiresAt?: string;
|
|
12372
13524
|
createdAt: string;
|
|
12373
13525
|
completedAt?: string;
|
|
12374
13526
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13527
|
+
card?: Record<string, never>;
|
|
12375
13528
|
}>;
|
|
12376
13529
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
12377
13530
|
id: string;
|
|
12378
13531
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12379
13532
|
method: "COP";
|
|
12380
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13533
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12381
13534
|
amountCop: number;
|
|
12382
13535
|
feeCop?: number;
|
|
12383
13536
|
amountUsd?: string;
|
|
@@ -12386,18 +13539,19 @@ declare class CopPayments extends APIResource {
|
|
|
12386
13539
|
metadata: {
|
|
12387
13540
|
[key: string]: string;
|
|
12388
13541
|
};
|
|
12389
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13542
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12390
13543
|
expiresAt?: string;
|
|
12391
13544
|
createdAt: string;
|
|
12392
13545
|
completedAt?: string;
|
|
12393
13546
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13547
|
+
card?: Record<string, never>;
|
|
12394
13548
|
}>;
|
|
12395
|
-
/** Daviplata: submit the code the buyer received by SMS. A wrong code fails with `invalid_otp`. */
|
|
13549
|
+
/** Daviplata with `next.type: "submit_otp"`: submit the code the buyer received by SMS. A wrong code fails with `invalid_otp`. */
|
|
12396
13550
|
submitOtp(id: string, params: RequestBody<'CopPayments_submitOtp'>, options?: RequestOptions): Promise<{
|
|
12397
13551
|
id: string;
|
|
12398
13552
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12399
13553
|
method: "COP";
|
|
12400
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13554
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12401
13555
|
amountCop: number;
|
|
12402
13556
|
feeCop?: number;
|
|
12403
13557
|
amountUsd?: string;
|
|
@@ -12406,18 +13560,19 @@ declare class CopPayments extends APIResource {
|
|
|
12406
13560
|
metadata: {
|
|
12407
13561
|
[key: string]: string;
|
|
12408
13562
|
};
|
|
12409
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13563
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12410
13564
|
expiresAt?: string;
|
|
12411
13565
|
createdAt: string;
|
|
12412
13566
|
completedAt?: string;
|
|
12413
13567
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13568
|
+
card?: Record<string, never>;
|
|
12414
13569
|
}>;
|
|
12415
13570
|
/** Cancel a pending payment. */
|
|
12416
13571
|
cancel(id: string, options?: RequestOptions): Promise<{
|
|
12417
13572
|
id: string;
|
|
12418
13573
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12419
13574
|
method: "COP";
|
|
12420
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13575
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12421
13576
|
amountCop: number;
|
|
12422
13577
|
feeCop?: number;
|
|
12423
13578
|
amountUsd?: string;
|
|
@@ -12426,18 +13581,22 @@ declare class CopPayments extends APIResource {
|
|
|
12426
13581
|
metadata: {
|
|
12427
13582
|
[key: string]: string;
|
|
12428
13583
|
};
|
|
12429
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13584
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12430
13585
|
expiresAt?: string;
|
|
12431
13586
|
createdAt: string;
|
|
12432
13587
|
completedAt?: string;
|
|
12433
13588
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13589
|
+
card?: Record<string, never>;
|
|
12434
13590
|
}>;
|
|
12435
|
-
/**
|
|
13591
|
+
/**
|
|
13592
|
+
* Full refund of a completed payment, within the channel's window (card 24 h, Bre-B 96 h).
|
|
13593
|
+
* Channels that cannot be refunded through the API fail with `refund_not_supported`.
|
|
13594
|
+
*/
|
|
12436
13595
|
refund(id: string, options?: RequestOptions): Promise<{
|
|
12437
13596
|
id: string;
|
|
12438
13597
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12439
13598
|
method: "COP";
|
|
12440
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13599
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12441
13600
|
amountCop: number;
|
|
12442
13601
|
feeCop?: number;
|
|
12443
13602
|
amountUsd?: string;
|
|
@@ -12446,11 +13605,12 @@ declare class CopPayments extends APIResource {
|
|
|
12446
13605
|
metadata: {
|
|
12447
13606
|
[key: string]: string;
|
|
12448
13607
|
};
|
|
12449
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13608
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12450
13609
|
expiresAt?: string;
|
|
12451
13610
|
createdAt: string;
|
|
12452
13611
|
completedAt?: string;
|
|
12453
13612
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13613
|
+
card?: Record<string, never>;
|
|
12454
13614
|
}>;
|
|
12455
13615
|
}
|
|
12456
13616
|
/** Your COP balance, in whole pesos. Kept apart from VES and stablecoins. */
|
|
@@ -12463,10 +13623,16 @@ declare class CopBalance extends APIResource {
|
|
|
12463
13623
|
asOf: string;
|
|
12464
13624
|
}>;
|
|
12465
13625
|
}
|
|
12466
|
-
/** Collect Colombian pesos (Bre-B, Nequi, Daviplata). */
|
|
13626
|
+
/** Collect Colombian pesos (PSE, Bancolombia, Bre-B, Nequi, Daviplata; cards via the hosted checkout). */
|
|
12467
13627
|
declare class Cop extends APIResource {
|
|
12468
13628
|
readonly payments: CopPayments;
|
|
12469
13629
|
readonly balance: CopBalance;
|
|
13630
|
+
/** Channels you can use right now, with what each needs, plus the PSE banks and terms links. */
|
|
13631
|
+
channels(options?: RequestOptions): Promise<{
|
|
13632
|
+
channels: components["schemas"]["CopChannelDto"][];
|
|
13633
|
+
pseBanks?: components["schemas"]["CopPseBankDto"][];
|
|
13634
|
+
terms?: components["schemas"]["CopTermsDto"];
|
|
13635
|
+
}>;
|
|
12470
13636
|
}
|
|
12471
13637
|
|
|
12472
13638
|
/** One stablecoin balance (`currency`: USDT by default, or USDC). Never converted to VES. */
|
|
@@ -12570,9 +13736,32 @@ declare class Crypto extends APIResource {
|
|
|
12570
13736
|
readonly depositAddresses: DepositAddresses;
|
|
12571
13737
|
readonly networks: CryptoNetworks;
|
|
12572
13738
|
readonly payouts: CryptoPayouts;
|
|
13739
|
+
/**
|
|
13740
|
+
* Test mode only: credit a deposit to one of your deposit addresses (`customerRef` + `currency` +
|
|
13741
|
+
* `network`, requested before) as if it had arrived on chain. Sends `payment.completed` with
|
|
13742
|
+
* `livemode: false`. A Live key gets 403 `test_mode_only`; an unknown address 404.
|
|
13743
|
+
*/
|
|
13744
|
+
simulateDeposit(params: RequestBody<'Crypto_simulateDeposit'>, options?: RequestOptions): Promise<{
|
|
13745
|
+
paymentId: string;
|
|
13746
|
+
status: "COMPLETED";
|
|
13747
|
+
method: "USDT" | "USDC";
|
|
13748
|
+
currency: "USDT" | "USDC";
|
|
13749
|
+
amount: string;
|
|
13750
|
+
fee: string;
|
|
13751
|
+
amountUsdt?: string;
|
|
13752
|
+
feeUsdt?: string;
|
|
13753
|
+
network: string;
|
|
13754
|
+
customerRef: string;
|
|
13755
|
+
txHashes: string[];
|
|
13756
|
+
livemode: boolean;
|
|
13757
|
+
simulated: boolean;
|
|
13758
|
+
createdAt: string;
|
|
13759
|
+
}>;
|
|
12573
13760
|
}
|
|
12574
13761
|
|
|
12575
13762
|
type MerchantListParams = Omit<QueryParams<'Merchants_listOrGetByRef'>, 'externalRef'>;
|
|
13763
|
+
type MerchantTransactionListParams = QueryParams<'Merchants_listTransactions'>;
|
|
13764
|
+
type MerchantStatementParams = Omit<QueryParams<'Merchants_statement'>, 'format'>;
|
|
12576
13765
|
/** Where a merchant gets paid (bank account or Pago Móvil). */
|
|
12577
13766
|
declare class PayoutMethods extends APIResource {
|
|
12578
13767
|
list(merchantId: string, options?: RequestOptions): Promise<{
|
|
@@ -12753,7 +13942,11 @@ declare class Merchants extends APIResource {
|
|
|
12753
13942
|
ledgerNetVes: string;
|
|
12754
13943
|
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
12755
13944
|
}>;
|
|
12756
|
-
/**
|
|
13945
|
+
/**
|
|
13946
|
+
* Credit this seller's pending balance from your platform balance. Send `amountVes`, or
|
|
13947
|
+
* `amountUsd` to convert at the official BCV rate; `transferKey` makes it idempotent.
|
|
13948
|
+
* The response is the seller balance plus `transfer` (amounts and rate used).
|
|
13949
|
+
*/
|
|
12757
13950
|
transfer(id: string, params: RequestBody<'Merchants_transfer'>, options?: RequestOptions): Promise<{
|
|
12758
13951
|
merchantId: string;
|
|
12759
13952
|
accountId: string;
|
|
@@ -12763,7 +13956,39 @@ declare class Merchants extends APIResource {
|
|
|
12763
13956
|
paidOutVes: string;
|
|
12764
13957
|
ledgerNetVes: string;
|
|
12765
13958
|
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
13959
|
+
transfer: components["schemas"]["MerchantTransferSnapshotDto"];
|
|
13960
|
+
}>;
|
|
13961
|
+
/** Seller balance movements, newest first. Await for one page, or `for await` over every movement. */
|
|
13962
|
+
listTransactions(id: string, params?: MerchantTransactionListParams, options?: RequestOptions): PagePromise<{
|
|
13963
|
+
items: components["schemas"]["MerchantMovementDto"][];
|
|
13964
|
+
nextCursor: string | null;
|
|
13965
|
+
}, {
|
|
13966
|
+
id: string;
|
|
13967
|
+
type: "credit" | "release" | "reversal" | "payout" | "payout_reversal" | "payout_fee" | "payout_fee_reversal" | "adjustment";
|
|
13968
|
+
amountVes: string;
|
|
13969
|
+
releasedVes?: string;
|
|
13970
|
+
description: string;
|
|
13971
|
+
transferKey?: string;
|
|
13972
|
+
paymentId?: string | null;
|
|
13973
|
+
payoutId?: string | null;
|
|
13974
|
+
availableAt?: string | null;
|
|
13975
|
+
amountUsd?: string;
|
|
13976
|
+
rate?: string;
|
|
13977
|
+
rateSource?: string;
|
|
13978
|
+
createdAt: string;
|
|
13979
|
+
}>;
|
|
13980
|
+
/** Monthly statement (`month: 'YYYY-MM'`, America/Caracas): opening, movements, closing. */
|
|
13981
|
+
retrieveStatement(id: string, params: MerchantStatementParams, options?: RequestOptions): Promise<{
|
|
13982
|
+
merchantId: string;
|
|
13983
|
+
month: string;
|
|
13984
|
+
from: string;
|
|
13985
|
+
to: string;
|
|
13986
|
+
openingVes: string;
|
|
13987
|
+
closingVes: string;
|
|
13988
|
+
movements: components["schemas"]["MerchantMovementDto"][];
|
|
12766
13989
|
}>;
|
|
13990
|
+
/** The same monthly statement as CSV (with a running balance column), returned as a string. */
|
|
13991
|
+
retrieveStatementCsv(id: string, params: MerchantStatementParams, options?: RequestOptions): Promise<string>;
|
|
12767
13992
|
listAuditEvents(id: string, options?: RequestOptions): Promise<{
|
|
12768
13993
|
items: components["schemas"]["MerchantAuditEventDto"][];
|
|
12769
13994
|
}>;
|
|
@@ -13199,15 +14424,22 @@ interface CopPaymentWebhookData {
|
|
|
13199
14424
|
method: 'COP';
|
|
13200
14425
|
currency: 'COP';
|
|
13201
14426
|
status: 'pending' | 'completed' | 'failed' | 'canceled' | 'refunded';
|
|
13202
|
-
channel: 'breb' | 'nequi' | 'daviplata';
|
|
14427
|
+
channel: 'breb' | 'nequi' | 'daviplata' | 'card' | 'pse' | 'bancolombia_transfer' | 'bancolombia_qr';
|
|
13203
14428
|
amountCop: number;
|
|
14429
|
+
/** Card payments: brand and last 4 digits. */
|
|
14430
|
+
card?: {
|
|
14431
|
+
brand: string;
|
|
14432
|
+
last4: string;
|
|
14433
|
+
};
|
|
13204
14434
|
feeCop?: number;
|
|
13205
14435
|
amountUsd?: string;
|
|
13206
14436
|
copRate?: string;
|
|
13207
14437
|
reference?: string;
|
|
13208
14438
|
externalRef?: string;
|
|
13209
14439
|
metadata: Record<string, string>;
|
|
13210
|
-
failureCode?: 'expired' | 'rejected' | 'processor_error' | 'processor_unknown';
|
|
14440
|
+
failureCode?: 'expired' | 'rejected' | 'processor_error' | 'processor_unknown' | 'chargeback';
|
|
14441
|
+
/** `payment.reversed` from a card dispute: `"chargeback"` (the amount was debited from your COP balance). */
|
|
14442
|
+
reason?: 'chargeback';
|
|
13211
14443
|
expiresAt?: string;
|
|
13212
14444
|
createdAt: string;
|
|
13213
14445
|
completedAt?: string;
|
|
@@ -13347,6 +14579,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
13347
14579
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
13348
14580
|
}
|
|
13349
14581
|
|
|
13350
|
-
declare const VERSION = "0.
|
|
14582
|
+
declare const VERSION = "0.14.0";
|
|
13351
14583
|
|
|
13352
14584
|
export { type CopPaymentWebhookData, 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 };
|