@vexpay/node 0.11.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/dist/index.d.ts 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
@@ -176,7 +176,7 @@ interface components {
176
176
  * "payment.failed"
177
177
  * ]
178
178
  */
179
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
179
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "customer.created" | "customer.updated" | "customer.deleted" | "customer.subscription.created" | "customer.subscription.updated" | "customer.subscription.deleted" | "customer.subscription.trial_will_end" | "customer.subscription.reactivated" | "invoice.created" | "invoice.upcoming" | "invoice.paid" | "invoice.payment_attempt" | "invoice.payment_failed" | "invoice.overdue" | "invoice.voided" | "invoice.marked_uncollectible" | "payment_method.attached" | "payment_method.updated" | "payment_method.detached" | "notification.test")[];
180
180
  };
181
181
  WebhookEndpointDto: {
182
182
  /** Format: uuid */
@@ -185,7 +185,7 @@ interface components {
185
185
  tenantId: string;
186
186
  /** Format: uri */
187
187
  url: string;
188
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
188
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "customer.created" | "customer.updated" | "customer.deleted" | "customer.subscription.created" | "customer.subscription.updated" | "customer.subscription.deleted" | "customer.subscription.trial_will_end" | "customer.subscription.reactivated" | "invoice.created" | "invoice.upcoming" | "invoice.paid" | "invoice.payment_attempt" | "invoice.payment_failed" | "invoice.overdue" | "invoice.voided" | "invoice.marked_uncollectible" | "payment_method.attached" | "payment_method.updated" | "payment_method.detached" | "notification.test")[];
189
189
  isActive: boolean;
190
190
  /** Format: date-time */
191
191
  createdAt: string;
@@ -206,7 +206,7 @@ interface components {
206
206
  * "payout.completed"
207
207
  * ]
208
208
  */
209
- events?: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
209
+ events?: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "customer.created" | "customer.updated" | "customer.deleted" | "customer.subscription.created" | "customer.subscription.updated" | "customer.subscription.deleted" | "customer.subscription.trial_will_end" | "customer.subscription.reactivated" | "invoice.created" | "invoice.upcoming" | "invoice.paid" | "invoice.payment_attempt" | "invoice.payment_failed" | "invoice.overdue" | "invoice.voided" | "invoice.marked_uncollectible" | "payment_method.attached" | "payment_method.updated" | "payment_method.detached" | "notification.test")[];
210
210
  /** @example true */
211
211
  isActive?: boolean;
212
212
  };
@@ -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 Nequi and Daviplata.
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 Nequi and Daviplata.
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 `nequi` and `daviplata`; optional for `breb`. */
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
- /** @enum {string} */
1252
- type: "show_qr" | "approve_in_app" | "submit_otp";
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
- /** @enum {string} */
1295
- failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
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: string;
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;
@@ -2535,72 +2869,392 @@ interface components {
2535
2869
  /** Format: uuid */
2536
2870
  tenantId: string;
2537
2871
  };
2538
- };
2539
- responses: never;
2540
- parameters: never;
2541
- requestBodies: never;
2542
- headers: never;
2543
- pathItems: never;
2544
- }
2545
- interface operations {
2546
- Balance_getBalance: {
2547
- parameters: {
2548
- query?: never;
2549
- header?: never;
2550
- path?: never;
2551
- cookie?: never;
2872
+ CreateCustomerDto: {
2873
+ /** @example Ana Pérez */
2874
+ name?: string | null;
2875
+ /** @example ana@example.com */
2876
+ email?: string | null;
2877
+ /**
2878
+ * @description Venezuelan mobile; stored as 11 digits starting with 04.
2879
+ * @example 04141234567
2880
+ */
2881
+ phone?: string | null;
2882
+ /**
2883
+ * @description Cédula or RIF; stored canonical, e.g. V12345678.
2884
+ * @example V-12.345.678
2885
+ */
2886
+ idNumber?: string | null;
2887
+ /**
2888
+ * @description 4-digit bank code from GET /v1/banks.
2889
+ * @example 0102
2890
+ */
2891
+ bankCode?: string | null;
2892
+ /** @description ≤ 20 string key/value pairs. */
2893
+ metadata?: {
2894
+ [key: string]: string;
2895
+ } | null;
2896
+ /** @description Test clock id (test mode only). Not available yet. */
2897
+ testClock?: string;
2552
2898
  };
2553
- requestBody?: never;
2554
- responses: {
2555
- 200: {
2556
- headers: {
2557
- [name: string]: unknown;
2558
- };
2559
- content: {
2560
- "application/json": components["schemas"]["PlatformBalanceDto"];
2561
- };
2562
- };
2563
- /** @description Missing, invalid, or inactive tenant API key. */
2564
- 401: {
2565
- headers: {
2566
- [name: string]: unknown;
2567
- };
2568
- content: {
2569
- "application/json": components["schemas"]["ApiErrorDto"];
2570
- };
2571
- };
2572
- /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
2573
- 403: {
2574
- headers: {
2575
- [name: string]: unknown;
2576
- };
2577
- content: {
2578
- "application/json": components["schemas"]["ApiErrorDto"];
2579
- };
2580
- };
2581
- /** @description Client error. */
2582
- "4XX": {
2583
- headers: {
2584
- [name: string]: unknown;
2585
- };
2586
- content: {
2587
- "application/json": components["schemas"]["ApiErrorDto"];
2588
- };
2589
- };
2590
- /** @description Server or upstream bank error. */
2591
- "5XX": {
2592
- headers: {
2593
- [name: string]: unknown;
2594
- };
2595
- content: {
2596
- "application/json": components["schemas"]["ApiErrorDto"];
2597
- };
2899
+ CustomerResponseDto: {
2900
+ /** @example cus_3fd84b2d9ad14f74a2d90f2f56984db5 */
2901
+ id: string;
2902
+ /** @example customer */
2903
+ object: string;
2904
+ name: string | null;
2905
+ email: string | null;
2906
+ /** @enum {string} */
2907
+ emailStatus: "none" | "deliverable" | "undeliverable";
2908
+ phone: string | null;
2909
+ idNumber: string | null;
2910
+ bankCode: string | null;
2911
+ metadata: {
2912
+ [key: string]: string;
2598
2913
  };
2914
+ testClock: string | null;
2915
+ createdAt: string;
2916
+ livemode: boolean;
2599
2917
  };
2600
- };
2601
- Balance_listTransactions: {
2602
- parameters: {
2603
- query?: {
2918
+ CustomerListResponseDto: {
2919
+ items: components["schemas"]["CustomerResponseDto"][];
2920
+ nextCursor: string | null;
2921
+ };
2922
+ UpdateCustomerDto: {
2923
+ /** @example Ana Pérez */
2924
+ name?: string | null;
2925
+ /** @example ana@example.com */
2926
+ email?: string | null;
2927
+ /**
2928
+ * @description Venezuelan mobile; stored as 11 digits starting with 04.
2929
+ * @example 04141234567
2930
+ */
2931
+ phone?: string | null;
2932
+ /**
2933
+ * @description Cédula or RIF; stored canonical, e.g. V12345678.
2934
+ * @example V-12.345.678
2935
+ */
2936
+ idNumber?: string | null;
2937
+ /**
2938
+ * @description 4-digit bank code from GET /v1/banks.
2939
+ * @example 0102
2940
+ */
2941
+ bankCode?: string | null;
2942
+ /** @description ≤ 20 string key/value pairs. */
2943
+ metadata?: {
2944
+ [key: string]: string;
2945
+ } | null;
2946
+ /** @description Test clock id (test mode only). Not available yet. */
2947
+ testClock?: string;
2948
+ };
2949
+ DeletedObjectResponseDto: {
2950
+ id: string;
2951
+ /** @example true */
2952
+ deleted: boolean;
2953
+ };
2954
+ RecurringDto: {
2955
+ /**
2956
+ * @example month
2957
+ * @enum {string}
2958
+ */
2959
+ interval: "day" | "week" | "month" | "year";
2960
+ /**
2961
+ * @description The whole interval is at most one year.
2962
+ * @default 1
2963
+ * @example 1
2964
+ */
2965
+ intervalCount?: number;
2966
+ };
2967
+ CreatePriceDto: {
2968
+ /** @description Product id. */
2969
+ product: string;
2970
+ /**
2971
+ * @description USD amount, up to 2 decimals, at least the minimum charge.
2972
+ * @example 10
2973
+ */
2974
+ unitAmountUsd: number;
2975
+ recurring: components["schemas"]["RecurringDto"];
2976
+ nickname?: string;
2977
+ metadata?: {
2978
+ [key: string]: string;
2979
+ };
2980
+ };
2981
+ PriceRecurringResponseDto: {
2982
+ /** @enum {string} */
2983
+ interval: "day" | "week" | "month" | "year";
2984
+ intervalCount: number;
2985
+ };
2986
+ PriceResponseDto: {
2987
+ /** @example price_3fd84b2d9ad14f74a2d90f2f56984db5 */
2988
+ id: string;
2989
+ /** @example price */
2990
+ object: string;
2991
+ product: string;
2992
+ /** @example 10.00 */
2993
+ unitAmountUsd: string;
2994
+ /** @example USD */
2995
+ currency: string;
2996
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
2997
+ nickname: string | null;
2998
+ active: boolean;
2999
+ metadata: {
3000
+ [key: string]: string;
3001
+ };
3002
+ createdAt: string;
3003
+ livemode: boolean;
3004
+ };
3005
+ PriceListResponseDto: {
3006
+ items: components["schemas"]["PriceResponseDto"][];
3007
+ nextCursor: string | null;
3008
+ };
3009
+ UpdatePriceDto: {
3010
+ active?: boolean;
3011
+ nickname?: string | null;
3012
+ metadata?: {
3013
+ [key: string]: string;
3014
+ };
3015
+ };
3016
+ CreateSubscriptionDto: {
3017
+ /** @description Customer id (cus_…). */
3018
+ customer: string;
3019
+ /** @description Active recurring price id (price_…). */
3020
+ price: string;
3021
+ /**
3022
+ * @description `charge_automatically` charges the customer's domiciliación on each collection attempt; the tenant must be allowed domiciliación.
3023
+ * @default send_invoice
3024
+ * @enum {string}
3025
+ */
3026
+ collectionMethod?: "send_invoice" | "charge_automatically";
3027
+ /** @description Daily collection attempts on each invoice before the subscription is canceled. Omit or null for the tenant's default (3 unless changed). */
3028
+ collectionAttempts?: number | null;
3029
+ /** @description Domiciliación payment method (pm_…, charge_automatically only). Default: the customer's most recent method that is not inactive. */
3030
+ paymentMethod?: string;
3031
+ trialPeriodDays?: number;
3032
+ /** @description ISO time in the future when the trial ends. */
3033
+ trialEnd?: string;
3034
+ /** @default false */
3035
+ cancelAtPeriodEnd?: boolean;
3036
+ /** @description Hosted checkout methods offered on its invoices. */
3037
+ methods?: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
3038
+ metadata?: {
3039
+ [key: string]: string;
3040
+ };
3041
+ };
3042
+ SubscriptionResponseDto: {
3043
+ /** @example sub_3fd84b2d9ad14f74a2d90f2f56984db5 */
3044
+ id: string;
3045
+ /** @example subscription */
3046
+ object: string;
3047
+ customer: string;
3048
+ price: components["schemas"]["PriceResponseDto"];
3049
+ /** @enum {string} */
3050
+ status: "trialing" | "active" | "past_due" | "canceled";
3051
+ /** @enum {string} */
3052
+ collectionMethod: "send_invoice" | "charge_automatically";
3053
+ /** @description Null = the tenant's default. */
3054
+ collectionAttempts: number | null;
3055
+ paymentMethod: string | null;
3056
+ currentPeriodStart: string;
3057
+ currentPeriodEnd: string;
3058
+ trialStart: string | null;
3059
+ trialEnd: string | null;
3060
+ cancelAtPeriodEnd: boolean;
3061
+ canceledAt: string | null;
3062
+ /** @enum {string|null} */
3063
+ cancellationReason: "requested" | "payment_failed" | null;
3064
+ latestInvoice: string | null;
3065
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
3066
+ metadata: {
3067
+ [key: string]: string;
3068
+ };
3069
+ createdAt: string;
3070
+ livemode: boolean;
3071
+ };
3072
+ SubscriptionListResponseDto: {
3073
+ items: components["schemas"]["SubscriptionResponseDto"][];
3074
+ nextCursor: string | null;
3075
+ };
3076
+ UpdateSubscriptionDto: {
3077
+ cancelAtPeriodEnd?: boolean;
3078
+ /** @enum {string} */
3079
+ collectionMethod?: "send_invoice" | "charge_automatically";
3080
+ paymentMethod?: string;
3081
+ /** @description null = the tenant's default. */
3082
+ collectionAttempts?: number | null;
3083
+ methods?: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
3084
+ metadata?: {
3085
+ [key: string]: string;
3086
+ };
3087
+ };
3088
+ InvoiceBillingFeeResponseDto: {
3089
+ /** @example 43.90 */
3090
+ amount: string;
3091
+ /** @enum {string} */
3092
+ currency: "VES" | "USDT" | "USDC" | "COP";
3093
+ /** @example 0.5 */
3094
+ percent: string;
3095
+ };
3096
+ InvoiceResponseDto: {
3097
+ /** @example in_3fd84b2d9ad14f74a2d90f2f56984db5 */
3098
+ id: string;
3099
+ /** @example invoice */
3100
+ object: string;
3101
+ /** @example K7Q2M9XA-0001 */
3102
+ number: string;
3103
+ /** @enum {string} */
3104
+ status: "open" | "paid" | "void" | "uncollectible";
3105
+ customer: string;
3106
+ subscription: string;
3107
+ /** @enum {string} */
3108
+ collectionMethod: "send_invoice" | "charge_automatically";
3109
+ /** @example 10.00 */
3110
+ amountDueUsd: string;
3111
+ /** @example 0.00 */
3112
+ amountPaidUsd: string;
3113
+ /** @example USD */
3114
+ currency: string;
3115
+ periodStart: string;
3116
+ periodEnd: string;
3117
+ /** @description Invoices are due when issued. */
3118
+ dueDate: string;
3119
+ /** @description Daily collection attempts for this invoice. */
3120
+ attemptsTotal: number;
3121
+ attemptCount: number;
3122
+ nextPaymentAttempt: string | null;
3123
+ paidAt: string | null;
3124
+ paidOutOfBand: boolean;
3125
+ paymentId: string | null;
3126
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
3127
+ hostedInvoiceUrl: string | null;
3128
+ createdAt: string;
3129
+ livemode: boolean;
3130
+ };
3131
+ InvoiceListResponseDto: {
3132
+ items: components["schemas"]["InvoiceResponseDto"][];
3133
+ nextCursor: string | null;
3134
+ };
3135
+ PayInvoiceDto: {
3136
+ /**
3137
+ * @description Mark the invoice paid outside VEXPay (cash, transfer). No balance change.
3138
+ * @example true
3139
+ */
3140
+ paidOutOfBand: boolean;
3141
+ };
3142
+ CreateSetupSessionDto: {
3143
+ /** @description Customer id (cus_…). */
3144
+ customer: string;
3145
+ /** @description Where the setup page sends the customer when done (https). */
3146
+ successUrl?: string;
3147
+ };
3148
+ SetupSessionResponseDto: {
3149
+ /** @example seti_3fd84b2d9ad14f74a2d90f2f56984db5 */
3150
+ id: string;
3151
+ /** @example setup_session */
3152
+ object: string;
3153
+ /** @description Hosted authorization page. Only returned on create. */
3154
+ url: string | null;
3155
+ customer: string;
3156
+ /** @enum {string} */
3157
+ status: "open" | "complete" | "expired";
3158
+ paymentMethod: string | null;
3159
+ successUrl: string | null;
3160
+ expiresAt: string;
3161
+ createdAt: string;
3162
+ livemode: boolean;
3163
+ };
3164
+ PaymentMethodResponseDto: {
3165
+ /** @example pm_3fd84b2d9ad14f74a2d90f2f56984db5 */
3166
+ id: string;
3167
+ /** @example payment_method */
3168
+ object: string;
3169
+ /** @example domiciliacion */
3170
+ type: string;
3171
+ customer: string;
3172
+ /**
3173
+ * @description pending until a charge succeeds; inactive when the bank reports the affiliation inactive.
3174
+ * @enum {string}
3175
+ */
3176
+ status: "pending" | "active" | "inactive";
3177
+ /** @example 4567 */
3178
+ phoneLast4: string;
3179
+ /** @example 0102 */
3180
+ bankCode: string;
3181
+ createdAt: string;
3182
+ activatedAt: string | null;
3183
+ deactivatedAt: string | null;
3184
+ /** @description Set once detached; a detached method is never charged. */
3185
+ detachedAt: string | null;
3186
+ livemode: boolean;
3187
+ };
3188
+ PaymentMethodListResponseDto: {
3189
+ items: components["schemas"]["PaymentMethodResponseDto"][];
3190
+ nextCursor: string | null;
3191
+ };
3192
+ };
3193
+ responses: never;
3194
+ parameters: never;
3195
+ requestBodies: never;
3196
+ headers: never;
3197
+ pathItems: never;
3198
+ }
3199
+ interface operations {
3200
+ Balance_getBalance: {
3201
+ parameters: {
3202
+ query?: never;
3203
+ header?: never;
3204
+ path?: never;
3205
+ cookie?: never;
3206
+ };
3207
+ requestBody?: never;
3208
+ responses: {
3209
+ 200: {
3210
+ headers: {
3211
+ [name: string]: unknown;
3212
+ };
3213
+ content: {
3214
+ "application/json": components["schemas"]["PlatformBalanceDto"];
3215
+ };
3216
+ };
3217
+ /** @description Missing, invalid, or inactive tenant API key. */
3218
+ 401: {
3219
+ headers: {
3220
+ [name: string]: unknown;
3221
+ };
3222
+ content: {
3223
+ "application/json": components["schemas"]["ApiErrorDto"];
3224
+ };
3225
+ };
3226
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
3227
+ 403: {
3228
+ headers: {
3229
+ [name: string]: unknown;
3230
+ };
3231
+ content: {
3232
+ "application/json": components["schemas"]["ApiErrorDto"];
3233
+ };
3234
+ };
3235
+ /** @description Client error. */
3236
+ "4XX": {
3237
+ headers: {
3238
+ [name: string]: unknown;
3239
+ };
3240
+ content: {
3241
+ "application/json": components["schemas"]["ApiErrorDto"];
3242
+ };
3243
+ };
3244
+ /** @description Server or upstream bank error. */
3245
+ "5XX": {
3246
+ headers: {
3247
+ [name: string]: unknown;
3248
+ };
3249
+ content: {
3250
+ "application/json": components["schemas"]["ApiErrorDto"];
3251
+ };
3252
+ };
3253
+ };
3254
+ };
3255
+ Balance_listTransactions: {
3256
+ parameters: {
3257
+ query?: {
2604
3258
  /** @description ISO 8601, exclusive (createdAt). */
2605
3259
  to?: string;
2606
3260
  /** @description ISO 8601, inclusive (createdAt). */
@@ -2610,7 +3264,7 @@ interface operations {
2610
3264
  /** @description Only movements of this payment. */
2611
3265
  paymentId?: string;
2612
3266
  /** @description One or more types (repeat or comma-separate). */
2613
- 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")[];
2614
3268
  /** @description `nextCursor` from the previous page. */
2615
3269
  cursor?: string;
2616
3270
  /** @description 1–100, default 50. */
@@ -5066,6 +5720,61 @@ interface operations {
5066
5720
  };
5067
5721
  };
5068
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
+ };
5069
5778
  CopPayments_create: {
5070
5779
  parameters: {
5071
5780
  query?: never;
@@ -5090,7 +5799,7 @@ interface operations {
5090
5799
  "application/json": components["schemas"]["CopPaymentDto"];
5091
5800
  };
5092
5801
  };
5093
- /** @description `invalid_data` (names the field) or `amount_out_of_range`. */
5802
+ /** @description `invalid_data` (names the field), `amount_below_minimum`, `amount_out_of_range`, or `channel_requires_checkout` (card). */
5094
5803
  400: {
5095
5804
  headers: {
5096
5805
  [name: string]: unknown;
@@ -5435,7 +6144,7 @@ interface operations {
5435
6144
  "application/json": components["schemas"]["ApiErrorDto"];
5436
6145
  };
5437
6146
  };
5438
- /** @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`. */
5439
6148
  409: {
5440
6149
  headers: {
5441
6150
  [name: string]: unknown;
@@ -5736,7 +6445,7 @@ interface operations {
5736
6445
  query?: {
5737
6446
  status?: "PENDING" | "COMPLETED" | "CANCELED";
5738
6447
  cursor?: string;
5739
- limit?: string;
6448
+ limit?: number;
5740
6449
  sourceCurrency?: "VES" | "COP";
5741
6450
  };
5742
6451
  header?: never;
@@ -7623,7 +8332,7 @@ interface operations {
7623
8332
  [name: string]: unknown;
7624
8333
  };
7625
8334
  content: {
7626
- "application/json": components["schemas"]["MerchantBalanceDto"];
8335
+ "application/json": components["schemas"]["MerchantTransferResponseDto"];
7627
8336
  };
7628
8337
  };
7629
8338
  /** @description Validation failure. */
@@ -7681,9 +8390,18 @@ interface operations {
7681
8390
  };
7682
8391
  };
7683
8392
  };
7684
- Merchants_getById: {
8393
+ Merchants_listTransactions: {
7685
8394
  parameters: {
7686
- query?: never;
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
+ };
7687
8405
  header?: never;
7688
8406
  path: {
7689
8407
  id: string;
@@ -7697,7 +8415,7 @@ interface operations {
7697
8415
  [name: string]: unknown;
7698
8416
  };
7699
8417
  content: {
7700
- "application/json": components["schemas"]["MerchantResponseDto"];
8418
+ "application/json": components["schemas"]["MerchantMovementListDto"];
7701
8419
  };
7702
8420
  };
7703
8421
  /** @description Validation failure. */
@@ -7755,9 +8473,14 @@ interface operations {
7755
8473
  };
7756
8474
  };
7757
8475
  };
7758
- Merchants_remove: {
8476
+ Merchants_statement: {
7759
8477
  parameters: {
7760
- query?: never;
8478
+ query: {
8479
+ /** @description YYYY-MM. */
8480
+ month: string;
8481
+ /** @description Default json. */
8482
+ format?: "json" | "csv";
8483
+ };
7761
8484
  header?: never;
7762
8485
  path: {
7763
8486
  id: string;
@@ -7771,7 +8494,7 @@ interface operations {
7771
8494
  [name: string]: unknown;
7772
8495
  };
7773
8496
  content: {
7774
- "application/json": components["schemas"]["DeleteMerchantResponseDto"];
8497
+ "application/json": components["schemas"]["MerchantStatementDto"];
7775
8498
  };
7776
8499
  };
7777
8500
  /** @description Validation failure. */
@@ -7801,7 +8524,6 @@ interface operations {
7801
8524
  "application/json": components["schemas"]["ApiErrorDto"];
7802
8525
  };
7803
8526
  };
7804
- /** @description Merchant not found for this tenant. */
7805
8527
  404: {
7806
8528
  headers: {
7807
8529
  [name: string]: unknown;
@@ -7810,7 +8532,156 @@ interface operations {
7810
8532
  "application/json": components["schemas"]["ApiErrorDto"];
7811
8533
  };
7812
8534
  };
7813
- /** @description merchant_has_payouts — merchant has payout history; deactivate instead. */
8535
+ /** @description Client error. */
8536
+ "4XX": {
8537
+ headers: {
8538
+ [name: string]: unknown;
8539
+ };
8540
+ content: {
8541
+ "application/json": components["schemas"]["ApiErrorDto"];
8542
+ };
8543
+ };
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. */
7814
8685
  409: {
7815
8686
  headers: {
7816
8687
  [name: string]: unknown;
@@ -9024,7 +9895,65 @@ interface operations {
9024
9895
  };
9025
9896
  };
9026
9897
  };
9027
- Notifications_sendTest: {
9898
+ Topups_list: {
9899
+ parameters: {
9900
+ query?: {
9901
+ /** @description 1–100, default 20. */
9902
+ limit?: number;
9903
+ };
9904
+ header?: never;
9905
+ path?: never;
9906
+ cookie?: never;
9907
+ };
9908
+ requestBody?: never;
9909
+ responses: {
9910
+ 200: {
9911
+ headers: {
9912
+ [name: string]: unknown;
9913
+ };
9914
+ content: {
9915
+ "application/json": components["schemas"]["TopupListDto"];
9916
+ };
9917
+ };
9918
+ /** @description Missing, invalid, or inactive tenant API key. */
9919
+ 401: {
9920
+ headers: {
9921
+ [name: string]: unknown;
9922
+ };
9923
+ content: {
9924
+ "application/json": components["schemas"]["ApiErrorDto"];
9925
+ };
9926
+ };
9927
+ /** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
9928
+ 403: {
9929
+ headers: {
9930
+ [name: string]: unknown;
9931
+ };
9932
+ content: {
9933
+ "application/json": components["schemas"]["ApiErrorDto"];
9934
+ };
9935
+ };
9936
+ /** @description Client error. */
9937
+ "4XX": {
9938
+ headers: {
9939
+ [name: string]: unknown;
9940
+ };
9941
+ content: {
9942
+ "application/json": components["schemas"]["ApiErrorDto"];
9943
+ };
9944
+ };
9945
+ /** @description Server or upstream bank error. */
9946
+ "5XX": {
9947
+ headers: {
9948
+ [name: string]: unknown;
9949
+ };
9950
+ content: {
9951
+ "application/json": components["schemas"]["ApiErrorDto"];
9952
+ };
9953
+ };
9954
+ };
9955
+ };
9956
+ Topups_create: {
9028
9957
  parameters: {
9029
9958
  query?: never;
9030
9959
  header?: {
@@ -9034,15 +9963,18 @@ interface operations {
9034
9963
  path?: never;
9035
9964
  cookie?: never;
9036
9965
  };
9037
- requestBody?: never;
9966
+ requestBody: {
9967
+ content: {
9968
+ "application/json": components["schemas"]["CreateTopupDto"];
9969
+ };
9970
+ };
9038
9971
  responses: {
9039
- /** @description Test event queued/delivered to matching endpoints. */
9040
- 202: {
9972
+ 201: {
9041
9973
  headers: {
9042
9974
  [name: string]: unknown;
9043
9975
  };
9044
9976
  content: {
9045
- "application/json": components["schemas"]["NotificationTestResponseDto"];
9977
+ "application/json": components["schemas"]["TopupDto"];
9046
9978
  };
9047
9979
  };
9048
9980
  /** @description Missing, invalid, or inactive tenant API key. */
@@ -9054,7 +9986,7 @@ interface operations {
9054
9986
  "application/json": components["schemas"]["ApiErrorDto"];
9055
9987
  };
9056
9988
  };
9057
- /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
9989
+ /** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
9058
9990
  403: {
9059
9991
  headers: {
9060
9992
  [name: string]: unknown;
@@ -9063,8 +9995,8 @@ interface operations {
9063
9995
  "application/json": components["schemas"]["ApiErrorDto"];
9064
9996
  };
9065
9997
  };
9066
- /** @description More than 10 test notifications in 10 minutes. */
9067
- 429: {
9998
+ /** @description `topup_cap_exceeded` — over the monthly limit (includes `remainingUsd` / `remainingVes`). */
9999
+ 422: {
9068
10000
  headers: {
9069
10001
  [name: string]: unknown;
9070
10002
  };
@@ -9092,44 +10024,2095 @@ interface operations {
9092
10024
  };
9093
10025
  };
9094
10026
  };
9095
- }
9096
-
9097
- type CursorPage<Item> = {
9098
- items: Item[];
9099
- nextCursor?: string | null;
9100
- };
9101
- /**
9102
- * Result of a cursor-paginated `list()`.
9103
- *
9104
- * const page = await vexpay.merchants.list({ limit: 100 }); // first page
9105
- * for await (const merchant of vexpay.merchants.list()) { … } // every item, all pages
9106
- *
9107
- * The first request is sent when the result is awaited or iterated.
9108
- */
9109
- declare class PagePromise<Page extends CursorPage<Item>, Item = Page['items'][number]> implements PromiseLike<Page>, AsyncIterable<Item> {
9110
- private readonly fetchPage;
9111
- private readonly startCursor?;
9112
- private firstPage?;
9113
- constructor(fetchPage: (cursor: string | undefined) => Promise<Page>, startCursor?: string | undefined);
9114
- private first;
9115
- then<TResult1 = Page, TResult2 = never>(onfulfilled?: ((value: Page) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
9116
- catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<Page | TResult>;
9117
- finally(onfinally?: (() => void) | null): Promise<Page>;
9118
- [Symbol.asyncIterator](): AsyncIterator<Item>;
9119
- /** Collects items across pages, stopping after `limit` (default 10 000). */
9120
- autoPagingToArray({ limit }?: {
9121
- limit?: number;
9122
- }): Promise<Item[]>;
9123
- }
9124
-
9125
- type OperationId = keyof operations;
9126
-
9127
- /** Every request/response schema in the VEXPay API, e.g. `Schemas['PaymentReceiptDto']`. */
9128
- type Schemas = components['schemas'];
9129
- type Params<O extends OperationId> = operations[O]['parameters'];
9130
- type PathParams<O extends OperationId> = NonNullable<Params<O>['path']>;
9131
- type QueryParams<O extends OperationId> = NonNullable<Params<O>['query']>;
9132
- type RequestBody<O extends OperationId> = operations[O] extends {
10027
+ Topups_get: {
10028
+ parameters: {
10029
+ query?: never;
10030
+ header?: never;
10031
+ path: {
10032
+ id: string;
10033
+ };
10034
+ cookie?: never;
10035
+ };
10036
+ requestBody?: never;
10037
+ responses: {
10038
+ 200: {
10039
+ headers: {
10040
+ [name: string]: unknown;
10041
+ };
10042
+ content: {
10043
+ "application/json": components["schemas"]["TopupDto"];
10044
+ };
10045
+ };
10046
+ /** @description Missing, invalid, or inactive tenant API key. */
10047
+ 401: {
10048
+ headers: {
10049
+ [name: string]: unknown;
10050
+ };
10051
+ content: {
10052
+ "application/json": components["schemas"]["ApiErrorDto"];
10053
+ };
10054
+ };
10055
+ /** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
10056
+ 403: {
10057
+ headers: {
10058
+ [name: string]: unknown;
10059
+ };
10060
+ content: {
10061
+ "application/json": components["schemas"]["ApiErrorDto"];
10062
+ };
10063
+ };
10064
+ /** @description Client error. */
10065
+ "4XX": {
10066
+ headers: {
10067
+ [name: string]: unknown;
10068
+ };
10069
+ content: {
10070
+ "application/json": components["schemas"]["ApiErrorDto"];
10071
+ };
10072
+ };
10073
+ /** @description Server or upstream bank error. */
10074
+ "5XX": {
10075
+ headers: {
10076
+ [name: string]: unknown;
10077
+ };
10078
+ content: {
10079
+ "application/json": components["schemas"]["ApiErrorDto"];
10080
+ };
10081
+ };
10082
+ };
10083
+ };
10084
+ Topups_instant: {
10085
+ parameters: {
10086
+ query?: never;
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
+ };
10091
+ path: {
10092
+ id: string;
10093
+ };
10094
+ cookie?: never;
10095
+ };
10096
+ requestBody?: never;
10097
+ responses: {
10098
+ 200: {
10099
+ headers: {
10100
+ [name: string]: unknown;
10101
+ };
10102
+ content: {
10103
+ "application/json": components["schemas"]["TopupDto"];
10104
+ };
10105
+ };
10106
+ /** @description Missing, invalid, or inactive tenant API key. */
10107
+ 401: {
10108
+ headers: {
10109
+ [name: string]: unknown;
10110
+ };
10111
+ content: {
10112
+ "application/json": components["schemas"]["ApiErrorDto"];
10113
+ };
10114
+ };
10115
+ /** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
10116
+ 403: {
10117
+ headers: {
10118
+ [name: string]: unknown;
10119
+ };
10120
+ content: {
10121
+ "application/json": components["schemas"]["ApiErrorDto"];
10122
+ };
10123
+ };
10124
+ /** @description `not_held` — nothing of this top-up is still held. */
10125
+ 409: {
10126
+ headers: {
10127
+ [name: string]: unknown;
10128
+ };
10129
+ content: {
10130
+ "application/json": components["schemas"]["ApiErrorDto"];
10131
+ };
10132
+ };
10133
+ /** @description Client error. */
10134
+ "4XX": {
10135
+ headers: {
10136
+ [name: string]: unknown;
10137
+ };
10138
+ content: {
10139
+ "application/json": components["schemas"]["ApiErrorDto"];
10140
+ };
10141
+ };
10142
+ /** @description Server or upstream bank error. */
10143
+ "5XX": {
10144
+ headers: {
10145
+ [name: string]: unknown;
10146
+ };
10147
+ content: {
10148
+ "application/json": components["schemas"]["ApiErrorDto"];
10149
+ };
10150
+ };
10151
+ };
10152
+ };
10153
+ Topups_simulate: {
10154
+ parameters: {
10155
+ query?: never;
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
+ };
10160
+ path: {
10161
+ id: string;
10162
+ };
10163
+ cookie?: never;
10164
+ };
10165
+ requestBody?: never;
10166
+ responses: {
10167
+ 200: {
10168
+ headers: {
10169
+ [name: string]: unknown;
10170
+ };
10171
+ content: {
10172
+ "application/json": components["schemas"]["TopupDto"];
10173
+ };
10174
+ };
10175
+ /** @description Missing, invalid, or inactive tenant API key. */
10176
+ 401: {
10177
+ headers: {
10178
+ [name: string]: unknown;
10179
+ };
10180
+ content: {
10181
+ "application/json": components["schemas"]["ApiErrorDto"];
10182
+ };
10183
+ };
10184
+ /** @description `topups_not_enabled` — top-ups are off for this account (VEX Pay turns them on). */
10185
+ 403: {
10186
+ headers: {
10187
+ [name: string]: unknown;
10188
+ };
10189
+ content: {
10190
+ "application/json": components["schemas"]["ApiErrorDto"];
10191
+ };
10192
+ };
10193
+ /** @description Client error. */
10194
+ "4XX": {
10195
+ headers: {
10196
+ [name: string]: unknown;
10197
+ };
10198
+ content: {
10199
+ "application/json": components["schemas"]["ApiErrorDto"];
10200
+ };
10201
+ };
10202
+ /** @description Server or upstream bank error. */
10203
+ "5XX": {
10204
+ headers: {
10205
+ [name: string]: unknown;
10206
+ };
10207
+ content: {
10208
+ "application/json": components["schemas"]["ApiErrorDto"];
10209
+ };
10210
+ };
10211
+ };
10212
+ };
10213
+ Notifications_sendTest: {
10214
+ parameters: {
10215
+ query?: never;
10216
+ header?: {
10217
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10218
+ "Idempotency-Key"?: string;
10219
+ };
10220
+ path?: never;
10221
+ cookie?: never;
10222
+ };
10223
+ requestBody?: never;
10224
+ responses: {
10225
+ /** @description Test event queued/delivered to matching endpoints. */
10226
+ 202: {
10227
+ headers: {
10228
+ [name: string]: unknown;
10229
+ };
10230
+ content: {
10231
+ "application/json": components["schemas"]["NotificationTestResponseDto"];
10232
+ };
10233
+ };
10234
+ /** @description Missing, invalid, or inactive tenant API key. */
10235
+ 401: {
10236
+ headers: {
10237
+ [name: string]: unknown;
10238
+ };
10239
+ content: {
10240
+ "application/json": components["schemas"]["ApiErrorDto"];
10241
+ };
10242
+ };
10243
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10244
+ 403: {
10245
+ headers: {
10246
+ [name: string]: unknown;
10247
+ };
10248
+ content: {
10249
+ "application/json": components["schemas"]["ApiErrorDto"];
10250
+ };
10251
+ };
10252
+ /** @description More than 10 test notifications in 10 minutes. */
10253
+ 429: {
10254
+ headers: {
10255
+ [name: string]: unknown;
10256
+ };
10257
+ content: {
10258
+ "application/json": components["schemas"]["ApiErrorDto"];
10259
+ };
10260
+ };
10261
+ /** @description Client error. */
10262
+ "4XX": {
10263
+ headers: {
10264
+ [name: string]: unknown;
10265
+ };
10266
+ content: {
10267
+ "application/json": components["schemas"]["ApiErrorDto"];
10268
+ };
10269
+ };
10270
+ /** @description Server or upstream bank error. */
10271
+ "5XX": {
10272
+ headers: {
10273
+ [name: string]: unknown;
10274
+ };
10275
+ content: {
10276
+ "application/json": components["schemas"]["ApiErrorDto"];
10277
+ };
10278
+ };
10279
+ };
10280
+ };
10281
+ Customers_list: {
10282
+ parameters: {
10283
+ query?: {
10284
+ email?: string;
10285
+ cursor?: string;
10286
+ limit?: number;
10287
+ };
10288
+ header?: never;
10289
+ path?: never;
10290
+ cookie?: never;
10291
+ };
10292
+ requestBody?: never;
10293
+ responses: {
10294
+ 200: {
10295
+ headers: {
10296
+ [name: string]: unknown;
10297
+ };
10298
+ content: {
10299
+ "application/json": components["schemas"]["CustomerListResponseDto"];
10300
+ };
10301
+ };
10302
+ /** @description Validation failure. */
10303
+ 400: {
10304
+ headers: {
10305
+ [name: string]: unknown;
10306
+ };
10307
+ content: {
10308
+ "application/json": components["schemas"]["ApiErrorDto"];
10309
+ };
10310
+ };
10311
+ /** @description Missing or invalid tenant API key. */
10312
+ 401: {
10313
+ headers: {
10314
+ [name: string]: unknown;
10315
+ };
10316
+ content: {
10317
+ "application/json": components["schemas"]["ApiErrorDto"];
10318
+ };
10319
+ };
10320
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10321
+ 403: {
10322
+ headers: {
10323
+ [name: string]: unknown;
10324
+ };
10325
+ content: {
10326
+ "application/json": components["schemas"]["ApiErrorDto"];
10327
+ };
10328
+ };
10329
+ /** @description Client error. */
10330
+ "4XX": {
10331
+ headers: {
10332
+ [name: string]: unknown;
10333
+ };
10334
+ content: {
10335
+ "application/json": components["schemas"]["ApiErrorDto"];
10336
+ };
10337
+ };
10338
+ /** @description Server or upstream bank error. */
10339
+ "5XX": {
10340
+ headers: {
10341
+ [name: string]: unknown;
10342
+ };
10343
+ content: {
10344
+ "application/json": components["schemas"]["ApiErrorDto"];
10345
+ };
10346
+ };
10347
+ };
10348
+ };
10349
+ Customers_create: {
10350
+ parameters: {
10351
+ query?: never;
10352
+ header?: {
10353
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10354
+ "Idempotency-Key"?: string;
10355
+ };
10356
+ path?: never;
10357
+ cookie?: never;
10358
+ };
10359
+ requestBody: {
10360
+ content: {
10361
+ "application/json": components["schemas"]["CreateCustomerDto"];
10362
+ };
10363
+ };
10364
+ responses: {
10365
+ 201: {
10366
+ headers: {
10367
+ [name: string]: unknown;
10368
+ };
10369
+ content: {
10370
+ "application/json": components["schemas"]["CustomerResponseDto"];
10371
+ };
10372
+ };
10373
+ /** @description Validation failure. */
10374
+ 400: {
10375
+ headers: {
10376
+ [name: string]: unknown;
10377
+ };
10378
+ content: {
10379
+ "application/json": components["schemas"]["ApiErrorDto"];
10380
+ };
10381
+ };
10382
+ /** @description Missing or invalid tenant API key. */
10383
+ 401: {
10384
+ headers: {
10385
+ [name: string]: unknown;
10386
+ };
10387
+ content: {
10388
+ "application/json": components["schemas"]["ApiErrorDto"];
10389
+ };
10390
+ };
10391
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10392
+ 403: {
10393
+ headers: {
10394
+ [name: string]: unknown;
10395
+ };
10396
+ content: {
10397
+ "application/json": components["schemas"]["ApiErrorDto"];
10398
+ };
10399
+ };
10400
+ /** @description Client error. */
10401
+ "4XX": {
10402
+ headers: {
10403
+ [name: string]: unknown;
10404
+ };
10405
+ content: {
10406
+ "application/json": components["schemas"]["ApiErrorDto"];
10407
+ };
10408
+ };
10409
+ /** @description Server or upstream bank error. */
10410
+ "5XX": {
10411
+ headers: {
10412
+ [name: string]: unknown;
10413
+ };
10414
+ content: {
10415
+ "application/json": components["schemas"]["ApiErrorDto"];
10416
+ };
10417
+ };
10418
+ };
10419
+ };
10420
+ Customers_retrieve: {
10421
+ parameters: {
10422
+ query?: never;
10423
+ header?: never;
10424
+ path: {
10425
+ id: string;
10426
+ };
10427
+ cookie?: never;
10428
+ };
10429
+ requestBody?: never;
10430
+ responses: {
10431
+ 200: {
10432
+ headers: {
10433
+ [name: string]: unknown;
10434
+ };
10435
+ content: {
10436
+ "application/json": components["schemas"]["CustomerResponseDto"];
10437
+ };
10438
+ };
10439
+ /** @description Validation failure. */
10440
+ 400: {
10441
+ headers: {
10442
+ [name: string]: unknown;
10443
+ };
10444
+ content: {
10445
+ "application/json": components["schemas"]["ApiErrorDto"];
10446
+ };
10447
+ };
10448
+ /** @description Missing or invalid tenant API key. */
10449
+ 401: {
10450
+ headers: {
10451
+ [name: string]: unknown;
10452
+ };
10453
+ content: {
10454
+ "application/json": components["schemas"]["ApiErrorDto"];
10455
+ };
10456
+ };
10457
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10458
+ 403: {
10459
+ headers: {
10460
+ [name: string]: unknown;
10461
+ };
10462
+ content: {
10463
+ "application/json": components["schemas"]["ApiErrorDto"];
10464
+ };
10465
+ };
10466
+ 404: {
10467
+ headers: {
10468
+ [name: string]: unknown;
10469
+ };
10470
+ content: {
10471
+ "application/json": components["schemas"]["ApiErrorDto"];
10472
+ };
10473
+ };
10474
+ /** @description Client error. */
10475
+ "4XX": {
10476
+ headers: {
10477
+ [name: string]: unknown;
10478
+ };
10479
+ content: {
10480
+ "application/json": components["schemas"]["ApiErrorDto"];
10481
+ };
10482
+ };
10483
+ /** @description Server or upstream bank error. */
10484
+ "5XX": {
10485
+ headers: {
10486
+ [name: string]: unknown;
10487
+ };
10488
+ content: {
10489
+ "application/json": components["schemas"]["ApiErrorDto"];
10490
+ };
10491
+ };
10492
+ };
10493
+ };
10494
+ Customers_update: {
10495
+ parameters: {
10496
+ query?: never;
10497
+ header?: {
10498
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10499
+ "Idempotency-Key"?: string;
10500
+ };
10501
+ path: {
10502
+ id: string;
10503
+ };
10504
+ cookie?: never;
10505
+ };
10506
+ requestBody: {
10507
+ content: {
10508
+ "application/json": components["schemas"]["UpdateCustomerDto"];
10509
+ };
10510
+ };
10511
+ responses: {
10512
+ 200: {
10513
+ headers: {
10514
+ [name: string]: unknown;
10515
+ };
10516
+ content: {
10517
+ "application/json": components["schemas"]["CustomerResponseDto"];
10518
+ };
10519
+ };
10520
+ /** @description Validation failure. */
10521
+ 400: {
10522
+ headers: {
10523
+ [name: string]: unknown;
10524
+ };
10525
+ content: {
10526
+ "application/json": components["schemas"]["ApiErrorDto"];
10527
+ };
10528
+ };
10529
+ /** @description Missing or invalid tenant API key. */
10530
+ 401: {
10531
+ headers: {
10532
+ [name: string]: unknown;
10533
+ };
10534
+ content: {
10535
+ "application/json": components["schemas"]["ApiErrorDto"];
10536
+ };
10537
+ };
10538
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10539
+ 403: {
10540
+ headers: {
10541
+ [name: string]: unknown;
10542
+ };
10543
+ content: {
10544
+ "application/json": components["schemas"]["ApiErrorDto"];
10545
+ };
10546
+ };
10547
+ 404: {
10548
+ headers: {
10549
+ [name: string]: unknown;
10550
+ };
10551
+ content: {
10552
+ "application/json": components["schemas"]["ApiErrorDto"];
10553
+ };
10554
+ };
10555
+ /** @description Client error. */
10556
+ "4XX": {
10557
+ headers: {
10558
+ [name: string]: unknown;
10559
+ };
10560
+ content: {
10561
+ "application/json": components["schemas"]["ApiErrorDto"];
10562
+ };
10563
+ };
10564
+ /** @description Server or upstream bank error. */
10565
+ "5XX": {
10566
+ headers: {
10567
+ [name: string]: unknown;
10568
+ };
10569
+ content: {
10570
+ "application/json": components["schemas"]["ApiErrorDto"];
10571
+ };
10572
+ };
10573
+ };
10574
+ };
10575
+ Customers_remove: {
10576
+ parameters: {
10577
+ query?: never;
10578
+ header?: never;
10579
+ path: {
10580
+ id: string;
10581
+ };
10582
+ cookie?: never;
10583
+ };
10584
+ requestBody?: never;
10585
+ responses: {
10586
+ 200: {
10587
+ headers: {
10588
+ [name: string]: unknown;
10589
+ };
10590
+ content: {
10591
+ "application/json": components["schemas"]["DeletedObjectResponseDto"];
10592
+ };
10593
+ };
10594
+ /** @description Validation failure. */
10595
+ 400: {
10596
+ headers: {
10597
+ [name: string]: unknown;
10598
+ };
10599
+ content: {
10600
+ "application/json": components["schemas"]["ApiErrorDto"];
10601
+ };
10602
+ };
10603
+ /** @description Missing or invalid tenant API key. */
10604
+ 401: {
10605
+ headers: {
10606
+ [name: string]: unknown;
10607
+ };
10608
+ content: {
10609
+ "application/json": components["schemas"]["ApiErrorDto"];
10610
+ };
10611
+ };
10612
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10613
+ 403: {
10614
+ headers: {
10615
+ [name: string]: unknown;
10616
+ };
10617
+ content: {
10618
+ "application/json": components["schemas"]["ApiErrorDto"];
10619
+ };
10620
+ };
10621
+ 404: {
10622
+ headers: {
10623
+ [name: string]: unknown;
10624
+ };
10625
+ content: {
10626
+ "application/json": components["schemas"]["ApiErrorDto"];
10627
+ };
10628
+ };
10629
+ /** @description customer_has_active_subscriptions */
10630
+ 409: {
10631
+ headers: {
10632
+ [name: string]: unknown;
10633
+ };
10634
+ content: {
10635
+ "application/json": components["schemas"]["ApiErrorDto"];
10636
+ };
10637
+ };
10638
+ /** @description Client error. */
10639
+ "4XX": {
10640
+ headers: {
10641
+ [name: string]: unknown;
10642
+ };
10643
+ content: {
10644
+ "application/json": components["schemas"]["ApiErrorDto"];
10645
+ };
10646
+ };
10647
+ /** @description Server or upstream bank error. */
10648
+ "5XX": {
10649
+ headers: {
10650
+ [name: string]: unknown;
10651
+ };
10652
+ content: {
10653
+ "application/json": components["schemas"]["ApiErrorDto"];
10654
+ };
10655
+ };
10656
+ };
10657
+ };
10658
+ Prices_list: {
10659
+ parameters: {
10660
+ query?: {
10661
+ product?: string;
10662
+ active?: "true" | "false";
10663
+ cursor?: string;
10664
+ limit?: number;
10665
+ };
10666
+ header?: never;
10667
+ path?: never;
10668
+ cookie?: never;
10669
+ };
10670
+ requestBody?: never;
10671
+ responses: {
10672
+ 200: {
10673
+ headers: {
10674
+ [name: string]: unknown;
10675
+ };
10676
+ content: {
10677
+ "application/json": components["schemas"]["PriceListResponseDto"];
10678
+ };
10679
+ };
10680
+ /** @description Validation failure. */
10681
+ 400: {
10682
+ headers: {
10683
+ [name: string]: unknown;
10684
+ };
10685
+ content: {
10686
+ "application/json": components["schemas"]["ApiErrorDto"];
10687
+ };
10688
+ };
10689
+ /** @description Missing or invalid tenant API key. */
10690
+ 401: {
10691
+ headers: {
10692
+ [name: string]: unknown;
10693
+ };
10694
+ content: {
10695
+ "application/json": components["schemas"]["ApiErrorDto"];
10696
+ };
10697
+ };
10698
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10699
+ 403: {
10700
+ headers: {
10701
+ [name: string]: unknown;
10702
+ };
10703
+ content: {
10704
+ "application/json": components["schemas"]["ApiErrorDto"];
10705
+ };
10706
+ };
10707
+ /** @description Client error. */
10708
+ "4XX": {
10709
+ headers: {
10710
+ [name: string]: unknown;
10711
+ };
10712
+ content: {
10713
+ "application/json": components["schemas"]["ApiErrorDto"];
10714
+ };
10715
+ };
10716
+ /** @description Server or upstream bank error. */
10717
+ "5XX": {
10718
+ headers: {
10719
+ [name: string]: unknown;
10720
+ };
10721
+ content: {
10722
+ "application/json": components["schemas"]["ApiErrorDto"];
10723
+ };
10724
+ };
10725
+ };
10726
+ };
10727
+ Prices_create: {
10728
+ parameters: {
10729
+ query?: never;
10730
+ header?: {
10731
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10732
+ "Idempotency-Key"?: string;
10733
+ };
10734
+ path?: never;
10735
+ cookie?: never;
10736
+ };
10737
+ requestBody: {
10738
+ content: {
10739
+ "application/json": components["schemas"]["CreatePriceDto"];
10740
+ };
10741
+ };
10742
+ responses: {
10743
+ 201: {
10744
+ headers: {
10745
+ [name: string]: unknown;
10746
+ };
10747
+ content: {
10748
+ "application/json": components["schemas"]["PriceResponseDto"];
10749
+ };
10750
+ };
10751
+ /** @description Validation failure. */
10752
+ 400: {
10753
+ headers: {
10754
+ [name: string]: unknown;
10755
+ };
10756
+ content: {
10757
+ "application/json": components["schemas"]["ApiErrorDto"];
10758
+ };
10759
+ };
10760
+ /** @description Missing or invalid tenant API key. */
10761
+ 401: {
10762
+ headers: {
10763
+ [name: string]: unknown;
10764
+ };
10765
+ content: {
10766
+ "application/json": components["schemas"]["ApiErrorDto"];
10767
+ };
10768
+ };
10769
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10770
+ 403: {
10771
+ headers: {
10772
+ [name: string]: unknown;
10773
+ };
10774
+ content: {
10775
+ "application/json": components["schemas"]["ApiErrorDto"];
10776
+ };
10777
+ };
10778
+ 404: {
10779
+ headers: {
10780
+ [name: string]: unknown;
10781
+ };
10782
+ content: {
10783
+ "application/json": components["schemas"]["ApiErrorDto"];
10784
+ };
10785
+ };
10786
+ /** @description amount_below_minimum */
10787
+ 422: {
10788
+ headers: {
10789
+ [name: string]: unknown;
10790
+ };
10791
+ content: {
10792
+ "application/json": components["schemas"]["ApiErrorDto"];
10793
+ };
10794
+ };
10795
+ /** @description Client error. */
10796
+ "4XX": {
10797
+ headers: {
10798
+ [name: string]: unknown;
10799
+ };
10800
+ content: {
10801
+ "application/json": components["schemas"]["ApiErrorDto"];
10802
+ };
10803
+ };
10804
+ /** @description Server or upstream bank error. */
10805
+ "5XX": {
10806
+ headers: {
10807
+ [name: string]: unknown;
10808
+ };
10809
+ content: {
10810
+ "application/json": components["schemas"]["ApiErrorDto"];
10811
+ };
10812
+ };
10813
+ };
10814
+ };
10815
+ Prices_retrieve: {
10816
+ parameters: {
10817
+ query?: never;
10818
+ header?: never;
10819
+ path: {
10820
+ id: string;
10821
+ };
10822
+ cookie?: never;
10823
+ };
10824
+ requestBody?: never;
10825
+ responses: {
10826
+ 200: {
10827
+ headers: {
10828
+ [name: string]: unknown;
10829
+ };
10830
+ content: {
10831
+ "application/json": components["schemas"]["PriceResponseDto"];
10832
+ };
10833
+ };
10834
+ /** @description Validation failure. */
10835
+ 400: {
10836
+ headers: {
10837
+ [name: string]: unknown;
10838
+ };
10839
+ content: {
10840
+ "application/json": components["schemas"]["ApiErrorDto"];
10841
+ };
10842
+ };
10843
+ /** @description Missing or invalid tenant API key. */
10844
+ 401: {
10845
+ headers: {
10846
+ [name: string]: unknown;
10847
+ };
10848
+ content: {
10849
+ "application/json": components["schemas"]["ApiErrorDto"];
10850
+ };
10851
+ };
10852
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10853
+ 403: {
10854
+ headers: {
10855
+ [name: string]: unknown;
10856
+ };
10857
+ content: {
10858
+ "application/json": components["schemas"]["ApiErrorDto"];
10859
+ };
10860
+ };
10861
+ 404: {
10862
+ headers: {
10863
+ [name: string]: unknown;
10864
+ };
10865
+ content: {
10866
+ "application/json": components["schemas"]["ApiErrorDto"];
10867
+ };
10868
+ };
10869
+ /** @description Client error. */
10870
+ "4XX": {
10871
+ headers: {
10872
+ [name: string]: unknown;
10873
+ };
10874
+ content: {
10875
+ "application/json": components["schemas"]["ApiErrorDto"];
10876
+ };
10877
+ };
10878
+ /** @description Server or upstream bank error. */
10879
+ "5XX": {
10880
+ headers: {
10881
+ [name: string]: unknown;
10882
+ };
10883
+ content: {
10884
+ "application/json": components["schemas"]["ApiErrorDto"];
10885
+ };
10886
+ };
10887
+ };
10888
+ };
10889
+ Prices_update: {
10890
+ parameters: {
10891
+ query?: never;
10892
+ header?: {
10893
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10894
+ "Idempotency-Key"?: string;
10895
+ };
10896
+ path: {
10897
+ id: string;
10898
+ };
10899
+ cookie?: never;
10900
+ };
10901
+ requestBody: {
10902
+ content: {
10903
+ "application/json": components["schemas"]["UpdatePriceDto"];
10904
+ };
10905
+ };
10906
+ responses: {
10907
+ 200: {
10908
+ headers: {
10909
+ [name: string]: unknown;
10910
+ };
10911
+ content: {
10912
+ "application/json": components["schemas"]["PriceResponseDto"];
10913
+ };
10914
+ };
10915
+ /** @description Validation failure. */
10916
+ 400: {
10917
+ headers: {
10918
+ [name: string]: unknown;
10919
+ };
10920
+ content: {
10921
+ "application/json": components["schemas"]["ApiErrorDto"];
10922
+ };
10923
+ };
10924
+ /** @description Missing or invalid tenant API key. */
10925
+ 401: {
10926
+ headers: {
10927
+ [name: string]: unknown;
10928
+ };
10929
+ content: {
10930
+ "application/json": components["schemas"]["ApiErrorDto"];
10931
+ };
10932
+ };
10933
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10934
+ 403: {
10935
+ headers: {
10936
+ [name: string]: unknown;
10937
+ };
10938
+ content: {
10939
+ "application/json": components["schemas"]["ApiErrorDto"];
10940
+ };
10941
+ };
10942
+ 404: {
10943
+ headers: {
10944
+ [name: string]: unknown;
10945
+ };
10946
+ content: {
10947
+ "application/json": components["schemas"]["ApiErrorDto"];
10948
+ };
10949
+ };
10950
+ /** @description Client error. */
10951
+ "4XX": {
10952
+ headers: {
10953
+ [name: string]: unknown;
10954
+ };
10955
+ content: {
10956
+ "application/json": components["schemas"]["ApiErrorDto"];
10957
+ };
10958
+ };
10959
+ /** @description Server or upstream bank error. */
10960
+ "5XX": {
10961
+ headers: {
10962
+ [name: string]: unknown;
10963
+ };
10964
+ content: {
10965
+ "application/json": components["schemas"]["ApiErrorDto"];
10966
+ };
10967
+ };
10968
+ };
10969
+ };
10970
+ Subscriptions_list: {
10971
+ parameters: {
10972
+ query?: {
10973
+ customer?: string;
10974
+ price?: string;
10975
+ status?: "trialing" | "active" | "past_due" | "canceled";
10976
+ cursor?: string;
10977
+ limit?: number;
10978
+ };
10979
+ header?: never;
10980
+ path?: never;
10981
+ cookie?: never;
10982
+ };
10983
+ requestBody?: never;
10984
+ responses: {
10985
+ 200: {
10986
+ headers: {
10987
+ [name: string]: unknown;
10988
+ };
10989
+ content: {
10990
+ "application/json": components["schemas"]["SubscriptionListResponseDto"];
10991
+ };
10992
+ };
10993
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
10994
+ 400: {
10995
+ headers: {
10996
+ [name: string]: unknown;
10997
+ };
10998
+ content: {
10999
+ "application/json": components["schemas"]["ApiErrorDto"];
11000
+ };
11001
+ };
11002
+ /** @description Missing or invalid tenant API key. */
11003
+ 401: {
11004
+ headers: {
11005
+ [name: string]: unknown;
11006
+ };
11007
+ content: {
11008
+ "application/json": components["schemas"]["ApiErrorDto"];
11009
+ };
11010
+ };
11011
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11012
+ 403: {
11013
+ headers: {
11014
+ [name: string]: unknown;
11015
+ };
11016
+ content: {
11017
+ "application/json": components["schemas"]["ApiErrorDto"];
11018
+ };
11019
+ };
11020
+ /** @description Client error. */
11021
+ "4XX": {
11022
+ headers: {
11023
+ [name: string]: unknown;
11024
+ };
11025
+ content: {
11026
+ "application/json": components["schemas"]["ApiErrorDto"];
11027
+ };
11028
+ };
11029
+ /** @description Server or upstream bank error. */
11030
+ "5XX": {
11031
+ headers: {
11032
+ [name: string]: unknown;
11033
+ };
11034
+ content: {
11035
+ "application/json": components["schemas"]["ApiErrorDto"];
11036
+ };
11037
+ };
11038
+ };
11039
+ };
11040
+ Subscriptions_create: {
11041
+ parameters: {
11042
+ query?: never;
11043
+ header?: {
11044
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
11045
+ "Idempotency-Key"?: string;
11046
+ };
11047
+ path?: never;
11048
+ cookie?: never;
11049
+ };
11050
+ requestBody: {
11051
+ content: {
11052
+ "application/json": components["schemas"]["CreateSubscriptionDto"];
11053
+ };
11054
+ };
11055
+ responses: {
11056
+ 201: {
11057
+ headers: {
11058
+ [name: string]: unknown;
11059
+ };
11060
+ content: {
11061
+ "application/json": components["schemas"]["SubscriptionResponseDto"];
11062
+ };
11063
+ };
11064
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
11065
+ 400: {
11066
+ headers: {
11067
+ [name: string]: unknown;
11068
+ };
11069
+ content: {
11070
+ "application/json": components["schemas"]["ApiErrorDto"];
11071
+ };
11072
+ };
11073
+ /** @description Missing or invalid tenant API key. */
11074
+ 401: {
11075
+ headers: {
11076
+ [name: string]: unknown;
11077
+ };
11078
+ content: {
11079
+ "application/json": components["schemas"]["ApiErrorDto"];
11080
+ };
11081
+ };
11082
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11083
+ 403: {
11084
+ headers: {
11085
+ [name: string]: unknown;
11086
+ };
11087
+ content: {
11088
+ "application/json": components["schemas"]["ApiErrorDto"];
11089
+ };
11090
+ };
11091
+ 404: {
11092
+ headers: {
11093
+ [name: string]: unknown;
11094
+ };
11095
+ content: {
11096
+ "application/json": components["schemas"]["ApiErrorDto"];
11097
+ };
11098
+ };
11099
+ /** @description Client error. */
11100
+ "4XX": {
11101
+ headers: {
11102
+ [name: string]: unknown;
11103
+ };
11104
+ content: {
11105
+ "application/json": components["schemas"]["ApiErrorDto"];
11106
+ };
11107
+ };
11108
+ /** @description Server or upstream bank error. */
11109
+ "5XX": {
11110
+ headers: {
11111
+ [name: string]: unknown;
11112
+ };
11113
+ content: {
11114
+ "application/json": components["schemas"]["ApiErrorDto"];
11115
+ };
11116
+ };
11117
+ };
11118
+ };
11119
+ Subscriptions_retrieve: {
11120
+ parameters: {
11121
+ query?: never;
11122
+ header?: never;
11123
+ path: {
11124
+ id: string;
11125
+ };
11126
+ cookie?: never;
11127
+ };
11128
+ requestBody?: never;
11129
+ responses: {
11130
+ 200: {
11131
+ headers: {
11132
+ [name: string]: unknown;
11133
+ };
11134
+ content: {
11135
+ "application/json": components["schemas"]["SubscriptionResponseDto"];
11136
+ };
11137
+ };
11138
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
11139
+ 400: {
11140
+ headers: {
11141
+ [name: string]: unknown;
11142
+ };
11143
+ content: {
11144
+ "application/json": components["schemas"]["ApiErrorDto"];
11145
+ };
11146
+ };
11147
+ /** @description Missing or invalid tenant API key. */
11148
+ 401: {
11149
+ headers: {
11150
+ [name: string]: unknown;
11151
+ };
11152
+ content: {
11153
+ "application/json": components["schemas"]["ApiErrorDto"];
11154
+ };
11155
+ };
11156
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11157
+ 403: {
11158
+ headers: {
11159
+ [name: string]: unknown;
11160
+ };
11161
+ content: {
11162
+ "application/json": components["schemas"]["ApiErrorDto"];
11163
+ };
11164
+ };
11165
+ 404: {
11166
+ headers: {
11167
+ [name: string]: unknown;
11168
+ };
11169
+ content: {
11170
+ "application/json": components["schemas"]["ApiErrorDto"];
11171
+ };
11172
+ };
11173
+ /** @description Client error. */
11174
+ "4XX": {
11175
+ headers: {
11176
+ [name: string]: unknown;
11177
+ };
11178
+ content: {
11179
+ "application/json": components["schemas"]["ApiErrorDto"];
11180
+ };
11181
+ };
11182
+ /** @description Server or upstream bank error. */
11183
+ "5XX": {
11184
+ headers: {
11185
+ [name: string]: unknown;
11186
+ };
11187
+ content: {
11188
+ "application/json": components["schemas"]["ApiErrorDto"];
11189
+ };
11190
+ };
11191
+ };
11192
+ };
11193
+ Subscriptions_update: {
11194
+ parameters: {
11195
+ query?: never;
11196
+ header?: {
11197
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
11198
+ "Idempotency-Key"?: string;
11199
+ };
11200
+ path: {
11201
+ id: string;
11202
+ };
11203
+ cookie?: never;
11204
+ };
11205
+ requestBody: {
11206
+ content: {
11207
+ "application/json": components["schemas"]["UpdateSubscriptionDto"];
11208
+ };
11209
+ };
11210
+ responses: {
11211
+ 200: {
11212
+ headers: {
11213
+ [name: string]: unknown;
11214
+ };
11215
+ content: {
11216
+ "application/json": components["schemas"]["SubscriptionResponseDto"];
11217
+ };
11218
+ };
11219
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
11220
+ 400: {
11221
+ headers: {
11222
+ [name: string]: unknown;
11223
+ };
11224
+ content: {
11225
+ "application/json": components["schemas"]["ApiErrorDto"];
11226
+ };
11227
+ };
11228
+ /** @description Missing or invalid tenant API key. */
11229
+ 401: {
11230
+ headers: {
11231
+ [name: string]: unknown;
11232
+ };
11233
+ content: {
11234
+ "application/json": components["schemas"]["ApiErrorDto"];
11235
+ };
11236
+ };
11237
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11238
+ 403: {
11239
+ headers: {
11240
+ [name: string]: unknown;
11241
+ };
11242
+ content: {
11243
+ "application/json": components["schemas"]["ApiErrorDto"];
11244
+ };
11245
+ };
11246
+ 404: {
11247
+ headers: {
11248
+ [name: string]: unknown;
11249
+ };
11250
+ content: {
11251
+ "application/json": components["schemas"]["ApiErrorDto"];
11252
+ };
11253
+ };
11254
+ /** @description Client error. */
11255
+ "4XX": {
11256
+ headers: {
11257
+ [name: string]: unknown;
11258
+ };
11259
+ content: {
11260
+ "application/json": components["schemas"]["ApiErrorDto"];
11261
+ };
11262
+ };
11263
+ /** @description Server or upstream bank error. */
11264
+ "5XX": {
11265
+ headers: {
11266
+ [name: string]: unknown;
11267
+ };
11268
+ content: {
11269
+ "application/json": components["schemas"]["ApiErrorDto"];
11270
+ };
11271
+ };
11272
+ };
11273
+ };
11274
+ Subscriptions_cancel: {
11275
+ parameters: {
11276
+ query?: never;
11277
+ header?: never;
11278
+ path: {
11279
+ id: string;
11280
+ };
11281
+ cookie?: never;
11282
+ };
11283
+ requestBody?: never;
11284
+ responses: {
11285
+ 200: {
11286
+ headers: {
11287
+ [name: string]: unknown;
11288
+ };
11289
+ content: {
11290
+ "application/json": components["schemas"]["SubscriptionResponseDto"];
11291
+ };
11292
+ };
11293
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
11294
+ 400: {
11295
+ headers: {
11296
+ [name: string]: unknown;
11297
+ };
11298
+ content: {
11299
+ "application/json": components["schemas"]["ApiErrorDto"];
11300
+ };
11301
+ };
11302
+ /** @description Missing or invalid tenant API key. */
11303
+ 401: {
11304
+ headers: {
11305
+ [name: string]: unknown;
11306
+ };
11307
+ content: {
11308
+ "application/json": components["schemas"]["ApiErrorDto"];
11309
+ };
11310
+ };
11311
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11312
+ 403: {
11313
+ headers: {
11314
+ [name: string]: unknown;
11315
+ };
11316
+ content: {
11317
+ "application/json": components["schemas"]["ApiErrorDto"];
11318
+ };
11319
+ };
11320
+ 404: {
11321
+ headers: {
11322
+ [name: string]: unknown;
11323
+ };
11324
+ content: {
11325
+ "application/json": components["schemas"]["ApiErrorDto"];
11326
+ };
11327
+ };
11328
+ /** @description Client error. */
11329
+ "4XX": {
11330
+ headers: {
11331
+ [name: string]: unknown;
11332
+ };
11333
+ content: {
11334
+ "application/json": components["schemas"]["ApiErrorDto"];
11335
+ };
11336
+ };
11337
+ /** @description Server or upstream bank error. */
11338
+ "5XX": {
11339
+ headers: {
11340
+ [name: string]: unknown;
11341
+ };
11342
+ content: {
11343
+ "application/json": components["schemas"]["ApiErrorDto"];
11344
+ };
11345
+ };
11346
+ };
11347
+ };
11348
+ Invoices_list: {
11349
+ parameters: {
11350
+ query?: {
11351
+ customer?: string;
11352
+ subscription?: string;
11353
+ status?: "open" | "paid" | "void" | "uncollectible";
11354
+ cursor?: string;
11355
+ limit?: number;
11356
+ };
11357
+ header?: never;
11358
+ path?: never;
11359
+ cookie?: never;
11360
+ };
11361
+ requestBody?: never;
11362
+ responses: {
11363
+ 200: {
11364
+ headers: {
11365
+ [name: string]: unknown;
11366
+ };
11367
+ content: {
11368
+ "application/json": components["schemas"]["InvoiceListResponseDto"];
11369
+ };
11370
+ };
11371
+ /** @description Validation failure or invoice_not_open. */
11372
+ 400: {
11373
+ headers: {
11374
+ [name: string]: unknown;
11375
+ };
11376
+ content: {
11377
+ "application/json": components["schemas"]["ApiErrorDto"];
11378
+ };
11379
+ };
11380
+ /** @description Missing or invalid tenant API key. */
11381
+ 401: {
11382
+ headers: {
11383
+ [name: string]: unknown;
11384
+ };
11385
+ content: {
11386
+ "application/json": components["schemas"]["ApiErrorDto"];
11387
+ };
11388
+ };
11389
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11390
+ 403: {
11391
+ headers: {
11392
+ [name: string]: unknown;
11393
+ };
11394
+ content: {
11395
+ "application/json": components["schemas"]["ApiErrorDto"];
11396
+ };
11397
+ };
11398
+ /** @description Client error. */
11399
+ "4XX": {
11400
+ headers: {
11401
+ [name: string]: unknown;
11402
+ };
11403
+ content: {
11404
+ "application/json": components["schemas"]["ApiErrorDto"];
11405
+ };
11406
+ };
11407
+ /** @description Server or upstream bank error. */
11408
+ "5XX": {
11409
+ headers: {
11410
+ [name: string]: unknown;
11411
+ };
11412
+ content: {
11413
+ "application/json": components["schemas"]["ApiErrorDto"];
11414
+ };
11415
+ };
11416
+ };
11417
+ };
11418
+ Invoices_retrieve: {
11419
+ parameters: {
11420
+ query?: never;
11421
+ header?: never;
11422
+ path: {
11423
+ id: string;
11424
+ };
11425
+ cookie?: never;
11426
+ };
11427
+ requestBody?: never;
11428
+ responses: {
11429
+ 200: {
11430
+ headers: {
11431
+ [name: string]: unknown;
11432
+ };
11433
+ content: {
11434
+ "application/json": components["schemas"]["InvoiceResponseDto"];
11435
+ };
11436
+ };
11437
+ /** @description Validation failure or invoice_not_open. */
11438
+ 400: {
11439
+ headers: {
11440
+ [name: string]: unknown;
11441
+ };
11442
+ content: {
11443
+ "application/json": components["schemas"]["ApiErrorDto"];
11444
+ };
11445
+ };
11446
+ /** @description Missing or invalid tenant API key. */
11447
+ 401: {
11448
+ headers: {
11449
+ [name: string]: unknown;
11450
+ };
11451
+ content: {
11452
+ "application/json": components["schemas"]["ApiErrorDto"];
11453
+ };
11454
+ };
11455
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11456
+ 403: {
11457
+ headers: {
11458
+ [name: string]: unknown;
11459
+ };
11460
+ content: {
11461
+ "application/json": components["schemas"]["ApiErrorDto"];
11462
+ };
11463
+ };
11464
+ 404: {
11465
+ headers: {
11466
+ [name: string]: unknown;
11467
+ };
11468
+ content: {
11469
+ "application/json": components["schemas"]["ApiErrorDto"];
11470
+ };
11471
+ };
11472
+ /** @description Client error. */
11473
+ "4XX": {
11474
+ headers: {
11475
+ [name: string]: unknown;
11476
+ };
11477
+ content: {
11478
+ "application/json": components["schemas"]["ApiErrorDto"];
11479
+ };
11480
+ };
11481
+ /** @description Server or upstream bank error. */
11482
+ "5XX": {
11483
+ headers: {
11484
+ [name: string]: unknown;
11485
+ };
11486
+ content: {
11487
+ "application/json": components["schemas"]["ApiErrorDto"];
11488
+ };
11489
+ };
11490
+ };
11491
+ };
11492
+ Invoices_void: {
11493
+ parameters: {
11494
+ query?: never;
11495
+ header?: {
11496
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
11497
+ "Idempotency-Key"?: string;
11498
+ };
11499
+ path: {
11500
+ id: string;
11501
+ };
11502
+ cookie?: never;
11503
+ };
11504
+ requestBody?: never;
11505
+ responses: {
11506
+ 200: {
11507
+ headers: {
11508
+ [name: string]: unknown;
11509
+ };
11510
+ content: {
11511
+ "application/json": components["schemas"]["InvoiceResponseDto"];
11512
+ };
11513
+ };
11514
+ /** @description Validation failure or invoice_not_open. */
11515
+ 400: {
11516
+ headers: {
11517
+ [name: string]: unknown;
11518
+ };
11519
+ content: {
11520
+ "application/json": components["schemas"]["ApiErrorDto"];
11521
+ };
11522
+ };
11523
+ /** @description Missing or invalid tenant API key. */
11524
+ 401: {
11525
+ headers: {
11526
+ [name: string]: unknown;
11527
+ };
11528
+ content: {
11529
+ "application/json": components["schemas"]["ApiErrorDto"];
11530
+ };
11531
+ };
11532
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11533
+ 403: {
11534
+ headers: {
11535
+ [name: string]: unknown;
11536
+ };
11537
+ content: {
11538
+ "application/json": components["schemas"]["ApiErrorDto"];
11539
+ };
11540
+ };
11541
+ 404: {
11542
+ headers: {
11543
+ [name: string]: unknown;
11544
+ };
11545
+ content: {
11546
+ "application/json": components["schemas"]["ApiErrorDto"];
11547
+ };
11548
+ };
11549
+ /** @description Client error. */
11550
+ "4XX": {
11551
+ headers: {
11552
+ [name: string]: unknown;
11553
+ };
11554
+ content: {
11555
+ "application/json": components["schemas"]["ApiErrorDto"];
11556
+ };
11557
+ };
11558
+ /** @description Server or upstream bank error. */
11559
+ "5XX": {
11560
+ headers: {
11561
+ [name: string]: unknown;
11562
+ };
11563
+ content: {
11564
+ "application/json": components["schemas"]["ApiErrorDto"];
11565
+ };
11566
+ };
11567
+ };
11568
+ };
11569
+ Invoices_markUncollectible: {
11570
+ parameters: {
11571
+ query?: never;
11572
+ header?: {
11573
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
11574
+ "Idempotency-Key"?: string;
11575
+ };
11576
+ path: {
11577
+ id: string;
11578
+ };
11579
+ cookie?: never;
11580
+ };
11581
+ requestBody?: never;
11582
+ responses: {
11583
+ 200: {
11584
+ headers: {
11585
+ [name: string]: unknown;
11586
+ };
11587
+ content: {
11588
+ "application/json": components["schemas"]["InvoiceResponseDto"];
11589
+ };
11590
+ };
11591
+ /** @description Validation failure or invoice_not_open. */
11592
+ 400: {
11593
+ headers: {
11594
+ [name: string]: unknown;
11595
+ };
11596
+ content: {
11597
+ "application/json": components["schemas"]["ApiErrorDto"];
11598
+ };
11599
+ };
11600
+ /** @description Missing or invalid tenant API key. */
11601
+ 401: {
11602
+ headers: {
11603
+ [name: string]: unknown;
11604
+ };
11605
+ content: {
11606
+ "application/json": components["schemas"]["ApiErrorDto"];
11607
+ };
11608
+ };
11609
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11610
+ 403: {
11611
+ headers: {
11612
+ [name: string]: unknown;
11613
+ };
11614
+ content: {
11615
+ "application/json": components["schemas"]["ApiErrorDto"];
11616
+ };
11617
+ };
11618
+ 404: {
11619
+ headers: {
11620
+ [name: string]: unknown;
11621
+ };
11622
+ content: {
11623
+ "application/json": components["schemas"]["ApiErrorDto"];
11624
+ };
11625
+ };
11626
+ /** @description Client error. */
11627
+ "4XX": {
11628
+ headers: {
11629
+ [name: string]: unknown;
11630
+ };
11631
+ content: {
11632
+ "application/json": components["schemas"]["ApiErrorDto"];
11633
+ };
11634
+ };
11635
+ /** @description Server or upstream bank error. */
11636
+ "5XX": {
11637
+ headers: {
11638
+ [name: string]: unknown;
11639
+ };
11640
+ content: {
11641
+ "application/json": components["schemas"]["ApiErrorDto"];
11642
+ };
11643
+ };
11644
+ };
11645
+ };
11646
+ Invoices_pay: {
11647
+ parameters: {
11648
+ query?: never;
11649
+ header?: {
11650
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
11651
+ "Idempotency-Key"?: string;
11652
+ };
11653
+ path: {
11654
+ id: string;
11655
+ };
11656
+ cookie?: never;
11657
+ };
11658
+ requestBody: {
11659
+ content: {
11660
+ "application/json": components["schemas"]["PayInvoiceDto"];
11661
+ };
11662
+ };
11663
+ responses: {
11664
+ 200: {
11665
+ headers: {
11666
+ [name: string]: unknown;
11667
+ };
11668
+ content: {
11669
+ "application/json": components["schemas"]["InvoiceResponseDto"];
11670
+ };
11671
+ };
11672
+ /** @description Validation failure or invoice_not_open. */
11673
+ 400: {
11674
+ headers: {
11675
+ [name: string]: unknown;
11676
+ };
11677
+ content: {
11678
+ "application/json": components["schemas"]["ApiErrorDto"];
11679
+ };
11680
+ };
11681
+ /** @description Missing or invalid tenant API key. */
11682
+ 401: {
11683
+ headers: {
11684
+ [name: string]: unknown;
11685
+ };
11686
+ content: {
11687
+ "application/json": components["schemas"]["ApiErrorDto"];
11688
+ };
11689
+ };
11690
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11691
+ 403: {
11692
+ headers: {
11693
+ [name: string]: unknown;
11694
+ };
11695
+ content: {
11696
+ "application/json": components["schemas"]["ApiErrorDto"];
11697
+ };
11698
+ };
11699
+ 404: {
11700
+ headers: {
11701
+ [name: string]: unknown;
11702
+ };
11703
+ content: {
11704
+ "application/json": components["schemas"]["ApiErrorDto"];
11705
+ };
11706
+ };
11707
+ /** @description Client error. */
11708
+ "4XX": {
11709
+ headers: {
11710
+ [name: string]: unknown;
11711
+ };
11712
+ content: {
11713
+ "application/json": components["schemas"]["ApiErrorDto"];
11714
+ };
11715
+ };
11716
+ /** @description Server or upstream bank error. */
11717
+ "5XX": {
11718
+ headers: {
11719
+ [name: string]: unknown;
11720
+ };
11721
+ content: {
11722
+ "application/json": components["schemas"]["ApiErrorDto"];
11723
+ };
11724
+ };
11725
+ };
11726
+ };
11727
+ SetupSessions_create: {
11728
+ parameters: {
11729
+ query?: never;
11730
+ header?: {
11731
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
11732
+ "Idempotency-Key"?: string;
11733
+ };
11734
+ path?: never;
11735
+ cookie?: never;
11736
+ };
11737
+ requestBody: {
11738
+ content: {
11739
+ "application/json": components["schemas"]["CreateSetupSessionDto"];
11740
+ };
11741
+ };
11742
+ responses: {
11743
+ 201: {
11744
+ headers: {
11745
+ [name: string]: unknown;
11746
+ };
11747
+ content: {
11748
+ "application/json": components["schemas"]["SetupSessionResponseDto"];
11749
+ };
11750
+ };
11751
+ /** @description Validation failure, method_not_allowed or automatic_charging_unavailable. */
11752
+ 400: {
11753
+ headers: {
11754
+ [name: string]: unknown;
11755
+ };
11756
+ content: {
11757
+ "application/json": components["schemas"]["ApiErrorDto"];
11758
+ };
11759
+ };
11760
+ /** @description Missing or invalid tenant API key. */
11761
+ 401: {
11762
+ headers: {
11763
+ [name: string]: unknown;
11764
+ };
11765
+ content: {
11766
+ "application/json": components["schemas"]["ApiErrorDto"];
11767
+ };
11768
+ };
11769
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11770
+ 403: {
11771
+ headers: {
11772
+ [name: string]: unknown;
11773
+ };
11774
+ content: {
11775
+ "application/json": components["schemas"]["ApiErrorDto"];
11776
+ };
11777
+ };
11778
+ 404: {
11779
+ headers: {
11780
+ [name: string]: unknown;
11781
+ };
11782
+ content: {
11783
+ "application/json": components["schemas"]["ApiErrorDto"];
11784
+ };
11785
+ };
11786
+ /** @description Client error. */
11787
+ "4XX": {
11788
+ headers: {
11789
+ [name: string]: unknown;
11790
+ };
11791
+ content: {
11792
+ "application/json": components["schemas"]["ApiErrorDto"];
11793
+ };
11794
+ };
11795
+ /** @description Server or upstream bank error. */
11796
+ "5XX": {
11797
+ headers: {
11798
+ [name: string]: unknown;
11799
+ };
11800
+ content: {
11801
+ "application/json": components["schemas"]["ApiErrorDto"];
11802
+ };
11803
+ };
11804
+ };
11805
+ };
11806
+ SetupSessions_retrieve: {
11807
+ parameters: {
11808
+ query?: never;
11809
+ header?: never;
11810
+ path: {
11811
+ id: string;
11812
+ };
11813
+ cookie?: never;
11814
+ };
11815
+ requestBody?: never;
11816
+ responses: {
11817
+ 200: {
11818
+ headers: {
11819
+ [name: string]: unknown;
11820
+ };
11821
+ content: {
11822
+ "application/json": components["schemas"]["SetupSessionResponseDto"];
11823
+ };
11824
+ };
11825
+ /** @description Validation failure, method_not_allowed or automatic_charging_unavailable. */
11826
+ 400: {
11827
+ headers: {
11828
+ [name: string]: unknown;
11829
+ };
11830
+ content: {
11831
+ "application/json": components["schemas"]["ApiErrorDto"];
11832
+ };
11833
+ };
11834
+ /** @description Missing or invalid tenant API key. */
11835
+ 401: {
11836
+ headers: {
11837
+ [name: string]: unknown;
11838
+ };
11839
+ content: {
11840
+ "application/json": components["schemas"]["ApiErrorDto"];
11841
+ };
11842
+ };
11843
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11844
+ 403: {
11845
+ headers: {
11846
+ [name: string]: unknown;
11847
+ };
11848
+ content: {
11849
+ "application/json": components["schemas"]["ApiErrorDto"];
11850
+ };
11851
+ };
11852
+ 404: {
11853
+ headers: {
11854
+ [name: string]: unknown;
11855
+ };
11856
+ content: {
11857
+ "application/json": components["schemas"]["ApiErrorDto"];
11858
+ };
11859
+ };
11860
+ /** @description Client error. */
11861
+ "4XX": {
11862
+ headers: {
11863
+ [name: string]: unknown;
11864
+ };
11865
+ content: {
11866
+ "application/json": components["schemas"]["ApiErrorDto"];
11867
+ };
11868
+ };
11869
+ /** @description Server or upstream bank error. */
11870
+ "5XX": {
11871
+ headers: {
11872
+ [name: string]: unknown;
11873
+ };
11874
+ content: {
11875
+ "application/json": components["schemas"]["ApiErrorDto"];
11876
+ };
11877
+ };
11878
+ };
11879
+ };
11880
+ PaymentMethods_retrieve: {
11881
+ parameters: {
11882
+ query?: never;
11883
+ header?: never;
11884
+ path: {
11885
+ id: string;
11886
+ };
11887
+ cookie?: never;
11888
+ };
11889
+ requestBody?: never;
11890
+ responses: {
11891
+ 200: {
11892
+ headers: {
11893
+ [name: string]: unknown;
11894
+ };
11895
+ content: {
11896
+ "application/json": components["schemas"]["PaymentMethodResponseDto"];
11897
+ };
11898
+ };
11899
+ /** @description Missing or invalid tenant API key. */
11900
+ 401: {
11901
+ headers: {
11902
+ [name: string]: unknown;
11903
+ };
11904
+ content: {
11905
+ "application/json": components["schemas"]["ApiErrorDto"];
11906
+ };
11907
+ };
11908
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11909
+ 403: {
11910
+ headers: {
11911
+ [name: string]: unknown;
11912
+ };
11913
+ content: {
11914
+ "application/json": components["schemas"]["ApiErrorDto"];
11915
+ };
11916
+ };
11917
+ 404: {
11918
+ headers: {
11919
+ [name: string]: unknown;
11920
+ };
11921
+ content: {
11922
+ "application/json": components["schemas"]["ApiErrorDto"];
11923
+ };
11924
+ };
11925
+ /** @description Client error. */
11926
+ "4XX": {
11927
+ headers: {
11928
+ [name: string]: unknown;
11929
+ };
11930
+ content: {
11931
+ "application/json": components["schemas"]["ApiErrorDto"];
11932
+ };
11933
+ };
11934
+ /** @description Server or upstream bank error. */
11935
+ "5XX": {
11936
+ headers: {
11937
+ [name: string]: unknown;
11938
+ };
11939
+ content: {
11940
+ "application/json": components["schemas"]["ApiErrorDto"];
11941
+ };
11942
+ };
11943
+ };
11944
+ };
11945
+ PaymentMethods_detach: {
11946
+ parameters: {
11947
+ query?: never;
11948
+ header?: never;
11949
+ path: {
11950
+ id: string;
11951
+ };
11952
+ cookie?: never;
11953
+ };
11954
+ requestBody?: never;
11955
+ responses: {
11956
+ 200: {
11957
+ headers: {
11958
+ [name: string]: unknown;
11959
+ };
11960
+ content: {
11961
+ "application/json": components["schemas"]["PaymentMethodResponseDto"];
11962
+ };
11963
+ };
11964
+ /** @description Missing or invalid tenant API key. */
11965
+ 401: {
11966
+ headers: {
11967
+ [name: string]: unknown;
11968
+ };
11969
+ content: {
11970
+ "application/json": components["schemas"]["ApiErrorDto"];
11971
+ };
11972
+ };
11973
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11974
+ 403: {
11975
+ headers: {
11976
+ [name: string]: unknown;
11977
+ };
11978
+ content: {
11979
+ "application/json": components["schemas"]["ApiErrorDto"];
11980
+ };
11981
+ };
11982
+ 404: {
11983
+ headers: {
11984
+ [name: string]: unknown;
11985
+ };
11986
+ content: {
11987
+ "application/json": components["schemas"]["ApiErrorDto"];
11988
+ };
11989
+ };
11990
+ /** @description Client error. */
11991
+ "4XX": {
11992
+ headers: {
11993
+ [name: string]: unknown;
11994
+ };
11995
+ content: {
11996
+ "application/json": components["schemas"]["ApiErrorDto"];
11997
+ };
11998
+ };
11999
+ /** @description Server or upstream bank error. */
12000
+ "5XX": {
12001
+ headers: {
12002
+ [name: string]: unknown;
12003
+ };
12004
+ content: {
12005
+ "application/json": components["schemas"]["ApiErrorDto"];
12006
+ };
12007
+ };
12008
+ };
12009
+ };
12010
+ PaymentMethods_list: {
12011
+ parameters: {
12012
+ query?: {
12013
+ cursor?: string;
12014
+ limit?: number;
12015
+ };
12016
+ header?: never;
12017
+ path: {
12018
+ id: string;
12019
+ };
12020
+ cookie?: never;
12021
+ };
12022
+ requestBody?: never;
12023
+ responses: {
12024
+ 200: {
12025
+ headers: {
12026
+ [name: string]: unknown;
12027
+ };
12028
+ content: {
12029
+ "application/json": components["schemas"]["PaymentMethodListResponseDto"];
12030
+ };
12031
+ };
12032
+ /** @description Missing or invalid tenant API key. */
12033
+ 401: {
12034
+ headers: {
12035
+ [name: string]: unknown;
12036
+ };
12037
+ content: {
12038
+ "application/json": components["schemas"]["ApiErrorDto"];
12039
+ };
12040
+ };
12041
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
12042
+ 403: {
12043
+ headers: {
12044
+ [name: string]: unknown;
12045
+ };
12046
+ content: {
12047
+ "application/json": components["schemas"]["ApiErrorDto"];
12048
+ };
12049
+ };
12050
+ 404: {
12051
+ headers: {
12052
+ [name: string]: unknown;
12053
+ };
12054
+ content: {
12055
+ "application/json": components["schemas"]["ApiErrorDto"];
12056
+ };
12057
+ };
12058
+ /** @description Client error. */
12059
+ "4XX": {
12060
+ headers: {
12061
+ [name: string]: unknown;
12062
+ };
12063
+ content: {
12064
+ "application/json": components["schemas"]["ApiErrorDto"];
12065
+ };
12066
+ };
12067
+ /** @description Server or upstream bank error. */
12068
+ "5XX": {
12069
+ headers: {
12070
+ [name: string]: unknown;
12071
+ };
12072
+ content: {
12073
+ "application/json": components["schemas"]["ApiErrorDto"];
12074
+ };
12075
+ };
12076
+ };
12077
+ };
12078
+ }
12079
+
12080
+ type CursorPage<Item> = {
12081
+ items: Item[];
12082
+ nextCursor?: string | null;
12083
+ };
12084
+ /**
12085
+ * Result of a cursor-paginated `list()`.
12086
+ *
12087
+ * const page = await vexpay.merchants.list({ limit: 100 }); // first page
12088
+ * for await (const merchant of vexpay.merchants.list()) { … } // every item, all pages
12089
+ *
12090
+ * The first request is sent when the result is awaited or iterated.
12091
+ */
12092
+ declare class PagePromise<Page extends CursorPage<Item>, Item = Page['items'][number]> implements PromiseLike<Page>, AsyncIterable<Item> {
12093
+ private readonly fetchPage;
12094
+ private readonly startCursor?;
12095
+ private firstPage?;
12096
+ constructor(fetchPage: (cursor: string | undefined) => Promise<Page>, startCursor?: string | undefined);
12097
+ private first;
12098
+ then<TResult1 = Page, TResult2 = never>(onfulfilled?: ((value: Page) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
12099
+ catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<Page | TResult>;
12100
+ finally(onfinally?: (() => void) | null): Promise<Page>;
12101
+ [Symbol.asyncIterator](): AsyncIterator<Item>;
12102
+ /** Collects items across pages, stopping after `limit` (default 10 000). */
12103
+ autoPagingToArray({ limit }?: {
12104
+ limit?: number;
12105
+ }): Promise<Item[]>;
12106
+ }
12107
+
12108
+ type OperationId = keyof operations;
12109
+
12110
+ /** Every request/response schema in the VEXPay API, e.g. `Schemas['PaymentReceiptDto']`. */
12111
+ type Schemas = components['schemas'];
12112
+ type Params<O extends OperationId> = operations[O]['parameters'];
12113
+ type PathParams<O extends OperationId> = NonNullable<Params<O>['path']>;
12114
+ type QueryParams<O extends OperationId> = NonNullable<Params<O>['query']>;
12115
+ type RequestBody<O extends OperationId> = operations[O] extends {
9133
12116
  requestBody?: infer RB;
9134
12117
  } ? NonNullable<RB> extends {
9135
12118
  content: {
@@ -9183,30 +12166,145 @@ declare class Quotes extends APIResource {
9183
12166
  [key: string]: unknown;
9184
12167
  };
9185
12168
  }>;
9186
- }
9187
- /** Every movement in your VES balance (payments, fees, payouts, chargebacks, …), newest first. */
9188
- declare class BalanceTransactions extends APIResource {
9189
- /** Await for one page, or `for await` over every movement. The amounts sum to `ledgerNetVes`. */
9190
- list(params?: QueryParams<'Balance_listTransactions'>, options?: RequestOptions): PagePromise<{
9191
- items: components["schemas"]["BalanceTransactionDto"][];
9192
- nextCursor: string | null;
9193
- }, {
12169
+ }
12170
+ /** Every movement in your VES balance (payments, fees, payouts, chargebacks, …), newest first. */
12171
+ declare class BalanceTransactions extends APIResource {
12172
+ /** Await for one page, or `for await` over every movement. The amounts sum to `ledgerNetVes`. */
12173
+ list(params?: QueryParams<'Balance_listTransactions'>, options?: RequestOptions): PagePromise<{
12174
+ items: components["schemas"]["BalanceTransactionDto"][];
12175
+ nextCursor: string | null;
12176
+ }, {
12177
+ id: string;
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";
12179
+ amountVes: string;
12180
+ paymentId?: string;
12181
+ payoutId?: string;
12182
+ chargebackId?: string;
12183
+ merchantId?: string;
12184
+ externalRef?: string;
12185
+ description: string;
12186
+ availableAt?: string;
12187
+ createdAt: string;
12188
+ }>;
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<{
9194
12280
  id: string;
9195
- 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";
12281
+ status: "pending" | "completed" | "expired" | "failed" | "reversed";
9196
12282
  amountVes: string;
9197
- paymentId?: string;
9198
- payoutId?: string;
9199
- chargebackId?: string;
9200
- merchantId?: string;
9201
- externalRef?: string;
9202
- description: 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;
9203
12294
  availableAt?: string;
12295
+ heldVes: string;
12296
+ instantFeePercent: string;
12297
+ instantFeeVes: string;
12298
+ instantReleasedAt?: string;
12299
+ receiver?: components["schemas"]["TopupReceiverDto"];
12300
+ test: boolean;
9204
12301
  createdAt: string;
9205
12302
  }>;
9206
12303
  }
9207
12304
  /** Your platform balance. */
9208
12305
  declare class Balance extends APIResource {
9209
12306
  readonly transactions: BalanceTransactions;
12307
+ readonly topups: BalanceTopups;
9210
12308
  retrieve(options?: RequestOptions): Promise<{
9211
12309
  tenantId: string;
9212
12310
  platformId: string;
@@ -9246,6 +12344,7 @@ declare class Payouts extends APIResource {
9246
12344
  grossMonto?: string;
9247
12345
  feePercent?: string;
9248
12346
  feeVes?: string;
12347
+ feePayer?: "tenant";
9249
12348
  concepto?: string;
9250
12349
  bankCode?: string;
9251
12350
  destination?: string;
@@ -9269,6 +12368,7 @@ declare class Payouts extends APIResource {
9269
12368
  grossMonto?: string;
9270
12369
  feePercent?: string;
9271
12370
  feeVes?: string;
12371
+ feePayer?: "tenant";
9272
12372
  concepto?: string;
9273
12373
  bankCode?: string;
9274
12374
  destination?: string;
@@ -9301,6 +12401,7 @@ declare class Payouts extends APIResource {
9301
12401
  grossMonto?: string;
9302
12402
  feePercent?: string;
9303
12403
  feeVes?: string;
12404
+ feePayer?: "tenant";
9304
12405
  concepto?: string;
9305
12406
  bankCode?: string;
9306
12407
  destination?: string;
@@ -9323,6 +12424,7 @@ declare class Payouts extends APIResource {
9323
12424
  grossMonto?: string;
9324
12425
  feePercent?: string;
9325
12426
  feeVes?: string;
12427
+ feePayer?: "tenant";
9326
12428
  concepto?: string;
9327
12429
  bankCode?: string;
9328
12430
  destination?: string;
@@ -9345,6 +12447,7 @@ declare class Payouts extends APIResource {
9345
12447
  grossMonto?: string;
9346
12448
  feePercent?: string;
9347
12449
  feeVes?: string;
12450
+ feePayer?: "tenant";
9348
12451
  concepto?: string;
9349
12452
  bankCode?: string;
9350
12453
  destination?: string;
@@ -9414,7 +12517,7 @@ declare class WebhookEndpoints extends APIResource {
9414
12517
  id: string;
9415
12518
  tenantId: string;
9416
12519
  url: string;
9417
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
12520
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "customer.created" | "customer.updated" | "customer.deleted" | "customer.subscription.created" | "customer.subscription.updated" | "customer.subscription.deleted" | "customer.subscription.trial_will_end" | "customer.subscription.reactivated" | "invoice.created" | "invoice.upcoming" | "invoice.paid" | "invoice.payment_attempt" | "invoice.payment_failed" | "invoice.overdue" | "invoice.voided" | "invoice.marked_uncollectible" | "payment_method.attached" | "payment_method.updated" | "payment_method.detached" | "notification.test")[];
9418
12521
  isActive: boolean;
9419
12522
  createdAt: string;
9420
12523
  secret?: string;
@@ -9423,7 +12526,7 @@ declare class WebhookEndpoints extends APIResource {
9423
12526
  id: string;
9424
12527
  tenantId: string;
9425
12528
  url: string;
9426
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
12529
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "customer.created" | "customer.updated" | "customer.deleted" | "customer.subscription.created" | "customer.subscription.updated" | "customer.subscription.deleted" | "customer.subscription.trial_will_end" | "customer.subscription.reactivated" | "invoice.created" | "invoice.upcoming" | "invoice.paid" | "invoice.payment_attempt" | "invoice.payment_failed" | "invoice.overdue" | "invoice.voided" | "invoice.marked_uncollectible" | "payment_method.attached" | "payment_method.updated" | "payment_method.detached" | "notification.test")[];
9427
12530
  isActive: boolean;
9428
12531
  createdAt: string;
9429
12532
  secret?: string;
@@ -9432,7 +12535,7 @@ declare class WebhookEndpoints extends APIResource {
9432
12535
  id: string;
9433
12536
  tenantId: string;
9434
12537
  url: string;
9435
- events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "notification.test")[];
12538
+ events: ("payment.pending" | "payment.completed" | "payment.failed" | "payment.canceled" | "payment.reversed" | "payment.chargeback" | "payment.chargeback_closed" | "merchant.verified" | "merchant.rejected" | "merchant.deactivated" | "merchant.reactivated" | "merchant.balance.updated" | "merchant.created" | "merchant.activated" | "merchant.updated" | "merchant.kyb_required" | "merchant.restricted" | "merchant.capability.updated" | "merchant.wallet_credit" | "payout.completed" | "payout.failed" | "conversion.created" | "conversion.completed" | "conversion.canceled" | "onward_payout.updated" | "tenant.status_changed" | "tenant.api_key.created" | "tenant.api_key.rotated" | "tenant.api_key.revoked" | "tenant.live_status_changed" | "customer.created" | "customer.updated" | "customer.deleted" | "customer.subscription.created" | "customer.subscription.updated" | "customer.subscription.deleted" | "customer.subscription.trial_will_end" | "customer.subscription.reactivated" | "invoice.created" | "invoice.upcoming" | "invoice.paid" | "invoice.payment_attempt" | "invoice.payment_failed" | "invoice.overdue" | "invoice.voided" | "invoice.marked_uncollectible" | "payment_method.attached" | "payment_method.updated" | "payment_method.detached" | "notification.test")[];
9436
12539
  isActive: boolean;
9437
12540
  createdAt: string;
9438
12541
  secret?: string;
@@ -9448,6 +12551,499 @@ declare class WebhookEndpoints extends APIResource {
9448
12551
  }>;
9449
12552
  }
9450
12553
 
12554
+ /** A customer's attached domiciliación payment methods. */
12555
+ declare class CustomerPaymentMethods extends APIResource {
12556
+ /** Await for one page, or `for await` over every attached method (newest first). */
12557
+ list(customerId: string, params?: QueryParams<'PaymentMethods_list'>, options?: RequestOptions): PagePromise<{
12558
+ items: components["schemas"]["PaymentMethodResponseDto"][];
12559
+ nextCursor: string | null;
12560
+ }, {
12561
+ id: string;
12562
+ object: string;
12563
+ type: string;
12564
+ customer: string;
12565
+ status: "pending" | "active" | "inactive";
12566
+ phoneLast4: string;
12567
+ bankCode: string;
12568
+ createdAt: string;
12569
+ activatedAt: string | null;
12570
+ deactivatedAt: string | null;
12571
+ detachedAt: string | null;
12572
+ livemode: boolean;
12573
+ }>;
12574
+ }
12575
+ /** Who you bill: subscriptions, invoices and payment methods belong to a customer. */
12576
+ declare class Customers extends APIResource {
12577
+ readonly paymentMethods: CustomerPaymentMethods;
12578
+ /** Pass `idempotencyKey` in options to retry safely. */
12579
+ create(params?: RequestBody<'Customers_create'>, options?: RequestOptions): Promise<{
12580
+ id: string;
12581
+ object: string;
12582
+ name: string | null;
12583
+ email: string | null;
12584
+ emailStatus: "none" | "deliverable" | "undeliverable";
12585
+ phone: string | null;
12586
+ idNumber: string | null;
12587
+ bankCode: string | null;
12588
+ metadata: {
12589
+ [key: string]: string;
12590
+ };
12591
+ testClock: string | null;
12592
+ createdAt: string;
12593
+ livemode: boolean;
12594
+ }>;
12595
+ /** Await for one page, or `for await` over every customer (newest first). Filter with `email`. */
12596
+ list(params?: QueryParams<'Customers_list'>, options?: RequestOptions): PagePromise<{
12597
+ items: components["schemas"]["CustomerResponseDto"][];
12598
+ nextCursor: string | null;
12599
+ }, {
12600
+ id: string;
12601
+ object: string;
12602
+ name: string | null;
12603
+ email: string | null;
12604
+ emailStatus: "none" | "deliverable" | "undeliverable";
12605
+ phone: string | null;
12606
+ idNumber: string | null;
12607
+ bankCode: string | null;
12608
+ metadata: {
12609
+ [key: string]: string;
12610
+ };
12611
+ testClock: string | null;
12612
+ createdAt: string;
12613
+ livemode: boolean;
12614
+ }>;
12615
+ retrieve(id: string, options?: RequestOptions): Promise<{
12616
+ id: string;
12617
+ object: string;
12618
+ name: string | null;
12619
+ email: string | null;
12620
+ emailStatus: "none" | "deliverable" | "undeliverable";
12621
+ phone: string | null;
12622
+ idNumber: string | null;
12623
+ bankCode: string | null;
12624
+ metadata: {
12625
+ [key: string]: string;
12626
+ };
12627
+ testClock: string | null;
12628
+ createdAt: string;
12629
+ livemode: boolean;
12630
+ }>;
12631
+ update(id: string, params: RequestBody<'Customers_update'>, options?: RequestOptions): Promise<{
12632
+ id: string;
12633
+ object: string;
12634
+ name: string | null;
12635
+ email: string | null;
12636
+ emailStatus: "none" | "deliverable" | "undeliverable";
12637
+ phone: string | null;
12638
+ idNumber: string | null;
12639
+ bankCode: string | null;
12640
+ metadata: {
12641
+ [key: string]: string;
12642
+ };
12643
+ testClock: string | null;
12644
+ createdAt: string;
12645
+ livemode: boolean;
12646
+ }>;
12647
+ /** Refused with 409 while the customer has a live subscription. */
12648
+ delete(id: string, options?: RequestOptions): Promise<{
12649
+ id: string;
12650
+ deleted: boolean;
12651
+ }>;
12652
+ }
12653
+ /** Recurring prices (USD per interval) on a product. */
12654
+ declare class Prices extends APIResource {
12655
+ create(params: RequestBody<'Prices_create'>, options?: RequestOptions): Promise<{
12656
+ id: string;
12657
+ object: string;
12658
+ product: string;
12659
+ unitAmountUsd: string;
12660
+ currency: string;
12661
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
12662
+ nickname: string | null;
12663
+ active: boolean;
12664
+ metadata: {
12665
+ [key: string]: string;
12666
+ };
12667
+ createdAt: string;
12668
+ livemode: boolean;
12669
+ }>;
12670
+ /** Await for one page, or `for await` over every price. Filter with `product` and `active`. */
12671
+ list(params?: QueryParams<'Prices_list'>, options?: RequestOptions): PagePromise<{
12672
+ items: components["schemas"]["PriceResponseDto"][];
12673
+ nextCursor: string | null;
12674
+ }, {
12675
+ id: string;
12676
+ object: string;
12677
+ product: string;
12678
+ unitAmountUsd: string;
12679
+ currency: string;
12680
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
12681
+ nickname: string | null;
12682
+ active: boolean;
12683
+ metadata: {
12684
+ [key: string]: string;
12685
+ };
12686
+ createdAt: string;
12687
+ livemode: boolean;
12688
+ }>;
12689
+ retrieve(id: string, options?: RequestOptions): Promise<{
12690
+ id: string;
12691
+ object: string;
12692
+ product: string;
12693
+ unitAmountUsd: string;
12694
+ currency: string;
12695
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
12696
+ nickname: string | null;
12697
+ active: boolean;
12698
+ metadata: {
12699
+ [key: string]: string;
12700
+ };
12701
+ createdAt: string;
12702
+ livemode: boolean;
12703
+ }>;
12704
+ /** Only `active`, `nickname` and `metadata` can change; create a new price for a new amount. */
12705
+ update(id: string, params: RequestBody<'Prices_update'>, options?: RequestOptions): Promise<{
12706
+ id: string;
12707
+ object: string;
12708
+ product: string;
12709
+ unitAmountUsd: string;
12710
+ currency: string;
12711
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
12712
+ nickname: string | null;
12713
+ active: boolean;
12714
+ metadata: {
12715
+ [key: string]: string;
12716
+ };
12717
+ createdAt: string;
12718
+ livemode: boolean;
12719
+ }>;
12720
+ }
12721
+ /** Bill a customer on a price every interval. */
12722
+ declare class Subscriptions extends APIResource {
12723
+ /** Pass `idempotencyKey` in options to retry safely. */
12724
+ create(params: RequestBody<'Subscriptions_create'>, options?: RequestOptions): Promise<{
12725
+ id: string;
12726
+ object: string;
12727
+ customer: string;
12728
+ price: components["schemas"]["PriceResponseDto"];
12729
+ status: "trialing" | "active" | "past_due" | "canceled";
12730
+ collectionMethod: "send_invoice" | "charge_automatically";
12731
+ collectionAttempts: number | null;
12732
+ paymentMethod: string | null;
12733
+ currentPeriodStart: string;
12734
+ currentPeriodEnd: string;
12735
+ trialStart: string | null;
12736
+ trialEnd: string | null;
12737
+ cancelAtPeriodEnd: boolean;
12738
+ canceledAt: string | null;
12739
+ cancellationReason: "requested" | "payment_failed" | null;
12740
+ latestInvoice: string | null;
12741
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
12742
+ metadata: {
12743
+ [key: string]: string;
12744
+ };
12745
+ createdAt: string;
12746
+ livemode: boolean;
12747
+ }>;
12748
+ /** Await for one page, or `for await` over every subscription (newest first). Filter with `customer`, `price`, `status`. */
12749
+ list(params?: QueryParams<'Subscriptions_list'>, options?: RequestOptions): PagePromise<{
12750
+ items: components["schemas"]["SubscriptionResponseDto"][];
12751
+ nextCursor: string | null;
12752
+ }, {
12753
+ id: string;
12754
+ object: string;
12755
+ customer: string;
12756
+ price: components["schemas"]["PriceResponseDto"];
12757
+ status: "trialing" | "active" | "past_due" | "canceled";
12758
+ collectionMethod: "send_invoice" | "charge_automatically";
12759
+ collectionAttempts: number | null;
12760
+ paymentMethod: string | null;
12761
+ currentPeriodStart: string;
12762
+ currentPeriodEnd: string;
12763
+ trialStart: string | null;
12764
+ trialEnd: string | null;
12765
+ cancelAtPeriodEnd: boolean;
12766
+ canceledAt: string | null;
12767
+ cancellationReason: "requested" | "payment_failed" | null;
12768
+ latestInvoice: string | null;
12769
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
12770
+ metadata: {
12771
+ [key: string]: string;
12772
+ };
12773
+ createdAt: string;
12774
+ livemode: boolean;
12775
+ }>;
12776
+ retrieve(id: string, options?: RequestOptions): Promise<{
12777
+ id: string;
12778
+ object: string;
12779
+ customer: string;
12780
+ price: components["schemas"]["PriceResponseDto"];
12781
+ status: "trialing" | "active" | "past_due" | "canceled";
12782
+ collectionMethod: "send_invoice" | "charge_automatically";
12783
+ collectionAttempts: number | null;
12784
+ paymentMethod: string | null;
12785
+ currentPeriodStart: string;
12786
+ currentPeriodEnd: string;
12787
+ trialStart: string | null;
12788
+ trialEnd: string | null;
12789
+ cancelAtPeriodEnd: boolean;
12790
+ canceledAt: string | null;
12791
+ cancellationReason: "requested" | "payment_failed" | null;
12792
+ latestInvoice: string | null;
12793
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
12794
+ metadata: {
12795
+ [key: string]: string;
12796
+ };
12797
+ createdAt: string;
12798
+ livemode: boolean;
12799
+ }>;
12800
+ /** Changes apply from the next invoice. Set `cancelAtPeriodEnd` to cancel when the period ends. */
12801
+ update(id: string, params: RequestBody<'Subscriptions_update'>, options?: RequestOptions): Promise<{
12802
+ id: string;
12803
+ object: string;
12804
+ customer: string;
12805
+ price: components["schemas"]["PriceResponseDto"];
12806
+ status: "trialing" | "active" | "past_due" | "canceled";
12807
+ collectionMethod: "send_invoice" | "charge_automatically";
12808
+ collectionAttempts: number | null;
12809
+ paymentMethod: string | null;
12810
+ currentPeriodStart: string;
12811
+ currentPeriodEnd: string;
12812
+ trialStart: string | null;
12813
+ trialEnd: string | null;
12814
+ cancelAtPeriodEnd: boolean;
12815
+ canceledAt: string | null;
12816
+ cancellationReason: "requested" | "payment_failed" | null;
12817
+ latestInvoice: string | null;
12818
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
12819
+ metadata: {
12820
+ [key: string]: string;
12821
+ };
12822
+ createdAt: string;
12823
+ livemode: boolean;
12824
+ }>;
12825
+ /** Cancel now; its open invoices are voided. */
12826
+ cancel(id: string, options?: RequestOptions): Promise<{
12827
+ id: string;
12828
+ object: string;
12829
+ customer: string;
12830
+ price: components["schemas"]["PriceResponseDto"];
12831
+ status: "trialing" | "active" | "past_due" | "canceled";
12832
+ collectionMethod: "send_invoice" | "charge_automatically";
12833
+ collectionAttempts: number | null;
12834
+ paymentMethod: string | null;
12835
+ currentPeriodStart: string;
12836
+ currentPeriodEnd: string;
12837
+ trialStart: string | null;
12838
+ trialEnd: string | null;
12839
+ cancelAtPeriodEnd: boolean;
12840
+ canceledAt: string | null;
12841
+ cancellationReason: "requested" | "payment_failed" | null;
12842
+ latestInvoice: string | null;
12843
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
12844
+ metadata: {
12845
+ [key: string]: string;
12846
+ };
12847
+ createdAt: string;
12848
+ livemode: boolean;
12849
+ }>;
12850
+ }
12851
+ /** What a subscription bills each period. */
12852
+ declare class Invoices extends APIResource {
12853
+ /** Await for one page, or `for await` over every invoice (newest first). Filter with `customer`, `subscription`, `status`. */
12854
+ list(params?: QueryParams<'Invoices_list'>, options?: RequestOptions): PagePromise<{
12855
+ items: components["schemas"]["InvoiceResponseDto"][];
12856
+ nextCursor: string | null;
12857
+ }, {
12858
+ id: string;
12859
+ object: string;
12860
+ number: string;
12861
+ status: "open" | "paid" | "void" | "uncollectible";
12862
+ customer: string;
12863
+ subscription: string;
12864
+ collectionMethod: "send_invoice" | "charge_automatically";
12865
+ amountDueUsd: string;
12866
+ amountPaidUsd: string;
12867
+ currency: string;
12868
+ periodStart: string;
12869
+ periodEnd: string;
12870
+ dueDate: string;
12871
+ attemptsTotal: number;
12872
+ attemptCount: number;
12873
+ nextPaymentAttempt: string | null;
12874
+ paidAt: string | null;
12875
+ paidOutOfBand: boolean;
12876
+ paymentId: string | null;
12877
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
12878
+ hostedInvoiceUrl: string | null;
12879
+ createdAt: string;
12880
+ livemode: boolean;
12881
+ }>;
12882
+ retrieve(id: string, options?: RequestOptions): Promise<{
12883
+ id: string;
12884
+ object: string;
12885
+ number: string;
12886
+ status: "open" | "paid" | "void" | "uncollectible";
12887
+ customer: string;
12888
+ subscription: string;
12889
+ collectionMethod: "send_invoice" | "charge_automatically";
12890
+ amountDueUsd: string;
12891
+ amountPaidUsd: string;
12892
+ currency: string;
12893
+ periodStart: string;
12894
+ periodEnd: string;
12895
+ dueDate: string;
12896
+ attemptsTotal: number;
12897
+ attemptCount: number;
12898
+ nextPaymentAttempt: string | null;
12899
+ paidAt: string | null;
12900
+ paidOutOfBand: boolean;
12901
+ paymentId: string | null;
12902
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
12903
+ hostedInvoiceUrl: string | null;
12904
+ createdAt: string;
12905
+ livemode: boolean;
12906
+ }>;
12907
+ /** Void an open invoice. */
12908
+ void(id: string, options?: RequestOptions): Promise<{
12909
+ id: string;
12910
+ object: string;
12911
+ number: string;
12912
+ status: "open" | "paid" | "void" | "uncollectible";
12913
+ customer: string;
12914
+ subscription: string;
12915
+ collectionMethod: "send_invoice" | "charge_automatically";
12916
+ amountDueUsd: string;
12917
+ amountPaidUsd: string;
12918
+ currency: string;
12919
+ periodStart: string;
12920
+ periodEnd: string;
12921
+ dueDate: string;
12922
+ attemptsTotal: number;
12923
+ attemptCount: number;
12924
+ nextPaymentAttempt: string | null;
12925
+ paidAt: string | null;
12926
+ paidOutOfBand: boolean;
12927
+ paymentId: string | null;
12928
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
12929
+ hostedInvoiceUrl: string | null;
12930
+ createdAt: string;
12931
+ livemode: boolean;
12932
+ }>;
12933
+ /** Stop chasing an open invoice; it can still be paid. */
12934
+ markUncollectible(id: string, options?: RequestOptions): Promise<{
12935
+ id: string;
12936
+ object: string;
12937
+ number: string;
12938
+ status: "open" | "paid" | "void" | "uncollectible";
12939
+ customer: string;
12940
+ subscription: string;
12941
+ collectionMethod: "send_invoice" | "charge_automatically";
12942
+ amountDueUsd: string;
12943
+ amountPaidUsd: string;
12944
+ currency: string;
12945
+ periodStart: string;
12946
+ periodEnd: string;
12947
+ dueDate: string;
12948
+ attemptsTotal: number;
12949
+ attemptCount: number;
12950
+ nextPaymentAttempt: string | null;
12951
+ paidAt: string | null;
12952
+ paidOutOfBand: boolean;
12953
+ paymentId: string | null;
12954
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
12955
+ hostedInvoiceUrl: string | null;
12956
+ createdAt: string;
12957
+ livemode: boolean;
12958
+ }>;
12959
+ /** Record an open invoice as paid outside VEXPay (`paidOutOfBand: true`); no money moves. */
12960
+ pay(id: string, params: RequestBody<'Invoices_pay'>, options?: RequestOptions): Promise<{
12961
+ id: string;
12962
+ object: string;
12963
+ number: string;
12964
+ status: "open" | "paid" | "void" | "uncollectible";
12965
+ customer: string;
12966
+ subscription: string;
12967
+ collectionMethod: "send_invoice" | "charge_automatically";
12968
+ amountDueUsd: string;
12969
+ amountPaidUsd: string;
12970
+ currency: string;
12971
+ periodStart: string;
12972
+ periodEnd: string;
12973
+ dueDate: string;
12974
+ attemptsTotal: number;
12975
+ attemptCount: number;
12976
+ nextPaymentAttempt: string | null;
12977
+ paidAt: string | null;
12978
+ paidOutOfBand: boolean;
12979
+ paymentId: string | null;
12980
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
12981
+ hostedInvoiceUrl: string | null;
12982
+ createdAt: string;
12983
+ livemode: boolean;
12984
+ }>;
12985
+ }
12986
+ /** A hosted link where a customer authorizes domiciliación (expires in 24 h). */
12987
+ declare class SetupSessions extends APIResource {
12988
+ /** `url` is returned only here — send it to the customer. */
12989
+ create(params: RequestBody<'SetupSessions_create'>, options?: RequestOptions): Promise<{
12990
+ id: string;
12991
+ object: string;
12992
+ url: string | null;
12993
+ customer: string;
12994
+ status: "open" | "complete" | "expired";
12995
+ paymentMethod: string | null;
12996
+ successUrl: string | null;
12997
+ expiresAt: string;
12998
+ createdAt: string;
12999
+ livemode: boolean;
13000
+ }>;
13001
+ retrieve(id: string, options?: RequestOptions): Promise<{
13002
+ id: string;
13003
+ object: string;
13004
+ url: string | null;
13005
+ customer: string;
13006
+ status: "open" | "complete" | "expired";
13007
+ paymentMethod: string | null;
13008
+ successUrl: string | null;
13009
+ expiresAt: string;
13010
+ createdAt: string;
13011
+ livemode: boolean;
13012
+ }>;
13013
+ }
13014
+ /** Domiciliación payment methods. List a customer's with `customers.paymentMethods.list()`. */
13015
+ declare class PaymentMethods extends APIResource {
13016
+ retrieve(id: string, options?: RequestOptions): Promise<{
13017
+ id: string;
13018
+ object: string;
13019
+ type: string;
13020
+ customer: string;
13021
+ status: "pending" | "active" | "inactive";
13022
+ phoneLast4: string;
13023
+ bankCode: string;
13024
+ createdAt: string;
13025
+ activatedAt: string | null;
13026
+ deactivatedAt: string | null;
13027
+ detachedAt: string | null;
13028
+ livemode: boolean;
13029
+ }>;
13030
+ /** The method is never charged again. */
13031
+ detach(id: string, options?: RequestOptions): Promise<{
13032
+ id: string;
13033
+ object: string;
13034
+ type: string;
13035
+ customer: string;
13036
+ status: "pending" | "active" | "inactive";
13037
+ phoneLast4: string;
13038
+ bankCode: string;
13039
+ createdAt: string;
13040
+ activatedAt: string | null;
13041
+ deactivatedAt: string | null;
13042
+ detachedAt: string | null;
13043
+ livemode: boolean;
13044
+ }>;
13045
+ }
13046
+
9451
13047
  /** Single-purchase checkouts: redirect to `url`, or embed with @vexpay/js using `clientSecret`. */
9452
13048
  declare class CheckoutSessions extends APIResource {
9453
13049
  /** `clientSecret` is returned only here — hand it to the browser, never store or log it. */
@@ -9734,21 +13330,24 @@ declare class Conversions extends APIResource {
9734
13330
  }
9735
13331
 
9736
13332
  /**
9737
- * Colombian peso payments: Bre-B (QR / transfer key), Nequi (push approval) or Daviplata (SMS
9738
- * code). Payments complete asynchronously — listen for `payment.completed` / `payment.failed`.
9739
- * COP must be enabled on your account (403 `method_not_allowed` otherwise).
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).
9740
13337
  */
9741
13338
  declare class CopPayments extends APIResource {
9742
13339
  /**
9743
- * Create a payment in whole pesos. `buyer` is required for `nequi` and `daviplata`. The response
9744
- * `next` says what the buyer does: `show_qr`, `approve_in_app` or `submit_otp`.
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).
9745
13344
  * Pass `idempotencyKey` in options to retry safely.
9746
13345
  */
9747
13346
  create(params: RequestBody<'CopPayments_create'>, options?: RequestOptions): Promise<{
9748
13347
  id: string;
9749
13348
  status: "pending" | "completed" | "failed" | "canceled" | "refunded";
9750
13349
  method: "COP";
9751
- channel: "breb" | "nequi" | "daviplata";
13350
+ channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
9752
13351
  amountCop: number;
9753
13352
  feeCop?: number;
9754
13353
  amountUsd?: string;
@@ -9757,17 +13356,18 @@ declare class CopPayments extends APIResource {
9757
13356
  metadata: {
9758
13357
  [key: string]: string;
9759
13358
  };
9760
- failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
13359
+ failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
9761
13360
  expiresAt?: string;
9762
13361
  createdAt: string;
9763
13362
  completedAt?: string;
9764
13363
  next?: components["schemas"]["CopNextActionDto"];
13364
+ card?: Record<string, never>;
9765
13365
  }>;
9766
13366
  retrieve(id: string, options?: RequestOptions): Promise<{
9767
13367
  id: string;
9768
13368
  status: "pending" | "completed" | "failed" | "canceled" | "refunded";
9769
13369
  method: "COP";
9770
- channel: "breb" | "nequi" | "daviplata";
13370
+ channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
9771
13371
  amountCop: number;
9772
13372
  feeCop?: number;
9773
13373
  amountUsd?: string;
@@ -9776,18 +13376,19 @@ declare class CopPayments extends APIResource {
9776
13376
  metadata: {
9777
13377
  [key: string]: string;
9778
13378
  };
9779
- failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
13379
+ failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
9780
13380
  expiresAt?: string;
9781
13381
  createdAt: string;
9782
13382
  completedAt?: string;
9783
13383
  next?: components["schemas"]["CopNextActionDto"];
13384
+ card?: Record<string, never>;
9784
13385
  }>;
9785
- /** 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`. */
9786
13387
  submitOtp(id: string, params: RequestBody<'CopPayments_submitOtp'>, options?: RequestOptions): Promise<{
9787
13388
  id: string;
9788
13389
  status: "pending" | "completed" | "failed" | "canceled" | "refunded";
9789
13390
  method: "COP";
9790
- channel: "breb" | "nequi" | "daviplata";
13391
+ channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
9791
13392
  amountCop: number;
9792
13393
  feeCop?: number;
9793
13394
  amountUsd?: string;
@@ -9796,18 +13397,19 @@ declare class CopPayments extends APIResource {
9796
13397
  metadata: {
9797
13398
  [key: string]: string;
9798
13399
  };
9799
- failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
13400
+ failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
9800
13401
  expiresAt?: string;
9801
13402
  createdAt: string;
9802
13403
  completedAt?: string;
9803
13404
  next?: components["schemas"]["CopNextActionDto"];
13405
+ card?: Record<string, never>;
9804
13406
  }>;
9805
13407
  /** Cancel a pending payment. */
9806
13408
  cancel(id: string, options?: RequestOptions): Promise<{
9807
13409
  id: string;
9808
13410
  status: "pending" | "completed" | "failed" | "canceled" | "refunded";
9809
13411
  method: "COP";
9810
- channel: "breb" | "nequi" | "daviplata";
13412
+ channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
9811
13413
  amountCop: number;
9812
13414
  feeCop?: number;
9813
13415
  amountUsd?: string;
@@ -9816,18 +13418,22 @@ declare class CopPayments extends APIResource {
9816
13418
  metadata: {
9817
13419
  [key: string]: string;
9818
13420
  };
9819
- failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
13421
+ failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
9820
13422
  expiresAt?: string;
9821
13423
  createdAt: string;
9822
13424
  completedAt?: string;
9823
13425
  next?: components["schemas"]["CopNextActionDto"];
13426
+ card?: Record<string, never>;
9824
13427
  }>;
9825
- /** Full refund of a completed payment, within 96 hours. */
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
+ */
9826
13432
  refund(id: string, options?: RequestOptions): Promise<{
9827
13433
  id: string;
9828
13434
  status: "pending" | "completed" | "failed" | "canceled" | "refunded";
9829
13435
  method: "COP";
9830
- channel: "breb" | "nequi" | "daviplata";
13436
+ channel: "breb" | "nequi" | "daviplata" | "card" | "pse" | "bancolombia_transfer" | "bancolombia_qr";
9831
13437
  amountCop: number;
9832
13438
  feeCop?: number;
9833
13439
  amountUsd?: string;
@@ -9836,11 +13442,12 @@ declare class CopPayments extends APIResource {
9836
13442
  metadata: {
9837
13443
  [key: string]: string;
9838
13444
  };
9839
- failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
13445
+ failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
9840
13446
  expiresAt?: string;
9841
13447
  createdAt: string;
9842
13448
  completedAt?: string;
9843
13449
  next?: components["schemas"]["CopNextActionDto"];
13450
+ card?: Record<string, never>;
9844
13451
  }>;
9845
13452
  }
9846
13453
  /** Your COP balance, in whole pesos. Kept apart from VES and stablecoins. */
@@ -9853,10 +13460,16 @@ declare class CopBalance extends APIResource {
9853
13460
  asOf: string;
9854
13461
  }>;
9855
13462
  }
9856
- /** Collect Colombian pesos (Bre-B, Nequi, Daviplata). */
13463
+ /** Collect Colombian pesos (PSE, Bancolombia, Bre-B, Nequi, Daviplata; cards via the hosted checkout). */
9857
13464
  declare class Cop extends APIResource {
9858
13465
  readonly payments: CopPayments;
9859
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
+ }>;
9860
13473
  }
9861
13474
 
9862
13475
  /** One stablecoin balance (`currency`: USDT by default, or USDC). Never converted to VES. */
@@ -9963,6 +13576,8 @@ declare class Crypto extends APIResource {
9963
13576
  }
9964
13577
 
9965
13578
  type MerchantListParams = Omit<QueryParams<'Merchants_listOrGetByRef'>, 'externalRef'>;
13579
+ type MerchantTransactionListParams = QueryParams<'Merchants_listTransactions'>;
13580
+ type MerchantStatementParams = Omit<QueryParams<'Merchants_statement'>, 'format'>;
9966
13581
  /** Where a merchant gets paid (bank account or Pago Móvil). */
9967
13582
  declare class PayoutMethods extends APIResource {
9968
13583
  list(merchantId: string, options?: RequestOptions): Promise<{
@@ -10143,7 +13758,11 @@ declare class Merchants extends APIResource {
10143
13758
  ledgerNetVes: string;
10144
13759
  cop?: components["schemas"]["MerchantCopBalanceDto"];
10145
13760
  }>;
10146
- /** Move VES between this merchant's balance and another. */
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
+ */
10147
13766
  transfer(id: string, params: RequestBody<'Merchants_transfer'>, options?: RequestOptions): Promise<{
10148
13767
  merchantId: string;
10149
13768
  accountId: string;
@@ -10153,7 +13772,39 @@ declare class Merchants extends APIResource {
10153
13772
  paidOutVes: string;
10154
13773
  ledgerNetVes: string;
10155
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"][];
10156
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>;
10157
13808
  listAuditEvents(id: string, options?: RequestOptions): Promise<{
10158
13809
  items: components["schemas"]["MerchantAuditEventDto"][];
10159
13810
  }>;
@@ -10534,7 +14185,7 @@ declare class Payments extends APIResource {
10534
14185
  }>;
10535
14186
  }
10536
14187
 
10537
- declare const WEBHOOK_EVENT_NAMES: readonly ["payment.pending", "payment.completed", "payment.failed", "payment.canceled", "payment.reversed", "payment.chargeback", "payment.chargeback_closed", "merchant.verified", "merchant.rejected", "merchant.deactivated", "merchant.reactivated", "merchant.balance.updated", "merchant.created", "merchant.activated", "merchant.updated", "merchant.kyb_required", "merchant.restricted", "merchant.capability.updated", "merchant.wallet_credit", "payout.completed", "payout.failed", "conversion.created", "conversion.completed", "conversion.canceled", "onward_payout.updated", "tenant.status_changed", "tenant.api_key.created", "tenant.api_key.rotated", "tenant.api_key.revoked", "tenant.live_status_changed", "notification.test"];
14188
+ declare const WEBHOOK_EVENT_NAMES: readonly ["payment.pending", "payment.completed", "payment.failed", "payment.canceled", "payment.reversed", "payment.chargeback", "payment.chargeback_closed", "merchant.verified", "merchant.rejected", "merchant.deactivated", "merchant.reactivated", "merchant.balance.updated", "merchant.created", "merchant.activated", "merchant.updated", "merchant.kyb_required", "merchant.restricted", "merchant.capability.updated", "merchant.wallet_credit", "payout.completed", "payout.failed", "conversion.created", "conversion.completed", "conversion.canceled", "onward_payout.updated", "tenant.status_changed", "tenant.api_key.created", "tenant.api_key.rotated", "tenant.api_key.revoked", "tenant.live_status_changed", "customer.created", "customer.updated", "customer.deleted", "customer.subscription.created", "customer.subscription.updated", "customer.subscription.deleted", "customer.subscription.trial_will_end", "customer.subscription.reactivated", "invoice.created", "invoice.upcoming", "invoice.paid", "invoice.payment_attempt", "invoice.payment_failed", "invoice.overdue", "invoice.voided", "invoice.marked_uncollectible", "payment_method.attached", "payment_method.updated", "payment_method.detached", "notification.test"];
10538
14189
  type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];
10539
14190
  /** `data` of every `payment.*` event. */
10540
14191
  interface PaymentWebhookData {
@@ -10589,15 +14240,22 @@ interface CopPaymentWebhookData {
10589
14240
  method: 'COP';
10590
14241
  currency: 'COP';
10591
14242
  status: 'pending' | 'completed' | 'failed' | 'canceled' | 'refunded';
10592
- channel: 'breb' | 'nequi' | 'daviplata';
14243
+ channel: 'breb' | 'nequi' | 'daviplata' | 'card' | 'pse' | 'bancolombia_transfer' | 'bancolombia_qr';
10593
14244
  amountCop: number;
14245
+ /** Card payments: brand and last 4 digits. */
14246
+ card?: {
14247
+ brand: string;
14248
+ last4: string;
14249
+ };
10594
14250
  feeCop?: number;
10595
14251
  amountUsd?: string;
10596
14252
  copRate?: string;
10597
14253
  reference?: string;
10598
14254
  externalRef?: string;
10599
14255
  metadata: Record<string, string>;
10600
- 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';
10601
14259
  expiresAt?: string;
10602
14260
  createdAt: string;
10603
14261
  completedAt?: string;
@@ -10673,6 +14331,17 @@ declare class VexPay {
10673
14331
  readonly paymentLinks: PaymentLinks;
10674
14332
  readonly tenantPayoutAccount: TenantPayoutAccount;
10675
14333
  readonly webhookEndpoints: WebhookEndpoints;
14334
+ /** Billing: who you bill. */
14335
+ readonly customers: Customers;
14336
+ /** Billing: recurring prices on products. */
14337
+ readonly prices: Prices;
14338
+ /** Billing: bill a customer on a price every interval. */
14339
+ readonly subscriptions: Subscriptions;
14340
+ readonly invoices: Invoices;
14341
+ /** Billing: hosted links where a customer authorizes domiciliación. */
14342
+ readonly setupSessions: SetupSessions;
14343
+ /** Billing: domiciliación payment methods (bolívar methods your account takes: `payments.methods()`). */
14344
+ readonly paymentMethods: PaymentMethods;
10676
14345
  /** Offline helpers: `constructEvent` verifies deliveries; no API calls. */
10677
14346
  readonly webhooks: Webhooks;
10678
14347
  constructor(apiKey: string, options?: VexPayOptions);
@@ -10726,6 +14395,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
10726
14395
  declare class VexPaySignatureVerificationError extends VexPayError {
10727
14396
  }
10728
14397
 
10729
- declare const VERSION = "0.11.0";
14398
+ declare const VERSION = "0.13.0";
10730
14399
 
10731
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 };