@vexpay/node 0.12.0 → 0.13.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 +78 -7
- package/dist/index.cjs +69 -6
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1233 -185
- package/dist/index.d.ts +1233 -185
- package/dist/index.js +69 -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.
|
|
@@ -1186,13 +1198,61 @@ interface components {
|
|
|
1186
1198
|
/** Format: date-time */
|
|
1187
1199
|
completedAt?: string;
|
|
1188
1200
|
};
|
|
1201
|
+
CopChannelDto: {
|
|
1202
|
+
/**
|
|
1203
|
+
* @example pse
|
|
1204
|
+
* @enum {string}
|
|
1205
|
+
*/
|
|
1206
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
1207
|
+
/**
|
|
1208
|
+
* @description Buyer-facing name (Spanish).
|
|
1209
|
+
* @example PSE
|
|
1210
|
+
*/
|
|
1211
|
+
label: string;
|
|
1212
|
+
/**
|
|
1213
|
+
* @description A `buyer` object is required.
|
|
1214
|
+
* @example true
|
|
1215
|
+
*/
|
|
1216
|
+
needsBuyer: boolean;
|
|
1217
|
+
/**
|
|
1218
|
+
* @description Show the buyer the `terms` links and send `buyer.termsAccepted: true`.
|
|
1219
|
+
* @example true
|
|
1220
|
+
*/
|
|
1221
|
+
needsTermsAcceptance: boolean;
|
|
1222
|
+
/**
|
|
1223
|
+
* @description Only through the hosted checkout (checkout sessions or payment links), never `POST /v1/cop/payments`.
|
|
1224
|
+
* @example false
|
|
1225
|
+
*/
|
|
1226
|
+
checkoutOnly: boolean;
|
|
1227
|
+
/** @example 20000 */
|
|
1228
|
+
minAmountCop: number;
|
|
1229
|
+
};
|
|
1230
|
+
CopPseBankDto: {
|
|
1231
|
+
/** @example 1007 */
|
|
1232
|
+
code: string;
|
|
1233
|
+
/** @example Bancolombia */
|
|
1234
|
+
name: string;
|
|
1235
|
+
};
|
|
1236
|
+
CopTermsDto: {
|
|
1237
|
+
/** @description Terms and conditions the buyer accepts. */
|
|
1238
|
+
termsUrl: string;
|
|
1239
|
+
/** @description Personal data processing authorization the buyer accepts. */
|
|
1240
|
+
personalDataUrl: string;
|
|
1241
|
+
};
|
|
1242
|
+
CopChannelsDto: {
|
|
1243
|
+
channels: components["schemas"]["CopChannelDto"][];
|
|
1244
|
+
/** @description Present when `pse` is listed: banks for `pse.bankCode`. */
|
|
1245
|
+
pseBanks?: components["schemas"]["CopPseBankDto"][];
|
|
1246
|
+
/** @description Present when a listed channel needs terms acceptance. */
|
|
1247
|
+
terms?: components["schemas"]["CopTermsDto"];
|
|
1248
|
+
};
|
|
1189
1249
|
CopBuyerDto: {
|
|
1190
1250
|
/** @example Juan */
|
|
1191
1251
|
firstName?: string;
|
|
1192
1252
|
/** @example Pérez */
|
|
1193
1253
|
lastName?: string;
|
|
1194
1254
|
/**
|
|
1195
|
-
* @description Required for
|
|
1255
|
+
* @description Required for every channel except `breb`.
|
|
1196
1256
|
* @example juan@example.com
|
|
1197
1257
|
*/
|
|
1198
1258
|
email?: string;
|
|
@@ -1208,10 +1268,28 @@ interface components {
|
|
|
1208
1268
|
*/
|
|
1209
1269
|
documentType?: "CC" | "CE" | "TI" | "NIT" | "PP";
|
|
1210
1270
|
/**
|
|
1211
|
-
* @description National document number. Required for
|
|
1271
|
+
* @description National document number. Required for every channel except `breb`.
|
|
1212
1272
|
* @example 1234567890
|
|
1213
1273
|
*/
|
|
1214
1274
|
documentNumber?: string;
|
|
1275
|
+
/**
|
|
1276
|
+
* @description PSE only (required): `natural` person or `juridica` (company).
|
|
1277
|
+
* @example natural
|
|
1278
|
+
* @enum {string}
|
|
1279
|
+
*/
|
|
1280
|
+
personType?: "natural" | "juridica";
|
|
1281
|
+
/**
|
|
1282
|
+
* @description Required (`true`) for channels the channel catalog marks `needsTermsAcceptance`: confirms you showed the buyer the catalog `terms` links.
|
|
1283
|
+
* @example true
|
|
1284
|
+
*/
|
|
1285
|
+
termsAccepted?: boolean;
|
|
1286
|
+
};
|
|
1287
|
+
CopPseDto: {
|
|
1288
|
+
/**
|
|
1289
|
+
* @description Bank code from `GET /v1/cop/channels` → `pseBanks`.
|
|
1290
|
+
* @example 1007
|
|
1291
|
+
*/
|
|
1292
|
+
bankCode: string;
|
|
1215
1293
|
};
|
|
1216
1294
|
CreateCopPaymentDto: {
|
|
1217
1295
|
/**
|
|
@@ -1220,11 +1298,11 @@ interface components {
|
|
|
1220
1298
|
*/
|
|
1221
1299
|
amountCop: number;
|
|
1222
1300
|
/**
|
|
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.
|
|
1301
|
+
* @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
1302
|
* @example breb
|
|
1225
1303
|
* @enum {string}
|
|
1226
1304
|
*/
|
|
1227
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
1305
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
1228
1306
|
/**
|
|
1229
1307
|
* @description Shown to the buyer.
|
|
1230
1308
|
* @example Order 1042
|
|
@@ -1244,14 +1322,26 @@ interface components {
|
|
|
1244
1322
|
metadata?: {
|
|
1245
1323
|
[key: string]: string;
|
|
1246
1324
|
};
|
|
1247
|
-
/** @description Required for
|
|
1325
|
+
/** @description Required for every channel except `breb`. */
|
|
1248
1326
|
buyer?: components["schemas"]["CopBuyerDto"];
|
|
1327
|
+
/** @description Required for `pse`. */
|
|
1328
|
+
pse?: components["schemas"]["CopPseDto"];
|
|
1249
1329
|
};
|
|
1250
1330
|
CopNextActionDto: {
|
|
1251
|
-
/**
|
|
1252
|
-
|
|
1331
|
+
/**
|
|
1332
|
+
* @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.
|
|
1333
|
+
* @enum {string}
|
|
1334
|
+
*/
|
|
1335
|
+
type: "show_qr" | "approve_in_app" | "submit_otp" | "redirect" | "redirect_pending" | "processing";
|
|
1253
1336
|
/** @description Bre-B: base64 PNG of the payment QR. Returned only when the payment is created. */
|
|
1254
1337
|
qrPngBase64?: string;
|
|
1338
|
+
/** @description Bancolombia QR: base64 SVG of the payment QR. */
|
|
1339
|
+
qrSvgBase64?: string;
|
|
1340
|
+
/**
|
|
1341
|
+
* @description `redirect`: where the buyer authorizes the payment.
|
|
1342
|
+
* @example https://…
|
|
1343
|
+
*/
|
|
1344
|
+
url?: string;
|
|
1255
1345
|
/** @description Bre-B: transfer key the buyer can enter instead of scanning. */
|
|
1256
1346
|
transferKey?: string;
|
|
1257
1347
|
/**
|
|
@@ -1268,7 +1358,7 @@ interface components {
|
|
|
1268
1358
|
/** @enum {string} */
|
|
1269
1359
|
method: "COP";
|
|
1270
1360
|
/** @enum {string} */
|
|
1271
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
1361
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
1272
1362
|
/** @example 100000 */
|
|
1273
1363
|
amountCop: number;
|
|
1274
1364
|
/**
|
|
@@ -1291,16 +1381,27 @@ interface components {
|
|
|
1291
1381
|
metadata: {
|
|
1292
1382
|
[key: string]: string;
|
|
1293
1383
|
};
|
|
1294
|
-
/**
|
|
1295
|
-
|
|
1384
|
+
/**
|
|
1385
|
+
* @description `chargeback`: a refunded card payment the buyer disputed with their bank.
|
|
1386
|
+
* @enum {string}
|
|
1387
|
+
*/
|
|
1388
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
1296
1389
|
/** Format: date-time */
|
|
1297
1390
|
expiresAt?: string;
|
|
1298
1391
|
/** Format: date-time */
|
|
1299
1392
|
createdAt: string;
|
|
1300
1393
|
/** Format: date-time */
|
|
1301
1394
|
completedAt?: string;
|
|
1302
|
-
/** @description What the buyer must do next. Returned when the payment is created. */
|
|
1395
|
+
/** @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
1396
|
next?: components["schemas"]["CopNextActionDto"];
|
|
1397
|
+
/**
|
|
1398
|
+
* @description Card payments: brand and last 4 digits, once known.
|
|
1399
|
+
* @example {
|
|
1400
|
+
* "brand": "VISA",
|
|
1401
|
+
* "last4": "4242"
|
|
1402
|
+
* }
|
|
1403
|
+
*/
|
|
1404
|
+
card?: Record<string, never>;
|
|
1304
1405
|
};
|
|
1305
1406
|
SubmitCopOtpDto: {
|
|
1306
1407
|
/**
|
|
@@ -2310,10 +2411,15 @@ interface components {
|
|
|
2310
2411
|
};
|
|
2311
2412
|
CreateMerchantTransferDto: {
|
|
2312
2413
|
/**
|
|
2313
|
-
* @description Exact two-decimal VES amount to move from platform float → seller pending.
|
|
2414
|
+
* @description Exact two-decimal VES amount to move from platform float → seller pending. Send this or `amountUsd`, not both.
|
|
2314
2415
|
* @example 1523.40
|
|
2315
2416
|
*/
|
|
2316
|
-
amountVes
|
|
2417
|
+
amountVes?: string;
|
|
2418
|
+
/**
|
|
2419
|
+
* @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.
|
|
2420
|
+
* @example 100.00
|
|
2421
|
+
*/
|
|
2422
|
+
amountUsd?: string;
|
|
2317
2423
|
/**
|
|
2318
2424
|
* @description Idempotency key for this transfer under the merchant.
|
|
2319
2425
|
* @example xfer_bid_1042
|
|
@@ -2325,6 +2431,136 @@ interface components {
|
|
|
2325
2431
|
*/
|
|
2326
2432
|
paymentId?: string;
|
|
2327
2433
|
};
|
|
2434
|
+
MerchantTransferSnapshotDto: {
|
|
2435
|
+
/** @example q1-nov-2026-u123 */
|
|
2436
|
+
transferKey: string;
|
|
2437
|
+
/**
|
|
2438
|
+
* @description VES credited to the merchant.
|
|
2439
|
+
* @example 21540.00
|
|
2440
|
+
*/
|
|
2441
|
+
amountVes: string;
|
|
2442
|
+
/**
|
|
2443
|
+
* @description USD transfers only: the USD amount requested.
|
|
2444
|
+
* @example 100.00
|
|
2445
|
+
*/
|
|
2446
|
+
amountUsd?: string;
|
|
2447
|
+
/**
|
|
2448
|
+
* @description USD transfers only: the BCV rate used.
|
|
2449
|
+
* @example 215.4000
|
|
2450
|
+
*/
|
|
2451
|
+
rate?: string;
|
|
2452
|
+
/**
|
|
2453
|
+
* @description USD transfers only: always `bcv`.
|
|
2454
|
+
* @example bcv
|
|
2455
|
+
*/
|
|
2456
|
+
rateSource?: string;
|
|
2457
|
+
/**
|
|
2458
|
+
* Format: date-time
|
|
2459
|
+
* @description USD transfers only: when the rate was read.
|
|
2460
|
+
*/
|
|
2461
|
+
rateAsOf?: string;
|
|
2462
|
+
};
|
|
2463
|
+
MerchantTransferResponseDto: {
|
|
2464
|
+
/** Format: uuid */
|
|
2465
|
+
merchantId: string;
|
|
2466
|
+
/** @example acct_3fd84b2d9ad14f74a2d90f2f56984db5 */
|
|
2467
|
+
accountId: string;
|
|
2468
|
+
/** Format: uuid */
|
|
2469
|
+
tenantId: string;
|
|
2470
|
+
/** @example 100.00 */
|
|
2471
|
+
pendingVes: string;
|
|
2472
|
+
/** @example 250.00 */
|
|
2473
|
+
availableVes: string;
|
|
2474
|
+
/** @example 50.00 */
|
|
2475
|
+
paidOutVes: string;
|
|
2476
|
+
/** @example 350.00 */
|
|
2477
|
+
ledgerNetVes: string;
|
|
2478
|
+
/** @description COP balances from COP sales on seller links. Present only once the seller has COP activity. */
|
|
2479
|
+
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
2480
|
+
/** @description What this transfer credited (the original values on a replay). */
|
|
2481
|
+
transfer: components["schemas"]["MerchantTransferSnapshotDto"];
|
|
2482
|
+
};
|
|
2483
|
+
MerchantMovementDto: {
|
|
2484
|
+
/** Format: uuid */
|
|
2485
|
+
id: string;
|
|
2486
|
+
/**
|
|
2487
|
+
* @example credit
|
|
2488
|
+
* @enum {string}
|
|
2489
|
+
*/
|
|
2490
|
+
type: "credit" | "release" | "reversal" | "payout" | "payout_reversal" | "payout_fee" | "payout_fee_reversal" | "adjustment";
|
|
2491
|
+
/**
|
|
2492
|
+
* @description Signed change of the total balance (pending + available). A `release` row is 0.00.
|
|
2493
|
+
* @example 21540.00
|
|
2494
|
+
*/
|
|
2495
|
+
amountVes: string;
|
|
2496
|
+
/**
|
|
2497
|
+
* @description `release` rows only: VES moved from pending to available (negative = put back on hold).
|
|
2498
|
+
* @example 21540.00
|
|
2499
|
+
*/
|
|
2500
|
+
releasedVes?: string;
|
|
2501
|
+
/** @example Credit */
|
|
2502
|
+
description: string;
|
|
2503
|
+
/**
|
|
2504
|
+
* @description `credit` rows: the transferKey you sent.
|
|
2505
|
+
* @example q1-nov-u1
|
|
2506
|
+
*/
|
|
2507
|
+
transferKey?: string;
|
|
2508
|
+
/** Format: uuid */
|
|
2509
|
+
paymentId?: string | null;
|
|
2510
|
+
/** Format: uuid */
|
|
2511
|
+
payoutId?: string | null;
|
|
2512
|
+
/**
|
|
2513
|
+
* Format: date-time
|
|
2514
|
+
* @description `credit` rows: when the credit becomes withdrawable.
|
|
2515
|
+
*/
|
|
2516
|
+
availableAt?: string | null;
|
|
2517
|
+
/**
|
|
2518
|
+
* @description Credits sent with `amountUsd`: the USD amount.
|
|
2519
|
+
* @example 100.00
|
|
2520
|
+
*/
|
|
2521
|
+
amountUsd?: string;
|
|
2522
|
+
/**
|
|
2523
|
+
* @description Credits sent with `amountUsd`: the rate used.
|
|
2524
|
+
* @example 215.4000
|
|
2525
|
+
*/
|
|
2526
|
+
rate?: string;
|
|
2527
|
+
/** @example bcv */
|
|
2528
|
+
rateSource?: string;
|
|
2529
|
+
/** Format: date-time */
|
|
2530
|
+
createdAt: string;
|
|
2531
|
+
};
|
|
2532
|
+
MerchantMovementListDto: {
|
|
2533
|
+
items: components["schemas"]["MerchantMovementDto"][];
|
|
2534
|
+
/** @description Pass as `cursor` for the next (older) page; null on the last page. */
|
|
2535
|
+
nextCursor: string | null;
|
|
2536
|
+
};
|
|
2537
|
+
MerchantStatementDto: {
|
|
2538
|
+
/** Format: uuid */
|
|
2539
|
+
merchantId: string;
|
|
2540
|
+
/** @example 2026-11 */
|
|
2541
|
+
month: string;
|
|
2542
|
+
/**
|
|
2543
|
+
* Format: date-time
|
|
2544
|
+
* @description Month start, America/Caracas.
|
|
2545
|
+
* @example 2026-11-01T04:00:00.000Z
|
|
2546
|
+
*/
|
|
2547
|
+
from: string;
|
|
2548
|
+
/**
|
|
2549
|
+
* Format: date-time
|
|
2550
|
+
* @description Month end (exclusive), America/Caracas.
|
|
2551
|
+
* @example 2026-12-01T04:00:00.000Z
|
|
2552
|
+
*/
|
|
2553
|
+
to: string;
|
|
2554
|
+
/** @example 0.00 */
|
|
2555
|
+
openingVes: string;
|
|
2556
|
+
/**
|
|
2557
|
+
* @description openingVes + Σ movements[].amountVes.
|
|
2558
|
+
* @example 21800.00
|
|
2559
|
+
*/
|
|
2560
|
+
closingVes: string;
|
|
2561
|
+
/** @description Oldest first. */
|
|
2562
|
+
movements: components["schemas"]["MerchantMovementDto"][];
|
|
2563
|
+
};
|
|
2328
2564
|
UpdateMerchantDto: {
|
|
2329
2565
|
/** @description Soft off-switch for payouts. false = deactivated (history kept). */
|
|
2330
2566
|
isActive?: boolean;
|
|
@@ -2527,6 +2763,104 @@ interface components {
|
|
|
2527
2763
|
maxQuantity?: number | null;
|
|
2528
2764
|
redirectUrl?: string | null;
|
|
2529
2765
|
};
|
|
2766
|
+
CreateTopupDto: {
|
|
2767
|
+
/**
|
|
2768
|
+
* @description Bs to load, two decimals, above 0.
|
|
2769
|
+
* @example 100000.00
|
|
2770
|
+
*/
|
|
2771
|
+
amountVes: string;
|
|
2772
|
+
/**
|
|
2773
|
+
* @description Phone the Pago Móvil is sent from (Venezuelan mobile, 04XXXXXXXXX).
|
|
2774
|
+
* @example 04121234567
|
|
2775
|
+
*/
|
|
2776
|
+
payerPhone: string;
|
|
2777
|
+
/**
|
|
2778
|
+
* @description Cédula or RIF of the payer.
|
|
2779
|
+
* @example V12345678
|
|
2780
|
+
*/
|
|
2781
|
+
payerCedula: string;
|
|
2782
|
+
/**
|
|
2783
|
+
* @description Where the money comes from (10–500 characters). Visible to VEX Pay ops.
|
|
2784
|
+
* @example Ingresos de publicidad, quincena 2
|
|
2785
|
+
*/
|
|
2786
|
+
sourceNote: string;
|
|
2787
|
+
};
|
|
2788
|
+
TopupReceiverDto: {
|
|
2789
|
+
/**
|
|
2790
|
+
* @description Bank code to pick in your bank app. The bank name is not shown.
|
|
2791
|
+
* @example 0169
|
|
2792
|
+
*/
|
|
2793
|
+
bankCode: string;
|
|
2794
|
+
/** @example 04140000000 */
|
|
2795
|
+
phone: string;
|
|
2796
|
+
/** @example J-000000000 */
|
|
2797
|
+
identification: string;
|
|
2798
|
+
};
|
|
2799
|
+
TopupDto: {
|
|
2800
|
+
id: string;
|
|
2801
|
+
/** @enum {string} */
|
|
2802
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
2803
|
+
/** @example 100000.00 */
|
|
2804
|
+
amountVes: string;
|
|
2805
|
+
/**
|
|
2806
|
+
* @description USD at the BCV rate snapshotted at creation.
|
|
2807
|
+
* @example 500.00
|
|
2808
|
+
*/
|
|
2809
|
+
amountUsd: string;
|
|
2810
|
+
/** @example 200.0000 */
|
|
2811
|
+
bcvRate: string;
|
|
2812
|
+
/** @example 3.5000 */
|
|
2813
|
+
feePercent: string;
|
|
2814
|
+
/** @example 0.25 */
|
|
2815
|
+
feeFixedUsd: string;
|
|
2816
|
+
/**
|
|
2817
|
+
* @description Charged when the top-up completes.
|
|
2818
|
+
* @example 3550.00
|
|
2819
|
+
*/
|
|
2820
|
+
feeVes?: string;
|
|
2821
|
+
/**
|
|
2822
|
+
* @description Credited to your balance (amount − fee).
|
|
2823
|
+
* @example 96450.00
|
|
2824
|
+
*/
|
|
2825
|
+
creditedVes?: string;
|
|
2826
|
+
sourceNote: string;
|
|
2827
|
+
payerPhone: string;
|
|
2828
|
+
bankReference?: string;
|
|
2829
|
+
expiresAt: string;
|
|
2830
|
+
completedAt?: string;
|
|
2831
|
+
/** @description When the credit becomes available on its own (null = available). */
|
|
2832
|
+
availableAt?: string;
|
|
2833
|
+
/**
|
|
2834
|
+
* @description Part of this top-up still held.
|
|
2835
|
+
* @example 96450.00
|
|
2836
|
+
*/
|
|
2837
|
+
heldVes: string;
|
|
2838
|
+
/**
|
|
2839
|
+
* @description Instant availability fee percent.
|
|
2840
|
+
* @example 1.5000
|
|
2841
|
+
*/
|
|
2842
|
+
instantFeePercent: string;
|
|
2843
|
+
/**
|
|
2844
|
+
* @description Fee to release heldVes now.
|
|
2845
|
+
* @example 1446.75
|
|
2846
|
+
*/
|
|
2847
|
+
instantFeeVes: string;
|
|
2848
|
+
/** @description When the held part was released early with the instant fee. */
|
|
2849
|
+
instantReleasedAt?: string;
|
|
2850
|
+
/** @description Where to send the Pago Móvil (pending only). */
|
|
2851
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
2852
|
+
test: boolean;
|
|
2853
|
+
createdAt: string;
|
|
2854
|
+
};
|
|
2855
|
+
TopupListDto: {
|
|
2856
|
+
data: components["schemas"]["TopupDto"][];
|
|
2857
|
+
/** @example 3000.00 */
|
|
2858
|
+
monthlyCapUsd: string | null;
|
|
2859
|
+
/** @example 500.00 */
|
|
2860
|
+
monthUsedUsd: string;
|
|
2861
|
+
/** @example 2500.00 */
|
|
2862
|
+
monthRemainingUsd: string;
|
|
2863
|
+
};
|
|
2530
2864
|
NotificationTestResponseDto: {
|
|
2531
2865
|
/** @example true */
|
|
2532
2866
|
sent: boolean;
|
|
@@ -2930,7 +3264,7 @@ interface operations {
|
|
|
2930
3264
|
/** @description Only movements of this payment. */
|
|
2931
3265
|
paymentId?: string;
|
|
2932
3266
|
/** @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")[];
|
|
3267
|
+
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
3268
|
/** @description `nextCursor` from the previous page. */
|
|
2935
3269
|
cursor?: string;
|
|
2936
3270
|
/** @description 1–100, default 50. */
|
|
@@ -5386,6 +5720,61 @@ interface operations {
|
|
|
5386
5720
|
};
|
|
5387
5721
|
};
|
|
5388
5722
|
};
|
|
5723
|
+
CopPayments_channels: {
|
|
5724
|
+
parameters: {
|
|
5725
|
+
query?: never;
|
|
5726
|
+
header?: never;
|
|
5727
|
+
path?: never;
|
|
5728
|
+
cookie?: never;
|
|
5729
|
+
};
|
|
5730
|
+
requestBody?: never;
|
|
5731
|
+
responses: {
|
|
5732
|
+
200: {
|
|
5733
|
+
headers: {
|
|
5734
|
+
[name: string]: unknown;
|
|
5735
|
+
};
|
|
5736
|
+
content: {
|
|
5737
|
+
"application/json": components["schemas"]["CopChannelsDto"];
|
|
5738
|
+
};
|
|
5739
|
+
};
|
|
5740
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
5741
|
+
401: {
|
|
5742
|
+
headers: {
|
|
5743
|
+
[name: string]: unknown;
|
|
5744
|
+
};
|
|
5745
|
+
content: {
|
|
5746
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5747
|
+
};
|
|
5748
|
+
};
|
|
5749
|
+
/** @description `method_not_allowed` — COP is not enabled for this account. */
|
|
5750
|
+
403: {
|
|
5751
|
+
headers: {
|
|
5752
|
+
[name: string]: unknown;
|
|
5753
|
+
};
|
|
5754
|
+
content: {
|
|
5755
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5756
|
+
};
|
|
5757
|
+
};
|
|
5758
|
+
/** @description Client error. */
|
|
5759
|
+
"4XX": {
|
|
5760
|
+
headers: {
|
|
5761
|
+
[name: string]: unknown;
|
|
5762
|
+
};
|
|
5763
|
+
content: {
|
|
5764
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5765
|
+
};
|
|
5766
|
+
};
|
|
5767
|
+
/** @description Server or upstream bank error. */
|
|
5768
|
+
"5XX": {
|
|
5769
|
+
headers: {
|
|
5770
|
+
[name: string]: unknown;
|
|
5771
|
+
};
|
|
5772
|
+
content: {
|
|
5773
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5774
|
+
};
|
|
5775
|
+
};
|
|
5776
|
+
};
|
|
5777
|
+
};
|
|
5389
5778
|
CopPayments_create: {
|
|
5390
5779
|
parameters: {
|
|
5391
5780
|
query?: never;
|
|
@@ -5410,7 +5799,7 @@ interface operations {
|
|
|
5410
5799
|
"application/json": components["schemas"]["CopPaymentDto"];
|
|
5411
5800
|
};
|
|
5412
5801
|
};
|
|
5413
|
-
/** @description `invalid_data` (names the field)
|
|
5802
|
+
/** @description `invalid_data` (names the field), `amount_below_minimum`, `amount_out_of_range`, or `channel_requires_checkout` (card). */
|
|
5414
5803
|
400: {
|
|
5415
5804
|
headers: {
|
|
5416
5805
|
[name: string]: unknown;
|
|
@@ -5755,7 +6144,7 @@ interface operations {
|
|
|
5755
6144
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
5756
6145
|
};
|
|
5757
6146
|
};
|
|
5758
|
-
/** @description `invalid_state`, `refund_window_expired` or `insufficient_balance`. */
|
|
6147
|
+
/** @description `invalid_state`, `refund_not_supported` (the channel has no refunds), `refund_window_expired` or `insufficient_balance`. */
|
|
5759
6148
|
409: {
|
|
5760
6149
|
headers: {
|
|
5761
6150
|
[name: string]: unknown;
|
|
@@ -7943,7 +8332,7 @@ interface operations {
|
|
|
7943
8332
|
[name: string]: unknown;
|
|
7944
8333
|
};
|
|
7945
8334
|
content: {
|
|
7946
|
-
"application/json": components["schemas"]["
|
|
8335
|
+
"application/json": components["schemas"]["MerchantTransferResponseDto"];
|
|
7947
8336
|
};
|
|
7948
8337
|
};
|
|
7949
8338
|
/** @description Validation failure. */
|
|
@@ -8001,9 +8390,18 @@ interface operations {
|
|
|
8001
8390
|
};
|
|
8002
8391
|
};
|
|
8003
8392
|
};
|
|
8004
|
-
|
|
8393
|
+
Merchants_listTransactions: {
|
|
8005
8394
|
parameters: {
|
|
8006
|
-
query?:
|
|
8395
|
+
query?: {
|
|
8396
|
+
/** @description ISO 8601, exclusive (createdAt). */
|
|
8397
|
+
to?: string;
|
|
8398
|
+
/** @description ISO 8601, inclusive (createdAt). */
|
|
8399
|
+
from?: string;
|
|
8400
|
+
/** @description `nextCursor` from the previous page. */
|
|
8401
|
+
cursor?: string;
|
|
8402
|
+
/** @description 1–100, default 50. */
|
|
8403
|
+
limit?: number;
|
|
8404
|
+
};
|
|
8007
8405
|
header?: never;
|
|
8008
8406
|
path: {
|
|
8009
8407
|
id: string;
|
|
@@ -8017,7 +8415,7 @@ interface operations {
|
|
|
8017
8415
|
[name: string]: unknown;
|
|
8018
8416
|
};
|
|
8019
8417
|
content: {
|
|
8020
|
-
"application/json": components["schemas"]["
|
|
8418
|
+
"application/json": components["schemas"]["MerchantMovementListDto"];
|
|
8021
8419
|
};
|
|
8022
8420
|
};
|
|
8023
8421
|
/** @description Validation failure. */
|
|
@@ -8075,9 +8473,14 @@ interface operations {
|
|
|
8075
8473
|
};
|
|
8076
8474
|
};
|
|
8077
8475
|
};
|
|
8078
|
-
|
|
8476
|
+
Merchants_statement: {
|
|
8079
8477
|
parameters: {
|
|
8080
|
-
query
|
|
8478
|
+
query: {
|
|
8479
|
+
/** @description YYYY-MM. */
|
|
8480
|
+
month: string;
|
|
8481
|
+
/** @description Default json. */
|
|
8482
|
+
format?: "json" | "csv";
|
|
8483
|
+
};
|
|
8081
8484
|
header?: never;
|
|
8082
8485
|
path: {
|
|
8083
8486
|
id: string;
|
|
@@ -8091,7 +8494,7 @@ interface operations {
|
|
|
8091
8494
|
[name: string]: unknown;
|
|
8092
8495
|
};
|
|
8093
8496
|
content: {
|
|
8094
|
-
"application/json": components["schemas"]["
|
|
8497
|
+
"application/json": components["schemas"]["MerchantStatementDto"];
|
|
8095
8498
|
};
|
|
8096
8499
|
};
|
|
8097
8500
|
/** @description Validation failure. */
|
|
@@ -8121,7 +8524,6 @@ interface operations {
|
|
|
8121
8524
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8122
8525
|
};
|
|
8123
8526
|
};
|
|
8124
|
-
/** @description Merchant not found for this tenant. */
|
|
8125
8527
|
404: {
|
|
8126
8528
|
headers: {
|
|
8127
8529
|
[name: string]: unknown;
|
|
@@ -8130,8 +8532,8 @@ interface operations {
|
|
|
8130
8532
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8131
8533
|
};
|
|
8132
8534
|
};
|
|
8133
|
-
/** @description
|
|
8134
|
-
|
|
8535
|
+
/** @description Client error. */
|
|
8536
|
+
"4XX": {
|
|
8135
8537
|
headers: {
|
|
8136
8538
|
[name: string]: unknown;
|
|
8137
8539
|
};
|
|
@@ -8139,9 +8541,158 @@ interface operations {
|
|
|
8139
8541
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8140
8542
|
};
|
|
8141
8543
|
};
|
|
8142
|
-
/** @description
|
|
8143
|
-
"
|
|
8144
|
-
headers: {
|
|
8544
|
+
/** @description Server or upstream bank error. */
|
|
8545
|
+
"5XX": {
|
|
8546
|
+
headers: {
|
|
8547
|
+
[name: string]: unknown;
|
|
8548
|
+
};
|
|
8549
|
+
content: {
|
|
8550
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8551
|
+
};
|
|
8552
|
+
};
|
|
8553
|
+
};
|
|
8554
|
+
};
|
|
8555
|
+
Merchants_getById: {
|
|
8556
|
+
parameters: {
|
|
8557
|
+
query?: never;
|
|
8558
|
+
header?: never;
|
|
8559
|
+
path: {
|
|
8560
|
+
id: string;
|
|
8561
|
+
};
|
|
8562
|
+
cookie?: never;
|
|
8563
|
+
};
|
|
8564
|
+
requestBody?: never;
|
|
8565
|
+
responses: {
|
|
8566
|
+
200: {
|
|
8567
|
+
headers: {
|
|
8568
|
+
[name: string]: unknown;
|
|
8569
|
+
};
|
|
8570
|
+
content: {
|
|
8571
|
+
"application/json": components["schemas"]["MerchantResponseDto"];
|
|
8572
|
+
};
|
|
8573
|
+
};
|
|
8574
|
+
/** @description Validation failure. */
|
|
8575
|
+
400: {
|
|
8576
|
+
headers: {
|
|
8577
|
+
[name: string]: unknown;
|
|
8578
|
+
};
|
|
8579
|
+
content: {
|
|
8580
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8581
|
+
};
|
|
8582
|
+
};
|
|
8583
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
8584
|
+
401: {
|
|
8585
|
+
headers: {
|
|
8586
|
+
[name: string]: unknown;
|
|
8587
|
+
};
|
|
8588
|
+
content: {
|
|
8589
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8590
|
+
};
|
|
8591
|
+
};
|
|
8592
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
8593
|
+
403: {
|
|
8594
|
+
headers: {
|
|
8595
|
+
[name: string]: unknown;
|
|
8596
|
+
};
|
|
8597
|
+
content: {
|
|
8598
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8599
|
+
};
|
|
8600
|
+
};
|
|
8601
|
+
404: {
|
|
8602
|
+
headers: {
|
|
8603
|
+
[name: string]: unknown;
|
|
8604
|
+
};
|
|
8605
|
+
content: {
|
|
8606
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8607
|
+
};
|
|
8608
|
+
};
|
|
8609
|
+
/** @description Client error. */
|
|
8610
|
+
"4XX": {
|
|
8611
|
+
headers: {
|
|
8612
|
+
[name: string]: unknown;
|
|
8613
|
+
};
|
|
8614
|
+
content: {
|
|
8615
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8616
|
+
};
|
|
8617
|
+
};
|
|
8618
|
+
/** @description Server or upstream bank error. */
|
|
8619
|
+
"5XX": {
|
|
8620
|
+
headers: {
|
|
8621
|
+
[name: string]: unknown;
|
|
8622
|
+
};
|
|
8623
|
+
content: {
|
|
8624
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8625
|
+
};
|
|
8626
|
+
};
|
|
8627
|
+
};
|
|
8628
|
+
};
|
|
8629
|
+
Merchants_remove: {
|
|
8630
|
+
parameters: {
|
|
8631
|
+
query?: never;
|
|
8632
|
+
header?: never;
|
|
8633
|
+
path: {
|
|
8634
|
+
id: string;
|
|
8635
|
+
};
|
|
8636
|
+
cookie?: never;
|
|
8637
|
+
};
|
|
8638
|
+
requestBody?: never;
|
|
8639
|
+
responses: {
|
|
8640
|
+
200: {
|
|
8641
|
+
headers: {
|
|
8642
|
+
[name: string]: unknown;
|
|
8643
|
+
};
|
|
8644
|
+
content: {
|
|
8645
|
+
"application/json": components["schemas"]["DeleteMerchantResponseDto"];
|
|
8646
|
+
};
|
|
8647
|
+
};
|
|
8648
|
+
/** @description Validation failure. */
|
|
8649
|
+
400: {
|
|
8650
|
+
headers: {
|
|
8651
|
+
[name: string]: unknown;
|
|
8652
|
+
};
|
|
8653
|
+
content: {
|
|
8654
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8655
|
+
};
|
|
8656
|
+
};
|
|
8657
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
8658
|
+
401: {
|
|
8659
|
+
headers: {
|
|
8660
|
+
[name: string]: unknown;
|
|
8661
|
+
};
|
|
8662
|
+
content: {
|
|
8663
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8664
|
+
};
|
|
8665
|
+
};
|
|
8666
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
8667
|
+
403: {
|
|
8668
|
+
headers: {
|
|
8669
|
+
[name: string]: unknown;
|
|
8670
|
+
};
|
|
8671
|
+
content: {
|
|
8672
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8673
|
+
};
|
|
8674
|
+
};
|
|
8675
|
+
/** @description Merchant not found for this tenant. */
|
|
8676
|
+
404: {
|
|
8677
|
+
headers: {
|
|
8678
|
+
[name: string]: unknown;
|
|
8679
|
+
};
|
|
8680
|
+
content: {
|
|
8681
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8682
|
+
};
|
|
8683
|
+
};
|
|
8684
|
+
/** @description merchant_has_payouts — merchant has payout history; deactivate instead. */
|
|
8685
|
+
409: {
|
|
8686
|
+
headers: {
|
|
8687
|
+
[name: string]: unknown;
|
|
8688
|
+
};
|
|
8689
|
+
content: {
|
|
8690
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8691
|
+
};
|
|
8692
|
+
};
|
|
8693
|
+
/** @description Client error. */
|
|
8694
|
+
"4XX": {
|
|
8695
|
+
headers: {
|
|
8145
8696
|
[name: string]: unknown;
|
|
8146
8697
|
};
|
|
8147
8698
|
content: {
|
|
@@ -8653,8 +9204,380 @@ interface operations {
|
|
|
8653
9204
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8654
9205
|
};
|
|
8655
9206
|
};
|
|
8656
|
-
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
8657
|
-
403: {
|
|
9207
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9208
|
+
403: {
|
|
9209
|
+
headers: {
|
|
9210
|
+
[name: string]: unknown;
|
|
9211
|
+
};
|
|
9212
|
+
content: {
|
|
9213
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9214
|
+
};
|
|
9215
|
+
};
|
|
9216
|
+
/** @description Client error. */
|
|
9217
|
+
"4XX": {
|
|
9218
|
+
headers: {
|
|
9219
|
+
[name: string]: unknown;
|
|
9220
|
+
};
|
|
9221
|
+
content: {
|
|
9222
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9223
|
+
};
|
|
9224
|
+
};
|
|
9225
|
+
/** @description Server or upstream bank error. */
|
|
9226
|
+
"5XX": {
|
|
9227
|
+
headers: {
|
|
9228
|
+
[name: string]: unknown;
|
|
9229
|
+
};
|
|
9230
|
+
content: {
|
|
9231
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9232
|
+
};
|
|
9233
|
+
};
|
|
9234
|
+
};
|
|
9235
|
+
};
|
|
9236
|
+
Products_create: {
|
|
9237
|
+
parameters: {
|
|
9238
|
+
query?: never;
|
|
9239
|
+
header?: {
|
|
9240
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9241
|
+
"Idempotency-Key"?: string;
|
|
9242
|
+
};
|
|
9243
|
+
path?: never;
|
|
9244
|
+
cookie?: never;
|
|
9245
|
+
};
|
|
9246
|
+
requestBody: {
|
|
9247
|
+
content: {
|
|
9248
|
+
"application/json": components["schemas"]["CreateProductDto"];
|
|
9249
|
+
};
|
|
9250
|
+
};
|
|
9251
|
+
responses: {
|
|
9252
|
+
201: {
|
|
9253
|
+
headers: {
|
|
9254
|
+
[name: string]: unknown;
|
|
9255
|
+
};
|
|
9256
|
+
content: {
|
|
9257
|
+
"application/json": components["schemas"]["ProductResponseDto"];
|
|
9258
|
+
};
|
|
9259
|
+
};
|
|
9260
|
+
/** @description Validation failure. */
|
|
9261
|
+
400: {
|
|
9262
|
+
headers: {
|
|
9263
|
+
[name: string]: unknown;
|
|
9264
|
+
};
|
|
9265
|
+
content: {
|
|
9266
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9267
|
+
};
|
|
9268
|
+
};
|
|
9269
|
+
/** @description Missing or invalid tenant API key. */
|
|
9270
|
+
401: {
|
|
9271
|
+
headers: {
|
|
9272
|
+
[name: string]: unknown;
|
|
9273
|
+
};
|
|
9274
|
+
content: {
|
|
9275
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9276
|
+
};
|
|
9277
|
+
};
|
|
9278
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9279
|
+
403: {
|
|
9280
|
+
headers: {
|
|
9281
|
+
[name: string]: unknown;
|
|
9282
|
+
};
|
|
9283
|
+
content: {
|
|
9284
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9285
|
+
};
|
|
9286
|
+
};
|
|
9287
|
+
/** @description Client error. */
|
|
9288
|
+
"4XX": {
|
|
9289
|
+
headers: {
|
|
9290
|
+
[name: string]: unknown;
|
|
9291
|
+
};
|
|
9292
|
+
content: {
|
|
9293
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9294
|
+
};
|
|
9295
|
+
};
|
|
9296
|
+
/** @description Server or upstream bank error. */
|
|
9297
|
+
"5XX": {
|
|
9298
|
+
headers: {
|
|
9299
|
+
[name: string]: unknown;
|
|
9300
|
+
};
|
|
9301
|
+
content: {
|
|
9302
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9303
|
+
};
|
|
9304
|
+
};
|
|
9305
|
+
};
|
|
9306
|
+
};
|
|
9307
|
+
Products_get: {
|
|
9308
|
+
parameters: {
|
|
9309
|
+
query?: never;
|
|
9310
|
+
header?: never;
|
|
9311
|
+
path: {
|
|
9312
|
+
id: string;
|
|
9313
|
+
};
|
|
9314
|
+
cookie?: never;
|
|
9315
|
+
};
|
|
9316
|
+
requestBody?: never;
|
|
9317
|
+
responses: {
|
|
9318
|
+
200: {
|
|
9319
|
+
headers: {
|
|
9320
|
+
[name: string]: unknown;
|
|
9321
|
+
};
|
|
9322
|
+
content: {
|
|
9323
|
+
"application/json": components["schemas"]["ProductResponseDto"];
|
|
9324
|
+
};
|
|
9325
|
+
};
|
|
9326
|
+
/** @description Validation failure. */
|
|
9327
|
+
400: {
|
|
9328
|
+
headers: {
|
|
9329
|
+
[name: string]: unknown;
|
|
9330
|
+
};
|
|
9331
|
+
content: {
|
|
9332
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9333
|
+
};
|
|
9334
|
+
};
|
|
9335
|
+
/** @description Missing or invalid tenant API key. */
|
|
9336
|
+
401: {
|
|
9337
|
+
headers: {
|
|
9338
|
+
[name: string]: unknown;
|
|
9339
|
+
};
|
|
9340
|
+
content: {
|
|
9341
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9342
|
+
};
|
|
9343
|
+
};
|
|
9344
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9345
|
+
403: {
|
|
9346
|
+
headers: {
|
|
9347
|
+
[name: string]: unknown;
|
|
9348
|
+
};
|
|
9349
|
+
content: {
|
|
9350
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9351
|
+
};
|
|
9352
|
+
};
|
|
9353
|
+
404: {
|
|
9354
|
+
headers: {
|
|
9355
|
+
[name: string]: unknown;
|
|
9356
|
+
};
|
|
9357
|
+
content: {
|
|
9358
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9359
|
+
};
|
|
9360
|
+
};
|
|
9361
|
+
/** @description Client error. */
|
|
9362
|
+
"4XX": {
|
|
9363
|
+
headers: {
|
|
9364
|
+
[name: string]: unknown;
|
|
9365
|
+
};
|
|
9366
|
+
content: {
|
|
9367
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9368
|
+
};
|
|
9369
|
+
};
|
|
9370
|
+
/** @description Server or upstream bank error. */
|
|
9371
|
+
"5XX": {
|
|
9372
|
+
headers: {
|
|
9373
|
+
[name: string]: unknown;
|
|
9374
|
+
};
|
|
9375
|
+
content: {
|
|
9376
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9377
|
+
};
|
|
9378
|
+
};
|
|
9379
|
+
};
|
|
9380
|
+
};
|
|
9381
|
+
Products_remove: {
|
|
9382
|
+
parameters: {
|
|
9383
|
+
query?: never;
|
|
9384
|
+
header?: never;
|
|
9385
|
+
path: {
|
|
9386
|
+
id: string;
|
|
9387
|
+
};
|
|
9388
|
+
cookie?: never;
|
|
9389
|
+
};
|
|
9390
|
+
requestBody?: never;
|
|
9391
|
+
responses: {
|
|
9392
|
+
/** @description Validation failure. */
|
|
9393
|
+
400: {
|
|
9394
|
+
headers: {
|
|
9395
|
+
[name: string]: unknown;
|
|
9396
|
+
};
|
|
9397
|
+
content: {
|
|
9398
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9399
|
+
};
|
|
9400
|
+
};
|
|
9401
|
+
/** @description Missing or invalid tenant API key. */
|
|
9402
|
+
401: {
|
|
9403
|
+
headers: {
|
|
9404
|
+
[name: string]: unknown;
|
|
9405
|
+
};
|
|
9406
|
+
content: {
|
|
9407
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9408
|
+
};
|
|
9409
|
+
};
|
|
9410
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9411
|
+
403: {
|
|
9412
|
+
headers: {
|
|
9413
|
+
[name: string]: unknown;
|
|
9414
|
+
};
|
|
9415
|
+
content: {
|
|
9416
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9417
|
+
};
|
|
9418
|
+
};
|
|
9419
|
+
404: {
|
|
9420
|
+
headers: {
|
|
9421
|
+
[name: string]: unknown;
|
|
9422
|
+
};
|
|
9423
|
+
content: {
|
|
9424
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9425
|
+
};
|
|
9426
|
+
};
|
|
9427
|
+
/** @description product_has_sales */
|
|
9428
|
+
409: {
|
|
9429
|
+
headers: {
|
|
9430
|
+
[name: string]: unknown;
|
|
9431
|
+
};
|
|
9432
|
+
content: {
|
|
9433
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9434
|
+
};
|
|
9435
|
+
};
|
|
9436
|
+
/** @description Client error. */
|
|
9437
|
+
"4XX": {
|
|
9438
|
+
headers: {
|
|
9439
|
+
[name: string]: unknown;
|
|
9440
|
+
};
|
|
9441
|
+
content: {
|
|
9442
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9443
|
+
};
|
|
9444
|
+
};
|
|
9445
|
+
/** @description Server or upstream bank error. */
|
|
9446
|
+
"5XX": {
|
|
9447
|
+
headers: {
|
|
9448
|
+
[name: string]: unknown;
|
|
9449
|
+
};
|
|
9450
|
+
content: {
|
|
9451
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9452
|
+
};
|
|
9453
|
+
};
|
|
9454
|
+
};
|
|
9455
|
+
};
|
|
9456
|
+
Products_update: {
|
|
9457
|
+
parameters: {
|
|
9458
|
+
query?: never;
|
|
9459
|
+
header?: never;
|
|
9460
|
+
path: {
|
|
9461
|
+
id: string;
|
|
9462
|
+
};
|
|
9463
|
+
cookie?: never;
|
|
9464
|
+
};
|
|
9465
|
+
requestBody: {
|
|
9466
|
+
content: {
|
|
9467
|
+
"application/json": components["schemas"]["UpdateProductDto"];
|
|
9468
|
+
};
|
|
9469
|
+
};
|
|
9470
|
+
responses: {
|
|
9471
|
+
200: {
|
|
9472
|
+
headers: {
|
|
9473
|
+
[name: string]: unknown;
|
|
9474
|
+
};
|
|
9475
|
+
content: {
|
|
9476
|
+
"application/json": components["schemas"]["ProductResponseDto"];
|
|
9477
|
+
};
|
|
9478
|
+
};
|
|
9479
|
+
/** @description Validation failure. */
|
|
9480
|
+
400: {
|
|
9481
|
+
headers: {
|
|
9482
|
+
[name: string]: unknown;
|
|
9483
|
+
};
|
|
9484
|
+
content: {
|
|
9485
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9486
|
+
};
|
|
9487
|
+
};
|
|
9488
|
+
/** @description Missing or invalid tenant API key. */
|
|
9489
|
+
401: {
|
|
9490
|
+
headers: {
|
|
9491
|
+
[name: string]: unknown;
|
|
9492
|
+
};
|
|
9493
|
+
content: {
|
|
9494
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9495
|
+
};
|
|
9496
|
+
};
|
|
9497
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9498
|
+
403: {
|
|
9499
|
+
headers: {
|
|
9500
|
+
[name: string]: unknown;
|
|
9501
|
+
};
|
|
9502
|
+
content: {
|
|
9503
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9504
|
+
};
|
|
9505
|
+
};
|
|
9506
|
+
404: {
|
|
9507
|
+
headers: {
|
|
9508
|
+
[name: string]: unknown;
|
|
9509
|
+
};
|
|
9510
|
+
content: {
|
|
9511
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9512
|
+
};
|
|
9513
|
+
};
|
|
9514
|
+
/** @description Client error. */
|
|
9515
|
+
"4XX": {
|
|
9516
|
+
headers: {
|
|
9517
|
+
[name: string]: unknown;
|
|
9518
|
+
};
|
|
9519
|
+
content: {
|
|
9520
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9521
|
+
};
|
|
9522
|
+
};
|
|
9523
|
+
/** @description Server or upstream bank error. */
|
|
9524
|
+
"5XX": {
|
|
9525
|
+
headers: {
|
|
9526
|
+
[name: string]: unknown;
|
|
9527
|
+
};
|
|
9528
|
+
content: {
|
|
9529
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9530
|
+
};
|
|
9531
|
+
};
|
|
9532
|
+
};
|
|
9533
|
+
};
|
|
9534
|
+
Products_listLinks: {
|
|
9535
|
+
parameters: {
|
|
9536
|
+
query?: never;
|
|
9537
|
+
header?: never;
|
|
9538
|
+
path: {
|
|
9539
|
+
id: string;
|
|
9540
|
+
};
|
|
9541
|
+
cookie?: never;
|
|
9542
|
+
};
|
|
9543
|
+
requestBody?: never;
|
|
9544
|
+
responses: {
|
|
9545
|
+
200: {
|
|
9546
|
+
headers: {
|
|
9547
|
+
[name: string]: unknown;
|
|
9548
|
+
};
|
|
9549
|
+
content: {
|
|
9550
|
+
"application/json": components["schemas"]["PaymentLinkListResponseDto"];
|
|
9551
|
+
};
|
|
9552
|
+
};
|
|
9553
|
+
/** @description Validation failure. */
|
|
9554
|
+
400: {
|
|
9555
|
+
headers: {
|
|
9556
|
+
[name: string]: unknown;
|
|
9557
|
+
};
|
|
9558
|
+
content: {
|
|
9559
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9560
|
+
};
|
|
9561
|
+
};
|
|
9562
|
+
/** @description Missing or invalid tenant API key. */
|
|
9563
|
+
401: {
|
|
9564
|
+
headers: {
|
|
9565
|
+
[name: string]: unknown;
|
|
9566
|
+
};
|
|
9567
|
+
content: {
|
|
9568
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9569
|
+
};
|
|
9570
|
+
};
|
|
9571
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9572
|
+
403: {
|
|
9573
|
+
headers: {
|
|
9574
|
+
[name: string]: unknown;
|
|
9575
|
+
};
|
|
9576
|
+
content: {
|
|
9577
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9578
|
+
};
|
|
9579
|
+
};
|
|
9580
|
+
404: {
|
|
8658
9581
|
headers: {
|
|
8659
9582
|
[name: string]: unknown;
|
|
8660
9583
|
};
|
|
@@ -8682,19 +9605,21 @@ interface operations {
|
|
|
8682
9605
|
};
|
|
8683
9606
|
};
|
|
8684
9607
|
};
|
|
8685
|
-
|
|
9608
|
+
Products_createLink: {
|
|
8686
9609
|
parameters: {
|
|
8687
9610
|
query?: never;
|
|
8688
9611
|
header?: {
|
|
8689
9612
|
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
8690
9613
|
"Idempotency-Key"?: string;
|
|
8691
9614
|
};
|
|
8692
|
-
path
|
|
9615
|
+
path: {
|
|
9616
|
+
id: string;
|
|
9617
|
+
};
|
|
8693
9618
|
cookie?: never;
|
|
8694
9619
|
};
|
|
8695
9620
|
requestBody: {
|
|
8696
9621
|
content: {
|
|
8697
|
-
"application/json": components["schemas"]["
|
|
9622
|
+
"application/json": components["schemas"]["CreatePaymentLinkDto"];
|
|
8698
9623
|
};
|
|
8699
9624
|
};
|
|
8700
9625
|
responses: {
|
|
@@ -8703,7 +9628,7 @@ interface operations {
|
|
|
8703
9628
|
[name: string]: unknown;
|
|
8704
9629
|
};
|
|
8705
9630
|
content: {
|
|
8706
|
-
"application/json": components["schemas"]["
|
|
9631
|
+
"application/json": components["schemas"]["PaymentLinkResponseDto"];
|
|
8707
9632
|
};
|
|
8708
9633
|
};
|
|
8709
9634
|
/** @description Validation failure. */
|
|
@@ -8733,6 +9658,23 @@ interface operations {
|
|
|
8733
9658
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8734
9659
|
};
|
|
8735
9660
|
};
|
|
9661
|
+
404: {
|
|
9662
|
+
headers: {
|
|
9663
|
+
[name: string]: unknown;
|
|
9664
|
+
};
|
|
9665
|
+
content: {
|
|
9666
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9667
|
+
};
|
|
9668
|
+
};
|
|
9669
|
+
/** @description slug_taken */
|
|
9670
|
+
409: {
|
|
9671
|
+
headers: {
|
|
9672
|
+
[name: string]: unknown;
|
|
9673
|
+
};
|
|
9674
|
+
content: {
|
|
9675
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9676
|
+
};
|
|
9677
|
+
};
|
|
8736
9678
|
/** @description Client error. */
|
|
8737
9679
|
"4XX": {
|
|
8738
9680
|
headers: {
|
|
@@ -8753,7 +9695,7 @@ interface operations {
|
|
|
8753
9695
|
};
|
|
8754
9696
|
};
|
|
8755
9697
|
};
|
|
8756
|
-
|
|
9698
|
+
PaymentLinks_get: {
|
|
8757
9699
|
parameters: {
|
|
8758
9700
|
query?: never;
|
|
8759
9701
|
header?: never;
|
|
@@ -8769,16 +9711,7 @@ interface operations {
|
|
|
8769
9711
|
[name: string]: unknown;
|
|
8770
9712
|
};
|
|
8771
9713
|
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"];
|
|
9714
|
+
"application/json": components["schemas"]["PaymentLinkResponseDto"];
|
|
8782
9715
|
};
|
|
8783
9716
|
};
|
|
8784
9717
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -8827,7 +9760,7 @@ interface operations {
|
|
|
8827
9760
|
};
|
|
8828
9761
|
};
|
|
8829
9762
|
};
|
|
8830
|
-
|
|
9763
|
+
PaymentLinks_remove: {
|
|
8831
9764
|
parameters: {
|
|
8832
9765
|
query?: never;
|
|
8833
9766
|
header?: never;
|
|
@@ -8838,15 +9771,6 @@ interface operations {
|
|
|
8838
9771
|
};
|
|
8839
9772
|
requestBody?: never;
|
|
8840
9773
|
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
9774
|
/** @description Missing or invalid tenant API key. */
|
|
8851
9775
|
401: {
|
|
8852
9776
|
headers: {
|
|
@@ -8902,7 +9826,7 @@ interface operations {
|
|
|
8902
9826
|
};
|
|
8903
9827
|
};
|
|
8904
9828
|
};
|
|
8905
|
-
|
|
9829
|
+
PaymentLinks_update: {
|
|
8906
9830
|
parameters: {
|
|
8907
9831
|
query?: never;
|
|
8908
9832
|
header?: never;
|
|
@@ -8913,7 +9837,7 @@ interface operations {
|
|
|
8913
9837
|
};
|
|
8914
9838
|
requestBody: {
|
|
8915
9839
|
content: {
|
|
8916
|
-
"application/json": components["schemas"]["
|
|
9840
|
+
"application/json": components["schemas"]["UpdatePaymentLinkDto"];
|
|
8917
9841
|
};
|
|
8918
9842
|
};
|
|
8919
9843
|
responses: {
|
|
@@ -8922,16 +9846,7 @@ interface operations {
|
|
|
8922
9846
|
[name: string]: unknown;
|
|
8923
9847
|
};
|
|
8924
9848
|
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"];
|
|
9849
|
+
"application/json": components["schemas"]["PaymentLinkResponseDto"];
|
|
8935
9850
|
};
|
|
8936
9851
|
};
|
|
8937
9852
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -8980,13 +9895,14 @@ interface operations {
|
|
|
8980
9895
|
};
|
|
8981
9896
|
};
|
|
8982
9897
|
};
|
|
8983
|
-
|
|
9898
|
+
Topups_list: {
|
|
8984
9899
|
parameters: {
|
|
8985
|
-
query?:
|
|
8986
|
-
|
|
8987
|
-
|
|
8988
|
-
id: string;
|
|
9900
|
+
query?: {
|
|
9901
|
+
/** @description 1–100, default 20. */
|
|
9902
|
+
limit?: number;
|
|
8989
9903
|
};
|
|
9904
|
+
header?: never;
|
|
9905
|
+
path?: never;
|
|
8990
9906
|
cookie?: never;
|
|
8991
9907
|
};
|
|
8992
9908
|
requestBody?: never;
|
|
@@ -8996,19 +9912,10 @@ interface operations {
|
|
|
8996
9912
|
[name: string]: unknown;
|
|
8997
9913
|
};
|
|
8998
9914
|
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"];
|
|
9915
|
+
"application/json": components["schemas"]["TopupListDto"];
|
|
9009
9916
|
};
|
|
9010
9917
|
};
|
|
9011
|
-
/** @description Missing or
|
|
9918
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9012
9919
|
401: {
|
|
9013
9920
|
headers: {
|
|
9014
9921
|
[name: string]: unknown;
|
|
@@ -9017,7 +9924,7 @@ interface operations {
|
|
|
9017
9924
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9018
9925
|
};
|
|
9019
9926
|
};
|
|
9020
|
-
/** @description
|
|
9927
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
9021
9928
|
403: {
|
|
9022
9929
|
headers: {
|
|
9023
9930
|
[name: string]: unknown;
|
|
@@ -9026,14 +9933,6 @@ interface operations {
|
|
|
9026
9933
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9027
9934
|
};
|
|
9028
9935
|
};
|
|
9029
|
-
404: {
|
|
9030
|
-
headers: {
|
|
9031
|
-
[name: string]: unknown;
|
|
9032
|
-
};
|
|
9033
|
-
content: {
|
|
9034
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9035
|
-
};
|
|
9036
|
-
};
|
|
9037
9936
|
/** @description Client error. */
|
|
9038
9937
|
"4XX": {
|
|
9039
9938
|
headers: {
|
|
@@ -9054,21 +9953,19 @@ interface operations {
|
|
|
9054
9953
|
};
|
|
9055
9954
|
};
|
|
9056
9955
|
};
|
|
9057
|
-
|
|
9956
|
+
Topups_create: {
|
|
9058
9957
|
parameters: {
|
|
9059
9958
|
query?: never;
|
|
9060
9959
|
header?: {
|
|
9061
9960
|
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9062
9961
|
"Idempotency-Key"?: string;
|
|
9063
9962
|
};
|
|
9064
|
-
path
|
|
9065
|
-
id: string;
|
|
9066
|
-
};
|
|
9963
|
+
path?: never;
|
|
9067
9964
|
cookie?: never;
|
|
9068
9965
|
};
|
|
9069
9966
|
requestBody: {
|
|
9070
9967
|
content: {
|
|
9071
|
-
"application/json": components["schemas"]["
|
|
9968
|
+
"application/json": components["schemas"]["CreateTopupDto"];
|
|
9072
9969
|
};
|
|
9073
9970
|
};
|
|
9074
9971
|
responses: {
|
|
@@ -9077,19 +9974,10 @@ interface operations {
|
|
|
9077
9974
|
[name: string]: unknown;
|
|
9078
9975
|
};
|
|
9079
9976
|
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"];
|
|
9977
|
+
"application/json": components["schemas"]["TopupDto"];
|
|
9090
9978
|
};
|
|
9091
9979
|
};
|
|
9092
|
-
/** @description Missing or
|
|
9980
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9093
9981
|
401: {
|
|
9094
9982
|
headers: {
|
|
9095
9983
|
[name: string]: unknown;
|
|
@@ -9098,7 +9986,7 @@ interface operations {
|
|
|
9098
9986
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9099
9987
|
};
|
|
9100
9988
|
};
|
|
9101
|
-
/** @description
|
|
9989
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
9102
9990
|
403: {
|
|
9103
9991
|
headers: {
|
|
9104
9992
|
[name: string]: unknown;
|
|
@@ -9107,16 +9995,8 @@ interface operations {
|
|
|
9107
9995
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9108
9996
|
};
|
|
9109
9997
|
};
|
|
9110
|
-
|
|
9111
|
-
|
|
9112
|
-
[name: string]: unknown;
|
|
9113
|
-
};
|
|
9114
|
-
content: {
|
|
9115
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9116
|
-
};
|
|
9117
|
-
};
|
|
9118
|
-
/** @description slug_taken */
|
|
9119
|
-
409: {
|
|
9998
|
+
/** @description `topup_cap_exceeded` — over the monthly limit (includes `remainingUsd` / `remainingVes`). */
|
|
9999
|
+
422: {
|
|
9120
10000
|
headers: {
|
|
9121
10001
|
[name: string]: unknown;
|
|
9122
10002
|
};
|
|
@@ -9144,7 +10024,7 @@ interface operations {
|
|
|
9144
10024
|
};
|
|
9145
10025
|
};
|
|
9146
10026
|
};
|
|
9147
|
-
|
|
10027
|
+
Topups_get: {
|
|
9148
10028
|
parameters: {
|
|
9149
10029
|
query?: never;
|
|
9150
10030
|
header?: never;
|
|
@@ -9160,10 +10040,10 @@ interface operations {
|
|
|
9160
10040
|
[name: string]: unknown;
|
|
9161
10041
|
};
|
|
9162
10042
|
content: {
|
|
9163
|
-
"application/json": components["schemas"]["
|
|
10043
|
+
"application/json": components["schemas"]["TopupDto"];
|
|
9164
10044
|
};
|
|
9165
10045
|
};
|
|
9166
|
-
/** @description Missing or
|
|
10046
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9167
10047
|
401: {
|
|
9168
10048
|
headers: {
|
|
9169
10049
|
[name: string]: unknown;
|
|
@@ -9172,7 +10052,7 @@ interface operations {
|
|
|
9172
10052
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9173
10053
|
};
|
|
9174
10054
|
};
|
|
9175
|
-
/** @description
|
|
10055
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
9176
10056
|
403: {
|
|
9177
10057
|
headers: {
|
|
9178
10058
|
[name: string]: unknown;
|
|
@@ -9181,14 +10061,6 @@ interface operations {
|
|
|
9181
10061
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9182
10062
|
};
|
|
9183
10063
|
};
|
|
9184
|
-
404: {
|
|
9185
|
-
headers: {
|
|
9186
|
-
[name: string]: unknown;
|
|
9187
|
-
};
|
|
9188
|
-
content: {
|
|
9189
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9190
|
-
};
|
|
9191
|
-
};
|
|
9192
10064
|
/** @description Client error. */
|
|
9193
10065
|
"4XX": {
|
|
9194
10066
|
headers: {
|
|
@@ -9209,10 +10081,13 @@ interface operations {
|
|
|
9209
10081
|
};
|
|
9210
10082
|
};
|
|
9211
10083
|
};
|
|
9212
|
-
|
|
10084
|
+
Topups_instant: {
|
|
9213
10085
|
parameters: {
|
|
9214
10086
|
query?: never;
|
|
9215
|
-
header?:
|
|
10087
|
+
header?: {
|
|
10088
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
10089
|
+
"Idempotency-Key"?: string;
|
|
10090
|
+
};
|
|
9216
10091
|
path: {
|
|
9217
10092
|
id: string;
|
|
9218
10093
|
};
|
|
@@ -9220,17 +10095,16 @@ interface operations {
|
|
|
9220
10095
|
};
|
|
9221
10096
|
requestBody?: never;
|
|
9222
10097
|
responses: {
|
|
9223
|
-
|
|
9224
|
-
401: {
|
|
10098
|
+
200: {
|
|
9225
10099
|
headers: {
|
|
9226
10100
|
[name: string]: unknown;
|
|
9227
10101
|
};
|
|
9228
10102
|
content: {
|
|
9229
|
-
"application/json": components["schemas"]["
|
|
10103
|
+
"application/json": components["schemas"]["TopupDto"];
|
|
9230
10104
|
};
|
|
9231
10105
|
};
|
|
9232
|
-
/** @description
|
|
9233
|
-
|
|
10106
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
10107
|
+
401: {
|
|
9234
10108
|
headers: {
|
|
9235
10109
|
[name: string]: unknown;
|
|
9236
10110
|
};
|
|
@@ -9238,7 +10112,8 @@ interface operations {
|
|
|
9238
10112
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9239
10113
|
};
|
|
9240
10114
|
};
|
|
9241
|
-
|
|
10115
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
10116
|
+
403: {
|
|
9242
10117
|
headers: {
|
|
9243
10118
|
[name: string]: unknown;
|
|
9244
10119
|
};
|
|
@@ -9246,7 +10121,7 @@ interface operations {
|
|
|
9246
10121
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9247
10122
|
};
|
|
9248
10123
|
};
|
|
9249
|
-
/** @description
|
|
10124
|
+
/** @description `not_held` — nothing of this top-up is still held. */
|
|
9250
10125
|
409: {
|
|
9251
10126
|
headers: {
|
|
9252
10127
|
[name: string]: unknown;
|
|
@@ -9275,30 +10150,29 @@ interface operations {
|
|
|
9275
10150
|
};
|
|
9276
10151
|
};
|
|
9277
10152
|
};
|
|
9278
|
-
|
|
10153
|
+
Topups_simulate: {
|
|
9279
10154
|
parameters: {
|
|
9280
10155
|
query?: never;
|
|
9281
|
-
header?:
|
|
10156
|
+
header?: {
|
|
10157
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
10158
|
+
"Idempotency-Key"?: string;
|
|
10159
|
+
};
|
|
9282
10160
|
path: {
|
|
9283
10161
|
id: string;
|
|
9284
10162
|
};
|
|
9285
10163
|
cookie?: never;
|
|
9286
10164
|
};
|
|
9287
|
-
requestBody
|
|
9288
|
-
content: {
|
|
9289
|
-
"application/json": components["schemas"]["UpdatePaymentLinkDto"];
|
|
9290
|
-
};
|
|
9291
|
-
};
|
|
10165
|
+
requestBody?: never;
|
|
9292
10166
|
responses: {
|
|
9293
10167
|
200: {
|
|
9294
10168
|
headers: {
|
|
9295
10169
|
[name: string]: unknown;
|
|
9296
10170
|
};
|
|
9297
10171
|
content: {
|
|
9298
|
-
"application/json": components["schemas"]["
|
|
10172
|
+
"application/json": components["schemas"]["TopupDto"];
|
|
9299
10173
|
};
|
|
9300
10174
|
};
|
|
9301
|
-
/** @description Missing or
|
|
10175
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9302
10176
|
401: {
|
|
9303
10177
|
headers: {
|
|
9304
10178
|
[name: string]: unknown;
|
|
@@ -9307,7 +10181,7 @@ interface operations {
|
|
|
9307
10181
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9308
10182
|
};
|
|
9309
10183
|
};
|
|
9310
|
-
/** @description
|
|
10184
|
+
/** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
|
|
9311
10185
|
403: {
|
|
9312
10186
|
headers: {
|
|
9313
10187
|
[name: string]: unknown;
|
|
@@ -9316,14 +10190,6 @@ interface operations {
|
|
|
9316
10190
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9317
10191
|
};
|
|
9318
10192
|
};
|
|
9319
|
-
404: {
|
|
9320
|
-
headers: {
|
|
9321
|
-
[name: string]: unknown;
|
|
9322
|
-
};
|
|
9323
|
-
content: {
|
|
9324
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9325
|
-
};
|
|
9326
|
-
};
|
|
9327
10193
|
/** @description Client error. */
|
|
9328
10194
|
"4XX": {
|
|
9329
10195
|
headers: {
|
|
@@ -11309,7 +12175,7 @@ declare class BalanceTransactions extends APIResource {
|
|
|
11309
12175
|
nextCursor: string | null;
|
|
11310
12176
|
}, {
|
|
11311
12177
|
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";
|
|
12178
|
+
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
12179
|
amountVes: string;
|
|
11314
12180
|
paymentId?: string;
|
|
11315
12181
|
payoutId?: string;
|
|
@@ -11321,9 +12187,124 @@ declare class BalanceTransactions extends APIResource {
|
|
|
11321
12187
|
createdAt: string;
|
|
11322
12188
|
}>;
|
|
11323
12189
|
}
|
|
12190
|
+
/**
|
|
12191
|
+
* Load your own Bs balance by Pago Móvil (money that is not a sale). Send the exact `amountVes` from
|
|
12192
|
+
* `payerPhone` to the returned `receiver` before `expiresAt`; the top-up completes when the transfer
|
|
12193
|
+
* arrives. Each top-up needs a `sourceNote` and counts against your monthly limit. Enabled per account
|
|
12194
|
+
* (`topups_not_enabled`, 403).
|
|
12195
|
+
*/
|
|
12196
|
+
declare class BalanceTopups extends APIResource {
|
|
12197
|
+
/** Start a top-up. Over the monthly limit fails with `topup_cap_exceeded` (422). */
|
|
12198
|
+
create(params: RequestBody<'Topups_create'>, options?: RequestOptions): Promise<{
|
|
12199
|
+
id: string;
|
|
12200
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
12201
|
+
amountVes: string;
|
|
12202
|
+
amountUsd: string;
|
|
12203
|
+
bcvRate: string;
|
|
12204
|
+
feePercent: string;
|
|
12205
|
+
feeFixedUsd: string;
|
|
12206
|
+
feeVes?: string;
|
|
12207
|
+
creditedVes?: string;
|
|
12208
|
+
sourceNote: string;
|
|
12209
|
+
payerPhone: string;
|
|
12210
|
+
bankReference?: string;
|
|
12211
|
+
expiresAt: string;
|
|
12212
|
+
completedAt?: string;
|
|
12213
|
+
availableAt?: string;
|
|
12214
|
+
heldVes: string;
|
|
12215
|
+
instantFeePercent: string;
|
|
12216
|
+
instantFeeVes: string;
|
|
12217
|
+
instantReleasedAt?: string;
|
|
12218
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
12219
|
+
test: boolean;
|
|
12220
|
+
createdAt: string;
|
|
12221
|
+
}>;
|
|
12222
|
+
/** Your latest top-ups (newest first, `limit` 1–100) plus this month's limit usage. */
|
|
12223
|
+
list(params?: QueryParams<'Topups_list'>, options?: RequestOptions): Promise<{
|
|
12224
|
+
data: components["schemas"]["TopupDto"][];
|
|
12225
|
+
monthlyCapUsd: string | null;
|
|
12226
|
+
monthUsedUsd: string;
|
|
12227
|
+
monthRemainingUsd: string;
|
|
12228
|
+
}>;
|
|
12229
|
+
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
12230
|
+
id: string;
|
|
12231
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
12232
|
+
amountVes: string;
|
|
12233
|
+
amountUsd: string;
|
|
12234
|
+
bcvRate: string;
|
|
12235
|
+
feePercent: string;
|
|
12236
|
+
feeFixedUsd: string;
|
|
12237
|
+
feeVes?: string;
|
|
12238
|
+
creditedVes?: string;
|
|
12239
|
+
sourceNote: string;
|
|
12240
|
+
payerPhone: string;
|
|
12241
|
+
bankReference?: string;
|
|
12242
|
+
expiresAt: string;
|
|
12243
|
+
completedAt?: string;
|
|
12244
|
+
availableAt?: string;
|
|
12245
|
+
heldVes: string;
|
|
12246
|
+
instantFeePercent: string;
|
|
12247
|
+
instantFeeVes: string;
|
|
12248
|
+
instantReleasedAt?: string;
|
|
12249
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
12250
|
+
test: boolean;
|
|
12251
|
+
createdAt: string;
|
|
12252
|
+
}>;
|
|
12253
|
+
/** Release the still-held part of a completed top-up now, for `instantFeeVes`. Idempotent; `not_held` (409) if nothing is held. */
|
|
12254
|
+
instant(id: string, options?: RequestOptions): Promise<{
|
|
12255
|
+
id: string;
|
|
12256
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
12257
|
+
amountVes: string;
|
|
12258
|
+
amountUsd: string;
|
|
12259
|
+
bcvRate: string;
|
|
12260
|
+
feePercent: string;
|
|
12261
|
+
feeFixedUsd: string;
|
|
12262
|
+
feeVes?: string;
|
|
12263
|
+
creditedVes?: string;
|
|
12264
|
+
sourceNote: string;
|
|
12265
|
+
payerPhone: string;
|
|
12266
|
+
bankReference?: string;
|
|
12267
|
+
expiresAt: string;
|
|
12268
|
+
completedAt?: string;
|
|
12269
|
+
availableAt?: string;
|
|
12270
|
+
heldVes: string;
|
|
12271
|
+
instantFeePercent: string;
|
|
12272
|
+
instantFeeVes: string;
|
|
12273
|
+
instantReleasedAt?: string;
|
|
12274
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
12275
|
+
test: boolean;
|
|
12276
|
+
createdAt: string;
|
|
12277
|
+
}>;
|
|
12278
|
+
/** Test mode only: complete the top-up as if the Pago Móvil arrived. */
|
|
12279
|
+
simulate(id: string, options?: RequestOptions): Promise<{
|
|
12280
|
+
id: string;
|
|
12281
|
+
status: "pending" | "completed" | "expired" | "failed" | "reversed";
|
|
12282
|
+
amountVes: string;
|
|
12283
|
+
amountUsd: string;
|
|
12284
|
+
bcvRate: string;
|
|
12285
|
+
feePercent: string;
|
|
12286
|
+
feeFixedUsd: string;
|
|
12287
|
+
feeVes?: string;
|
|
12288
|
+
creditedVes?: string;
|
|
12289
|
+
sourceNote: string;
|
|
12290
|
+
payerPhone: string;
|
|
12291
|
+
bankReference?: string;
|
|
12292
|
+
expiresAt: string;
|
|
12293
|
+
completedAt?: string;
|
|
12294
|
+
availableAt?: string;
|
|
12295
|
+
heldVes: string;
|
|
12296
|
+
instantFeePercent: string;
|
|
12297
|
+
instantFeeVes: string;
|
|
12298
|
+
instantReleasedAt?: string;
|
|
12299
|
+
receiver?: components["schemas"]["TopupReceiverDto"];
|
|
12300
|
+
test: boolean;
|
|
12301
|
+
createdAt: string;
|
|
12302
|
+
}>;
|
|
12303
|
+
}
|
|
11324
12304
|
/** Your platform balance. */
|
|
11325
12305
|
declare class Balance extends APIResource {
|
|
11326
12306
|
readonly transactions: BalanceTransactions;
|
|
12307
|
+
readonly topups: BalanceTopups;
|
|
11327
12308
|
retrieve(options?: RequestOptions): Promise<{
|
|
11328
12309
|
tenantId: string;
|
|
11329
12310
|
platformId: string;
|
|
@@ -11363,6 +12344,7 @@ declare class Payouts extends APIResource {
|
|
|
11363
12344
|
grossMonto?: string;
|
|
11364
12345
|
feePercent?: string;
|
|
11365
12346
|
feeVes?: string;
|
|
12347
|
+
feePayer?: "tenant";
|
|
11366
12348
|
concepto?: string;
|
|
11367
12349
|
bankCode?: string;
|
|
11368
12350
|
destination?: string;
|
|
@@ -11386,6 +12368,7 @@ declare class Payouts extends APIResource {
|
|
|
11386
12368
|
grossMonto?: string;
|
|
11387
12369
|
feePercent?: string;
|
|
11388
12370
|
feeVes?: string;
|
|
12371
|
+
feePayer?: "tenant";
|
|
11389
12372
|
concepto?: string;
|
|
11390
12373
|
bankCode?: string;
|
|
11391
12374
|
destination?: string;
|
|
@@ -11418,6 +12401,7 @@ declare class Payouts extends APIResource {
|
|
|
11418
12401
|
grossMonto?: string;
|
|
11419
12402
|
feePercent?: string;
|
|
11420
12403
|
feeVes?: string;
|
|
12404
|
+
feePayer?: "tenant";
|
|
11421
12405
|
concepto?: string;
|
|
11422
12406
|
bankCode?: string;
|
|
11423
12407
|
destination?: string;
|
|
@@ -11440,6 +12424,7 @@ declare class Payouts extends APIResource {
|
|
|
11440
12424
|
grossMonto?: string;
|
|
11441
12425
|
feePercent?: string;
|
|
11442
12426
|
feeVes?: string;
|
|
12427
|
+
feePayer?: "tenant";
|
|
11443
12428
|
concepto?: string;
|
|
11444
12429
|
bankCode?: string;
|
|
11445
12430
|
destination?: string;
|
|
@@ -11462,6 +12447,7 @@ declare class Payouts extends APIResource {
|
|
|
11462
12447
|
grossMonto?: string;
|
|
11463
12448
|
feePercent?: string;
|
|
11464
12449
|
feeVes?: string;
|
|
12450
|
+
feePayer?: "tenant";
|
|
11465
12451
|
concepto?: string;
|
|
11466
12452
|
bankCode?: string;
|
|
11467
12453
|
destination?: string;
|
|
@@ -12344,21 +13330,24 @@ declare class Conversions extends APIResource {
|
|
|
12344
13330
|
}
|
|
12345
13331
|
|
|
12346
13332
|
/**
|
|
12347
|
-
* Colombian peso payments:
|
|
12348
|
-
*
|
|
12349
|
-
*
|
|
13333
|
+
* Colombian peso payments: PSE and Bancolombia (bank redirect), Bancolombia QR, Bre-B (QR /
|
|
13334
|
+
* transfer key), Nequi (push approval) or Daviplata (SMS code or redirect). Cards are taken only on
|
|
13335
|
+
* the hosted checkout. Payments complete asynchronously — listen for `payment.completed` /
|
|
13336
|
+
* `payment.failed`. COP must be enabled on your account (403 `method_not_allowed` otherwise).
|
|
12350
13337
|
*/
|
|
12351
13338
|
declare class CopPayments extends APIResource {
|
|
12352
13339
|
/**
|
|
12353
|
-
* Create a payment in whole pesos. `buyer` is required for
|
|
12354
|
-
* `
|
|
13340
|
+
* Create a payment in whole pesos. `buyer` is required for every channel except `breb`, with
|
|
13341
|
+
* `termsAccepted: true` when {@link Cop.channels} says `needsTermsAcceptance`; `pse` also needs
|
|
13342
|
+
* `pse.bankCode`. The response `next` says what the buyer does: `show_qr`, `approve_in_app`,
|
|
13343
|
+
* `submit_otp`, `redirect` (send them to `next.url`) or `redirect_pending` (retrieve again shortly).
|
|
12355
13344
|
* Pass `idempotencyKey` in options to retry safely.
|
|
12356
13345
|
*/
|
|
12357
13346
|
create(params: RequestBody<'CopPayments_create'>, options?: RequestOptions): Promise<{
|
|
12358
13347
|
id: string;
|
|
12359
13348
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12360
13349
|
method: "COP";
|
|
12361
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13350
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12362
13351
|
amountCop: number;
|
|
12363
13352
|
feeCop?: number;
|
|
12364
13353
|
amountUsd?: string;
|
|
@@ -12367,17 +13356,18 @@ declare class CopPayments extends APIResource {
|
|
|
12367
13356
|
metadata: {
|
|
12368
13357
|
[key: string]: string;
|
|
12369
13358
|
};
|
|
12370
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13359
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12371
13360
|
expiresAt?: string;
|
|
12372
13361
|
createdAt: string;
|
|
12373
13362
|
completedAt?: string;
|
|
12374
13363
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13364
|
+
card?: Record<string, never>;
|
|
12375
13365
|
}>;
|
|
12376
13366
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
12377
13367
|
id: string;
|
|
12378
13368
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12379
13369
|
method: "COP";
|
|
12380
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13370
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12381
13371
|
amountCop: number;
|
|
12382
13372
|
feeCop?: number;
|
|
12383
13373
|
amountUsd?: string;
|
|
@@ -12386,18 +13376,19 @@ declare class CopPayments extends APIResource {
|
|
|
12386
13376
|
metadata: {
|
|
12387
13377
|
[key: string]: string;
|
|
12388
13378
|
};
|
|
12389
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13379
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12390
13380
|
expiresAt?: string;
|
|
12391
13381
|
createdAt: string;
|
|
12392
13382
|
completedAt?: string;
|
|
12393
13383
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13384
|
+
card?: Record<string, never>;
|
|
12394
13385
|
}>;
|
|
12395
|
-
/** Daviplata: submit the code the buyer received by SMS. A wrong code fails with `invalid_otp`. */
|
|
13386
|
+
/** Daviplata with `next.type: "submit_otp"`: submit the code the buyer received by SMS. A wrong code fails with `invalid_otp`. */
|
|
12396
13387
|
submitOtp(id: string, params: RequestBody<'CopPayments_submitOtp'>, options?: RequestOptions): Promise<{
|
|
12397
13388
|
id: string;
|
|
12398
13389
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12399
13390
|
method: "COP";
|
|
12400
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13391
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12401
13392
|
amountCop: number;
|
|
12402
13393
|
feeCop?: number;
|
|
12403
13394
|
amountUsd?: string;
|
|
@@ -12406,18 +13397,19 @@ declare class CopPayments extends APIResource {
|
|
|
12406
13397
|
metadata: {
|
|
12407
13398
|
[key: string]: string;
|
|
12408
13399
|
};
|
|
12409
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13400
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12410
13401
|
expiresAt?: string;
|
|
12411
13402
|
createdAt: string;
|
|
12412
13403
|
completedAt?: string;
|
|
12413
13404
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13405
|
+
card?: Record<string, never>;
|
|
12414
13406
|
}>;
|
|
12415
13407
|
/** Cancel a pending payment. */
|
|
12416
13408
|
cancel(id: string, options?: RequestOptions): Promise<{
|
|
12417
13409
|
id: string;
|
|
12418
13410
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12419
13411
|
method: "COP";
|
|
12420
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13412
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12421
13413
|
amountCop: number;
|
|
12422
13414
|
feeCop?: number;
|
|
12423
13415
|
amountUsd?: string;
|
|
@@ -12426,18 +13418,22 @@ declare class CopPayments extends APIResource {
|
|
|
12426
13418
|
metadata: {
|
|
12427
13419
|
[key: string]: string;
|
|
12428
13420
|
};
|
|
12429
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13421
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12430
13422
|
expiresAt?: string;
|
|
12431
13423
|
createdAt: string;
|
|
12432
13424
|
completedAt?: string;
|
|
12433
13425
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13426
|
+
card?: Record<string, never>;
|
|
12434
13427
|
}>;
|
|
12435
|
-
/**
|
|
13428
|
+
/**
|
|
13429
|
+
* Full refund of a completed payment, within the channel's window (card 24 h, Bre-B 96 h).
|
|
13430
|
+
* Channels that cannot be refunded through the API fail with `refund_not_supported`.
|
|
13431
|
+
*/
|
|
12436
13432
|
refund(id: string, options?: RequestOptions): Promise<{
|
|
12437
13433
|
id: string;
|
|
12438
13434
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
12439
13435
|
method: "COP";
|
|
12440
|
-
channel: "breb" | "nequi" | "daviplata";
|
|
13436
|
+
channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
|
|
12441
13437
|
amountCop: number;
|
|
12442
13438
|
feeCop?: number;
|
|
12443
13439
|
amountUsd?: string;
|
|
@@ -12446,11 +13442,12 @@ declare class CopPayments extends APIResource {
|
|
|
12446
13442
|
metadata: {
|
|
12447
13443
|
[key: string]: string;
|
|
12448
13444
|
};
|
|
12449
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
13445
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
12450
13446
|
expiresAt?: string;
|
|
12451
13447
|
createdAt: string;
|
|
12452
13448
|
completedAt?: string;
|
|
12453
13449
|
next?: components["schemas"]["CopNextActionDto"];
|
|
13450
|
+
card?: Record<string, never>;
|
|
12454
13451
|
}>;
|
|
12455
13452
|
}
|
|
12456
13453
|
/** Your COP balance, in whole pesos. Kept apart from VES and stablecoins. */
|
|
@@ -12463,10 +13460,16 @@ declare class CopBalance extends APIResource {
|
|
|
12463
13460
|
asOf: string;
|
|
12464
13461
|
}>;
|
|
12465
13462
|
}
|
|
12466
|
-
/** Collect Colombian pesos (Bre-B, Nequi, Daviplata). */
|
|
13463
|
+
/** Collect Colombian pesos (PSE, Bancolombia, Bre-B, Nequi, Daviplata; cards via the hosted checkout). */
|
|
12467
13464
|
declare class Cop extends APIResource {
|
|
12468
13465
|
readonly payments: CopPayments;
|
|
12469
13466
|
readonly balance: CopBalance;
|
|
13467
|
+
/** Channels you can use right now, with what each needs, plus the PSE banks and terms links. */
|
|
13468
|
+
channels(options?: RequestOptions): Promise<{
|
|
13469
|
+
channels: components["schemas"]["CopChannelDto"][];
|
|
13470
|
+
pseBanks?: components["schemas"]["CopPseBankDto"][];
|
|
13471
|
+
terms?: components["schemas"]["CopTermsDto"];
|
|
13472
|
+
}>;
|
|
12470
13473
|
}
|
|
12471
13474
|
|
|
12472
13475
|
/** One stablecoin balance (`currency`: USDT by default, or USDC). Never converted to VES. */
|
|
@@ -12573,6 +13576,8 @@ declare class Crypto extends APIResource {
|
|
|
12573
13576
|
}
|
|
12574
13577
|
|
|
12575
13578
|
type MerchantListParams = Omit<QueryParams<'Merchants_listOrGetByRef'>, 'externalRef'>;
|
|
13579
|
+
type MerchantTransactionListParams = QueryParams<'Merchants_listTransactions'>;
|
|
13580
|
+
type MerchantStatementParams = Omit<QueryParams<'Merchants_statement'>, 'format'>;
|
|
12576
13581
|
/** Where a merchant gets paid (bank account or Pago Móvil). */
|
|
12577
13582
|
declare class PayoutMethods extends APIResource {
|
|
12578
13583
|
list(merchantId: string, options?: RequestOptions): Promise<{
|
|
@@ -12753,7 +13758,11 @@ declare class Merchants extends APIResource {
|
|
|
12753
13758
|
ledgerNetVes: string;
|
|
12754
13759
|
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
12755
13760
|
}>;
|
|
12756
|
-
/**
|
|
13761
|
+
/**
|
|
13762
|
+
* Credit this seller's pending balance from your platform balance. Send `amountVes`, or
|
|
13763
|
+
* `amountUsd` to convert at the official BCV rate; `transferKey` makes it idempotent.
|
|
13764
|
+
* The response is the seller balance plus `transfer` (amounts and rate used).
|
|
13765
|
+
*/
|
|
12757
13766
|
transfer(id: string, params: RequestBody<'Merchants_transfer'>, options?: RequestOptions): Promise<{
|
|
12758
13767
|
merchantId: string;
|
|
12759
13768
|
accountId: string;
|
|
@@ -12763,7 +13772,39 @@ declare class Merchants extends APIResource {
|
|
|
12763
13772
|
paidOutVes: string;
|
|
12764
13773
|
ledgerNetVes: string;
|
|
12765
13774
|
cop?: components["schemas"]["MerchantCopBalanceDto"];
|
|
13775
|
+
transfer: components["schemas"]["MerchantTransferSnapshotDto"];
|
|
13776
|
+
}>;
|
|
13777
|
+
/** Seller balance movements, newest first. Await for one page, or `for await` over every movement. */
|
|
13778
|
+
listTransactions(id: string, params?: MerchantTransactionListParams, options?: RequestOptions): PagePromise<{
|
|
13779
|
+
items: components["schemas"]["MerchantMovementDto"][];
|
|
13780
|
+
nextCursor: string | null;
|
|
13781
|
+
}, {
|
|
13782
|
+
id: string;
|
|
13783
|
+
type: "credit" | "release" | "reversal" | "payout" | "payout_reversal" | "payout_fee" | "payout_fee_reversal" | "adjustment";
|
|
13784
|
+
amountVes: string;
|
|
13785
|
+
releasedVes?: string;
|
|
13786
|
+
description: string;
|
|
13787
|
+
transferKey?: string;
|
|
13788
|
+
paymentId?: string | null;
|
|
13789
|
+
payoutId?: string | null;
|
|
13790
|
+
availableAt?: string | null;
|
|
13791
|
+
amountUsd?: string;
|
|
13792
|
+
rate?: string;
|
|
13793
|
+
rateSource?: string;
|
|
13794
|
+
createdAt: string;
|
|
13795
|
+
}>;
|
|
13796
|
+
/** Monthly statement (`month: 'YYYY-MM'`, America/Caracas): opening, movements, closing. */
|
|
13797
|
+
retrieveStatement(id: string, params: MerchantStatementParams, options?: RequestOptions): Promise<{
|
|
13798
|
+
merchantId: string;
|
|
13799
|
+
month: string;
|
|
13800
|
+
from: string;
|
|
13801
|
+
to: string;
|
|
13802
|
+
openingVes: string;
|
|
13803
|
+
closingVes: string;
|
|
13804
|
+
movements: components["schemas"]["MerchantMovementDto"][];
|
|
12766
13805
|
}>;
|
|
13806
|
+
/** The same monthly statement as CSV (with a running balance column), returned as a string. */
|
|
13807
|
+
retrieveStatementCsv(id: string, params: MerchantStatementParams, options?: RequestOptions): Promise<string>;
|
|
12767
13808
|
listAuditEvents(id: string, options?: RequestOptions): Promise<{
|
|
12768
13809
|
items: components["schemas"]["MerchantAuditEventDto"][];
|
|
12769
13810
|
}>;
|
|
@@ -13199,15 +14240,22 @@ interface CopPaymentWebhookData {
|
|
|
13199
14240
|
method: 'COP';
|
|
13200
14241
|
currency: 'COP';
|
|
13201
14242
|
status: 'pending' | 'completed' | 'failed' | 'canceled' | 'refunded';
|
|
13202
|
-
channel: 'breb' | 'nequi' | 'daviplata';
|
|
14243
|
+
channel: 'breb' | 'nequi' | 'daviplata' | 'card' | 'pse' | 'bancolombia_transfer' | 'bancolombia_qr';
|
|
13203
14244
|
amountCop: number;
|
|
14245
|
+
/** Card payments: brand and last 4 digits. */
|
|
14246
|
+
card?: {
|
|
14247
|
+
brand: string;
|
|
14248
|
+
last4: string;
|
|
14249
|
+
};
|
|
13204
14250
|
feeCop?: number;
|
|
13205
14251
|
amountUsd?: string;
|
|
13206
14252
|
copRate?: string;
|
|
13207
14253
|
reference?: string;
|
|
13208
14254
|
externalRef?: string;
|
|
13209
14255
|
metadata: Record<string, string>;
|
|
13210
|
-
failureCode?: 'expired' | 'rejected' | 'processor_error' | 'processor_unknown';
|
|
14256
|
+
failureCode?: 'expired' | 'rejected' | 'processor_error' | 'processor_unknown' | 'chargeback';
|
|
14257
|
+
/** `payment.reversed` from a card dispute: `"chargeback"` (the amount was debited from your COP balance). */
|
|
14258
|
+
reason?: 'chargeback';
|
|
13211
14259
|
expiresAt?: string;
|
|
13212
14260
|
createdAt: string;
|
|
13213
14261
|
completedAt?: string;
|
|
@@ -13347,6 +14395,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
13347
14395
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
13348
14396
|
}
|
|
13349
14397
|
|
|
13350
|
-
declare const VERSION = "0.
|
|
14398
|
+
declare const VERSION = "0.13.0";
|
|
13351
14399
|
|
|
13352
14400
|
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 };
|