@vexpay/node 0.11.0 → 0.12.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.cts CHANGED
@@ -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
  };
@@ -2535,6 +2535,326 @@ interface components {
2535
2535
  /** Format: uuid */
2536
2536
  tenantId: string;
2537
2537
  };
2538
+ CreateCustomerDto: {
2539
+ /** @example Ana Pérez */
2540
+ name?: string | null;
2541
+ /** @example ana@example.com */
2542
+ email?: string | null;
2543
+ /**
2544
+ * @description Venezuelan mobile; stored as 11 digits starting with 04.
2545
+ * @example 04141234567
2546
+ */
2547
+ phone?: string | null;
2548
+ /**
2549
+ * @description Cédula or RIF; stored canonical, e.g. V12345678.
2550
+ * @example V-12.345.678
2551
+ */
2552
+ idNumber?: string | null;
2553
+ /**
2554
+ * @description 4-digit bank code from GET /v1/banks.
2555
+ * @example 0102
2556
+ */
2557
+ bankCode?: string | null;
2558
+ /** @description ≤ 20 string key/value pairs. */
2559
+ metadata?: {
2560
+ [key: string]: string;
2561
+ } | null;
2562
+ /** @description Test clock id (test mode only). Not available yet. */
2563
+ testClock?: string;
2564
+ };
2565
+ CustomerResponseDto: {
2566
+ /** @example cus_3fd84b2d9ad14f74a2d90f2f56984db5 */
2567
+ id: string;
2568
+ /** @example customer */
2569
+ object: string;
2570
+ name: string | null;
2571
+ email: string | null;
2572
+ /** @enum {string} */
2573
+ emailStatus: "none" | "deliverable" | "undeliverable";
2574
+ phone: string | null;
2575
+ idNumber: string | null;
2576
+ bankCode: string | null;
2577
+ metadata: {
2578
+ [key: string]: string;
2579
+ };
2580
+ testClock: string | null;
2581
+ createdAt: string;
2582
+ livemode: boolean;
2583
+ };
2584
+ CustomerListResponseDto: {
2585
+ items: components["schemas"]["CustomerResponseDto"][];
2586
+ nextCursor: string | null;
2587
+ };
2588
+ UpdateCustomerDto: {
2589
+ /** @example Ana Pérez */
2590
+ name?: string | null;
2591
+ /** @example ana@example.com */
2592
+ email?: string | null;
2593
+ /**
2594
+ * @description Venezuelan mobile; stored as 11 digits starting with 04.
2595
+ * @example 04141234567
2596
+ */
2597
+ phone?: string | null;
2598
+ /**
2599
+ * @description Cédula or RIF; stored canonical, e.g. V12345678.
2600
+ * @example V-12.345.678
2601
+ */
2602
+ idNumber?: string | null;
2603
+ /**
2604
+ * @description 4-digit bank code from GET /v1/banks.
2605
+ * @example 0102
2606
+ */
2607
+ bankCode?: string | null;
2608
+ /** @description ≤ 20 string key/value pairs. */
2609
+ metadata?: {
2610
+ [key: string]: string;
2611
+ } | null;
2612
+ /** @description Test clock id (test mode only). Not available yet. */
2613
+ testClock?: string;
2614
+ };
2615
+ DeletedObjectResponseDto: {
2616
+ id: string;
2617
+ /** @example true */
2618
+ deleted: boolean;
2619
+ };
2620
+ RecurringDto: {
2621
+ /**
2622
+ * @example month
2623
+ * @enum {string}
2624
+ */
2625
+ interval: "day" | "week" | "month" | "year";
2626
+ /**
2627
+ * @description The whole interval is at most one year.
2628
+ * @default 1
2629
+ * @example 1
2630
+ */
2631
+ intervalCount?: number;
2632
+ };
2633
+ CreatePriceDto: {
2634
+ /** @description Product id. */
2635
+ product: string;
2636
+ /**
2637
+ * @description USD amount, up to 2 decimals, at least the minimum charge.
2638
+ * @example 10
2639
+ */
2640
+ unitAmountUsd: number;
2641
+ recurring: components["schemas"]["RecurringDto"];
2642
+ nickname?: string;
2643
+ metadata?: {
2644
+ [key: string]: string;
2645
+ };
2646
+ };
2647
+ PriceRecurringResponseDto: {
2648
+ /** @enum {string} */
2649
+ interval: "day" | "week" | "month" | "year";
2650
+ intervalCount: number;
2651
+ };
2652
+ PriceResponseDto: {
2653
+ /** @example price_3fd84b2d9ad14f74a2d90f2f56984db5 */
2654
+ id: string;
2655
+ /** @example price */
2656
+ object: string;
2657
+ product: string;
2658
+ /** @example 10.00 */
2659
+ unitAmountUsd: string;
2660
+ /** @example USD */
2661
+ currency: string;
2662
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
2663
+ nickname: string | null;
2664
+ active: boolean;
2665
+ metadata: {
2666
+ [key: string]: string;
2667
+ };
2668
+ createdAt: string;
2669
+ livemode: boolean;
2670
+ };
2671
+ PriceListResponseDto: {
2672
+ items: components["schemas"]["PriceResponseDto"][];
2673
+ nextCursor: string | null;
2674
+ };
2675
+ UpdatePriceDto: {
2676
+ active?: boolean;
2677
+ nickname?: string | null;
2678
+ metadata?: {
2679
+ [key: string]: string;
2680
+ };
2681
+ };
2682
+ CreateSubscriptionDto: {
2683
+ /** @description Customer id (cus_…). */
2684
+ customer: string;
2685
+ /** @description Active recurring price id (price_…). */
2686
+ price: string;
2687
+ /**
2688
+ * @description `charge_automatically` charges the customer's domiciliación on each collection attempt; the tenant must be allowed domiciliación.
2689
+ * @default send_invoice
2690
+ * @enum {string}
2691
+ */
2692
+ collectionMethod?: "send_invoice" | "charge_automatically";
2693
+ /** @description Daily collection attempts on each invoice before the subscription is canceled. Omit or null for the tenant's default (3 unless changed). */
2694
+ collectionAttempts?: number | null;
2695
+ /** @description Domiciliación payment method (pm_…, charge_automatically only). Default: the customer's most recent method that is not inactive. */
2696
+ paymentMethod?: string;
2697
+ trialPeriodDays?: number;
2698
+ /** @description ISO time in the future when the trial ends. */
2699
+ trialEnd?: string;
2700
+ /** @default false */
2701
+ cancelAtPeriodEnd?: boolean;
2702
+ /** @description Hosted checkout methods offered on its invoices. */
2703
+ methods?: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
2704
+ metadata?: {
2705
+ [key: string]: string;
2706
+ };
2707
+ };
2708
+ SubscriptionResponseDto: {
2709
+ /** @example sub_3fd84b2d9ad14f74a2d90f2f56984db5 */
2710
+ id: string;
2711
+ /** @example subscription */
2712
+ object: string;
2713
+ customer: string;
2714
+ price: components["schemas"]["PriceResponseDto"];
2715
+ /** @enum {string} */
2716
+ status: "trialing" | "active" | "past_due" | "canceled";
2717
+ /** @enum {string} */
2718
+ collectionMethod: "send_invoice" | "charge_automatically";
2719
+ /** @description Null = the tenant's default. */
2720
+ collectionAttempts: number | null;
2721
+ paymentMethod: string | null;
2722
+ currentPeriodStart: string;
2723
+ currentPeriodEnd: string;
2724
+ trialStart: string | null;
2725
+ trialEnd: string | null;
2726
+ cancelAtPeriodEnd: boolean;
2727
+ canceledAt: string | null;
2728
+ /** @enum {string|null} */
2729
+ cancellationReason: "requested" | "payment_failed" | null;
2730
+ latestInvoice: string | null;
2731
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
2732
+ metadata: {
2733
+ [key: string]: string;
2734
+ };
2735
+ createdAt: string;
2736
+ livemode: boolean;
2737
+ };
2738
+ SubscriptionListResponseDto: {
2739
+ items: components["schemas"]["SubscriptionResponseDto"][];
2740
+ nextCursor: string | null;
2741
+ };
2742
+ UpdateSubscriptionDto: {
2743
+ cancelAtPeriodEnd?: boolean;
2744
+ /** @enum {string} */
2745
+ collectionMethod?: "send_invoice" | "charge_automatically";
2746
+ paymentMethod?: string;
2747
+ /** @description null = the tenant's default. */
2748
+ collectionAttempts?: number | null;
2749
+ methods?: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
2750
+ metadata?: {
2751
+ [key: string]: string;
2752
+ };
2753
+ };
2754
+ InvoiceBillingFeeResponseDto: {
2755
+ /** @example 43.90 */
2756
+ amount: string;
2757
+ /** @enum {string} */
2758
+ currency: "VES" | "USDT" | "USDC" | "COP";
2759
+ /** @example 0.5 */
2760
+ percent: string;
2761
+ };
2762
+ InvoiceResponseDto: {
2763
+ /** @example in_3fd84b2d9ad14f74a2d90f2f56984db5 */
2764
+ id: string;
2765
+ /** @example invoice */
2766
+ object: string;
2767
+ /** @example K7Q2M9XA-0001 */
2768
+ number: string;
2769
+ /** @enum {string} */
2770
+ status: "open" | "paid" | "void" | "uncollectible";
2771
+ customer: string;
2772
+ subscription: string;
2773
+ /** @enum {string} */
2774
+ collectionMethod: "send_invoice" | "charge_automatically";
2775
+ /** @example 10.00 */
2776
+ amountDueUsd: string;
2777
+ /** @example 0.00 */
2778
+ amountPaidUsd: string;
2779
+ /** @example USD */
2780
+ currency: string;
2781
+ periodStart: string;
2782
+ periodEnd: string;
2783
+ /** @description Invoices are due when issued. */
2784
+ dueDate: string;
2785
+ /** @description Daily collection attempts for this invoice. */
2786
+ attemptsTotal: number;
2787
+ attemptCount: number;
2788
+ nextPaymentAttempt: string | null;
2789
+ paidAt: string | null;
2790
+ paidOutOfBand: boolean;
2791
+ paymentId: string | null;
2792
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
2793
+ hostedInvoiceUrl: string | null;
2794
+ createdAt: string;
2795
+ livemode: boolean;
2796
+ };
2797
+ InvoiceListResponseDto: {
2798
+ items: components["schemas"]["InvoiceResponseDto"][];
2799
+ nextCursor: string | null;
2800
+ };
2801
+ PayInvoiceDto: {
2802
+ /**
2803
+ * @description Mark the invoice paid outside VEXPay (cash, transfer). No balance change.
2804
+ * @example true
2805
+ */
2806
+ paidOutOfBand: boolean;
2807
+ };
2808
+ CreateSetupSessionDto: {
2809
+ /** @description Customer id (cus_…). */
2810
+ customer: string;
2811
+ /** @description Where the setup page sends the customer when done (https). */
2812
+ successUrl?: string;
2813
+ };
2814
+ SetupSessionResponseDto: {
2815
+ /** @example seti_3fd84b2d9ad14f74a2d90f2f56984db5 */
2816
+ id: string;
2817
+ /** @example setup_session */
2818
+ object: string;
2819
+ /** @description Hosted authorization page. Only returned on create. */
2820
+ url: string | null;
2821
+ customer: string;
2822
+ /** @enum {string} */
2823
+ status: "open" | "complete" | "expired";
2824
+ paymentMethod: string | null;
2825
+ successUrl: string | null;
2826
+ expiresAt: string;
2827
+ createdAt: string;
2828
+ livemode: boolean;
2829
+ };
2830
+ PaymentMethodResponseDto: {
2831
+ /** @example pm_3fd84b2d9ad14f74a2d90f2f56984db5 */
2832
+ id: string;
2833
+ /** @example payment_method */
2834
+ object: string;
2835
+ /** @example domiciliacion */
2836
+ type: string;
2837
+ customer: string;
2838
+ /**
2839
+ * @description pending until a charge succeeds; inactive when the bank reports the affiliation inactive.
2840
+ * @enum {string}
2841
+ */
2842
+ status: "pending" | "active" | "inactive";
2843
+ /** @example 4567 */
2844
+ phoneLast4: string;
2845
+ /** @example 0102 */
2846
+ bankCode: string;
2847
+ createdAt: string;
2848
+ activatedAt: string | null;
2849
+ deactivatedAt: string | null;
2850
+ /** @description Set once detached; a detached method is never charged. */
2851
+ detachedAt: string | null;
2852
+ livemode: boolean;
2853
+ };
2854
+ PaymentMethodListResponseDto: {
2855
+ items: components["schemas"]["PaymentMethodResponseDto"][];
2856
+ nextCursor: string | null;
2857
+ };
2538
2858
  };
2539
2859
  responses: never;
2540
2860
  parameters: never;
@@ -5736,7 +6056,7 @@ interface operations {
5736
6056
  query?: {
5737
6057
  status?: "PENDING" | "COMPLETED" | "CANCELED";
5738
6058
  cursor?: string;
5739
- limit?: string;
6059
+ limit?: number;
5740
6060
  sourceCurrency?: "VES" | "COP";
5741
6061
  };
5742
6062
  header?: never;
@@ -9092,119 +9412,1916 @@ interface operations {
9092
9412
  };
9093
9413
  };
9094
9414
  };
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 {
9133
- requestBody?: infer RB;
9134
- } ? NonNullable<RB> extends {
9135
- content: {
9136
- 'application/json': infer B;
9137
- };
9138
- } ? B : never : never;
9139
- type Responses<O extends OperationId> = operations[O]['responses'];
9140
- type SuccessCode<R> = Extract<keyof R, 200 | 201 | 202 | 204>;
9141
- /** The JSON body of the operation's success response (`void` when none is documented). */
9142
- type ResponseBody<O extends OperationId> = [SuccessCode<Responses<O>>] extends [never] ? void : Responses<O>[SuccessCode<Responses<O>>] extends {
9143
- content: {
9144
- 'application/json': infer J;
9145
- };
9146
- } ? J : void;
9147
-
9148
- type CallArgs = {
9149
- path?: Record<string, string>;
9150
- query?: object;
9151
- body?: unknown;
9152
- };
9153
- /** Base class for resources: turns an operationId + args into a typed HTTP call. */
9154
- declare abstract class APIResource {
9155
- protected readonly http: HttpClient;
9156
- constructor(http: HttpClient);
9157
- /** Async so a bad argument surfaces as a rejected promise, never a synchronous throw. */
9158
- protected call<O extends OperationId>(operationId: O, args?: CallArgs, options?: RequestOptions): Promise<ResponseBody<O>>;
9159
- }
9160
-
9161
- /** Venezuelan bank catalog (SIMF codes, supported services, logos). */
9162
- declare class Banks extends APIResource {
9163
- list(options?: RequestOptions): Promise<{
9164
- code: string;
9165
- name: string;
9166
- services: string[];
9167
- logoUrl: string | null;
9168
- }[]>;
9169
- }
9170
- /** USD → VES at the official BCV rate. */
9171
- declare class Quotes extends APIResource {
9172
- retrieve(params: QueryParams<'Payments_getQuote'>, options?: RequestOptions): Promise<{
9173
- usdAmount: number;
9174
- bcvRate: number;
9175
- rate?: number;
9176
- rateSource?: "BCV" | "MARKET";
9177
- vesAmount: number;
9178
- medianRate: number;
9179
- medianVesAmount: number;
9180
- source: string;
9181
- fetchedAt: string;
9182
- sources: {
9183
- [key: string]: unknown;
9415
+ Customers_list: {
9416
+ parameters: {
9417
+ query?: {
9418
+ email?: string;
9419
+ cursor?: string;
9420
+ limit?: number;
9421
+ };
9422
+ header?: never;
9423
+ path?: never;
9424
+ cookie?: never;
9184
9425
  };
9185
- }>;
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
- }, {
9194
- 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";
9196
- amountVes: string;
9197
- paymentId?: string;
9198
- payoutId?: string;
9199
- chargebackId?: string;
9200
- merchantId?: string;
9201
- externalRef?: string;
9202
- description: string;
9203
- availableAt?: string;
9204
- createdAt: string;
9205
- }>;
9206
- }
9207
- /** Your platform balance. */
9426
+ requestBody?: never;
9427
+ responses: {
9428
+ 200: {
9429
+ headers: {
9430
+ [name: string]: unknown;
9431
+ };
9432
+ content: {
9433
+ "application/json": components["schemas"]["CustomerListResponseDto"];
9434
+ };
9435
+ };
9436
+ /** @description Validation failure. */
9437
+ 400: {
9438
+ headers: {
9439
+ [name: string]: unknown;
9440
+ };
9441
+ content: {
9442
+ "application/json": components["schemas"]["ApiErrorDto"];
9443
+ };
9444
+ };
9445
+ /** @description Missing or invalid tenant API key. */
9446
+ 401: {
9447
+ headers: {
9448
+ [name: string]: unknown;
9449
+ };
9450
+ content: {
9451
+ "application/json": components["schemas"]["ApiErrorDto"];
9452
+ };
9453
+ };
9454
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
9455
+ 403: {
9456
+ headers: {
9457
+ [name: string]: unknown;
9458
+ };
9459
+ content: {
9460
+ "application/json": components["schemas"]["ApiErrorDto"];
9461
+ };
9462
+ };
9463
+ /** @description Client error. */
9464
+ "4XX": {
9465
+ headers: {
9466
+ [name: string]: unknown;
9467
+ };
9468
+ content: {
9469
+ "application/json": components["schemas"]["ApiErrorDto"];
9470
+ };
9471
+ };
9472
+ /** @description Server or upstream bank error. */
9473
+ "5XX": {
9474
+ headers: {
9475
+ [name: string]: unknown;
9476
+ };
9477
+ content: {
9478
+ "application/json": components["schemas"]["ApiErrorDto"];
9479
+ };
9480
+ };
9481
+ };
9482
+ };
9483
+ Customers_create: {
9484
+ parameters: {
9485
+ query?: never;
9486
+ header?: {
9487
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
9488
+ "Idempotency-Key"?: string;
9489
+ };
9490
+ path?: never;
9491
+ cookie?: never;
9492
+ };
9493
+ requestBody: {
9494
+ content: {
9495
+ "application/json": components["schemas"]["CreateCustomerDto"];
9496
+ };
9497
+ };
9498
+ responses: {
9499
+ 201: {
9500
+ headers: {
9501
+ [name: string]: unknown;
9502
+ };
9503
+ content: {
9504
+ "application/json": components["schemas"]["CustomerResponseDto"];
9505
+ };
9506
+ };
9507
+ /** @description Validation failure. */
9508
+ 400: {
9509
+ headers: {
9510
+ [name: string]: unknown;
9511
+ };
9512
+ content: {
9513
+ "application/json": components["schemas"]["ApiErrorDto"];
9514
+ };
9515
+ };
9516
+ /** @description Missing or invalid tenant API key. */
9517
+ 401: {
9518
+ headers: {
9519
+ [name: string]: unknown;
9520
+ };
9521
+ content: {
9522
+ "application/json": components["schemas"]["ApiErrorDto"];
9523
+ };
9524
+ };
9525
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
9526
+ 403: {
9527
+ headers: {
9528
+ [name: string]: unknown;
9529
+ };
9530
+ content: {
9531
+ "application/json": components["schemas"]["ApiErrorDto"];
9532
+ };
9533
+ };
9534
+ /** @description Client error. */
9535
+ "4XX": {
9536
+ headers: {
9537
+ [name: string]: unknown;
9538
+ };
9539
+ content: {
9540
+ "application/json": components["schemas"]["ApiErrorDto"];
9541
+ };
9542
+ };
9543
+ /** @description Server or upstream bank error. */
9544
+ "5XX": {
9545
+ headers: {
9546
+ [name: string]: unknown;
9547
+ };
9548
+ content: {
9549
+ "application/json": components["schemas"]["ApiErrorDto"];
9550
+ };
9551
+ };
9552
+ };
9553
+ };
9554
+ Customers_retrieve: {
9555
+ parameters: {
9556
+ query?: never;
9557
+ header?: never;
9558
+ path: {
9559
+ id: string;
9560
+ };
9561
+ cookie?: never;
9562
+ };
9563
+ requestBody?: never;
9564
+ responses: {
9565
+ 200: {
9566
+ headers: {
9567
+ [name: string]: unknown;
9568
+ };
9569
+ content: {
9570
+ "application/json": components["schemas"]["CustomerResponseDto"];
9571
+ };
9572
+ };
9573
+ /** @description Validation failure. */
9574
+ 400: {
9575
+ headers: {
9576
+ [name: string]: unknown;
9577
+ };
9578
+ content: {
9579
+ "application/json": components["schemas"]["ApiErrorDto"];
9580
+ };
9581
+ };
9582
+ /** @description Missing or invalid tenant API key. */
9583
+ 401: {
9584
+ headers: {
9585
+ [name: string]: unknown;
9586
+ };
9587
+ content: {
9588
+ "application/json": components["schemas"]["ApiErrorDto"];
9589
+ };
9590
+ };
9591
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
9592
+ 403: {
9593
+ headers: {
9594
+ [name: string]: unknown;
9595
+ };
9596
+ content: {
9597
+ "application/json": components["schemas"]["ApiErrorDto"];
9598
+ };
9599
+ };
9600
+ 404: {
9601
+ headers: {
9602
+ [name: string]: unknown;
9603
+ };
9604
+ content: {
9605
+ "application/json": components["schemas"]["ApiErrorDto"];
9606
+ };
9607
+ };
9608
+ /** @description Client error. */
9609
+ "4XX": {
9610
+ headers: {
9611
+ [name: string]: unknown;
9612
+ };
9613
+ content: {
9614
+ "application/json": components["schemas"]["ApiErrorDto"];
9615
+ };
9616
+ };
9617
+ /** @description Server or upstream bank error. */
9618
+ "5XX": {
9619
+ headers: {
9620
+ [name: string]: unknown;
9621
+ };
9622
+ content: {
9623
+ "application/json": components["schemas"]["ApiErrorDto"];
9624
+ };
9625
+ };
9626
+ };
9627
+ };
9628
+ Customers_update: {
9629
+ parameters: {
9630
+ query?: never;
9631
+ header?: {
9632
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
9633
+ "Idempotency-Key"?: string;
9634
+ };
9635
+ path: {
9636
+ id: string;
9637
+ };
9638
+ cookie?: never;
9639
+ };
9640
+ requestBody: {
9641
+ content: {
9642
+ "application/json": components["schemas"]["UpdateCustomerDto"];
9643
+ };
9644
+ };
9645
+ responses: {
9646
+ 200: {
9647
+ headers: {
9648
+ [name: string]: unknown;
9649
+ };
9650
+ content: {
9651
+ "application/json": components["schemas"]["CustomerResponseDto"];
9652
+ };
9653
+ };
9654
+ /** @description Validation failure. */
9655
+ 400: {
9656
+ headers: {
9657
+ [name: string]: unknown;
9658
+ };
9659
+ content: {
9660
+ "application/json": components["schemas"]["ApiErrorDto"];
9661
+ };
9662
+ };
9663
+ /** @description Missing or invalid tenant API key. */
9664
+ 401: {
9665
+ headers: {
9666
+ [name: string]: unknown;
9667
+ };
9668
+ content: {
9669
+ "application/json": components["schemas"]["ApiErrorDto"];
9670
+ };
9671
+ };
9672
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
9673
+ 403: {
9674
+ headers: {
9675
+ [name: string]: unknown;
9676
+ };
9677
+ content: {
9678
+ "application/json": components["schemas"]["ApiErrorDto"];
9679
+ };
9680
+ };
9681
+ 404: {
9682
+ headers: {
9683
+ [name: string]: unknown;
9684
+ };
9685
+ content: {
9686
+ "application/json": components["schemas"]["ApiErrorDto"];
9687
+ };
9688
+ };
9689
+ /** @description Client error. */
9690
+ "4XX": {
9691
+ headers: {
9692
+ [name: string]: unknown;
9693
+ };
9694
+ content: {
9695
+ "application/json": components["schemas"]["ApiErrorDto"];
9696
+ };
9697
+ };
9698
+ /** @description Server or upstream bank error. */
9699
+ "5XX": {
9700
+ headers: {
9701
+ [name: string]: unknown;
9702
+ };
9703
+ content: {
9704
+ "application/json": components["schemas"]["ApiErrorDto"];
9705
+ };
9706
+ };
9707
+ };
9708
+ };
9709
+ Customers_remove: {
9710
+ parameters: {
9711
+ query?: never;
9712
+ header?: never;
9713
+ path: {
9714
+ id: string;
9715
+ };
9716
+ cookie?: never;
9717
+ };
9718
+ requestBody?: never;
9719
+ responses: {
9720
+ 200: {
9721
+ headers: {
9722
+ [name: string]: unknown;
9723
+ };
9724
+ content: {
9725
+ "application/json": components["schemas"]["DeletedObjectResponseDto"];
9726
+ };
9727
+ };
9728
+ /** @description Validation failure. */
9729
+ 400: {
9730
+ headers: {
9731
+ [name: string]: unknown;
9732
+ };
9733
+ content: {
9734
+ "application/json": components["schemas"]["ApiErrorDto"];
9735
+ };
9736
+ };
9737
+ /** @description Missing or invalid tenant API key. */
9738
+ 401: {
9739
+ headers: {
9740
+ [name: string]: unknown;
9741
+ };
9742
+ content: {
9743
+ "application/json": components["schemas"]["ApiErrorDto"];
9744
+ };
9745
+ };
9746
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
9747
+ 403: {
9748
+ headers: {
9749
+ [name: string]: unknown;
9750
+ };
9751
+ content: {
9752
+ "application/json": components["schemas"]["ApiErrorDto"];
9753
+ };
9754
+ };
9755
+ 404: {
9756
+ headers: {
9757
+ [name: string]: unknown;
9758
+ };
9759
+ content: {
9760
+ "application/json": components["schemas"]["ApiErrorDto"];
9761
+ };
9762
+ };
9763
+ /** @description customer_has_active_subscriptions */
9764
+ 409: {
9765
+ headers: {
9766
+ [name: string]: unknown;
9767
+ };
9768
+ content: {
9769
+ "application/json": components["schemas"]["ApiErrorDto"];
9770
+ };
9771
+ };
9772
+ /** @description Client error. */
9773
+ "4XX": {
9774
+ headers: {
9775
+ [name: string]: unknown;
9776
+ };
9777
+ content: {
9778
+ "application/json": components["schemas"]["ApiErrorDto"];
9779
+ };
9780
+ };
9781
+ /** @description Server or upstream bank error. */
9782
+ "5XX": {
9783
+ headers: {
9784
+ [name: string]: unknown;
9785
+ };
9786
+ content: {
9787
+ "application/json": components["schemas"]["ApiErrorDto"];
9788
+ };
9789
+ };
9790
+ };
9791
+ };
9792
+ Prices_list: {
9793
+ parameters: {
9794
+ query?: {
9795
+ product?: string;
9796
+ active?: "true" | "false";
9797
+ cursor?: string;
9798
+ limit?: number;
9799
+ };
9800
+ header?: never;
9801
+ path?: never;
9802
+ cookie?: never;
9803
+ };
9804
+ requestBody?: never;
9805
+ responses: {
9806
+ 200: {
9807
+ headers: {
9808
+ [name: string]: unknown;
9809
+ };
9810
+ content: {
9811
+ "application/json": components["schemas"]["PriceListResponseDto"];
9812
+ };
9813
+ };
9814
+ /** @description Validation failure. */
9815
+ 400: {
9816
+ headers: {
9817
+ [name: string]: unknown;
9818
+ };
9819
+ content: {
9820
+ "application/json": components["schemas"]["ApiErrorDto"];
9821
+ };
9822
+ };
9823
+ /** @description Missing or invalid tenant API key. */
9824
+ 401: {
9825
+ headers: {
9826
+ [name: string]: unknown;
9827
+ };
9828
+ content: {
9829
+ "application/json": components["schemas"]["ApiErrorDto"];
9830
+ };
9831
+ };
9832
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
9833
+ 403: {
9834
+ headers: {
9835
+ [name: string]: unknown;
9836
+ };
9837
+ content: {
9838
+ "application/json": components["schemas"]["ApiErrorDto"];
9839
+ };
9840
+ };
9841
+ /** @description Client error. */
9842
+ "4XX": {
9843
+ headers: {
9844
+ [name: string]: unknown;
9845
+ };
9846
+ content: {
9847
+ "application/json": components["schemas"]["ApiErrorDto"];
9848
+ };
9849
+ };
9850
+ /** @description Server or upstream bank error. */
9851
+ "5XX": {
9852
+ headers: {
9853
+ [name: string]: unknown;
9854
+ };
9855
+ content: {
9856
+ "application/json": components["schemas"]["ApiErrorDto"];
9857
+ };
9858
+ };
9859
+ };
9860
+ };
9861
+ Prices_create: {
9862
+ parameters: {
9863
+ query?: never;
9864
+ header?: {
9865
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
9866
+ "Idempotency-Key"?: string;
9867
+ };
9868
+ path?: never;
9869
+ cookie?: never;
9870
+ };
9871
+ requestBody: {
9872
+ content: {
9873
+ "application/json": components["schemas"]["CreatePriceDto"];
9874
+ };
9875
+ };
9876
+ responses: {
9877
+ 201: {
9878
+ headers: {
9879
+ [name: string]: unknown;
9880
+ };
9881
+ content: {
9882
+ "application/json": components["schemas"]["PriceResponseDto"];
9883
+ };
9884
+ };
9885
+ /** @description Validation failure. */
9886
+ 400: {
9887
+ headers: {
9888
+ [name: string]: unknown;
9889
+ };
9890
+ content: {
9891
+ "application/json": components["schemas"]["ApiErrorDto"];
9892
+ };
9893
+ };
9894
+ /** @description Missing or invalid tenant API key. */
9895
+ 401: {
9896
+ headers: {
9897
+ [name: string]: unknown;
9898
+ };
9899
+ content: {
9900
+ "application/json": components["schemas"]["ApiErrorDto"];
9901
+ };
9902
+ };
9903
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
9904
+ 403: {
9905
+ headers: {
9906
+ [name: string]: unknown;
9907
+ };
9908
+ content: {
9909
+ "application/json": components["schemas"]["ApiErrorDto"];
9910
+ };
9911
+ };
9912
+ 404: {
9913
+ headers: {
9914
+ [name: string]: unknown;
9915
+ };
9916
+ content: {
9917
+ "application/json": components["schemas"]["ApiErrorDto"];
9918
+ };
9919
+ };
9920
+ /** @description amount_below_minimum */
9921
+ 422: {
9922
+ headers: {
9923
+ [name: string]: unknown;
9924
+ };
9925
+ content: {
9926
+ "application/json": components["schemas"]["ApiErrorDto"];
9927
+ };
9928
+ };
9929
+ /** @description Client error. */
9930
+ "4XX": {
9931
+ headers: {
9932
+ [name: string]: unknown;
9933
+ };
9934
+ content: {
9935
+ "application/json": components["schemas"]["ApiErrorDto"];
9936
+ };
9937
+ };
9938
+ /** @description Server or upstream bank error. */
9939
+ "5XX": {
9940
+ headers: {
9941
+ [name: string]: unknown;
9942
+ };
9943
+ content: {
9944
+ "application/json": components["schemas"]["ApiErrorDto"];
9945
+ };
9946
+ };
9947
+ };
9948
+ };
9949
+ Prices_retrieve: {
9950
+ parameters: {
9951
+ query?: never;
9952
+ header?: never;
9953
+ path: {
9954
+ id: string;
9955
+ };
9956
+ cookie?: never;
9957
+ };
9958
+ requestBody?: never;
9959
+ responses: {
9960
+ 200: {
9961
+ headers: {
9962
+ [name: string]: unknown;
9963
+ };
9964
+ content: {
9965
+ "application/json": components["schemas"]["PriceResponseDto"];
9966
+ };
9967
+ };
9968
+ /** @description Validation failure. */
9969
+ 400: {
9970
+ headers: {
9971
+ [name: string]: unknown;
9972
+ };
9973
+ content: {
9974
+ "application/json": components["schemas"]["ApiErrorDto"];
9975
+ };
9976
+ };
9977
+ /** @description Missing or invalid tenant API key. */
9978
+ 401: {
9979
+ headers: {
9980
+ [name: string]: unknown;
9981
+ };
9982
+ content: {
9983
+ "application/json": components["schemas"]["ApiErrorDto"];
9984
+ };
9985
+ };
9986
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
9987
+ 403: {
9988
+ headers: {
9989
+ [name: string]: unknown;
9990
+ };
9991
+ content: {
9992
+ "application/json": components["schemas"]["ApiErrorDto"];
9993
+ };
9994
+ };
9995
+ 404: {
9996
+ headers: {
9997
+ [name: string]: unknown;
9998
+ };
9999
+ content: {
10000
+ "application/json": components["schemas"]["ApiErrorDto"];
10001
+ };
10002
+ };
10003
+ /** @description Client error. */
10004
+ "4XX": {
10005
+ headers: {
10006
+ [name: string]: unknown;
10007
+ };
10008
+ content: {
10009
+ "application/json": components["schemas"]["ApiErrorDto"];
10010
+ };
10011
+ };
10012
+ /** @description Server or upstream bank error. */
10013
+ "5XX": {
10014
+ headers: {
10015
+ [name: string]: unknown;
10016
+ };
10017
+ content: {
10018
+ "application/json": components["schemas"]["ApiErrorDto"];
10019
+ };
10020
+ };
10021
+ };
10022
+ };
10023
+ Prices_update: {
10024
+ parameters: {
10025
+ query?: never;
10026
+ header?: {
10027
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10028
+ "Idempotency-Key"?: string;
10029
+ };
10030
+ path: {
10031
+ id: string;
10032
+ };
10033
+ cookie?: never;
10034
+ };
10035
+ requestBody: {
10036
+ content: {
10037
+ "application/json": components["schemas"]["UpdatePriceDto"];
10038
+ };
10039
+ };
10040
+ responses: {
10041
+ 200: {
10042
+ headers: {
10043
+ [name: string]: unknown;
10044
+ };
10045
+ content: {
10046
+ "application/json": components["schemas"]["PriceResponseDto"];
10047
+ };
10048
+ };
10049
+ /** @description Validation failure. */
10050
+ 400: {
10051
+ headers: {
10052
+ [name: string]: unknown;
10053
+ };
10054
+ content: {
10055
+ "application/json": components["schemas"]["ApiErrorDto"];
10056
+ };
10057
+ };
10058
+ /** @description Missing or invalid tenant API key. */
10059
+ 401: {
10060
+ headers: {
10061
+ [name: string]: unknown;
10062
+ };
10063
+ content: {
10064
+ "application/json": components["schemas"]["ApiErrorDto"];
10065
+ };
10066
+ };
10067
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10068
+ 403: {
10069
+ headers: {
10070
+ [name: string]: unknown;
10071
+ };
10072
+ content: {
10073
+ "application/json": components["schemas"]["ApiErrorDto"];
10074
+ };
10075
+ };
10076
+ 404: {
10077
+ headers: {
10078
+ [name: string]: unknown;
10079
+ };
10080
+ content: {
10081
+ "application/json": components["schemas"]["ApiErrorDto"];
10082
+ };
10083
+ };
10084
+ /** @description Client error. */
10085
+ "4XX": {
10086
+ headers: {
10087
+ [name: string]: unknown;
10088
+ };
10089
+ content: {
10090
+ "application/json": components["schemas"]["ApiErrorDto"];
10091
+ };
10092
+ };
10093
+ /** @description Server or upstream bank error. */
10094
+ "5XX": {
10095
+ headers: {
10096
+ [name: string]: unknown;
10097
+ };
10098
+ content: {
10099
+ "application/json": components["schemas"]["ApiErrorDto"];
10100
+ };
10101
+ };
10102
+ };
10103
+ };
10104
+ Subscriptions_list: {
10105
+ parameters: {
10106
+ query?: {
10107
+ customer?: string;
10108
+ price?: string;
10109
+ status?: "trialing" | "active" | "past_due" | "canceled";
10110
+ cursor?: string;
10111
+ limit?: number;
10112
+ };
10113
+ header?: never;
10114
+ path?: never;
10115
+ cookie?: never;
10116
+ };
10117
+ requestBody?: never;
10118
+ responses: {
10119
+ 200: {
10120
+ headers: {
10121
+ [name: string]: unknown;
10122
+ };
10123
+ content: {
10124
+ "application/json": components["schemas"]["SubscriptionListResponseDto"];
10125
+ };
10126
+ };
10127
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
10128
+ 400: {
10129
+ headers: {
10130
+ [name: string]: unknown;
10131
+ };
10132
+ content: {
10133
+ "application/json": components["schemas"]["ApiErrorDto"];
10134
+ };
10135
+ };
10136
+ /** @description Missing or invalid tenant API key. */
10137
+ 401: {
10138
+ headers: {
10139
+ [name: string]: unknown;
10140
+ };
10141
+ content: {
10142
+ "application/json": components["schemas"]["ApiErrorDto"];
10143
+ };
10144
+ };
10145
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10146
+ 403: {
10147
+ headers: {
10148
+ [name: string]: unknown;
10149
+ };
10150
+ content: {
10151
+ "application/json": components["schemas"]["ApiErrorDto"];
10152
+ };
10153
+ };
10154
+ /** @description Client error. */
10155
+ "4XX": {
10156
+ headers: {
10157
+ [name: string]: unknown;
10158
+ };
10159
+ content: {
10160
+ "application/json": components["schemas"]["ApiErrorDto"];
10161
+ };
10162
+ };
10163
+ /** @description Server or upstream bank error. */
10164
+ "5XX": {
10165
+ headers: {
10166
+ [name: string]: unknown;
10167
+ };
10168
+ content: {
10169
+ "application/json": components["schemas"]["ApiErrorDto"];
10170
+ };
10171
+ };
10172
+ };
10173
+ };
10174
+ Subscriptions_create: {
10175
+ parameters: {
10176
+ query?: never;
10177
+ header?: {
10178
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10179
+ "Idempotency-Key"?: string;
10180
+ };
10181
+ path?: never;
10182
+ cookie?: never;
10183
+ };
10184
+ requestBody: {
10185
+ content: {
10186
+ "application/json": components["schemas"]["CreateSubscriptionDto"];
10187
+ };
10188
+ };
10189
+ responses: {
10190
+ 201: {
10191
+ headers: {
10192
+ [name: string]: unknown;
10193
+ };
10194
+ content: {
10195
+ "application/json": components["schemas"]["SubscriptionResponseDto"];
10196
+ };
10197
+ };
10198
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
10199
+ 400: {
10200
+ headers: {
10201
+ [name: string]: unknown;
10202
+ };
10203
+ content: {
10204
+ "application/json": components["schemas"]["ApiErrorDto"];
10205
+ };
10206
+ };
10207
+ /** @description Missing or invalid tenant API key. */
10208
+ 401: {
10209
+ headers: {
10210
+ [name: string]: unknown;
10211
+ };
10212
+ content: {
10213
+ "application/json": components["schemas"]["ApiErrorDto"];
10214
+ };
10215
+ };
10216
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10217
+ 403: {
10218
+ headers: {
10219
+ [name: string]: unknown;
10220
+ };
10221
+ content: {
10222
+ "application/json": components["schemas"]["ApiErrorDto"];
10223
+ };
10224
+ };
10225
+ 404: {
10226
+ headers: {
10227
+ [name: string]: unknown;
10228
+ };
10229
+ content: {
10230
+ "application/json": components["schemas"]["ApiErrorDto"];
10231
+ };
10232
+ };
10233
+ /** @description Client error. */
10234
+ "4XX": {
10235
+ headers: {
10236
+ [name: string]: unknown;
10237
+ };
10238
+ content: {
10239
+ "application/json": components["schemas"]["ApiErrorDto"];
10240
+ };
10241
+ };
10242
+ /** @description Server or upstream bank error. */
10243
+ "5XX": {
10244
+ headers: {
10245
+ [name: string]: unknown;
10246
+ };
10247
+ content: {
10248
+ "application/json": components["schemas"]["ApiErrorDto"];
10249
+ };
10250
+ };
10251
+ };
10252
+ };
10253
+ Subscriptions_retrieve: {
10254
+ parameters: {
10255
+ query?: never;
10256
+ header?: never;
10257
+ path: {
10258
+ id: string;
10259
+ };
10260
+ cookie?: never;
10261
+ };
10262
+ requestBody?: never;
10263
+ responses: {
10264
+ 200: {
10265
+ headers: {
10266
+ [name: string]: unknown;
10267
+ };
10268
+ content: {
10269
+ "application/json": components["schemas"]["SubscriptionResponseDto"];
10270
+ };
10271
+ };
10272
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
10273
+ 400: {
10274
+ headers: {
10275
+ [name: string]: unknown;
10276
+ };
10277
+ content: {
10278
+ "application/json": components["schemas"]["ApiErrorDto"];
10279
+ };
10280
+ };
10281
+ /** @description Missing or invalid tenant API key. */
10282
+ 401: {
10283
+ headers: {
10284
+ [name: string]: unknown;
10285
+ };
10286
+ content: {
10287
+ "application/json": components["schemas"]["ApiErrorDto"];
10288
+ };
10289
+ };
10290
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10291
+ 403: {
10292
+ headers: {
10293
+ [name: string]: unknown;
10294
+ };
10295
+ content: {
10296
+ "application/json": components["schemas"]["ApiErrorDto"];
10297
+ };
10298
+ };
10299
+ 404: {
10300
+ headers: {
10301
+ [name: string]: unknown;
10302
+ };
10303
+ content: {
10304
+ "application/json": components["schemas"]["ApiErrorDto"];
10305
+ };
10306
+ };
10307
+ /** @description Client error. */
10308
+ "4XX": {
10309
+ headers: {
10310
+ [name: string]: unknown;
10311
+ };
10312
+ content: {
10313
+ "application/json": components["schemas"]["ApiErrorDto"];
10314
+ };
10315
+ };
10316
+ /** @description Server or upstream bank error. */
10317
+ "5XX": {
10318
+ headers: {
10319
+ [name: string]: unknown;
10320
+ };
10321
+ content: {
10322
+ "application/json": components["schemas"]["ApiErrorDto"];
10323
+ };
10324
+ };
10325
+ };
10326
+ };
10327
+ Subscriptions_update: {
10328
+ parameters: {
10329
+ query?: never;
10330
+ header?: {
10331
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10332
+ "Idempotency-Key"?: string;
10333
+ };
10334
+ path: {
10335
+ id: string;
10336
+ };
10337
+ cookie?: never;
10338
+ };
10339
+ requestBody: {
10340
+ content: {
10341
+ "application/json": components["schemas"]["UpdateSubscriptionDto"];
10342
+ };
10343
+ };
10344
+ responses: {
10345
+ 200: {
10346
+ headers: {
10347
+ [name: string]: unknown;
10348
+ };
10349
+ content: {
10350
+ "application/json": components["schemas"]["SubscriptionResponseDto"];
10351
+ };
10352
+ };
10353
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
10354
+ 400: {
10355
+ headers: {
10356
+ [name: string]: unknown;
10357
+ };
10358
+ content: {
10359
+ "application/json": components["schemas"]["ApiErrorDto"];
10360
+ };
10361
+ };
10362
+ /** @description Missing or invalid tenant API key. */
10363
+ 401: {
10364
+ headers: {
10365
+ [name: string]: unknown;
10366
+ };
10367
+ content: {
10368
+ "application/json": components["schemas"]["ApiErrorDto"];
10369
+ };
10370
+ };
10371
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10372
+ 403: {
10373
+ headers: {
10374
+ [name: string]: unknown;
10375
+ };
10376
+ content: {
10377
+ "application/json": components["schemas"]["ApiErrorDto"];
10378
+ };
10379
+ };
10380
+ 404: {
10381
+ headers: {
10382
+ [name: string]: unknown;
10383
+ };
10384
+ content: {
10385
+ "application/json": components["schemas"]["ApiErrorDto"];
10386
+ };
10387
+ };
10388
+ /** @description Client error. */
10389
+ "4XX": {
10390
+ headers: {
10391
+ [name: string]: unknown;
10392
+ };
10393
+ content: {
10394
+ "application/json": components["schemas"]["ApiErrorDto"];
10395
+ };
10396
+ };
10397
+ /** @description Server or upstream bank error. */
10398
+ "5XX": {
10399
+ headers: {
10400
+ [name: string]: unknown;
10401
+ };
10402
+ content: {
10403
+ "application/json": components["schemas"]["ApiErrorDto"];
10404
+ };
10405
+ };
10406
+ };
10407
+ };
10408
+ Subscriptions_cancel: {
10409
+ parameters: {
10410
+ query?: never;
10411
+ header?: never;
10412
+ path: {
10413
+ id: string;
10414
+ };
10415
+ cookie?: never;
10416
+ };
10417
+ requestBody?: never;
10418
+ responses: {
10419
+ 200: {
10420
+ headers: {
10421
+ [name: string]: unknown;
10422
+ };
10423
+ content: {
10424
+ "application/json": components["schemas"]["SubscriptionResponseDto"];
10425
+ };
10426
+ };
10427
+ /** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
10428
+ 400: {
10429
+ headers: {
10430
+ [name: string]: unknown;
10431
+ };
10432
+ content: {
10433
+ "application/json": components["schemas"]["ApiErrorDto"];
10434
+ };
10435
+ };
10436
+ /** @description Missing or invalid tenant API key. */
10437
+ 401: {
10438
+ headers: {
10439
+ [name: string]: unknown;
10440
+ };
10441
+ content: {
10442
+ "application/json": components["schemas"]["ApiErrorDto"];
10443
+ };
10444
+ };
10445
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10446
+ 403: {
10447
+ headers: {
10448
+ [name: string]: unknown;
10449
+ };
10450
+ content: {
10451
+ "application/json": components["schemas"]["ApiErrorDto"];
10452
+ };
10453
+ };
10454
+ 404: {
10455
+ headers: {
10456
+ [name: string]: unknown;
10457
+ };
10458
+ content: {
10459
+ "application/json": components["schemas"]["ApiErrorDto"];
10460
+ };
10461
+ };
10462
+ /** @description Client error. */
10463
+ "4XX": {
10464
+ headers: {
10465
+ [name: string]: unknown;
10466
+ };
10467
+ content: {
10468
+ "application/json": components["schemas"]["ApiErrorDto"];
10469
+ };
10470
+ };
10471
+ /** @description Server or upstream bank error. */
10472
+ "5XX": {
10473
+ headers: {
10474
+ [name: string]: unknown;
10475
+ };
10476
+ content: {
10477
+ "application/json": components["schemas"]["ApiErrorDto"];
10478
+ };
10479
+ };
10480
+ };
10481
+ };
10482
+ Invoices_list: {
10483
+ parameters: {
10484
+ query?: {
10485
+ customer?: string;
10486
+ subscription?: string;
10487
+ status?: "open" | "paid" | "void" | "uncollectible";
10488
+ cursor?: string;
10489
+ limit?: number;
10490
+ };
10491
+ header?: never;
10492
+ path?: never;
10493
+ cookie?: never;
10494
+ };
10495
+ requestBody?: never;
10496
+ responses: {
10497
+ 200: {
10498
+ headers: {
10499
+ [name: string]: unknown;
10500
+ };
10501
+ content: {
10502
+ "application/json": components["schemas"]["InvoiceListResponseDto"];
10503
+ };
10504
+ };
10505
+ /** @description Validation failure or invoice_not_open. */
10506
+ 400: {
10507
+ headers: {
10508
+ [name: string]: unknown;
10509
+ };
10510
+ content: {
10511
+ "application/json": components["schemas"]["ApiErrorDto"];
10512
+ };
10513
+ };
10514
+ /** @description Missing or invalid tenant API key. */
10515
+ 401: {
10516
+ headers: {
10517
+ [name: string]: unknown;
10518
+ };
10519
+ content: {
10520
+ "application/json": components["schemas"]["ApiErrorDto"];
10521
+ };
10522
+ };
10523
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10524
+ 403: {
10525
+ headers: {
10526
+ [name: string]: unknown;
10527
+ };
10528
+ content: {
10529
+ "application/json": components["schemas"]["ApiErrorDto"];
10530
+ };
10531
+ };
10532
+ /** @description Client error. */
10533
+ "4XX": {
10534
+ headers: {
10535
+ [name: string]: unknown;
10536
+ };
10537
+ content: {
10538
+ "application/json": components["schemas"]["ApiErrorDto"];
10539
+ };
10540
+ };
10541
+ /** @description Server or upstream bank error. */
10542
+ "5XX": {
10543
+ headers: {
10544
+ [name: string]: unknown;
10545
+ };
10546
+ content: {
10547
+ "application/json": components["schemas"]["ApiErrorDto"];
10548
+ };
10549
+ };
10550
+ };
10551
+ };
10552
+ Invoices_retrieve: {
10553
+ parameters: {
10554
+ query?: never;
10555
+ header?: never;
10556
+ path: {
10557
+ id: string;
10558
+ };
10559
+ cookie?: never;
10560
+ };
10561
+ requestBody?: never;
10562
+ responses: {
10563
+ 200: {
10564
+ headers: {
10565
+ [name: string]: unknown;
10566
+ };
10567
+ content: {
10568
+ "application/json": components["schemas"]["InvoiceResponseDto"];
10569
+ };
10570
+ };
10571
+ /** @description Validation failure or invoice_not_open. */
10572
+ 400: {
10573
+ headers: {
10574
+ [name: string]: unknown;
10575
+ };
10576
+ content: {
10577
+ "application/json": components["schemas"]["ApiErrorDto"];
10578
+ };
10579
+ };
10580
+ /** @description Missing or invalid tenant API key. */
10581
+ 401: {
10582
+ headers: {
10583
+ [name: string]: unknown;
10584
+ };
10585
+ content: {
10586
+ "application/json": components["schemas"]["ApiErrorDto"];
10587
+ };
10588
+ };
10589
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10590
+ 403: {
10591
+ headers: {
10592
+ [name: string]: unknown;
10593
+ };
10594
+ content: {
10595
+ "application/json": components["schemas"]["ApiErrorDto"];
10596
+ };
10597
+ };
10598
+ 404: {
10599
+ headers: {
10600
+ [name: string]: unknown;
10601
+ };
10602
+ content: {
10603
+ "application/json": components["schemas"]["ApiErrorDto"];
10604
+ };
10605
+ };
10606
+ /** @description Client error. */
10607
+ "4XX": {
10608
+ headers: {
10609
+ [name: string]: unknown;
10610
+ };
10611
+ content: {
10612
+ "application/json": components["schemas"]["ApiErrorDto"];
10613
+ };
10614
+ };
10615
+ /** @description Server or upstream bank error. */
10616
+ "5XX": {
10617
+ headers: {
10618
+ [name: string]: unknown;
10619
+ };
10620
+ content: {
10621
+ "application/json": components["schemas"]["ApiErrorDto"];
10622
+ };
10623
+ };
10624
+ };
10625
+ };
10626
+ Invoices_void: {
10627
+ parameters: {
10628
+ query?: never;
10629
+ header?: {
10630
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10631
+ "Idempotency-Key"?: string;
10632
+ };
10633
+ path: {
10634
+ id: string;
10635
+ };
10636
+ cookie?: never;
10637
+ };
10638
+ requestBody?: never;
10639
+ responses: {
10640
+ 200: {
10641
+ headers: {
10642
+ [name: string]: unknown;
10643
+ };
10644
+ content: {
10645
+ "application/json": components["schemas"]["InvoiceResponseDto"];
10646
+ };
10647
+ };
10648
+ /** @description Validation failure or invoice_not_open. */
10649
+ 400: {
10650
+ headers: {
10651
+ [name: string]: unknown;
10652
+ };
10653
+ content: {
10654
+ "application/json": components["schemas"]["ApiErrorDto"];
10655
+ };
10656
+ };
10657
+ /** @description Missing or invalid tenant API key. */
10658
+ 401: {
10659
+ headers: {
10660
+ [name: string]: unknown;
10661
+ };
10662
+ content: {
10663
+ "application/json": components["schemas"]["ApiErrorDto"];
10664
+ };
10665
+ };
10666
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10667
+ 403: {
10668
+ headers: {
10669
+ [name: string]: unknown;
10670
+ };
10671
+ content: {
10672
+ "application/json": components["schemas"]["ApiErrorDto"];
10673
+ };
10674
+ };
10675
+ 404: {
10676
+ headers: {
10677
+ [name: string]: unknown;
10678
+ };
10679
+ content: {
10680
+ "application/json": components["schemas"]["ApiErrorDto"];
10681
+ };
10682
+ };
10683
+ /** @description Client error. */
10684
+ "4XX": {
10685
+ headers: {
10686
+ [name: string]: unknown;
10687
+ };
10688
+ content: {
10689
+ "application/json": components["schemas"]["ApiErrorDto"];
10690
+ };
10691
+ };
10692
+ /** @description Server or upstream bank error. */
10693
+ "5XX": {
10694
+ headers: {
10695
+ [name: string]: unknown;
10696
+ };
10697
+ content: {
10698
+ "application/json": components["schemas"]["ApiErrorDto"];
10699
+ };
10700
+ };
10701
+ };
10702
+ };
10703
+ Invoices_markUncollectible: {
10704
+ parameters: {
10705
+ query?: never;
10706
+ header?: {
10707
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10708
+ "Idempotency-Key"?: string;
10709
+ };
10710
+ path: {
10711
+ id: string;
10712
+ };
10713
+ cookie?: never;
10714
+ };
10715
+ requestBody?: never;
10716
+ responses: {
10717
+ 200: {
10718
+ headers: {
10719
+ [name: string]: unknown;
10720
+ };
10721
+ content: {
10722
+ "application/json": components["schemas"]["InvoiceResponseDto"];
10723
+ };
10724
+ };
10725
+ /** @description Validation failure or invoice_not_open. */
10726
+ 400: {
10727
+ headers: {
10728
+ [name: string]: unknown;
10729
+ };
10730
+ content: {
10731
+ "application/json": components["schemas"]["ApiErrorDto"];
10732
+ };
10733
+ };
10734
+ /** @description Missing or invalid tenant API key. */
10735
+ 401: {
10736
+ headers: {
10737
+ [name: string]: unknown;
10738
+ };
10739
+ content: {
10740
+ "application/json": components["schemas"]["ApiErrorDto"];
10741
+ };
10742
+ };
10743
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10744
+ 403: {
10745
+ headers: {
10746
+ [name: string]: unknown;
10747
+ };
10748
+ content: {
10749
+ "application/json": components["schemas"]["ApiErrorDto"];
10750
+ };
10751
+ };
10752
+ 404: {
10753
+ headers: {
10754
+ [name: string]: unknown;
10755
+ };
10756
+ content: {
10757
+ "application/json": components["schemas"]["ApiErrorDto"];
10758
+ };
10759
+ };
10760
+ /** @description Client error. */
10761
+ "4XX": {
10762
+ headers: {
10763
+ [name: string]: unknown;
10764
+ };
10765
+ content: {
10766
+ "application/json": components["schemas"]["ApiErrorDto"];
10767
+ };
10768
+ };
10769
+ /** @description Server or upstream bank error. */
10770
+ "5XX": {
10771
+ headers: {
10772
+ [name: string]: unknown;
10773
+ };
10774
+ content: {
10775
+ "application/json": components["schemas"]["ApiErrorDto"];
10776
+ };
10777
+ };
10778
+ };
10779
+ };
10780
+ Invoices_pay: {
10781
+ parameters: {
10782
+ query?: never;
10783
+ header?: {
10784
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10785
+ "Idempotency-Key"?: string;
10786
+ };
10787
+ path: {
10788
+ id: string;
10789
+ };
10790
+ cookie?: never;
10791
+ };
10792
+ requestBody: {
10793
+ content: {
10794
+ "application/json": components["schemas"]["PayInvoiceDto"];
10795
+ };
10796
+ };
10797
+ responses: {
10798
+ 200: {
10799
+ headers: {
10800
+ [name: string]: unknown;
10801
+ };
10802
+ content: {
10803
+ "application/json": components["schemas"]["InvoiceResponseDto"];
10804
+ };
10805
+ };
10806
+ /** @description Validation failure or invoice_not_open. */
10807
+ 400: {
10808
+ headers: {
10809
+ [name: string]: unknown;
10810
+ };
10811
+ content: {
10812
+ "application/json": components["schemas"]["ApiErrorDto"];
10813
+ };
10814
+ };
10815
+ /** @description Missing or invalid tenant API key. */
10816
+ 401: {
10817
+ headers: {
10818
+ [name: string]: unknown;
10819
+ };
10820
+ content: {
10821
+ "application/json": components["schemas"]["ApiErrorDto"];
10822
+ };
10823
+ };
10824
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10825
+ 403: {
10826
+ headers: {
10827
+ [name: string]: unknown;
10828
+ };
10829
+ content: {
10830
+ "application/json": components["schemas"]["ApiErrorDto"];
10831
+ };
10832
+ };
10833
+ 404: {
10834
+ headers: {
10835
+ [name: string]: unknown;
10836
+ };
10837
+ content: {
10838
+ "application/json": components["schemas"]["ApiErrorDto"];
10839
+ };
10840
+ };
10841
+ /** @description Client error. */
10842
+ "4XX": {
10843
+ headers: {
10844
+ [name: string]: unknown;
10845
+ };
10846
+ content: {
10847
+ "application/json": components["schemas"]["ApiErrorDto"];
10848
+ };
10849
+ };
10850
+ /** @description Server or upstream bank error. */
10851
+ "5XX": {
10852
+ headers: {
10853
+ [name: string]: unknown;
10854
+ };
10855
+ content: {
10856
+ "application/json": components["schemas"]["ApiErrorDto"];
10857
+ };
10858
+ };
10859
+ };
10860
+ };
10861
+ SetupSessions_create: {
10862
+ parameters: {
10863
+ query?: never;
10864
+ header?: {
10865
+ /** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
10866
+ "Idempotency-Key"?: string;
10867
+ };
10868
+ path?: never;
10869
+ cookie?: never;
10870
+ };
10871
+ requestBody: {
10872
+ content: {
10873
+ "application/json": components["schemas"]["CreateSetupSessionDto"];
10874
+ };
10875
+ };
10876
+ responses: {
10877
+ 201: {
10878
+ headers: {
10879
+ [name: string]: unknown;
10880
+ };
10881
+ content: {
10882
+ "application/json": components["schemas"]["SetupSessionResponseDto"];
10883
+ };
10884
+ };
10885
+ /** @description Validation failure, method_not_allowed or automatic_charging_unavailable. */
10886
+ 400: {
10887
+ headers: {
10888
+ [name: string]: unknown;
10889
+ };
10890
+ content: {
10891
+ "application/json": components["schemas"]["ApiErrorDto"];
10892
+ };
10893
+ };
10894
+ /** @description Missing or invalid tenant API key. */
10895
+ 401: {
10896
+ headers: {
10897
+ [name: string]: unknown;
10898
+ };
10899
+ content: {
10900
+ "application/json": components["schemas"]["ApiErrorDto"];
10901
+ };
10902
+ };
10903
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10904
+ 403: {
10905
+ headers: {
10906
+ [name: string]: unknown;
10907
+ };
10908
+ content: {
10909
+ "application/json": components["schemas"]["ApiErrorDto"];
10910
+ };
10911
+ };
10912
+ 404: {
10913
+ headers: {
10914
+ [name: string]: unknown;
10915
+ };
10916
+ content: {
10917
+ "application/json": components["schemas"]["ApiErrorDto"];
10918
+ };
10919
+ };
10920
+ /** @description Client error. */
10921
+ "4XX": {
10922
+ headers: {
10923
+ [name: string]: unknown;
10924
+ };
10925
+ content: {
10926
+ "application/json": components["schemas"]["ApiErrorDto"];
10927
+ };
10928
+ };
10929
+ /** @description Server or upstream bank error. */
10930
+ "5XX": {
10931
+ headers: {
10932
+ [name: string]: unknown;
10933
+ };
10934
+ content: {
10935
+ "application/json": components["schemas"]["ApiErrorDto"];
10936
+ };
10937
+ };
10938
+ };
10939
+ };
10940
+ SetupSessions_retrieve: {
10941
+ parameters: {
10942
+ query?: never;
10943
+ header?: never;
10944
+ path: {
10945
+ id: string;
10946
+ };
10947
+ cookie?: never;
10948
+ };
10949
+ requestBody?: never;
10950
+ responses: {
10951
+ 200: {
10952
+ headers: {
10953
+ [name: string]: unknown;
10954
+ };
10955
+ content: {
10956
+ "application/json": components["schemas"]["SetupSessionResponseDto"];
10957
+ };
10958
+ };
10959
+ /** @description Validation failure, method_not_allowed or automatic_charging_unavailable. */
10960
+ 400: {
10961
+ headers: {
10962
+ [name: string]: unknown;
10963
+ };
10964
+ content: {
10965
+ "application/json": components["schemas"]["ApiErrorDto"];
10966
+ };
10967
+ };
10968
+ /** @description Missing or invalid tenant API key. */
10969
+ 401: {
10970
+ headers: {
10971
+ [name: string]: unknown;
10972
+ };
10973
+ content: {
10974
+ "application/json": components["schemas"]["ApiErrorDto"];
10975
+ };
10976
+ };
10977
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
10978
+ 403: {
10979
+ headers: {
10980
+ [name: string]: unknown;
10981
+ };
10982
+ content: {
10983
+ "application/json": components["schemas"]["ApiErrorDto"];
10984
+ };
10985
+ };
10986
+ 404: {
10987
+ headers: {
10988
+ [name: string]: unknown;
10989
+ };
10990
+ content: {
10991
+ "application/json": components["schemas"]["ApiErrorDto"];
10992
+ };
10993
+ };
10994
+ /** @description Client error. */
10995
+ "4XX": {
10996
+ headers: {
10997
+ [name: string]: unknown;
10998
+ };
10999
+ content: {
11000
+ "application/json": components["schemas"]["ApiErrorDto"];
11001
+ };
11002
+ };
11003
+ /** @description Server or upstream bank error. */
11004
+ "5XX": {
11005
+ headers: {
11006
+ [name: string]: unknown;
11007
+ };
11008
+ content: {
11009
+ "application/json": components["schemas"]["ApiErrorDto"];
11010
+ };
11011
+ };
11012
+ };
11013
+ };
11014
+ PaymentMethods_retrieve: {
11015
+ parameters: {
11016
+ query?: never;
11017
+ header?: never;
11018
+ path: {
11019
+ id: string;
11020
+ };
11021
+ cookie?: never;
11022
+ };
11023
+ requestBody?: never;
11024
+ responses: {
11025
+ 200: {
11026
+ headers: {
11027
+ [name: string]: unknown;
11028
+ };
11029
+ content: {
11030
+ "application/json": components["schemas"]["PaymentMethodResponseDto"];
11031
+ };
11032
+ };
11033
+ /** @description Missing or invalid tenant API key. */
11034
+ 401: {
11035
+ headers: {
11036
+ [name: string]: unknown;
11037
+ };
11038
+ content: {
11039
+ "application/json": components["schemas"]["ApiErrorDto"];
11040
+ };
11041
+ };
11042
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11043
+ 403: {
11044
+ headers: {
11045
+ [name: string]: unknown;
11046
+ };
11047
+ content: {
11048
+ "application/json": components["schemas"]["ApiErrorDto"];
11049
+ };
11050
+ };
11051
+ 404: {
11052
+ headers: {
11053
+ [name: string]: unknown;
11054
+ };
11055
+ content: {
11056
+ "application/json": components["schemas"]["ApiErrorDto"];
11057
+ };
11058
+ };
11059
+ /** @description Client error. */
11060
+ "4XX": {
11061
+ headers: {
11062
+ [name: string]: unknown;
11063
+ };
11064
+ content: {
11065
+ "application/json": components["schemas"]["ApiErrorDto"];
11066
+ };
11067
+ };
11068
+ /** @description Server or upstream bank error. */
11069
+ "5XX": {
11070
+ headers: {
11071
+ [name: string]: unknown;
11072
+ };
11073
+ content: {
11074
+ "application/json": components["schemas"]["ApiErrorDto"];
11075
+ };
11076
+ };
11077
+ };
11078
+ };
11079
+ PaymentMethods_detach: {
11080
+ parameters: {
11081
+ query?: never;
11082
+ header?: never;
11083
+ path: {
11084
+ id: string;
11085
+ };
11086
+ cookie?: never;
11087
+ };
11088
+ requestBody?: never;
11089
+ responses: {
11090
+ 200: {
11091
+ headers: {
11092
+ [name: string]: unknown;
11093
+ };
11094
+ content: {
11095
+ "application/json": components["schemas"]["PaymentMethodResponseDto"];
11096
+ };
11097
+ };
11098
+ /** @description Missing or invalid tenant API key. */
11099
+ 401: {
11100
+ headers: {
11101
+ [name: string]: unknown;
11102
+ };
11103
+ content: {
11104
+ "application/json": components["schemas"]["ApiErrorDto"];
11105
+ };
11106
+ };
11107
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11108
+ 403: {
11109
+ headers: {
11110
+ [name: string]: unknown;
11111
+ };
11112
+ content: {
11113
+ "application/json": components["schemas"]["ApiErrorDto"];
11114
+ };
11115
+ };
11116
+ 404: {
11117
+ headers: {
11118
+ [name: string]: unknown;
11119
+ };
11120
+ content: {
11121
+ "application/json": components["schemas"]["ApiErrorDto"];
11122
+ };
11123
+ };
11124
+ /** @description Client error. */
11125
+ "4XX": {
11126
+ headers: {
11127
+ [name: string]: unknown;
11128
+ };
11129
+ content: {
11130
+ "application/json": components["schemas"]["ApiErrorDto"];
11131
+ };
11132
+ };
11133
+ /** @description Server or upstream bank error. */
11134
+ "5XX": {
11135
+ headers: {
11136
+ [name: string]: unknown;
11137
+ };
11138
+ content: {
11139
+ "application/json": components["schemas"]["ApiErrorDto"];
11140
+ };
11141
+ };
11142
+ };
11143
+ };
11144
+ PaymentMethods_list: {
11145
+ parameters: {
11146
+ query?: {
11147
+ cursor?: string;
11148
+ limit?: number;
11149
+ };
11150
+ header?: never;
11151
+ path: {
11152
+ id: string;
11153
+ };
11154
+ cookie?: never;
11155
+ };
11156
+ requestBody?: never;
11157
+ responses: {
11158
+ 200: {
11159
+ headers: {
11160
+ [name: string]: unknown;
11161
+ };
11162
+ content: {
11163
+ "application/json": components["schemas"]["PaymentMethodListResponseDto"];
11164
+ };
11165
+ };
11166
+ /** @description Missing or invalid tenant API key. */
11167
+ 401: {
11168
+ headers: {
11169
+ [name: string]: unknown;
11170
+ };
11171
+ content: {
11172
+ "application/json": components["schemas"]["ApiErrorDto"];
11173
+ };
11174
+ };
11175
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
11176
+ 403: {
11177
+ headers: {
11178
+ [name: string]: unknown;
11179
+ };
11180
+ content: {
11181
+ "application/json": components["schemas"]["ApiErrorDto"];
11182
+ };
11183
+ };
11184
+ 404: {
11185
+ headers: {
11186
+ [name: string]: unknown;
11187
+ };
11188
+ content: {
11189
+ "application/json": components["schemas"]["ApiErrorDto"];
11190
+ };
11191
+ };
11192
+ /** @description Client error. */
11193
+ "4XX": {
11194
+ headers: {
11195
+ [name: string]: unknown;
11196
+ };
11197
+ content: {
11198
+ "application/json": components["schemas"]["ApiErrorDto"];
11199
+ };
11200
+ };
11201
+ /** @description Server or upstream bank error. */
11202
+ "5XX": {
11203
+ headers: {
11204
+ [name: string]: unknown;
11205
+ };
11206
+ content: {
11207
+ "application/json": components["schemas"]["ApiErrorDto"];
11208
+ };
11209
+ };
11210
+ };
11211
+ };
11212
+ }
11213
+
11214
+ type CursorPage<Item> = {
11215
+ items: Item[];
11216
+ nextCursor?: string | null;
11217
+ };
11218
+ /**
11219
+ * Result of a cursor-paginated `list()`.
11220
+ *
11221
+ * const page = await vexpay.merchants.list({ limit: 100 }); // first page
11222
+ * for await (const merchant of vexpay.merchants.list()) { … } // every item, all pages
11223
+ *
11224
+ * The first request is sent when the result is awaited or iterated.
11225
+ */
11226
+ declare class PagePromise<Page extends CursorPage<Item>, Item = Page['items'][number]> implements PromiseLike<Page>, AsyncIterable<Item> {
11227
+ private readonly fetchPage;
11228
+ private readonly startCursor?;
11229
+ private firstPage?;
11230
+ constructor(fetchPage: (cursor: string | undefined) => Promise<Page>, startCursor?: string | undefined);
11231
+ private first;
11232
+ then<TResult1 = Page, TResult2 = never>(onfulfilled?: ((value: Page) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
11233
+ catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<Page | TResult>;
11234
+ finally(onfinally?: (() => void) | null): Promise<Page>;
11235
+ [Symbol.asyncIterator](): AsyncIterator<Item>;
11236
+ /** Collects items across pages, stopping after `limit` (default 10 000). */
11237
+ autoPagingToArray({ limit }?: {
11238
+ limit?: number;
11239
+ }): Promise<Item[]>;
11240
+ }
11241
+
11242
+ type OperationId = keyof operations;
11243
+
11244
+ /** Every request/response schema in the VEXPay API, e.g. `Schemas['PaymentReceiptDto']`. */
11245
+ type Schemas = components['schemas'];
11246
+ type Params<O extends OperationId> = operations[O]['parameters'];
11247
+ type PathParams<O extends OperationId> = NonNullable<Params<O>['path']>;
11248
+ type QueryParams<O extends OperationId> = NonNullable<Params<O>['query']>;
11249
+ type RequestBody<O extends OperationId> = operations[O] extends {
11250
+ requestBody?: infer RB;
11251
+ } ? NonNullable<RB> extends {
11252
+ content: {
11253
+ 'application/json': infer B;
11254
+ };
11255
+ } ? B : never : never;
11256
+ type Responses<O extends OperationId> = operations[O]['responses'];
11257
+ type SuccessCode<R> = Extract<keyof R, 200 | 201 | 202 | 204>;
11258
+ /** The JSON body of the operation's success response (`void` when none is documented). */
11259
+ type ResponseBody<O extends OperationId> = [SuccessCode<Responses<O>>] extends [never] ? void : Responses<O>[SuccessCode<Responses<O>>] extends {
11260
+ content: {
11261
+ 'application/json': infer J;
11262
+ };
11263
+ } ? J : void;
11264
+
11265
+ type CallArgs = {
11266
+ path?: Record<string, string>;
11267
+ query?: object;
11268
+ body?: unknown;
11269
+ };
11270
+ /** Base class for resources: turns an operationId + args into a typed HTTP call. */
11271
+ declare abstract class APIResource {
11272
+ protected readonly http: HttpClient;
11273
+ constructor(http: HttpClient);
11274
+ /** Async so a bad argument surfaces as a rejected promise, never a synchronous throw. */
11275
+ protected call<O extends OperationId>(operationId: O, args?: CallArgs, options?: RequestOptions): Promise<ResponseBody<O>>;
11276
+ }
11277
+
11278
+ /** Venezuelan bank catalog (SIMF codes, supported services, logos). */
11279
+ declare class Banks extends APIResource {
11280
+ list(options?: RequestOptions): Promise<{
11281
+ code: string;
11282
+ name: string;
11283
+ services: string[];
11284
+ logoUrl: string | null;
11285
+ }[]>;
11286
+ }
11287
+ /** USD → VES at the official BCV rate. */
11288
+ declare class Quotes extends APIResource {
11289
+ retrieve(params: QueryParams<'Payments_getQuote'>, options?: RequestOptions): Promise<{
11290
+ usdAmount: number;
11291
+ bcvRate: number;
11292
+ rate?: number;
11293
+ rateSource?: "BCV" | "MARKET";
11294
+ vesAmount: number;
11295
+ medianRate: number;
11296
+ medianVesAmount: number;
11297
+ source: string;
11298
+ fetchedAt: string;
11299
+ sources: {
11300
+ [key: string]: unknown;
11301
+ };
11302
+ }>;
11303
+ }
11304
+ /** Every movement in your VES balance (payments, fees, payouts, chargebacks, …), newest first. */
11305
+ declare class BalanceTransactions extends APIResource {
11306
+ /** Await for one page, or `for await` over every movement. The amounts sum to `ledgerNetVes`. */
11307
+ list(params?: QueryParams<'Balance_listTransactions'>, options?: RequestOptions): PagePromise<{
11308
+ items: components["schemas"]["BalanceTransactionDto"][];
11309
+ nextCursor: string | null;
11310
+ }, {
11311
+ id: string;
11312
+ type: "payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee";
11313
+ amountVes: string;
11314
+ paymentId?: string;
11315
+ payoutId?: string;
11316
+ chargebackId?: string;
11317
+ merchantId?: string;
11318
+ externalRef?: string;
11319
+ description: string;
11320
+ availableAt?: string;
11321
+ createdAt: string;
11322
+ }>;
11323
+ }
11324
+ /** Your platform balance. */
9208
11325
  declare class Balance extends APIResource {
9209
11326
  readonly transactions: BalanceTransactions;
9210
11327
  retrieve(options?: RequestOptions): Promise<{
@@ -9414,7 +11531,7 @@ declare class WebhookEndpoints extends APIResource {
9414
11531
  id: string;
9415
11532
  tenantId: string;
9416
11533
  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")[];
11534
+ 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
11535
  isActive: boolean;
9419
11536
  createdAt: string;
9420
11537
  secret?: string;
@@ -9423,7 +11540,7 @@ declare class WebhookEndpoints extends APIResource {
9423
11540
  id: string;
9424
11541
  tenantId: string;
9425
11542
  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")[];
11543
+ 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
11544
  isActive: boolean;
9428
11545
  createdAt: string;
9429
11546
  secret?: string;
@@ -9432,7 +11549,7 @@ declare class WebhookEndpoints extends APIResource {
9432
11549
  id: string;
9433
11550
  tenantId: string;
9434
11551
  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")[];
11552
+ 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
11553
  isActive: boolean;
9437
11554
  createdAt: string;
9438
11555
  secret?: string;
@@ -9448,6 +11565,499 @@ declare class WebhookEndpoints extends APIResource {
9448
11565
  }>;
9449
11566
  }
9450
11567
 
11568
+ /** A customer's attached domiciliación payment methods. */
11569
+ declare class CustomerPaymentMethods extends APIResource {
11570
+ /** Await for one page, or `for await` over every attached method (newest first). */
11571
+ list(customerId: string, params?: QueryParams<'PaymentMethods_list'>, options?: RequestOptions): PagePromise<{
11572
+ items: components["schemas"]["PaymentMethodResponseDto"][];
11573
+ nextCursor: string | null;
11574
+ }, {
11575
+ id: string;
11576
+ object: string;
11577
+ type: string;
11578
+ customer: string;
11579
+ status: "pending" | "active" | "inactive";
11580
+ phoneLast4: string;
11581
+ bankCode: string;
11582
+ createdAt: string;
11583
+ activatedAt: string | null;
11584
+ deactivatedAt: string | null;
11585
+ detachedAt: string | null;
11586
+ livemode: boolean;
11587
+ }>;
11588
+ }
11589
+ /** Who you bill: subscriptions, invoices and payment methods belong to a customer. */
11590
+ declare class Customers extends APIResource {
11591
+ readonly paymentMethods: CustomerPaymentMethods;
11592
+ /** Pass `idempotencyKey` in options to retry safely. */
11593
+ create(params?: RequestBody<'Customers_create'>, options?: RequestOptions): Promise<{
11594
+ id: string;
11595
+ object: string;
11596
+ name: string | null;
11597
+ email: string | null;
11598
+ emailStatus: "none" | "deliverable" | "undeliverable";
11599
+ phone: string | null;
11600
+ idNumber: string | null;
11601
+ bankCode: string | null;
11602
+ metadata: {
11603
+ [key: string]: string;
11604
+ };
11605
+ testClock: string | null;
11606
+ createdAt: string;
11607
+ livemode: boolean;
11608
+ }>;
11609
+ /** Await for one page, or `for await` over every customer (newest first). Filter with `email`. */
11610
+ list(params?: QueryParams<'Customers_list'>, options?: RequestOptions): PagePromise<{
11611
+ items: components["schemas"]["CustomerResponseDto"][];
11612
+ nextCursor: string | null;
11613
+ }, {
11614
+ id: string;
11615
+ object: string;
11616
+ name: string | null;
11617
+ email: string | null;
11618
+ emailStatus: "none" | "deliverable" | "undeliverable";
11619
+ phone: string | null;
11620
+ idNumber: string | null;
11621
+ bankCode: string | null;
11622
+ metadata: {
11623
+ [key: string]: string;
11624
+ };
11625
+ testClock: string | null;
11626
+ createdAt: string;
11627
+ livemode: boolean;
11628
+ }>;
11629
+ retrieve(id: string, options?: RequestOptions): Promise<{
11630
+ id: string;
11631
+ object: string;
11632
+ name: string | null;
11633
+ email: string | null;
11634
+ emailStatus: "none" | "deliverable" | "undeliverable";
11635
+ phone: string | null;
11636
+ idNumber: string | null;
11637
+ bankCode: string | null;
11638
+ metadata: {
11639
+ [key: string]: string;
11640
+ };
11641
+ testClock: string | null;
11642
+ createdAt: string;
11643
+ livemode: boolean;
11644
+ }>;
11645
+ update(id: string, params: RequestBody<'Customers_update'>, options?: RequestOptions): Promise<{
11646
+ id: string;
11647
+ object: string;
11648
+ name: string | null;
11649
+ email: string | null;
11650
+ emailStatus: "none" | "deliverable" | "undeliverable";
11651
+ phone: string | null;
11652
+ idNumber: string | null;
11653
+ bankCode: string | null;
11654
+ metadata: {
11655
+ [key: string]: string;
11656
+ };
11657
+ testClock: string | null;
11658
+ createdAt: string;
11659
+ livemode: boolean;
11660
+ }>;
11661
+ /** Refused with 409 while the customer has a live subscription. */
11662
+ delete(id: string, options?: RequestOptions): Promise<{
11663
+ id: string;
11664
+ deleted: boolean;
11665
+ }>;
11666
+ }
11667
+ /** Recurring prices (USD per interval) on a product. */
11668
+ declare class Prices extends APIResource {
11669
+ create(params: RequestBody<'Prices_create'>, options?: RequestOptions): Promise<{
11670
+ id: string;
11671
+ object: string;
11672
+ product: string;
11673
+ unitAmountUsd: string;
11674
+ currency: string;
11675
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
11676
+ nickname: string | null;
11677
+ active: boolean;
11678
+ metadata: {
11679
+ [key: string]: string;
11680
+ };
11681
+ createdAt: string;
11682
+ livemode: boolean;
11683
+ }>;
11684
+ /** Await for one page, or `for await` over every price. Filter with `product` and `active`. */
11685
+ list(params?: QueryParams<'Prices_list'>, options?: RequestOptions): PagePromise<{
11686
+ items: components["schemas"]["PriceResponseDto"][];
11687
+ nextCursor: string | null;
11688
+ }, {
11689
+ id: string;
11690
+ object: string;
11691
+ product: string;
11692
+ unitAmountUsd: string;
11693
+ currency: string;
11694
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
11695
+ nickname: string | null;
11696
+ active: boolean;
11697
+ metadata: {
11698
+ [key: string]: string;
11699
+ };
11700
+ createdAt: string;
11701
+ livemode: boolean;
11702
+ }>;
11703
+ retrieve(id: string, options?: RequestOptions): Promise<{
11704
+ id: string;
11705
+ object: string;
11706
+ product: string;
11707
+ unitAmountUsd: string;
11708
+ currency: string;
11709
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
11710
+ nickname: string | null;
11711
+ active: boolean;
11712
+ metadata: {
11713
+ [key: string]: string;
11714
+ };
11715
+ createdAt: string;
11716
+ livemode: boolean;
11717
+ }>;
11718
+ /** Only `active`, `nickname` and `metadata` can change; create a new price for a new amount. */
11719
+ update(id: string, params: RequestBody<'Prices_update'>, options?: RequestOptions): Promise<{
11720
+ id: string;
11721
+ object: string;
11722
+ product: string;
11723
+ unitAmountUsd: string;
11724
+ currency: string;
11725
+ recurring: components["schemas"]["PriceRecurringResponseDto"];
11726
+ nickname: string | null;
11727
+ active: boolean;
11728
+ metadata: {
11729
+ [key: string]: string;
11730
+ };
11731
+ createdAt: string;
11732
+ livemode: boolean;
11733
+ }>;
11734
+ }
11735
+ /** Bill a customer on a price every interval. */
11736
+ declare class Subscriptions extends APIResource {
11737
+ /** Pass `idempotencyKey` in options to retry safely. */
11738
+ create(params: RequestBody<'Subscriptions_create'>, options?: RequestOptions): Promise<{
11739
+ id: string;
11740
+ object: string;
11741
+ customer: string;
11742
+ price: components["schemas"]["PriceResponseDto"];
11743
+ status: "trialing" | "active" | "past_due" | "canceled";
11744
+ collectionMethod: "send_invoice" | "charge_automatically";
11745
+ collectionAttempts: number | null;
11746
+ paymentMethod: string | null;
11747
+ currentPeriodStart: string;
11748
+ currentPeriodEnd: string;
11749
+ trialStart: string | null;
11750
+ trialEnd: string | null;
11751
+ cancelAtPeriodEnd: boolean;
11752
+ canceledAt: string | null;
11753
+ cancellationReason: "requested" | "payment_failed" | null;
11754
+ latestInvoice: string | null;
11755
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
11756
+ metadata: {
11757
+ [key: string]: string;
11758
+ };
11759
+ createdAt: string;
11760
+ livemode: boolean;
11761
+ }>;
11762
+ /** Await for one page, or `for await` over every subscription (newest first). Filter with `customer`, `price`, `status`. */
11763
+ list(params?: QueryParams<'Subscriptions_list'>, options?: RequestOptions): PagePromise<{
11764
+ items: components["schemas"]["SubscriptionResponseDto"][];
11765
+ nextCursor: string | null;
11766
+ }, {
11767
+ id: string;
11768
+ object: string;
11769
+ customer: string;
11770
+ price: components["schemas"]["PriceResponseDto"];
11771
+ status: "trialing" | "active" | "past_due" | "canceled";
11772
+ collectionMethod: "send_invoice" | "charge_automatically";
11773
+ collectionAttempts: number | null;
11774
+ paymentMethod: string | null;
11775
+ currentPeriodStart: string;
11776
+ currentPeriodEnd: string;
11777
+ trialStart: string | null;
11778
+ trialEnd: string | null;
11779
+ cancelAtPeriodEnd: boolean;
11780
+ canceledAt: string | null;
11781
+ cancellationReason: "requested" | "payment_failed" | null;
11782
+ latestInvoice: string | null;
11783
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
11784
+ metadata: {
11785
+ [key: string]: string;
11786
+ };
11787
+ createdAt: string;
11788
+ livemode: boolean;
11789
+ }>;
11790
+ retrieve(id: string, options?: RequestOptions): Promise<{
11791
+ id: string;
11792
+ object: string;
11793
+ customer: string;
11794
+ price: components["schemas"]["PriceResponseDto"];
11795
+ status: "trialing" | "active" | "past_due" | "canceled";
11796
+ collectionMethod: "send_invoice" | "charge_automatically";
11797
+ collectionAttempts: number | null;
11798
+ paymentMethod: string | null;
11799
+ currentPeriodStart: string;
11800
+ currentPeriodEnd: string;
11801
+ trialStart: string | null;
11802
+ trialEnd: string | null;
11803
+ cancelAtPeriodEnd: boolean;
11804
+ canceledAt: string | null;
11805
+ cancellationReason: "requested" | "payment_failed" | null;
11806
+ latestInvoice: string | null;
11807
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
11808
+ metadata: {
11809
+ [key: string]: string;
11810
+ };
11811
+ createdAt: string;
11812
+ livemode: boolean;
11813
+ }>;
11814
+ /** Changes apply from the next invoice. Set `cancelAtPeriodEnd` to cancel when the period ends. */
11815
+ update(id: string, params: RequestBody<'Subscriptions_update'>, options?: RequestOptions): Promise<{
11816
+ id: string;
11817
+ object: string;
11818
+ customer: string;
11819
+ price: components["schemas"]["PriceResponseDto"];
11820
+ status: "trialing" | "active" | "past_due" | "canceled";
11821
+ collectionMethod: "send_invoice" | "charge_automatically";
11822
+ collectionAttempts: number | null;
11823
+ paymentMethod: string | null;
11824
+ currentPeriodStart: string;
11825
+ currentPeriodEnd: string;
11826
+ trialStart: string | null;
11827
+ trialEnd: string | null;
11828
+ cancelAtPeriodEnd: boolean;
11829
+ canceledAt: string | null;
11830
+ cancellationReason: "requested" | "payment_failed" | null;
11831
+ latestInvoice: string | null;
11832
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
11833
+ metadata: {
11834
+ [key: string]: string;
11835
+ };
11836
+ createdAt: string;
11837
+ livemode: boolean;
11838
+ }>;
11839
+ /** Cancel now; its open invoices are voided. */
11840
+ cancel(id: string, options?: RequestOptions): Promise<{
11841
+ id: string;
11842
+ object: string;
11843
+ customer: string;
11844
+ price: components["schemas"]["PriceResponseDto"];
11845
+ status: "trialing" | "active" | "past_due" | "canceled";
11846
+ collectionMethod: "send_invoice" | "charge_automatically";
11847
+ collectionAttempts: number | null;
11848
+ paymentMethod: string | null;
11849
+ currentPeriodStart: string;
11850
+ currentPeriodEnd: string;
11851
+ trialStart: string | null;
11852
+ trialEnd: string | null;
11853
+ cancelAtPeriodEnd: boolean;
11854
+ canceledAt: string | null;
11855
+ cancellationReason: "requested" | "payment_failed" | null;
11856
+ latestInvoice: string | null;
11857
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
11858
+ metadata: {
11859
+ [key: string]: string;
11860
+ };
11861
+ createdAt: string;
11862
+ livemode: boolean;
11863
+ }>;
11864
+ }
11865
+ /** What a subscription bills each period. */
11866
+ declare class Invoices extends APIResource {
11867
+ /** Await for one page, or `for await` over every invoice (newest first). Filter with `customer`, `subscription`, `status`. */
11868
+ list(params?: QueryParams<'Invoices_list'>, options?: RequestOptions): PagePromise<{
11869
+ items: components["schemas"]["InvoiceResponseDto"][];
11870
+ nextCursor: string | null;
11871
+ }, {
11872
+ id: string;
11873
+ object: string;
11874
+ number: string;
11875
+ status: "open" | "paid" | "void" | "uncollectible";
11876
+ customer: string;
11877
+ subscription: string;
11878
+ collectionMethod: "send_invoice" | "charge_automatically";
11879
+ amountDueUsd: string;
11880
+ amountPaidUsd: string;
11881
+ currency: string;
11882
+ periodStart: string;
11883
+ periodEnd: string;
11884
+ dueDate: string;
11885
+ attemptsTotal: number;
11886
+ attemptCount: number;
11887
+ nextPaymentAttempt: string | null;
11888
+ paidAt: string | null;
11889
+ paidOutOfBand: boolean;
11890
+ paymentId: string | null;
11891
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
11892
+ hostedInvoiceUrl: string | null;
11893
+ createdAt: string;
11894
+ livemode: boolean;
11895
+ }>;
11896
+ retrieve(id: string, options?: RequestOptions): Promise<{
11897
+ id: string;
11898
+ object: string;
11899
+ number: string;
11900
+ status: "open" | "paid" | "void" | "uncollectible";
11901
+ customer: string;
11902
+ subscription: string;
11903
+ collectionMethod: "send_invoice" | "charge_automatically";
11904
+ amountDueUsd: string;
11905
+ amountPaidUsd: string;
11906
+ currency: string;
11907
+ periodStart: string;
11908
+ periodEnd: string;
11909
+ dueDate: string;
11910
+ attemptsTotal: number;
11911
+ attemptCount: number;
11912
+ nextPaymentAttempt: string | null;
11913
+ paidAt: string | null;
11914
+ paidOutOfBand: boolean;
11915
+ paymentId: string | null;
11916
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
11917
+ hostedInvoiceUrl: string | null;
11918
+ createdAt: string;
11919
+ livemode: boolean;
11920
+ }>;
11921
+ /** Void an open invoice. */
11922
+ void(id: string, options?: RequestOptions): Promise<{
11923
+ id: string;
11924
+ object: string;
11925
+ number: string;
11926
+ status: "open" | "paid" | "void" | "uncollectible";
11927
+ customer: string;
11928
+ subscription: string;
11929
+ collectionMethod: "send_invoice" | "charge_automatically";
11930
+ amountDueUsd: string;
11931
+ amountPaidUsd: string;
11932
+ currency: string;
11933
+ periodStart: string;
11934
+ periodEnd: string;
11935
+ dueDate: string;
11936
+ attemptsTotal: number;
11937
+ attemptCount: number;
11938
+ nextPaymentAttempt: string | null;
11939
+ paidAt: string | null;
11940
+ paidOutOfBand: boolean;
11941
+ paymentId: string | null;
11942
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
11943
+ hostedInvoiceUrl: string | null;
11944
+ createdAt: string;
11945
+ livemode: boolean;
11946
+ }>;
11947
+ /** Stop chasing an open invoice; it can still be paid. */
11948
+ markUncollectible(id: string, options?: RequestOptions): Promise<{
11949
+ id: string;
11950
+ object: string;
11951
+ number: string;
11952
+ status: "open" | "paid" | "void" | "uncollectible";
11953
+ customer: string;
11954
+ subscription: string;
11955
+ collectionMethod: "send_invoice" | "charge_automatically";
11956
+ amountDueUsd: string;
11957
+ amountPaidUsd: string;
11958
+ currency: string;
11959
+ periodStart: string;
11960
+ periodEnd: string;
11961
+ dueDate: string;
11962
+ attemptsTotal: number;
11963
+ attemptCount: number;
11964
+ nextPaymentAttempt: string | null;
11965
+ paidAt: string | null;
11966
+ paidOutOfBand: boolean;
11967
+ paymentId: string | null;
11968
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
11969
+ hostedInvoiceUrl: string | null;
11970
+ createdAt: string;
11971
+ livemode: boolean;
11972
+ }>;
11973
+ /** Record an open invoice as paid outside VEXPay (`paidOutOfBand: true`); no money moves. */
11974
+ pay(id: string, params: RequestBody<'Invoices_pay'>, options?: RequestOptions): Promise<{
11975
+ id: string;
11976
+ object: string;
11977
+ number: string;
11978
+ status: "open" | "paid" | "void" | "uncollectible";
11979
+ customer: string;
11980
+ subscription: string;
11981
+ collectionMethod: "send_invoice" | "charge_automatically";
11982
+ amountDueUsd: string;
11983
+ amountPaidUsd: string;
11984
+ currency: string;
11985
+ periodStart: string;
11986
+ periodEnd: string;
11987
+ dueDate: string;
11988
+ attemptsTotal: number;
11989
+ attemptCount: number;
11990
+ nextPaymentAttempt: string | null;
11991
+ paidAt: string | null;
11992
+ paidOutOfBand: boolean;
11993
+ paymentId: string | null;
11994
+ billingFee: components["schemas"]["InvoiceBillingFeeResponseDto"];
11995
+ hostedInvoiceUrl: string | null;
11996
+ createdAt: string;
11997
+ livemode: boolean;
11998
+ }>;
11999
+ }
12000
+ /** A hosted link where a customer authorizes domiciliación (expires in 24 h). */
12001
+ declare class SetupSessions extends APIResource {
12002
+ /** `url` is returned only here — send it to the customer. */
12003
+ create(params: RequestBody<'SetupSessions_create'>, options?: RequestOptions): Promise<{
12004
+ id: string;
12005
+ object: string;
12006
+ url: string | null;
12007
+ customer: string;
12008
+ status: "open" | "complete" | "expired";
12009
+ paymentMethod: string | null;
12010
+ successUrl: string | null;
12011
+ expiresAt: string;
12012
+ createdAt: string;
12013
+ livemode: boolean;
12014
+ }>;
12015
+ retrieve(id: string, options?: RequestOptions): Promise<{
12016
+ id: string;
12017
+ object: string;
12018
+ url: string | null;
12019
+ customer: string;
12020
+ status: "open" | "complete" | "expired";
12021
+ paymentMethod: string | null;
12022
+ successUrl: string | null;
12023
+ expiresAt: string;
12024
+ createdAt: string;
12025
+ livemode: boolean;
12026
+ }>;
12027
+ }
12028
+ /** Domiciliación payment methods. List a customer's with `customers.paymentMethods.list()`. */
12029
+ declare class PaymentMethods extends APIResource {
12030
+ retrieve(id: string, options?: RequestOptions): Promise<{
12031
+ id: string;
12032
+ object: string;
12033
+ type: string;
12034
+ customer: string;
12035
+ status: "pending" | "active" | "inactive";
12036
+ phoneLast4: string;
12037
+ bankCode: string;
12038
+ createdAt: string;
12039
+ activatedAt: string | null;
12040
+ deactivatedAt: string | null;
12041
+ detachedAt: string | null;
12042
+ livemode: boolean;
12043
+ }>;
12044
+ /** The method is never charged again. */
12045
+ detach(id: string, options?: RequestOptions): Promise<{
12046
+ id: string;
12047
+ object: string;
12048
+ type: string;
12049
+ customer: string;
12050
+ status: "pending" | "active" | "inactive";
12051
+ phoneLast4: string;
12052
+ bankCode: string;
12053
+ createdAt: string;
12054
+ activatedAt: string | null;
12055
+ deactivatedAt: string | null;
12056
+ detachedAt: string | null;
12057
+ livemode: boolean;
12058
+ }>;
12059
+ }
12060
+
9451
12061
  /** Single-purchase checkouts: redirect to `url`, or embed with @vexpay/js using `clientSecret`. */
9452
12062
  declare class CheckoutSessions extends APIResource {
9453
12063
  /** `clientSecret` is returned only here — hand it to the browser, never store or log it. */
@@ -10534,7 +13144,7 @@ declare class Payments extends APIResource {
10534
13144
  }>;
10535
13145
  }
10536
13146
 
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"];
13147
+ 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
13148
  type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];
10539
13149
  /** `data` of every `payment.*` event. */
10540
13150
  interface PaymentWebhookData {
@@ -10673,6 +13283,17 @@ declare class VexPay {
10673
13283
  readonly paymentLinks: PaymentLinks;
10674
13284
  readonly tenantPayoutAccount: TenantPayoutAccount;
10675
13285
  readonly webhookEndpoints: WebhookEndpoints;
13286
+ /** Billing: who you bill. */
13287
+ readonly customers: Customers;
13288
+ /** Billing: recurring prices on products. */
13289
+ readonly prices: Prices;
13290
+ /** Billing: bill a customer on a price every interval. */
13291
+ readonly subscriptions: Subscriptions;
13292
+ readonly invoices: Invoices;
13293
+ /** Billing: hosted links where a customer authorizes domiciliación. */
13294
+ readonly setupSessions: SetupSessions;
13295
+ /** Billing: domiciliación payment methods (bolívar methods your account takes: `payments.methods()`). */
13296
+ readonly paymentMethods: PaymentMethods;
10676
13297
  /** Offline helpers: `constructEvent` verifies deliveries; no API calls. */
10677
13298
  readonly webhooks: Webhooks;
10678
13299
  constructor(apiKey: string, options?: VexPayOptions);
@@ -10726,6 +13347,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
10726
13347
  declare class VexPaySignatureVerificationError extends VexPayError {
10727
13348
  }
10728
13349
 
10729
- declare const VERSION = "0.11.0";
13350
+ declare const VERSION = "0.12.0";
10730
13351
 
10731
13352
  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 };