@vexpay/node 0.14.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -13
- package/dist/index.cjs +56 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1320 -507
- package/dist/index.d.ts +1320 -507
- package/dist/index.js +56 -7
- package/dist/index.js.map +1 -1
- package/package.json +7 -3
package/dist/index.d.ts
CHANGED
|
@@ -50,6 +50,79 @@ interface components {
|
|
|
50
50
|
*/
|
|
51
51
|
error?: string;
|
|
52
52
|
};
|
|
53
|
+
CreateWebhookDto: {
|
|
54
|
+
/**
|
|
55
|
+
* Format: uri
|
|
56
|
+
* @example https://merchant.example.com/webhooks/vexpay
|
|
57
|
+
*/
|
|
58
|
+
url: string;
|
|
59
|
+
/**
|
|
60
|
+
* @description Signing secret. If omitted, a random secret is generated and returned once.
|
|
61
|
+
* @example replace-with-a-long-random-secret
|
|
62
|
+
*/
|
|
63
|
+
secret?: string;
|
|
64
|
+
/**
|
|
65
|
+
* @example [
|
|
66
|
+
* "payment.completed",
|
|
67
|
+
* "payment.failed"
|
|
68
|
+
* ]
|
|
69
|
+
*/
|
|
70
|
+
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" | "test_clock.advancing" | "test_clock.ready" | "notification.test")[];
|
|
71
|
+
};
|
|
72
|
+
WebhookEndpointDto: {
|
|
73
|
+
/** Format: uuid */
|
|
74
|
+
id: string;
|
|
75
|
+
/** Format: uuid */
|
|
76
|
+
tenantId: string;
|
|
77
|
+
/** Format: uri */
|
|
78
|
+
url: string;
|
|
79
|
+
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" | "test_clock.advancing" | "test_clock.ready" | "notification.test")[];
|
|
80
|
+
isActive: boolean;
|
|
81
|
+
/** Format: date-time */
|
|
82
|
+
createdAt: string;
|
|
83
|
+
/** @description Returned only when the endpoint is created. Store it securely; list responses omit it. */
|
|
84
|
+
secret?: string;
|
|
85
|
+
};
|
|
86
|
+
UpdateWebhookDto: {
|
|
87
|
+
/**
|
|
88
|
+
* Format: uri
|
|
89
|
+
* @example https://merchant.example.com/webhooks/vexpay
|
|
90
|
+
*/
|
|
91
|
+
url?: string;
|
|
92
|
+
/**
|
|
93
|
+
* @description Replaces the full event subscription list when provided.
|
|
94
|
+
* @example [
|
|
95
|
+
* "payment.completed",
|
|
96
|
+
* "payment.failed",
|
|
97
|
+
* "payout.completed"
|
|
98
|
+
* ]
|
|
99
|
+
*/
|
|
100
|
+
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" | "test_clock.advancing" | "test_clock.ready" | "notification.test")[];
|
|
101
|
+
/** @example true */
|
|
102
|
+
isActive?: boolean;
|
|
103
|
+
};
|
|
104
|
+
DeleteWebhookResponseDto: {
|
|
105
|
+
/** @example true */
|
|
106
|
+
deleted: boolean;
|
|
107
|
+
};
|
|
108
|
+
BsSettlementStatusDto: {
|
|
109
|
+
/**
|
|
110
|
+
* @description True when your available Bs is settled automatically as soon as the bank confirms each sale.
|
|
111
|
+
* @example true
|
|
112
|
+
*/
|
|
113
|
+
enabled: boolean;
|
|
114
|
+
/**
|
|
115
|
+
* @description `active` = settling; `no_payout_account` / `payout_account_unverified` = add and verify a payout account; `payout_account_cooling` = destination changed recently; `paused` = paused by VEX Pay; `disbursements` = your balance funds disbursements; `test_mode` = never settled in test mode.
|
|
116
|
+
* @example active
|
|
117
|
+
* @enum {string}
|
|
118
|
+
*/
|
|
119
|
+
status: "active" | "no_payout_account" | "payout_account_unverified" | "payout_account_cooling" | "paused" | "disbursements" | "test_mode";
|
|
120
|
+
/**
|
|
121
|
+
* @description Smallest available Bs amount that is settled.
|
|
122
|
+
* @example 100.00
|
|
123
|
+
*/
|
|
124
|
+
minimumVes: string;
|
|
125
|
+
};
|
|
53
126
|
PlatformBalanceDto: {
|
|
54
127
|
/** Format: uuid */
|
|
55
128
|
tenantId: string;
|
|
@@ -76,8 +149,8 @@ interface components {
|
|
|
76
149
|
/** @example 8650.00 */
|
|
77
150
|
ledgerNetVes: string;
|
|
78
151
|
/**
|
|
79
|
-
* @description VES under
|
|
80
|
-
* @example
|
|
152
|
+
* @description VES under a balance hold set by VEX Pay (none by default, see `balanceHoldHours`): such credits count in `ledgerNetVes` but cannot be paid out until their hold ends. Conversions and seller transfers may still use them.
|
|
153
|
+
* @example 0.00
|
|
81
154
|
*/
|
|
82
155
|
heldVes?: string;
|
|
83
156
|
/**
|
|
@@ -87,10 +160,17 @@ interface components {
|
|
|
87
160
|
*/
|
|
88
161
|
nextReleaseAt?: string | null;
|
|
89
162
|
/**
|
|
90
|
-
* @description What payouts can spend: ledgerNetVes − reserveVes − heldVes (seller obligations already deducted via SELLER_TRANSFER).
|
|
163
|
+
* @description What payouts and automatic settlement can spend: ledgerNetVes − reserveVes − heldVes − unconfirmedVes (seller obligations already deducted via SELLER_TRANSFER).
|
|
91
164
|
* @example 4150.00
|
|
92
165
|
*/
|
|
93
166
|
availableVes: string;
|
|
167
|
+
/**
|
|
168
|
+
* @description Bs from payments the bank has not confirmed yet: they count in `ledgerNetVes` but cannot be paid out or settled until the bank confirms them. Conversions and seller transfers may still use them.
|
|
169
|
+
* @example 4500.00
|
|
170
|
+
*/
|
|
171
|
+
unconfirmedVes?: string;
|
|
172
|
+
/** @description Automatic Bs settlement to your verified payout account. */
|
|
173
|
+
settlement?: components["schemas"]["BsSettlementStatusDto"];
|
|
94
174
|
/** @example 8650.00 */
|
|
95
175
|
platformAvailableVes: string;
|
|
96
176
|
/**
|
|
@@ -107,8 +187,8 @@ interface components {
|
|
|
107
187
|
/** @example 0.00 */
|
|
108
188
|
feeFixedUsd: string;
|
|
109
189
|
/**
|
|
110
|
-
* @description Hours each incoming credit is held before payouts can spend it (0 = no hold). Set by
|
|
111
|
-
* @example
|
|
190
|
+
* @description Hours each incoming credit is held before payouts can spend it (0 = no hold, the default). Set by VEX Pay.
|
|
191
|
+
* @example 0
|
|
112
192
|
*/
|
|
113
193
|
balanceHoldHours?: number;
|
|
114
194
|
};
|
|
@@ -159,61 +239,6 @@ interface components {
|
|
|
159
239
|
/** @description Pass as `cursor` to get the next (older) page; null on the last page. */
|
|
160
240
|
nextCursor: string | null;
|
|
161
241
|
};
|
|
162
|
-
CreateWebhookDto: {
|
|
163
|
-
/**
|
|
164
|
-
* Format: uri
|
|
165
|
-
* @example https://merchant.example.com/webhooks/vexpay
|
|
166
|
-
*/
|
|
167
|
-
url: string;
|
|
168
|
-
/**
|
|
169
|
-
* @description Signing secret. If omitted, a random secret is generated and returned once.
|
|
170
|
-
* @example replace-with-a-long-random-secret
|
|
171
|
-
*/
|
|
172
|
-
secret?: string;
|
|
173
|
-
/**
|
|
174
|
-
* @example [
|
|
175
|
-
* "payment.completed",
|
|
176
|
-
* "payment.failed"
|
|
177
|
-
* ]
|
|
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" | "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
|
-
};
|
|
181
|
-
WebhookEndpointDto: {
|
|
182
|
-
/** Format: uuid */
|
|
183
|
-
id: string;
|
|
184
|
-
/** Format: uuid */
|
|
185
|
-
tenantId: string;
|
|
186
|
-
/** Format: uri */
|
|
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" | "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
|
-
isActive: boolean;
|
|
190
|
-
/** Format: date-time */
|
|
191
|
-
createdAt: string;
|
|
192
|
-
/** @description Returned only when the endpoint is created. Store it securely; list responses omit it. */
|
|
193
|
-
secret?: string;
|
|
194
|
-
};
|
|
195
|
-
UpdateWebhookDto: {
|
|
196
|
-
/**
|
|
197
|
-
* Format: uri
|
|
198
|
-
* @example https://merchant.example.com/webhooks/vexpay
|
|
199
|
-
*/
|
|
200
|
-
url?: string;
|
|
201
|
-
/**
|
|
202
|
-
* @description Replaces the full event subscription list when provided.
|
|
203
|
-
* @example [
|
|
204
|
-
* "payment.completed",
|
|
205
|
-
* "payment.failed",
|
|
206
|
-
* "payout.completed"
|
|
207
|
-
* ]
|
|
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" | "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
|
-
/** @example true */
|
|
211
|
-
isActive?: boolean;
|
|
212
|
-
};
|
|
213
|
-
DeleteWebhookResponseDto: {
|
|
214
|
-
/** @example true */
|
|
215
|
-
deleted: boolean;
|
|
216
|
-
};
|
|
217
242
|
PayoutResponseDto: {
|
|
218
243
|
/**
|
|
219
244
|
* Format: uuid
|
|
@@ -221,15 +246,15 @@ interface components {
|
|
|
221
246
|
*/
|
|
222
247
|
payoutId: string;
|
|
223
248
|
/**
|
|
224
|
-
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit`, funds returned) when rejected.
|
|
249
|
+
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit` or `rejected_bank_unfunded`, funds returned) when rejected.
|
|
225
250
|
* @enum {string}
|
|
226
251
|
*/
|
|
227
252
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
228
253
|
/**
|
|
229
|
-
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent).
|
|
254
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
230
255
|
* @enum {string}
|
|
231
256
|
*/
|
|
232
|
-
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
257
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
233
258
|
/** @description Bank reference when available. */
|
|
234
259
|
reference?: string | null;
|
|
235
260
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -299,15 +324,15 @@ interface components {
|
|
|
299
324
|
*/
|
|
300
325
|
payoutId: string;
|
|
301
326
|
/**
|
|
302
|
-
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit`, funds returned) when rejected.
|
|
327
|
+
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit` or `rejected_bank_unfunded`, funds returned) when rejected.
|
|
303
328
|
* @enum {string}
|
|
304
329
|
*/
|
|
305
330
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
306
331
|
/**
|
|
307
|
-
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent).
|
|
332
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
308
333
|
* @enum {string}
|
|
309
334
|
*/
|
|
310
|
-
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
335
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
311
336
|
/** @description Bank reference when available. */
|
|
312
337
|
reference?: string | null;
|
|
313
338
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -464,8 +489,12 @@ interface components {
|
|
|
464
489
|
accountId: string;
|
|
465
490
|
/** @example 0163 */
|
|
466
491
|
bankCode: string;
|
|
467
|
-
/** @
|
|
492
|
+
/** @enum {string} */
|
|
493
|
+
type: "pago_movil" | "bank_account";
|
|
494
|
+
/** @description Masked destination: phone `…5555` (Pago Móvil) or account `••••6789` (bank_account). */
|
|
468
495
|
destination: string;
|
|
496
|
+
/** @description Account holder name (bank_account only). */
|
|
497
|
+
holderName?: string | null;
|
|
469
498
|
/** @example V12345678 */
|
|
470
499
|
identification: string;
|
|
471
500
|
/**
|
|
@@ -512,20 +541,36 @@ interface components {
|
|
|
512
541
|
};
|
|
513
542
|
UpsertTenantPayoutAccountDto: {
|
|
514
543
|
/**
|
|
515
|
-
* @description
|
|
544
|
+
* @description `pago_movil` (bank + phone) or `bank_account` (20-digit checking account). Switching type is a destination change.
|
|
545
|
+
* @default pago_movil
|
|
546
|
+
* @enum {string}
|
|
547
|
+
*/
|
|
548
|
+
type?: "pago_movil" | "bank_account";
|
|
549
|
+
/**
|
|
550
|
+
* @description Beneficiary bank SIMF code (3–4 digits). Prefer codes from GET /v1/banks. Required for `pago_movil`; for `bank_account` it is taken from the account number and, when sent, must match its first 4 digits.
|
|
516
551
|
* @example 0163
|
|
517
552
|
*/
|
|
518
|
-
banco
|
|
553
|
+
banco?: string;
|
|
519
554
|
/**
|
|
520
|
-
* @description Beneficiary cédula/RIF.
|
|
555
|
+
* @description Beneficiary (account holder) cédula/RIF.
|
|
521
556
|
* @example V12345678
|
|
522
557
|
*/
|
|
523
558
|
cedula: string;
|
|
524
559
|
/**
|
|
525
|
-
* @description Beneficiary Pago Móvil phone (58… or 0…).
|
|
560
|
+
* @description Beneficiary Pago Móvil phone (58… or 0…). Required for `pago_movil`.
|
|
526
561
|
* @example 584121234567
|
|
527
562
|
*/
|
|
528
|
-
telefono
|
|
563
|
+
telefono?: string;
|
|
564
|
+
/**
|
|
565
|
+
* @description 20-digit checking account number. Required for `bank_account`.
|
|
566
|
+
* @example 01160123450123456789
|
|
567
|
+
*/
|
|
568
|
+
cuenta?: string;
|
|
569
|
+
/**
|
|
570
|
+
* @description Account holder name. Required for `bank_account`.
|
|
571
|
+
* @example Rival Plus C.A.
|
|
572
|
+
*/
|
|
573
|
+
titular?: string;
|
|
529
574
|
};
|
|
530
575
|
ConfirmTenantPayoutAccountVerifyDto: {
|
|
531
576
|
/**
|
|
@@ -604,7 +649,7 @@ interface components {
|
|
|
604
649
|
success?: boolean;
|
|
605
650
|
/**
|
|
606
651
|
* Format: uuid
|
|
607
|
-
* @description
|
|
652
|
+
* @description VEX Pay payment id for this débito inmediato (method DEBITO_INMEDIATO).
|
|
608
653
|
* @example 3fd84b2d-9ad1-4f74-a2d9-0f2f56984db5
|
|
609
654
|
*/
|
|
610
655
|
paymentId: string;
|
|
@@ -759,6 +804,33 @@ interface components {
|
|
|
759
804
|
*/
|
|
760
805
|
cedula: string;
|
|
761
806
|
};
|
|
807
|
+
SplitShareDto: {
|
|
808
|
+
/**
|
|
809
|
+
* @description A merchant of your account (UUID or `mrc_…` id). Each merchant at most once per payment.
|
|
810
|
+
* @example mrc_3f2b9c1e0a7d4e6f8b1c2d3e4f5a6b7c
|
|
811
|
+
*/
|
|
812
|
+
merchantId: string;
|
|
813
|
+
/**
|
|
814
|
+
* @description This merchant's share, in the currency of the request's amount: VES for débito, C2P and Pago Móvil; for VPOS, VES when you send `vesAmount`, else USD. A string with exactly two decimals ("6000.00") or a number with at most two. USD shares are converted at the payment's rate and rounded down to Bs 0.01. Whatever the shares do not cover stays with your account (the marketplace remainder).
|
|
815
|
+
* @example 6000.00
|
|
816
|
+
*/
|
|
817
|
+
amount: string | number;
|
|
818
|
+
/**
|
|
819
|
+
* @description Your commission on this share, in VES (exactly two decimals). Not with applicationFeePercent.
|
|
820
|
+
* @example 1200.00
|
|
821
|
+
*/
|
|
822
|
+
applicationFeeVes?: string;
|
|
823
|
+
/**
|
|
824
|
+
* @description Your commission as a percent of this share's VES amount. When both are omitted the merchant's negotiated commission applies, else your default commission, else none.
|
|
825
|
+
* @example 20
|
|
826
|
+
*/
|
|
827
|
+
applicationFeePercent?: number;
|
|
828
|
+
/**
|
|
829
|
+
* @description Free text returned as sent.
|
|
830
|
+
* @example order-1042/provider-a
|
|
831
|
+
*/
|
|
832
|
+
reference?: string;
|
|
833
|
+
};
|
|
762
834
|
ImmediateDebitDto: {
|
|
763
835
|
/**
|
|
764
836
|
* @description 3–4 digit bank code (padded to 4 digits when sent to the network). Prefer codes from GET /v1/banks.
|
|
@@ -812,6 +884,8 @@ interface components {
|
|
|
812
884
|
* @example 10
|
|
813
885
|
*/
|
|
814
886
|
applicationFeePercent?: number;
|
|
887
|
+
/** @description Split this payment between up to 10 of your merchants (marketplace). Each merchant is credited its share minus its part of the VEX Pay fee and your commission when the bank confirms the payment; the rest stays with your account. Not with merchantId / applicationFeeVes / applicationFeePercent, and not with onwardPayout. See the "Marketplace: split one payment between comercios" guide. */
|
|
888
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
815
889
|
};
|
|
816
890
|
ManualOperationPollDto: {
|
|
817
891
|
/**
|
|
@@ -1002,13 +1076,13 @@ interface components {
|
|
|
1002
1076
|
*/
|
|
1003
1077
|
available: string;
|
|
1004
1078
|
/**
|
|
1005
|
-
* @description
|
|
1079
|
+
* @description Credited but not payable yet, in `currency`: under a balance hold until it ends, or bought with VES still awaiting bank confirmation until the bank confirms it.
|
|
1006
1080
|
* @example 0.00
|
|
1007
1081
|
*/
|
|
1008
1082
|
held?: string;
|
|
1009
1083
|
/**
|
|
1010
1084
|
* Format: date-time
|
|
1011
|
-
* @description When the soonest held amount becomes available; null when nothing is held.
|
|
1085
|
+
* @description When the soonest held amount becomes available; null when nothing is held or only amounts awaiting bank confirmation (no set time) are held.
|
|
1012
1086
|
*/
|
|
1013
1087
|
nextReleaseAt?: string | null;
|
|
1014
1088
|
/**
|
|
@@ -1272,7 +1346,7 @@ interface components {
|
|
|
1272
1346
|
merchantId?: string;
|
|
1273
1347
|
idempotencyKey: string;
|
|
1274
1348
|
txHash?: string;
|
|
1275
|
-
/** @description Settled inside
|
|
1349
|
+
/** @description Settled inside VEX Pay (destination is one of your own deposit addresses). */
|
|
1276
1350
|
internal: boolean;
|
|
1277
1351
|
failureReason?: string;
|
|
1278
1352
|
/** Format: date-time */
|
|
@@ -1375,7 +1449,7 @@ interface components {
|
|
|
1375
1449
|
};
|
|
1376
1450
|
CreateCopPaymentDto: {
|
|
1377
1451
|
/**
|
|
1378
|
-
* @description Amount in whole Colombian pesos. At least
|
|
1452
|
+
* @description Amount in whole Colombian pesos. At least 20,000 (`amount_below_minimum` otherwise).
|
|
1379
1453
|
* @example 100000
|
|
1380
1454
|
*/
|
|
1381
1455
|
amountCop: number;
|
|
@@ -1828,10 +1902,12 @@ interface components {
|
|
|
1828
1902
|
applicationFeePercent?: number;
|
|
1829
1903
|
/** @description Convert this payment's net VES to USDT once it completes and send it to this wallet. Needs USDT and conversions enabled; not allowed with merchantId. See the "Pay in bolívars, receive USDT" guide. */
|
|
1830
1904
|
onwardPayout?: components["schemas"]["OnwardPayoutDto"];
|
|
1905
|
+
/** @description Split this payment between up to 10 of your merchants (marketplace). Each merchant is credited its share minus its part of the VEX Pay fee and your commission when the bank confirms the payment; the rest stays with your account. Not with merchantId / applicationFeeVes / applicationFeePercent, and not with onwardPayout. See the "Marketplace: split one payment between comercios" guide. */
|
|
1906
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
1831
1907
|
};
|
|
1832
1908
|
OnwardPayoutStatusDto: {
|
|
1833
1909
|
/**
|
|
1834
|
-
* @description `waiting_release`: converted, waiting
|
|
1910
|
+
* @description `waiting_release`: converted, waiting before sending until the balance hold ends (see `sendAfter`) or, with `reason: awaiting_bank_confirmation`, until the bank confirms the paid VES.
|
|
1835
1911
|
* @example completed
|
|
1836
1912
|
* @enum {string}
|
|
1837
1913
|
*/
|
|
@@ -1864,18 +1940,53 @@ interface components {
|
|
|
1864
1940
|
/** @description On-chain hash once the payout completed. */
|
|
1865
1941
|
txHash?: string;
|
|
1866
1942
|
/**
|
|
1867
|
-
* @description Why it is held, failed or canceled.
|
|
1943
|
+
* @description Why it is waiting, held, failed or canceled (`awaiting_bank_confirmation` while the bank has not confirmed the paid VES).
|
|
1868
1944
|
* @example below_payout_minimum
|
|
1869
1945
|
*/
|
|
1870
1946
|
reason?: string;
|
|
1871
1947
|
/**
|
|
1872
1948
|
* Format: date-time
|
|
1873
|
-
* @description `waiting_release` only: when the converted USDT leaves the balance hold and the payout is sent.
|
|
1949
|
+
* @description `waiting_release` only: when the converted USDT leaves the balance hold and the payout is sent. Omitted while waiting for bank confirmation.
|
|
1874
1950
|
*/
|
|
1875
1951
|
sendAfter?: string;
|
|
1876
1952
|
/** Format: date-time */
|
|
1877
1953
|
updatedAt: string;
|
|
1878
1954
|
};
|
|
1955
|
+
PaymentSplitViewDto: {
|
|
1956
|
+
/** Format: uuid */
|
|
1957
|
+
merchantId: string;
|
|
1958
|
+
/**
|
|
1959
|
+
* @description The merchant's account id (same as the payment-level accountId).
|
|
1960
|
+
* @example acct_3f2b9c1e0a7d4e6f8b1c2d3e4f5a6b7c
|
|
1961
|
+
*/
|
|
1962
|
+
accountId: string;
|
|
1963
|
+
/**
|
|
1964
|
+
* @description The merchant's externalRef.
|
|
1965
|
+
* @example planazo-comercio-17
|
|
1966
|
+
*/
|
|
1967
|
+
merchantExternalRef?: string | null;
|
|
1968
|
+
/** @example 6000.00 */
|
|
1969
|
+
amountVes: string;
|
|
1970
|
+
/**
|
|
1971
|
+
* @description Your commission on this share.
|
|
1972
|
+
* @example 1200.00
|
|
1973
|
+
*/
|
|
1974
|
+
applicationFeeVes: string;
|
|
1975
|
+
/** @example 20.0000 */
|
|
1976
|
+
applicationFeePercent?: string | null;
|
|
1977
|
+
/**
|
|
1978
|
+
* @description This share's part of the VEX Pay fee (null until completed).
|
|
1979
|
+
* @example 180.00
|
|
1980
|
+
*/
|
|
1981
|
+
feeVes?: string | null;
|
|
1982
|
+
/**
|
|
1983
|
+
* @description Credited to the merchant (null until completed; 0.00 when the share nets nothing).
|
|
1984
|
+
* @example 4620.00
|
|
1985
|
+
*/
|
|
1986
|
+
netVes?: string | null;
|
|
1987
|
+
/** @example order-1042/provider-a */
|
|
1988
|
+
reference?: string | null;
|
|
1989
|
+
};
|
|
1879
1990
|
C2pIntentResponseDto: {
|
|
1880
1991
|
/**
|
|
1881
1992
|
* Format: uuid
|
|
@@ -1965,6 +2076,8 @@ interface components {
|
|
|
1965
2076
|
reversalTxId?: number;
|
|
1966
2077
|
/** @description Present when the pay-in was sent with `onwardPayout`. */
|
|
1967
2078
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
2079
|
+
/** @description Multi-merchant split payments only: each merchant share with its commission, VEX Pay fee and net (feeVes / netVes are set when the payment completes). Omitted for every other payment. */
|
|
2080
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
1968
2081
|
/**
|
|
1969
2082
|
* Format: uuid
|
|
1970
2083
|
* @description Use this value as intentId when executing the C2P charge.
|
|
@@ -2025,6 +2138,8 @@ interface components {
|
|
|
2025
2138
|
applicationFeePercent?: number;
|
|
2026
2139
|
/** @description Convert this payment's net VES to USDT once it completes and send it to this wallet. Needs USDT and conversions enabled; not allowed with merchantId. See the "Pay in bolívars, receive USDT" guide. */
|
|
2027
2140
|
onwardPayout?: components["schemas"]["OnwardPayoutDto"];
|
|
2141
|
+
/** @description Split this payment between up to 10 of your merchants (marketplace). Each merchant is credited its share minus its part of the VEX Pay fee and your commission when the bank confirms the payment; the rest stays with your account. Not with merchantId / applicationFeeVes / applicationFeePercent, and not with onwardPayout. See the "Marketplace: split one payment between comercios" guide. */
|
|
2142
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
2028
2143
|
};
|
|
2029
2144
|
PaymentReceiptDto: {
|
|
2030
2145
|
/**
|
|
@@ -2115,6 +2230,8 @@ interface components {
|
|
|
2115
2230
|
reversalTxId?: number;
|
|
2116
2231
|
/** @description Present when the pay-in was sent with `onwardPayout`. */
|
|
2117
2232
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
2233
|
+
/** @description Multi-merchant split payments only: each merchant share with its commission, VEX Pay fee and net (feeVes / netVes are set when the payment completes). Omitted for every other payment. */
|
|
2234
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
2118
2235
|
};
|
|
2119
2236
|
VposPaymentDto: {
|
|
2120
2237
|
/**
|
|
@@ -2181,6 +2298,8 @@ interface components {
|
|
|
2181
2298
|
* @example 10
|
|
2182
2299
|
*/
|
|
2183
2300
|
applicationFeePercent?: number;
|
|
2301
|
+
/** @description Split this payment between up to 10 of your merchants (marketplace). Each merchant is credited its share minus its part of the VEX Pay fee and your commission when the bank confirms the payment; the rest stays with your account. Not with merchantId / applicationFeeVes / applicationFeePercent, and not with onwardPayout. See the "Marketplace: split one payment between comercios" guide. */
|
|
2302
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
2184
2303
|
};
|
|
2185
2304
|
PaymentMethodAvailabilityDto: {
|
|
2186
2305
|
/**
|
|
@@ -2268,6 +2387,8 @@ interface components {
|
|
|
2268
2387
|
debtorCellPhone?: string;
|
|
2269
2388
|
/** @description Convert this payment's net VES to USDT once it completes and send it to this wallet. Needs USDT and conversions enabled; not allowed with merchantId. See the "Pay in bolívars, receive USDT" guide. */
|
|
2270
2389
|
onwardPayout?: components["schemas"]["OnwardPayoutDto"];
|
|
2390
|
+
/** @description Split this payment between up to 10 of your merchants (marketplace). Each merchant is credited its share minus its part of the VEX Pay fee and your commission when the bank confirms the payment; the rest stays with your account. Not with merchantId / applicationFeeVes / applicationFeePercent, and not with onwardPayout. See the "Marketplace: split one payment between comercios" guide. */
|
|
2391
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
2271
2392
|
};
|
|
2272
2393
|
PayoutMethodResponseDto: {
|
|
2273
2394
|
/** Format: uuid */
|
|
@@ -2466,6 +2587,8 @@ interface components {
|
|
|
2466
2587
|
* @example 04145555555
|
|
2467
2588
|
*/
|
|
2468
2589
|
phone?: string;
|
|
2590
|
+
/** @description Pay this merchant's available balance automatically every 15 minutes. Omit it to use your account's `merchantAutoPayoutDefault` (GET /v1/marketplace/settings). Used only when the merchant is created; change it later with PATCH /v1/merchants/{id}. */
|
|
2591
|
+
autoPayoutEnabled?: boolean;
|
|
2469
2592
|
};
|
|
2470
2593
|
CreatePayoutMethodDto: {
|
|
2471
2594
|
/**
|
|
@@ -2589,6 +2712,11 @@ interface components {
|
|
|
2589
2712
|
transferKey?: string;
|
|
2590
2713
|
/** Format: uuid */
|
|
2591
2714
|
paymentId?: string | null;
|
|
2715
|
+
/**
|
|
2716
|
+
* @description `credit` rows of a multi-merchant split payment: the share `reference` sent with the payment.
|
|
2717
|
+
* @example order-1042/provider-a
|
|
2718
|
+
*/
|
|
2719
|
+
splitReference?: string;
|
|
2592
2720
|
/** Format: uuid */
|
|
2593
2721
|
payoutId?: string | null;
|
|
2594
2722
|
/**
|
|
@@ -2654,6 +2782,35 @@ interface components {
|
|
|
2654
2782
|
*/
|
|
2655
2783
|
applicationFeePercent?: number | null;
|
|
2656
2784
|
};
|
|
2785
|
+
MarketplaceSettingsDto: {
|
|
2786
|
+
/**
|
|
2787
|
+
* @description When true, merchants you create without `autoPayoutEnabled` start with auto-payout on. Existing merchants keep their setting.
|
|
2788
|
+
* @example true
|
|
2789
|
+
*/
|
|
2790
|
+
merchantAutoPayoutDefault: boolean;
|
|
2791
|
+
/**
|
|
2792
|
+
* @description Smallest available balance, in USD at the BCV rate, that an automatic merchant payout sends. null = no minimum (any balance of Bs 1 or more).
|
|
2793
|
+
* @example 10.00
|
|
2794
|
+
*/
|
|
2795
|
+
merchantAutoPayoutMinUsd?: string | null;
|
|
2796
|
+
};
|
|
2797
|
+
UpdateMarketplaceSettingsDto: {
|
|
2798
|
+
/** @example true */
|
|
2799
|
+
merchantAutoPayoutDefault?: boolean;
|
|
2800
|
+
/**
|
|
2801
|
+
* @description USD with at most two decimals (string or number), 0–100000. null or 0 clears the minimum.
|
|
2802
|
+
* @example 10.00
|
|
2803
|
+
*/
|
|
2804
|
+
merchantAutoPayoutMinUsd?: string | null;
|
|
2805
|
+
};
|
|
2806
|
+
NotificationTestResponseDto: {
|
|
2807
|
+
/** @example true */
|
|
2808
|
+
sent: boolean;
|
|
2809
|
+
/** @example notification.test */
|
|
2810
|
+
event: string;
|
|
2811
|
+
/** Format: uuid */
|
|
2812
|
+
tenantId: string;
|
|
2813
|
+
};
|
|
2657
2814
|
CreateCheckoutSessionDto: {
|
|
2658
2815
|
/**
|
|
2659
2816
|
* @description USD amount, up to 2 decimals.
|
|
@@ -2729,7 +2886,7 @@ interface components {
|
|
|
2729
2886
|
* @example cs-9f2a4b7c1d3e_secret_k8Jc…
|
|
2730
2887
|
*/
|
|
2731
2888
|
clientSecret?: string;
|
|
2732
|
-
/** @example https://pay.
|
|
2889
|
+
/** @example https://pay.vexpay.app/pay/cs-9f2a4b7c1d3e */
|
|
2733
2890
|
url: string;
|
|
2734
2891
|
/** @example 25.00 */
|
|
2735
2892
|
amountUsd: string;
|
|
@@ -2802,7 +2959,7 @@ interface components {
|
|
|
2802
2959
|
items: components["schemas"]["PaymentLinkResponseDto"][];
|
|
2803
2960
|
};
|
|
2804
2961
|
CreateProductDto: {
|
|
2805
|
-
/** @example Camiseta
|
|
2962
|
+
/** @example Camiseta VEX Pay */
|
|
2806
2963
|
name: string;
|
|
2807
2964
|
description?: string;
|
|
2808
2965
|
/** @example https://cdn.example/shirt.png */
|
|
@@ -2943,14 +3100,6 @@ interface components {
|
|
|
2943
3100
|
/** @example 2500.00 */
|
|
2944
3101
|
monthRemainingUsd: string;
|
|
2945
3102
|
};
|
|
2946
|
-
NotificationTestResponseDto: {
|
|
2947
|
-
/** @example true */
|
|
2948
|
-
sent: boolean;
|
|
2949
|
-
/** @example notification.test */
|
|
2950
|
-
event: string;
|
|
2951
|
-
/** Format: uuid */
|
|
2952
|
-
tenantId: string;
|
|
2953
|
-
};
|
|
2954
3103
|
CreateCustomerDto: {
|
|
2955
3104
|
/** @example Ana Pérez */
|
|
2956
3105
|
name?: string | null;
|
|
@@ -2975,7 +3124,10 @@ interface components {
|
|
|
2975
3124
|
metadata?: {
|
|
2976
3125
|
[key: string]: string;
|
|
2977
3126
|
} | null;
|
|
2978
|
-
/**
|
|
3127
|
+
/**
|
|
3128
|
+
* @description Attach the customer to a test clock (test mode only, at most 3 customers per clock). Set on create only.
|
|
3129
|
+
* @example clock_3fd84b2d9ad14f74a2d90f2f56984db5
|
|
3130
|
+
*/
|
|
2979
3131
|
testClock?: string;
|
|
2980
3132
|
};
|
|
2981
3133
|
CustomerResponseDto: {
|
|
@@ -2993,6 +3145,7 @@ interface components {
|
|
|
2993
3145
|
metadata: {
|
|
2994
3146
|
[key: string]: string;
|
|
2995
3147
|
};
|
|
3148
|
+
/** @description Test clock id (`clock_…`) the customer runs on, or null. */
|
|
2996
3149
|
testClock: string | null;
|
|
2997
3150
|
createdAt: string;
|
|
2998
3151
|
livemode: boolean;
|
|
@@ -3025,7 +3178,10 @@ interface components {
|
|
|
3025
3178
|
metadata?: {
|
|
3026
3179
|
[key: string]: string;
|
|
3027
3180
|
} | null;
|
|
3028
|
-
/**
|
|
3181
|
+
/**
|
|
3182
|
+
* @description Attach the customer to a test clock (test mode only, at most 3 customers per clock). Set on create only.
|
|
3183
|
+
* @example clock_3fd84b2d9ad14f74a2d90f2f56984db5
|
|
3184
|
+
*/
|
|
3029
3185
|
testClock?: string;
|
|
3030
3186
|
};
|
|
3031
3187
|
DeletedObjectResponseDto: {
|
|
@@ -3216,7 +3372,7 @@ interface components {
|
|
|
3216
3372
|
};
|
|
3217
3373
|
PayInvoiceDto: {
|
|
3218
3374
|
/**
|
|
3219
|
-
* @description Mark the invoice paid outside
|
|
3375
|
+
* @description Mark the invoice paid outside VEX Pay (cash, transfer). No balance change.
|
|
3220
3376
|
* @example true
|
|
3221
3377
|
*/
|
|
3222
3378
|
paidOutOfBand: boolean;
|
|
@@ -3271,6 +3427,45 @@ interface components {
|
|
|
3271
3427
|
items: components["schemas"]["PaymentMethodResponseDto"][];
|
|
3272
3428
|
nextCursor: string | null;
|
|
3273
3429
|
};
|
|
3430
|
+
CreateTestClockDto: {
|
|
3431
|
+
/**
|
|
3432
|
+
* @description ISO 8601 time the clock starts at.
|
|
3433
|
+
* @example 2026-01-01T00:00:00.000Z
|
|
3434
|
+
*/
|
|
3435
|
+
frozenTime: string;
|
|
3436
|
+
/** @example Dunning test */
|
|
3437
|
+
name?: string | null;
|
|
3438
|
+
};
|
|
3439
|
+
TestClockResponseDto: {
|
|
3440
|
+
/** @example clock_3fd84b2d9ad14f74a2d90f2f56984db5 */
|
|
3441
|
+
id: string;
|
|
3442
|
+
/** @example test_clock */
|
|
3443
|
+
object: string;
|
|
3444
|
+
name: string | null;
|
|
3445
|
+
/** @description The clock's current time. */
|
|
3446
|
+
frozenTime: string;
|
|
3447
|
+
/**
|
|
3448
|
+
* @description advancing while events between the old and new time are being run.
|
|
3449
|
+
* @enum {string}
|
|
3450
|
+
*/
|
|
3451
|
+
status: "ready" | "advancing" | "internal_failure";
|
|
3452
|
+
/** @description While advancing: the time the clock is moving to. */
|
|
3453
|
+
targetTime: string | null;
|
|
3454
|
+
createdAt: string;
|
|
3455
|
+
/** @example false */
|
|
3456
|
+
livemode: boolean;
|
|
3457
|
+
};
|
|
3458
|
+
TestClockListResponseDto: {
|
|
3459
|
+
items: components["schemas"]["TestClockResponseDto"][];
|
|
3460
|
+
nextCursor: string | null;
|
|
3461
|
+
};
|
|
3462
|
+
AdvanceTestClockDto: {
|
|
3463
|
+
/**
|
|
3464
|
+
* @description ISO 8601 time to move to: later than the current one, and at most two intervals of the shortest subscription on the clock ahead.
|
|
3465
|
+
* @example 2026-01-05T00:00:00.000Z
|
|
3466
|
+
*/
|
|
3467
|
+
frozenTime: string;
|
|
3468
|
+
};
|
|
3274
3469
|
};
|
|
3275
3470
|
responses: never;
|
|
3276
3471
|
parameters: never;
|
|
@@ -3279,7 +3474,7 @@ interface components {
|
|
|
3279
3474
|
pathItems: never;
|
|
3280
3475
|
}
|
|
3281
3476
|
interface operations {
|
|
3282
|
-
|
|
3477
|
+
Webhooks_listWebhooks: {
|
|
3283
3478
|
parameters: {
|
|
3284
3479
|
query?: never;
|
|
3285
3480
|
header?: never;
|
|
@@ -3293,7 +3488,7 @@ interface operations {
|
|
|
3293
3488
|
[name: string]: unknown;
|
|
3294
3489
|
};
|
|
3295
3490
|
content: {
|
|
3296
|
-
"application/json": components["schemas"]["
|
|
3491
|
+
"application/json": components["schemas"]["WebhookEndpointDto"][];
|
|
3297
3492
|
};
|
|
3298
3493
|
};
|
|
3299
3494
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -3334,45 +3529,28 @@ interface operations {
|
|
|
3334
3529
|
};
|
|
3335
3530
|
};
|
|
3336
3531
|
};
|
|
3337
|
-
|
|
3532
|
+
Webhooks_createWebhook: {
|
|
3338
3533
|
parameters: {
|
|
3339
|
-
query?:
|
|
3340
|
-
|
|
3341
|
-
|
|
3342
|
-
|
|
3343
|
-
from?: string;
|
|
3344
|
-
/** @description Only movements of this payout. */
|
|
3345
|
-
payoutId?: string;
|
|
3346
|
-
/** @description Only movements of this payment. */
|
|
3347
|
-
paymentId?: string;
|
|
3348
|
-
/** @description One or more types (repeat or comma-separate). */
|
|
3349
|
-
type?: ("payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee" | "disbursement_payout_fee" | "disbursement_payout_fee_reversal" | "topup" | "topup_fee" | "topup_instant_release" | "topup_instant_fee")[];
|
|
3350
|
-
/** @description `nextCursor` from the previous page. */
|
|
3351
|
-
cursor?: string;
|
|
3352
|
-
/** @description 1–100, default 50. */
|
|
3353
|
-
limit?: number;
|
|
3534
|
+
query?: never;
|
|
3535
|
+
header?: {
|
|
3536
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
3537
|
+
"Idempotency-Key"?: string;
|
|
3354
3538
|
};
|
|
3355
|
-
header?: never;
|
|
3356
3539
|
path?: never;
|
|
3357
3540
|
cookie?: never;
|
|
3358
3541
|
};
|
|
3359
|
-
requestBody
|
|
3542
|
+
requestBody: {
|
|
3543
|
+
content: {
|
|
3544
|
+
"application/json": components["schemas"]["CreateWebhookDto"];
|
|
3545
|
+
};
|
|
3546
|
+
};
|
|
3360
3547
|
responses: {
|
|
3361
|
-
|
|
3548
|
+
201: {
|
|
3362
3549
|
headers: {
|
|
3363
3550
|
[name: string]: unknown;
|
|
3364
3551
|
};
|
|
3365
3552
|
content: {
|
|
3366
|
-
"application/json": components["schemas"]["
|
|
3367
|
-
};
|
|
3368
|
-
};
|
|
3369
|
-
/** @description `invalid_data` — a parameter is invalid. */
|
|
3370
|
-
400: {
|
|
3371
|
-
headers: {
|
|
3372
|
-
[name: string]: unknown;
|
|
3373
|
-
};
|
|
3374
|
-
content: {
|
|
3375
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3553
|
+
"application/json": components["schemas"]["WebhookEndpointDto"];
|
|
3376
3554
|
};
|
|
3377
3555
|
};
|
|
3378
3556
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -3413,11 +3591,13 @@ interface operations {
|
|
|
3413
3591
|
};
|
|
3414
3592
|
};
|
|
3415
3593
|
};
|
|
3416
|
-
|
|
3594
|
+
Webhooks_deleteWebhook: {
|
|
3417
3595
|
parameters: {
|
|
3418
3596
|
query?: never;
|
|
3419
3597
|
header?: never;
|
|
3420
|
-
path
|
|
3598
|
+
path: {
|
|
3599
|
+
id: string;
|
|
3600
|
+
};
|
|
3421
3601
|
cookie?: never;
|
|
3422
3602
|
};
|
|
3423
3603
|
requestBody?: never;
|
|
@@ -3427,7 +3607,7 @@ interface operations {
|
|
|
3427
3607
|
[name: string]: unknown;
|
|
3428
3608
|
};
|
|
3429
3609
|
content: {
|
|
3430
|
-
"application/json": components["schemas"]["
|
|
3610
|
+
"application/json": components["schemas"]["DeleteWebhookResponseDto"];
|
|
3431
3611
|
};
|
|
3432
3612
|
};
|
|
3433
3613
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -3448,6 +3628,14 @@ interface operations {
|
|
|
3448
3628
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3449
3629
|
};
|
|
3450
3630
|
};
|
|
3631
|
+
404: {
|
|
3632
|
+
headers: {
|
|
3633
|
+
[name: string]: unknown;
|
|
3634
|
+
};
|
|
3635
|
+
content: {
|
|
3636
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3637
|
+
};
|
|
3638
|
+
};
|
|
3451
3639
|
/** @description Client error. */
|
|
3452
3640
|
"4XX": {
|
|
3453
3641
|
headers: {
|
|
@@ -3468,23 +3656,22 @@ interface operations {
|
|
|
3468
3656
|
};
|
|
3469
3657
|
};
|
|
3470
3658
|
};
|
|
3471
|
-
|
|
3659
|
+
Webhooks_updateWebhook: {
|
|
3472
3660
|
parameters: {
|
|
3473
3661
|
query?: never;
|
|
3474
|
-
header?:
|
|
3475
|
-
|
|
3476
|
-
|
|
3662
|
+
header?: never;
|
|
3663
|
+
path: {
|
|
3664
|
+
id: string;
|
|
3477
3665
|
};
|
|
3478
|
-
path?: never;
|
|
3479
3666
|
cookie?: never;
|
|
3480
3667
|
};
|
|
3481
3668
|
requestBody: {
|
|
3482
3669
|
content: {
|
|
3483
|
-
"application/json": components["schemas"]["
|
|
3670
|
+
"application/json": components["schemas"]["UpdateWebhookDto"];
|
|
3484
3671
|
};
|
|
3485
3672
|
};
|
|
3486
3673
|
responses: {
|
|
3487
|
-
|
|
3674
|
+
200: {
|
|
3488
3675
|
headers: {
|
|
3489
3676
|
[name: string]: unknown;
|
|
3490
3677
|
};
|
|
@@ -3492,6 +3679,14 @@ interface operations {
|
|
|
3492
3679
|
"application/json": components["schemas"]["WebhookEndpointDto"];
|
|
3493
3680
|
};
|
|
3494
3681
|
};
|
|
3682
|
+
400: {
|
|
3683
|
+
headers: {
|
|
3684
|
+
[name: string]: unknown;
|
|
3685
|
+
};
|
|
3686
|
+
content: {
|
|
3687
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3688
|
+
};
|
|
3689
|
+
};
|
|
3495
3690
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
3496
3691
|
401: {
|
|
3497
3692
|
headers: {
|
|
@@ -3510,6 +3705,14 @@ interface operations {
|
|
|
3510
3705
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3511
3706
|
};
|
|
3512
3707
|
};
|
|
3708
|
+
404: {
|
|
3709
|
+
headers: {
|
|
3710
|
+
[name: string]: unknown;
|
|
3711
|
+
};
|
|
3712
|
+
content: {
|
|
3713
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3714
|
+
};
|
|
3715
|
+
};
|
|
3513
3716
|
/** @description Client error. */
|
|
3514
3717
|
"4XX": {
|
|
3515
3718
|
headers: {
|
|
@@ -3530,13 +3733,11 @@ interface operations {
|
|
|
3530
3733
|
};
|
|
3531
3734
|
};
|
|
3532
3735
|
};
|
|
3533
|
-
|
|
3736
|
+
Balance_getBalance: {
|
|
3534
3737
|
parameters: {
|
|
3535
3738
|
query?: never;
|
|
3536
3739
|
header?: never;
|
|
3537
|
-
path
|
|
3538
|
-
id: string;
|
|
3539
|
-
};
|
|
3740
|
+
path?: never;
|
|
3540
3741
|
cookie?: never;
|
|
3541
3742
|
};
|
|
3542
3743
|
requestBody?: never;
|
|
@@ -3546,7 +3747,7 @@ interface operations {
|
|
|
3546
3747
|
[name: string]: unknown;
|
|
3547
3748
|
};
|
|
3548
3749
|
content: {
|
|
3549
|
-
"application/json": components["schemas"]["
|
|
3750
|
+
"application/json": components["schemas"]["PlatformBalanceDto"];
|
|
3550
3751
|
};
|
|
3551
3752
|
};
|
|
3552
3753
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -3567,14 +3768,6 @@ interface operations {
|
|
|
3567
3768
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3568
3769
|
};
|
|
3569
3770
|
};
|
|
3570
|
-
404: {
|
|
3571
|
-
headers: {
|
|
3572
|
-
[name: string]: unknown;
|
|
3573
|
-
};
|
|
3574
|
-
content: {
|
|
3575
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3576
|
-
};
|
|
3577
|
-
};
|
|
3578
3771
|
/** @description Client error. */
|
|
3579
3772
|
"4XX": {
|
|
3580
3773
|
headers: {
|
|
@@ -3595,29 +3788,39 @@ interface operations {
|
|
|
3595
3788
|
};
|
|
3596
3789
|
};
|
|
3597
3790
|
};
|
|
3598
|
-
|
|
3791
|
+
Balance_listTransactions: {
|
|
3599
3792
|
parameters: {
|
|
3600
|
-
query?:
|
|
3601
|
-
|
|
3602
|
-
|
|
3603
|
-
|
|
3793
|
+
query?: {
|
|
3794
|
+
/** @description ISO 8601, exclusive (createdAt). */
|
|
3795
|
+
to?: string;
|
|
3796
|
+
/** @description ISO 8601, inclusive (createdAt). */
|
|
3797
|
+
from?: string;
|
|
3798
|
+
/** @description Only movements of this payout. */
|
|
3799
|
+
payoutId?: string;
|
|
3800
|
+
/** @description Only movements of this payment. */
|
|
3801
|
+
paymentId?: string;
|
|
3802
|
+
/** @description One or more types (repeat or comma-separate). */
|
|
3803
|
+
type?: ("payment" | "fee" | "payment_reversal" | "fee_reversal" | "payout" | "payout_reversal" | "chargeback" | "chargeback_fee" | "chargeback_reversal" | "adjustment" | "seller_transfer" | "seller_transfer_reversal" | "conversion" | "conversion_reversal" | "merchant_payout_fee" | "disbursement_payout_fee" | "disbursement_payout_fee_reversal" | "topup" | "topup_fee" | "topup_instant_release" | "topup_instant_fee")[];
|
|
3804
|
+
/** @description `nextCursor` from the previous page. */
|
|
3805
|
+
cursor?: string;
|
|
3806
|
+
/** @description 1–100, default 50. */
|
|
3807
|
+
limit?: number;
|
|
3604
3808
|
};
|
|
3809
|
+
header?: never;
|
|
3810
|
+
path?: never;
|
|
3605
3811
|
cookie?: never;
|
|
3606
3812
|
};
|
|
3607
|
-
requestBody
|
|
3608
|
-
content: {
|
|
3609
|
-
"application/json": components["schemas"]["UpdateWebhookDto"];
|
|
3610
|
-
};
|
|
3611
|
-
};
|
|
3813
|
+
requestBody?: never;
|
|
3612
3814
|
responses: {
|
|
3613
3815
|
200: {
|
|
3614
3816
|
headers: {
|
|
3615
3817
|
[name: string]: unknown;
|
|
3616
3818
|
};
|
|
3617
3819
|
content: {
|
|
3618
|
-
"application/json": components["schemas"]["
|
|
3820
|
+
"application/json": components["schemas"]["BalanceTransactionListDto"];
|
|
3619
3821
|
};
|
|
3620
3822
|
};
|
|
3823
|
+
/** @description `invalid_data` — a parameter is invalid. */
|
|
3621
3824
|
400: {
|
|
3622
3825
|
headers: {
|
|
3623
3826
|
[name: string]: unknown;
|
|
@@ -3644,14 +3847,6 @@ interface operations {
|
|
|
3644
3847
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3645
3848
|
};
|
|
3646
3849
|
};
|
|
3647
|
-
404: {
|
|
3648
|
-
headers: {
|
|
3649
|
-
[name: string]: unknown;
|
|
3650
|
-
};
|
|
3651
|
-
content: {
|
|
3652
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3653
|
-
};
|
|
3654
|
-
};
|
|
3655
3850
|
/** @description Client error. */
|
|
3656
3851
|
"4XX": {
|
|
3657
3852
|
headers: {
|
|
@@ -3813,6 +4008,15 @@ interface operations {
|
|
|
3813
4008
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3814
4009
|
};
|
|
3815
4010
|
};
|
|
4011
|
+
/** @description `insufficient_balance` (body: `availableVes`, `requestedVes`, `heldVes`, `nextReleaseAt`, `unconfirmedVes`, `maxPayoutVes`) or `insufficient_merchant_balance` (body: `availableVes`, `requestedVes`, `maxPayoutVes`) with `fromMerchantBalance`, `fee_exceeds_amount`, and other business rules. */
|
|
4012
|
+
422: {
|
|
4013
|
+
headers: {
|
|
4014
|
+
[name: string]: unknown;
|
|
4015
|
+
};
|
|
4016
|
+
content: {
|
|
4017
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4018
|
+
};
|
|
4019
|
+
};
|
|
3816
4020
|
/** @description Client error. */
|
|
3817
4021
|
"4XX": {
|
|
3818
4022
|
headers: {
|
|
@@ -3903,6 +4107,15 @@ interface operations {
|
|
|
3903
4107
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3904
4108
|
};
|
|
3905
4109
|
};
|
|
4110
|
+
/** @description `insufficient_balance` (body: `availableVes`, `requestedVes`, `heldVes`, `nextReleaseAt`, `unconfirmedVes`, `maxPayoutVes`) or `insufficient_merchant_balance` (body: `availableVes`, `requestedVes`, `maxPayoutVes`) with `fromMerchantBalance`, `fee_exceeds_amount`, and other business rules. */
|
|
4111
|
+
422: {
|
|
4112
|
+
headers: {
|
|
4113
|
+
[name: string]: unknown;
|
|
4114
|
+
};
|
|
4115
|
+
content: {
|
|
4116
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
4117
|
+
};
|
|
4118
|
+
};
|
|
3906
4119
|
/** @description Client error. */
|
|
3907
4120
|
"4XX": {
|
|
3908
4121
|
headers: {
|
|
@@ -4655,7 +4868,7 @@ interface operations {
|
|
|
4655
4868
|
};
|
|
4656
4869
|
};
|
|
4657
4870
|
responses: {
|
|
4658
|
-
/** @description Network payload plus
|
|
4871
|
+
/** @description Network payload plus VEX Pay `paymentId` (and `externalRef` when sent). */
|
|
4659
4872
|
200: {
|
|
4660
4873
|
headers: {
|
|
4661
4874
|
[name: string]: unknown;
|
|
@@ -9183,40 +9396,24 @@ interface operations {
|
|
|
9183
9396
|
};
|
|
9184
9397
|
};
|
|
9185
9398
|
};
|
|
9186
|
-
|
|
9399
|
+
MarketplaceSettings_get: {
|
|
9187
9400
|
parameters: {
|
|
9188
9401
|
query?: never;
|
|
9189
|
-
header?:
|
|
9190
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9191
|
-
"Idempotency-Key"?: string;
|
|
9192
|
-
};
|
|
9402
|
+
header?: never;
|
|
9193
9403
|
path?: never;
|
|
9194
9404
|
cookie?: never;
|
|
9195
9405
|
};
|
|
9196
|
-
requestBody
|
|
9197
|
-
content: {
|
|
9198
|
-
"application/json": components["schemas"]["CreateCheckoutSessionDto"];
|
|
9199
|
-
};
|
|
9200
|
-
};
|
|
9406
|
+
requestBody?: never;
|
|
9201
9407
|
responses: {
|
|
9202
|
-
|
|
9203
|
-
headers: {
|
|
9204
|
-
[name: string]: unknown;
|
|
9205
|
-
};
|
|
9206
|
-
content: {
|
|
9207
|
-
"application/json": components["schemas"]["CheckoutSessionResponseDto"];
|
|
9208
|
-
};
|
|
9209
|
-
};
|
|
9210
|
-
/** @description invalid_data (e.g. a non-https origin on a live tenant). */
|
|
9211
|
-
400: {
|
|
9408
|
+
200: {
|
|
9212
9409
|
headers: {
|
|
9213
9410
|
[name: string]: unknown;
|
|
9214
9411
|
};
|
|
9215
9412
|
content: {
|
|
9216
|
-
"application/json": components["schemas"]["
|
|
9413
|
+
"application/json": components["schemas"]["MarketplaceSettingsDto"];
|
|
9217
9414
|
};
|
|
9218
9415
|
};
|
|
9219
|
-
/** @description Missing or
|
|
9416
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9220
9417
|
401: {
|
|
9221
9418
|
headers: {
|
|
9222
9419
|
[name: string]: unknown;
|
|
@@ -9234,15 +9431,6 @@ interface operations {
|
|
|
9234
9431
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9235
9432
|
};
|
|
9236
9433
|
};
|
|
9237
|
-
/** @description amount_below_minimum */
|
|
9238
|
-
422: {
|
|
9239
|
-
headers: {
|
|
9240
|
-
[name: string]: unknown;
|
|
9241
|
-
};
|
|
9242
|
-
content: {
|
|
9243
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9244
|
-
};
|
|
9245
|
-
};
|
|
9246
9434
|
/** @description Client error. */
|
|
9247
9435
|
"4XX": {
|
|
9248
9436
|
headers: {
|
|
@@ -9263,27 +9451,29 @@ interface operations {
|
|
|
9263
9451
|
};
|
|
9264
9452
|
};
|
|
9265
9453
|
};
|
|
9266
|
-
|
|
9454
|
+
MarketplaceSettings_update: {
|
|
9267
9455
|
parameters: {
|
|
9268
9456
|
query?: never;
|
|
9269
9457
|
header?: never;
|
|
9270
|
-
path
|
|
9271
|
-
id: string;
|
|
9272
|
-
};
|
|
9458
|
+
path?: never;
|
|
9273
9459
|
cookie?: never;
|
|
9274
9460
|
};
|
|
9275
|
-
requestBody
|
|
9461
|
+
requestBody: {
|
|
9462
|
+
content: {
|
|
9463
|
+
"application/json": components["schemas"]["UpdateMarketplaceSettingsDto"];
|
|
9464
|
+
};
|
|
9465
|
+
};
|
|
9276
9466
|
responses: {
|
|
9277
9467
|
200: {
|
|
9278
9468
|
headers: {
|
|
9279
9469
|
[name: string]: unknown;
|
|
9280
9470
|
};
|
|
9281
9471
|
content: {
|
|
9282
|
-
"application/json": components["schemas"]["
|
|
9472
|
+
"application/json": components["schemas"]["MarketplaceSettingsDto"];
|
|
9283
9473
|
};
|
|
9284
9474
|
};
|
|
9285
|
-
/** @description
|
|
9286
|
-
|
|
9475
|
+
/** @description `invalid_data` — unknown field or invalid value. */
|
|
9476
|
+
400: {
|
|
9287
9477
|
headers: {
|
|
9288
9478
|
[name: string]: unknown;
|
|
9289
9479
|
};
|
|
@@ -9291,8 +9481,8 @@ interface operations {
|
|
|
9291
9481
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9292
9482
|
};
|
|
9293
9483
|
};
|
|
9294
|
-
/** @description
|
|
9295
|
-
|
|
9484
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9485
|
+
401: {
|
|
9296
9486
|
headers: {
|
|
9297
9487
|
[name: string]: unknown;
|
|
9298
9488
|
};
|
|
@@ -9300,7 +9490,8 @@ interface operations {
|
|
|
9300
9490
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9301
9491
|
};
|
|
9302
9492
|
};
|
|
9303
|
-
|
|
9493
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9494
|
+
403: {
|
|
9304
9495
|
headers: {
|
|
9305
9496
|
[name: string]: unknown;
|
|
9306
9497
|
};
|
|
@@ -9328,29 +9519,29 @@ interface operations {
|
|
|
9328
9519
|
};
|
|
9329
9520
|
};
|
|
9330
9521
|
};
|
|
9331
|
-
|
|
9522
|
+
Notifications_sendTest: {
|
|
9332
9523
|
parameters: {
|
|
9333
|
-
query?:
|
|
9334
|
-
|
|
9335
|
-
|
|
9336
|
-
|
|
9524
|
+
query?: never;
|
|
9525
|
+
header?: {
|
|
9526
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9527
|
+
"Idempotency-Key"?: string;
|
|
9337
9528
|
};
|
|
9338
|
-
header?: never;
|
|
9339
9529
|
path?: never;
|
|
9340
9530
|
cookie?: never;
|
|
9341
9531
|
};
|
|
9342
9532
|
requestBody?: never;
|
|
9343
9533
|
responses: {
|
|
9344
|
-
|
|
9534
|
+
/** @description Test event queued/delivered to matching endpoints. */
|
|
9535
|
+
202: {
|
|
9345
9536
|
headers: {
|
|
9346
9537
|
[name: string]: unknown;
|
|
9347
9538
|
};
|
|
9348
9539
|
content: {
|
|
9349
|
-
"application/json": components["schemas"]["
|
|
9540
|
+
"application/json": components["schemas"]["NotificationTestResponseDto"];
|
|
9350
9541
|
};
|
|
9351
9542
|
};
|
|
9352
|
-
/** @description
|
|
9353
|
-
|
|
9543
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
9544
|
+
401: {
|
|
9354
9545
|
headers: {
|
|
9355
9546
|
[name: string]: unknown;
|
|
9356
9547
|
};
|
|
@@ -9358,8 +9549,8 @@ interface operations {
|
|
|
9358
9549
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9359
9550
|
};
|
|
9360
9551
|
};
|
|
9361
|
-
/** @description
|
|
9362
|
-
|
|
9552
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9553
|
+
403: {
|
|
9363
9554
|
headers: {
|
|
9364
9555
|
[name: string]: unknown;
|
|
9365
9556
|
};
|
|
@@ -9367,8 +9558,8 @@ interface operations {
|
|
|
9367
9558
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9368
9559
|
};
|
|
9369
9560
|
};
|
|
9370
|
-
/** @description
|
|
9371
|
-
|
|
9561
|
+
/** @description More than 10 test notifications in 10 minutes. */
|
|
9562
|
+
429: {
|
|
9372
9563
|
headers: {
|
|
9373
9564
|
[name: string]: unknown;
|
|
9374
9565
|
};
|
|
@@ -9396,7 +9587,7 @@ interface operations {
|
|
|
9396
9587
|
};
|
|
9397
9588
|
};
|
|
9398
9589
|
};
|
|
9399
|
-
|
|
9590
|
+
CheckoutSessions_create: {
|
|
9400
9591
|
parameters: {
|
|
9401
9592
|
query?: never;
|
|
9402
9593
|
header?: {
|
|
@@ -9408,7 +9599,7 @@ interface operations {
|
|
|
9408
9599
|
};
|
|
9409
9600
|
requestBody: {
|
|
9410
9601
|
content: {
|
|
9411
|
-
"application/json": components["schemas"]["
|
|
9602
|
+
"application/json": components["schemas"]["CreateCheckoutSessionDto"];
|
|
9412
9603
|
};
|
|
9413
9604
|
};
|
|
9414
9605
|
responses: {
|
|
@@ -9417,10 +9608,10 @@ interface operations {
|
|
|
9417
9608
|
[name: string]: unknown;
|
|
9418
9609
|
};
|
|
9419
9610
|
content: {
|
|
9420
|
-
"application/json": components["schemas"]["
|
|
9611
|
+
"application/json": components["schemas"]["CheckoutSessionResponseDto"];
|
|
9421
9612
|
};
|
|
9422
9613
|
};
|
|
9423
|
-
/** @description
|
|
9614
|
+
/** @description invalid_data (e.g. a non-https origin on a live tenant). */
|
|
9424
9615
|
400: {
|
|
9425
9616
|
headers: {
|
|
9426
9617
|
[name: string]: unknown;
|
|
@@ -9447,6 +9638,15 @@ interface operations {
|
|
|
9447
9638
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9448
9639
|
};
|
|
9449
9640
|
};
|
|
9641
|
+
/** @description amount_below_minimum */
|
|
9642
|
+
422: {
|
|
9643
|
+
headers: {
|
|
9644
|
+
[name: string]: unknown;
|
|
9645
|
+
};
|
|
9646
|
+
content: {
|
|
9647
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9648
|
+
};
|
|
9649
|
+
};
|
|
9450
9650
|
/** @description Client error. */
|
|
9451
9651
|
"4XX": {
|
|
9452
9652
|
headers: {
|
|
@@ -9467,7 +9667,7 @@ interface operations {
|
|
|
9467
9667
|
};
|
|
9468
9668
|
};
|
|
9469
9669
|
};
|
|
9470
|
-
|
|
9670
|
+
CheckoutSessions_retrieve: {
|
|
9471
9671
|
parameters: {
|
|
9472
9672
|
query?: never;
|
|
9473
9673
|
header?: never;
|
|
@@ -9483,16 +9683,7 @@ interface operations {
|
|
|
9483
9683
|
[name: string]: unknown;
|
|
9484
9684
|
};
|
|
9485
9685
|
content: {
|
|
9486
|
-
"application/json": components["schemas"]["
|
|
9487
|
-
};
|
|
9488
|
-
};
|
|
9489
|
-
/** @description Validation failure. */
|
|
9490
|
-
400: {
|
|
9491
|
-
headers: {
|
|
9492
|
-
[name: string]: unknown;
|
|
9493
|
-
};
|
|
9494
|
-
content: {
|
|
9495
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9686
|
+
"application/json": components["schemas"]["CheckoutSessionResponseDto"];
|
|
9496
9687
|
};
|
|
9497
9688
|
};
|
|
9498
9689
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -9541,19 +9732,232 @@ interface operations {
|
|
|
9541
9732
|
};
|
|
9542
9733
|
};
|
|
9543
9734
|
};
|
|
9544
|
-
|
|
9735
|
+
Products_list: {
|
|
9545
9736
|
parameters: {
|
|
9546
|
-
query?:
|
|
9547
|
-
|
|
9548
|
-
|
|
9549
|
-
|
|
9737
|
+
query?: {
|
|
9738
|
+
active?: "true" | "false";
|
|
9739
|
+
cursor?: string;
|
|
9740
|
+
limit?: number;
|
|
9550
9741
|
};
|
|
9742
|
+
header?: never;
|
|
9743
|
+
path?: never;
|
|
9551
9744
|
cookie?: never;
|
|
9552
9745
|
};
|
|
9553
9746
|
requestBody?: never;
|
|
9554
9747
|
responses: {
|
|
9555
|
-
|
|
9556
|
-
|
|
9748
|
+
200: {
|
|
9749
|
+
headers: {
|
|
9750
|
+
[name: string]: unknown;
|
|
9751
|
+
};
|
|
9752
|
+
content: {
|
|
9753
|
+
"application/json": components["schemas"]["ProductListResponseDto"];
|
|
9754
|
+
};
|
|
9755
|
+
};
|
|
9756
|
+
/** @description Validation failure. */
|
|
9757
|
+
400: {
|
|
9758
|
+
headers: {
|
|
9759
|
+
[name: string]: unknown;
|
|
9760
|
+
};
|
|
9761
|
+
content: {
|
|
9762
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9763
|
+
};
|
|
9764
|
+
};
|
|
9765
|
+
/** @description Missing or invalid tenant API key. */
|
|
9766
|
+
401: {
|
|
9767
|
+
headers: {
|
|
9768
|
+
[name: string]: unknown;
|
|
9769
|
+
};
|
|
9770
|
+
content: {
|
|
9771
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9772
|
+
};
|
|
9773
|
+
};
|
|
9774
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9775
|
+
403: {
|
|
9776
|
+
headers: {
|
|
9777
|
+
[name: string]: unknown;
|
|
9778
|
+
};
|
|
9779
|
+
content: {
|
|
9780
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9781
|
+
};
|
|
9782
|
+
};
|
|
9783
|
+
/** @description Client error. */
|
|
9784
|
+
"4XX": {
|
|
9785
|
+
headers: {
|
|
9786
|
+
[name: string]: unknown;
|
|
9787
|
+
};
|
|
9788
|
+
content: {
|
|
9789
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9790
|
+
};
|
|
9791
|
+
};
|
|
9792
|
+
/** @description Server or upstream bank error. */
|
|
9793
|
+
"5XX": {
|
|
9794
|
+
headers: {
|
|
9795
|
+
[name: string]: unknown;
|
|
9796
|
+
};
|
|
9797
|
+
content: {
|
|
9798
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9799
|
+
};
|
|
9800
|
+
};
|
|
9801
|
+
};
|
|
9802
|
+
};
|
|
9803
|
+
Products_create: {
|
|
9804
|
+
parameters: {
|
|
9805
|
+
query?: never;
|
|
9806
|
+
header?: {
|
|
9807
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9808
|
+
"Idempotency-Key"?: string;
|
|
9809
|
+
};
|
|
9810
|
+
path?: never;
|
|
9811
|
+
cookie?: never;
|
|
9812
|
+
};
|
|
9813
|
+
requestBody: {
|
|
9814
|
+
content: {
|
|
9815
|
+
"application/json": components["schemas"]["CreateProductDto"];
|
|
9816
|
+
};
|
|
9817
|
+
};
|
|
9818
|
+
responses: {
|
|
9819
|
+
201: {
|
|
9820
|
+
headers: {
|
|
9821
|
+
[name: string]: unknown;
|
|
9822
|
+
};
|
|
9823
|
+
content: {
|
|
9824
|
+
"application/json": components["schemas"]["ProductResponseDto"];
|
|
9825
|
+
};
|
|
9826
|
+
};
|
|
9827
|
+
/** @description Validation failure. */
|
|
9828
|
+
400: {
|
|
9829
|
+
headers: {
|
|
9830
|
+
[name: string]: unknown;
|
|
9831
|
+
};
|
|
9832
|
+
content: {
|
|
9833
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9834
|
+
};
|
|
9835
|
+
};
|
|
9836
|
+
/** @description Missing or invalid tenant API key. */
|
|
9837
|
+
401: {
|
|
9838
|
+
headers: {
|
|
9839
|
+
[name: string]: unknown;
|
|
9840
|
+
};
|
|
9841
|
+
content: {
|
|
9842
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9843
|
+
};
|
|
9844
|
+
};
|
|
9845
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9846
|
+
403: {
|
|
9847
|
+
headers: {
|
|
9848
|
+
[name: string]: unknown;
|
|
9849
|
+
};
|
|
9850
|
+
content: {
|
|
9851
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9852
|
+
};
|
|
9853
|
+
};
|
|
9854
|
+
/** @description Client error. */
|
|
9855
|
+
"4XX": {
|
|
9856
|
+
headers: {
|
|
9857
|
+
[name: string]: unknown;
|
|
9858
|
+
};
|
|
9859
|
+
content: {
|
|
9860
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9861
|
+
};
|
|
9862
|
+
};
|
|
9863
|
+
/** @description Server or upstream bank error. */
|
|
9864
|
+
"5XX": {
|
|
9865
|
+
headers: {
|
|
9866
|
+
[name: string]: unknown;
|
|
9867
|
+
};
|
|
9868
|
+
content: {
|
|
9869
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9870
|
+
};
|
|
9871
|
+
};
|
|
9872
|
+
};
|
|
9873
|
+
};
|
|
9874
|
+
Products_get: {
|
|
9875
|
+
parameters: {
|
|
9876
|
+
query?: never;
|
|
9877
|
+
header?: never;
|
|
9878
|
+
path: {
|
|
9879
|
+
id: string;
|
|
9880
|
+
};
|
|
9881
|
+
cookie?: never;
|
|
9882
|
+
};
|
|
9883
|
+
requestBody?: never;
|
|
9884
|
+
responses: {
|
|
9885
|
+
200: {
|
|
9886
|
+
headers: {
|
|
9887
|
+
[name: string]: unknown;
|
|
9888
|
+
};
|
|
9889
|
+
content: {
|
|
9890
|
+
"application/json": components["schemas"]["ProductResponseDto"];
|
|
9891
|
+
};
|
|
9892
|
+
};
|
|
9893
|
+
/** @description Validation failure. */
|
|
9894
|
+
400: {
|
|
9895
|
+
headers: {
|
|
9896
|
+
[name: string]: unknown;
|
|
9897
|
+
};
|
|
9898
|
+
content: {
|
|
9899
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9900
|
+
};
|
|
9901
|
+
};
|
|
9902
|
+
/** @description Missing or invalid tenant API key. */
|
|
9903
|
+
401: {
|
|
9904
|
+
headers: {
|
|
9905
|
+
[name: string]: unknown;
|
|
9906
|
+
};
|
|
9907
|
+
content: {
|
|
9908
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9909
|
+
};
|
|
9910
|
+
};
|
|
9911
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
9912
|
+
403: {
|
|
9913
|
+
headers: {
|
|
9914
|
+
[name: string]: unknown;
|
|
9915
|
+
};
|
|
9916
|
+
content: {
|
|
9917
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9918
|
+
};
|
|
9919
|
+
};
|
|
9920
|
+
404: {
|
|
9921
|
+
headers: {
|
|
9922
|
+
[name: string]: unknown;
|
|
9923
|
+
};
|
|
9924
|
+
content: {
|
|
9925
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9926
|
+
};
|
|
9927
|
+
};
|
|
9928
|
+
/** @description Client error. */
|
|
9929
|
+
"4XX": {
|
|
9930
|
+
headers: {
|
|
9931
|
+
[name: string]: unknown;
|
|
9932
|
+
};
|
|
9933
|
+
content: {
|
|
9934
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9935
|
+
};
|
|
9936
|
+
};
|
|
9937
|
+
/** @description Server or upstream bank error. */
|
|
9938
|
+
"5XX": {
|
|
9939
|
+
headers: {
|
|
9940
|
+
[name: string]: unknown;
|
|
9941
|
+
};
|
|
9942
|
+
content: {
|
|
9943
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9944
|
+
};
|
|
9945
|
+
};
|
|
9946
|
+
};
|
|
9947
|
+
};
|
|
9948
|
+
Products_remove: {
|
|
9949
|
+
parameters: {
|
|
9950
|
+
query?: never;
|
|
9951
|
+
header?: never;
|
|
9952
|
+
path: {
|
|
9953
|
+
id: string;
|
|
9954
|
+
};
|
|
9955
|
+
cookie?: never;
|
|
9956
|
+
};
|
|
9957
|
+
requestBody?: never;
|
|
9958
|
+
responses: {
|
|
9959
|
+
/** @description Validation failure. */
|
|
9960
|
+
400: {
|
|
9557
9961
|
headers: {
|
|
9558
9962
|
[name: string]: unknown;
|
|
9559
9963
|
};
|
|
@@ -10373,28 +10777,329 @@ interface operations {
|
|
|
10373
10777
|
};
|
|
10374
10778
|
};
|
|
10375
10779
|
};
|
|
10376
|
-
|
|
10780
|
+
Customers_list: {
|
|
10377
10781
|
parameters: {
|
|
10378
|
-
query?:
|
|
10379
|
-
|
|
10380
|
-
|
|
10381
|
-
|
|
10782
|
+
query?: {
|
|
10783
|
+
email?: string;
|
|
10784
|
+
cursor?: string;
|
|
10785
|
+
limit?: number;
|
|
10382
10786
|
};
|
|
10787
|
+
header?: never;
|
|
10383
10788
|
path?: never;
|
|
10384
10789
|
cookie?: never;
|
|
10385
10790
|
};
|
|
10386
10791
|
requestBody?: never;
|
|
10387
10792
|
responses: {
|
|
10388
|
-
|
|
10389
|
-
|
|
10793
|
+
200: {
|
|
10794
|
+
headers: {
|
|
10795
|
+
[name: string]: unknown;
|
|
10796
|
+
};
|
|
10797
|
+
content: {
|
|
10798
|
+
"application/json": components["schemas"]["CustomerListResponseDto"];
|
|
10799
|
+
};
|
|
10800
|
+
};
|
|
10801
|
+
/** @description Validation failure. */
|
|
10802
|
+
400: {
|
|
10803
|
+
headers: {
|
|
10804
|
+
[name: string]: unknown;
|
|
10805
|
+
};
|
|
10806
|
+
content: {
|
|
10807
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10808
|
+
};
|
|
10809
|
+
};
|
|
10810
|
+
/** @description Missing or invalid tenant API key. */
|
|
10811
|
+
401: {
|
|
10812
|
+
headers: {
|
|
10813
|
+
[name: string]: unknown;
|
|
10814
|
+
};
|
|
10815
|
+
content: {
|
|
10816
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10817
|
+
};
|
|
10818
|
+
};
|
|
10819
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
10820
|
+
403: {
|
|
10821
|
+
headers: {
|
|
10822
|
+
[name: string]: unknown;
|
|
10823
|
+
};
|
|
10824
|
+
content: {
|
|
10825
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10826
|
+
};
|
|
10827
|
+
};
|
|
10828
|
+
/** @description Client error. */
|
|
10829
|
+
"4XX": {
|
|
10830
|
+
headers: {
|
|
10831
|
+
[name: string]: unknown;
|
|
10832
|
+
};
|
|
10833
|
+
content: {
|
|
10834
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10835
|
+
};
|
|
10836
|
+
};
|
|
10837
|
+
/** @description Server or upstream bank error. */
|
|
10838
|
+
"5XX": {
|
|
10839
|
+
headers: {
|
|
10840
|
+
[name: string]: unknown;
|
|
10841
|
+
};
|
|
10842
|
+
content: {
|
|
10843
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10844
|
+
};
|
|
10845
|
+
};
|
|
10846
|
+
};
|
|
10847
|
+
};
|
|
10848
|
+
Customers_create: {
|
|
10849
|
+
parameters: {
|
|
10850
|
+
query?: never;
|
|
10851
|
+
header?: {
|
|
10852
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
10853
|
+
"Idempotency-Key"?: string;
|
|
10854
|
+
};
|
|
10855
|
+
path?: never;
|
|
10856
|
+
cookie?: never;
|
|
10857
|
+
};
|
|
10858
|
+
requestBody: {
|
|
10859
|
+
content: {
|
|
10860
|
+
"application/json": components["schemas"]["CreateCustomerDto"];
|
|
10861
|
+
};
|
|
10862
|
+
};
|
|
10863
|
+
responses: {
|
|
10864
|
+
201: {
|
|
10865
|
+
headers: {
|
|
10866
|
+
[name: string]: unknown;
|
|
10867
|
+
};
|
|
10868
|
+
content: {
|
|
10869
|
+
"application/json": components["schemas"]["CustomerResponseDto"];
|
|
10870
|
+
};
|
|
10871
|
+
};
|
|
10872
|
+
/** @description Validation failure. */
|
|
10873
|
+
400: {
|
|
10874
|
+
headers: {
|
|
10875
|
+
[name: string]: unknown;
|
|
10876
|
+
};
|
|
10877
|
+
content: {
|
|
10878
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10879
|
+
};
|
|
10880
|
+
};
|
|
10881
|
+
/** @description Missing or invalid tenant API key. */
|
|
10882
|
+
401: {
|
|
10883
|
+
headers: {
|
|
10884
|
+
[name: string]: unknown;
|
|
10885
|
+
};
|
|
10886
|
+
content: {
|
|
10887
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10888
|
+
};
|
|
10889
|
+
};
|
|
10890
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
10891
|
+
403: {
|
|
10892
|
+
headers: {
|
|
10893
|
+
[name: string]: unknown;
|
|
10894
|
+
};
|
|
10895
|
+
content: {
|
|
10896
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10897
|
+
};
|
|
10898
|
+
};
|
|
10899
|
+
/** @description Client error. */
|
|
10900
|
+
"4XX": {
|
|
10901
|
+
headers: {
|
|
10902
|
+
[name: string]: unknown;
|
|
10903
|
+
};
|
|
10904
|
+
content: {
|
|
10905
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10906
|
+
};
|
|
10907
|
+
};
|
|
10908
|
+
/** @description Server or upstream bank error. */
|
|
10909
|
+
"5XX": {
|
|
10910
|
+
headers: {
|
|
10911
|
+
[name: string]: unknown;
|
|
10912
|
+
};
|
|
10913
|
+
content: {
|
|
10914
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10915
|
+
};
|
|
10916
|
+
};
|
|
10917
|
+
};
|
|
10918
|
+
};
|
|
10919
|
+
Customers_retrieve: {
|
|
10920
|
+
parameters: {
|
|
10921
|
+
query?: never;
|
|
10922
|
+
header?: never;
|
|
10923
|
+
path: {
|
|
10924
|
+
id: string;
|
|
10925
|
+
};
|
|
10926
|
+
cookie?: never;
|
|
10927
|
+
};
|
|
10928
|
+
requestBody?: never;
|
|
10929
|
+
responses: {
|
|
10930
|
+
200: {
|
|
10931
|
+
headers: {
|
|
10932
|
+
[name: string]: unknown;
|
|
10933
|
+
};
|
|
10934
|
+
content: {
|
|
10935
|
+
"application/json": components["schemas"]["CustomerResponseDto"];
|
|
10936
|
+
};
|
|
10937
|
+
};
|
|
10938
|
+
/** @description Validation failure. */
|
|
10939
|
+
400: {
|
|
10940
|
+
headers: {
|
|
10941
|
+
[name: string]: unknown;
|
|
10942
|
+
};
|
|
10943
|
+
content: {
|
|
10944
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10945
|
+
};
|
|
10946
|
+
};
|
|
10947
|
+
/** @description Missing or invalid tenant API key. */
|
|
10948
|
+
401: {
|
|
10949
|
+
headers: {
|
|
10950
|
+
[name: string]: unknown;
|
|
10951
|
+
};
|
|
10952
|
+
content: {
|
|
10953
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10954
|
+
};
|
|
10955
|
+
};
|
|
10956
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
10957
|
+
403: {
|
|
10958
|
+
headers: {
|
|
10959
|
+
[name: string]: unknown;
|
|
10960
|
+
};
|
|
10961
|
+
content: {
|
|
10962
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10963
|
+
};
|
|
10964
|
+
};
|
|
10965
|
+
404: {
|
|
10966
|
+
headers: {
|
|
10967
|
+
[name: string]: unknown;
|
|
10968
|
+
};
|
|
10969
|
+
content: {
|
|
10970
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10971
|
+
};
|
|
10972
|
+
};
|
|
10973
|
+
/** @description Client error. */
|
|
10974
|
+
"4XX": {
|
|
10975
|
+
headers: {
|
|
10976
|
+
[name: string]: unknown;
|
|
10977
|
+
};
|
|
10978
|
+
content: {
|
|
10979
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10980
|
+
};
|
|
10981
|
+
};
|
|
10982
|
+
/** @description Server or upstream bank error. */
|
|
10983
|
+
"5XX": {
|
|
10984
|
+
headers: {
|
|
10985
|
+
[name: string]: unknown;
|
|
10986
|
+
};
|
|
10987
|
+
content: {
|
|
10988
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10989
|
+
};
|
|
10990
|
+
};
|
|
10991
|
+
};
|
|
10992
|
+
};
|
|
10993
|
+
Customers_update: {
|
|
10994
|
+
parameters: {
|
|
10995
|
+
query?: never;
|
|
10996
|
+
header?: {
|
|
10997
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
10998
|
+
"Idempotency-Key"?: string;
|
|
10999
|
+
};
|
|
11000
|
+
path: {
|
|
11001
|
+
id: string;
|
|
11002
|
+
};
|
|
11003
|
+
cookie?: never;
|
|
11004
|
+
};
|
|
11005
|
+
requestBody: {
|
|
11006
|
+
content: {
|
|
11007
|
+
"application/json": components["schemas"]["UpdateCustomerDto"];
|
|
11008
|
+
};
|
|
11009
|
+
};
|
|
11010
|
+
responses: {
|
|
11011
|
+
200: {
|
|
11012
|
+
headers: {
|
|
11013
|
+
[name: string]: unknown;
|
|
11014
|
+
};
|
|
11015
|
+
content: {
|
|
11016
|
+
"application/json": components["schemas"]["CustomerResponseDto"];
|
|
11017
|
+
};
|
|
11018
|
+
};
|
|
11019
|
+
/** @description Validation failure. */
|
|
11020
|
+
400: {
|
|
11021
|
+
headers: {
|
|
11022
|
+
[name: string]: unknown;
|
|
11023
|
+
};
|
|
11024
|
+
content: {
|
|
11025
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11026
|
+
};
|
|
11027
|
+
};
|
|
11028
|
+
/** @description Missing or invalid tenant API key. */
|
|
11029
|
+
401: {
|
|
11030
|
+
headers: {
|
|
11031
|
+
[name: string]: unknown;
|
|
11032
|
+
};
|
|
11033
|
+
content: {
|
|
11034
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11035
|
+
};
|
|
11036
|
+
};
|
|
11037
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
11038
|
+
403: {
|
|
11039
|
+
headers: {
|
|
11040
|
+
[name: string]: unknown;
|
|
11041
|
+
};
|
|
11042
|
+
content: {
|
|
11043
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11044
|
+
};
|
|
11045
|
+
};
|
|
11046
|
+
404: {
|
|
11047
|
+
headers: {
|
|
11048
|
+
[name: string]: unknown;
|
|
11049
|
+
};
|
|
11050
|
+
content: {
|
|
11051
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11052
|
+
};
|
|
11053
|
+
};
|
|
11054
|
+
/** @description Client error. */
|
|
11055
|
+
"4XX": {
|
|
11056
|
+
headers: {
|
|
11057
|
+
[name: string]: unknown;
|
|
11058
|
+
};
|
|
11059
|
+
content: {
|
|
11060
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11061
|
+
};
|
|
11062
|
+
};
|
|
11063
|
+
/** @description Server or upstream bank error. */
|
|
11064
|
+
"5XX": {
|
|
11065
|
+
headers: {
|
|
11066
|
+
[name: string]: unknown;
|
|
11067
|
+
};
|
|
11068
|
+
content: {
|
|
11069
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11070
|
+
};
|
|
11071
|
+
};
|
|
11072
|
+
};
|
|
11073
|
+
};
|
|
11074
|
+
Customers_remove: {
|
|
11075
|
+
parameters: {
|
|
11076
|
+
query?: never;
|
|
11077
|
+
header?: never;
|
|
11078
|
+
path: {
|
|
11079
|
+
id: string;
|
|
11080
|
+
};
|
|
11081
|
+
cookie?: never;
|
|
11082
|
+
};
|
|
11083
|
+
requestBody?: never;
|
|
11084
|
+
responses: {
|
|
11085
|
+
200: {
|
|
11086
|
+
headers: {
|
|
11087
|
+
[name: string]: unknown;
|
|
11088
|
+
};
|
|
11089
|
+
content: {
|
|
11090
|
+
"application/json": components["schemas"]["DeletedObjectResponseDto"];
|
|
11091
|
+
};
|
|
11092
|
+
};
|
|
11093
|
+
/** @description Validation failure. */
|
|
11094
|
+
400: {
|
|
10390
11095
|
headers: {
|
|
10391
11096
|
[name: string]: unknown;
|
|
10392
11097
|
};
|
|
10393
11098
|
content: {
|
|
10394
|
-
"application/json": components["schemas"]["
|
|
11099
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10395
11100
|
};
|
|
10396
11101
|
};
|
|
10397
|
-
/** @description Missing
|
|
11102
|
+
/** @description Missing or invalid tenant API key. */
|
|
10398
11103
|
401: {
|
|
10399
11104
|
headers: {
|
|
10400
11105
|
[name: string]: unknown;
|
|
@@ -10412,8 +11117,16 @@ interface operations {
|
|
|
10412
11117
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10413
11118
|
};
|
|
10414
11119
|
};
|
|
10415
|
-
|
|
10416
|
-
|
|
11120
|
+
404: {
|
|
11121
|
+
headers: {
|
|
11122
|
+
[name: string]: unknown;
|
|
11123
|
+
};
|
|
11124
|
+
content: {
|
|
11125
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11126
|
+
};
|
|
11127
|
+
};
|
|
11128
|
+
/** @description customer_has_active_subscriptions */
|
|
11129
|
+
409: {
|
|
10417
11130
|
headers: {
|
|
10418
11131
|
[name: string]: unknown;
|
|
10419
11132
|
};
|
|
@@ -10441,10 +11154,11 @@ interface operations {
|
|
|
10441
11154
|
};
|
|
10442
11155
|
};
|
|
10443
11156
|
};
|
|
10444
|
-
|
|
11157
|
+
Prices_list: {
|
|
10445
11158
|
parameters: {
|
|
10446
11159
|
query?: {
|
|
10447
|
-
|
|
11160
|
+
product?: string;
|
|
11161
|
+
active?: "true" | "false";
|
|
10448
11162
|
cursor?: string;
|
|
10449
11163
|
limit?: number;
|
|
10450
11164
|
};
|
|
@@ -10459,7 +11173,7 @@ interface operations {
|
|
|
10459
11173
|
[name: string]: unknown;
|
|
10460
11174
|
};
|
|
10461
11175
|
content: {
|
|
10462
|
-
"application/json": components["schemas"]["
|
|
11176
|
+
"application/json": components["schemas"]["PriceListResponseDto"];
|
|
10463
11177
|
};
|
|
10464
11178
|
};
|
|
10465
11179
|
/** @description Validation failure. */
|
|
@@ -10509,7 +11223,7 @@ interface operations {
|
|
|
10509
11223
|
};
|
|
10510
11224
|
};
|
|
10511
11225
|
};
|
|
10512
|
-
|
|
11226
|
+
Prices_create: {
|
|
10513
11227
|
parameters: {
|
|
10514
11228
|
query?: never;
|
|
10515
11229
|
header?: {
|
|
@@ -10521,7 +11235,7 @@ interface operations {
|
|
|
10521
11235
|
};
|
|
10522
11236
|
requestBody: {
|
|
10523
11237
|
content: {
|
|
10524
|
-
"application/json": components["schemas"]["
|
|
11238
|
+
"application/json": components["schemas"]["CreatePriceDto"];
|
|
10525
11239
|
};
|
|
10526
11240
|
};
|
|
10527
11241
|
responses: {
|
|
@@ -10530,7 +11244,7 @@ interface operations {
|
|
|
10530
11244
|
[name: string]: unknown;
|
|
10531
11245
|
};
|
|
10532
11246
|
content: {
|
|
10533
|
-
"application/json": components["schemas"]["
|
|
11247
|
+
"application/json": components["schemas"]["PriceResponseDto"];
|
|
10534
11248
|
};
|
|
10535
11249
|
};
|
|
10536
11250
|
/** @description Validation failure. */
|
|
@@ -10560,6 +11274,23 @@ interface operations {
|
|
|
10560
11274
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10561
11275
|
};
|
|
10562
11276
|
};
|
|
11277
|
+
404: {
|
|
11278
|
+
headers: {
|
|
11279
|
+
[name: string]: unknown;
|
|
11280
|
+
};
|
|
11281
|
+
content: {
|
|
11282
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11283
|
+
};
|
|
11284
|
+
};
|
|
11285
|
+
/** @description amount_below_minimum */
|
|
11286
|
+
422: {
|
|
11287
|
+
headers: {
|
|
11288
|
+
[name: string]: unknown;
|
|
11289
|
+
};
|
|
11290
|
+
content: {
|
|
11291
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11292
|
+
};
|
|
11293
|
+
};
|
|
10563
11294
|
/** @description Client error. */
|
|
10564
11295
|
"4XX": {
|
|
10565
11296
|
headers: {
|
|
@@ -10580,7 +11311,7 @@ interface operations {
|
|
|
10580
11311
|
};
|
|
10581
11312
|
};
|
|
10582
11313
|
};
|
|
10583
|
-
|
|
11314
|
+
Prices_retrieve: {
|
|
10584
11315
|
parameters: {
|
|
10585
11316
|
query?: never;
|
|
10586
11317
|
header?: never;
|
|
@@ -10596,7 +11327,7 @@ interface operations {
|
|
|
10596
11327
|
[name: string]: unknown;
|
|
10597
11328
|
};
|
|
10598
11329
|
content: {
|
|
10599
|
-
"application/json": components["schemas"]["
|
|
11330
|
+
"application/json": components["schemas"]["PriceResponseDto"];
|
|
10600
11331
|
};
|
|
10601
11332
|
};
|
|
10602
11333
|
/** @description Validation failure. */
|
|
@@ -10654,7 +11385,7 @@ interface operations {
|
|
|
10654
11385
|
};
|
|
10655
11386
|
};
|
|
10656
11387
|
};
|
|
10657
|
-
|
|
11388
|
+
Prices_update: {
|
|
10658
11389
|
parameters: {
|
|
10659
11390
|
query?: never;
|
|
10660
11391
|
header?: {
|
|
@@ -10668,7 +11399,7 @@ interface operations {
|
|
|
10668
11399
|
};
|
|
10669
11400
|
requestBody: {
|
|
10670
11401
|
content: {
|
|
10671
|
-
"application/json": components["schemas"]["
|
|
11402
|
+
"application/json": components["schemas"]["UpdatePriceDto"];
|
|
10672
11403
|
};
|
|
10673
11404
|
};
|
|
10674
11405
|
responses: {
|
|
@@ -10677,7 +11408,7 @@ interface operations {
|
|
|
10677
11408
|
[name: string]: unknown;
|
|
10678
11409
|
};
|
|
10679
11410
|
content: {
|
|
10680
|
-
"application/json": components["schemas"]["
|
|
11411
|
+
"application/json": components["schemas"]["PriceResponseDto"];
|
|
10681
11412
|
};
|
|
10682
11413
|
};
|
|
10683
11414
|
/** @description Validation failure. */
|
|
@@ -10735,13 +11466,17 @@ interface operations {
|
|
|
10735
11466
|
};
|
|
10736
11467
|
};
|
|
10737
11468
|
};
|
|
10738
|
-
|
|
11469
|
+
Subscriptions_list: {
|
|
10739
11470
|
parameters: {
|
|
10740
|
-
query?:
|
|
10741
|
-
|
|
10742
|
-
|
|
10743
|
-
|
|
11471
|
+
query?: {
|
|
11472
|
+
customer?: string;
|
|
11473
|
+
price?: string;
|
|
11474
|
+
status?: "trialing" | "active" | "past_due" | "canceled";
|
|
11475
|
+
cursor?: string;
|
|
11476
|
+
limit?: number;
|
|
10744
11477
|
};
|
|
11478
|
+
header?: never;
|
|
11479
|
+
path?: never;
|
|
10745
11480
|
cookie?: never;
|
|
10746
11481
|
};
|
|
10747
11482
|
requestBody?: never;
|
|
@@ -10751,10 +11486,10 @@ interface operations {
|
|
|
10751
11486
|
[name: string]: unknown;
|
|
10752
11487
|
};
|
|
10753
11488
|
content: {
|
|
10754
|
-
"application/json": components["schemas"]["
|
|
11489
|
+
"application/json": components["schemas"]["SubscriptionListResponseDto"];
|
|
10755
11490
|
};
|
|
10756
11491
|
};
|
|
10757
|
-
/** @description Validation failure. */
|
|
11492
|
+
/** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
|
|
10758
11493
|
400: {
|
|
10759
11494
|
headers: {
|
|
10760
11495
|
[name: string]: unknown;
|
|
@@ -10781,23 +11516,6 @@ interface operations {
|
|
|
10781
11516
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10782
11517
|
};
|
|
10783
11518
|
};
|
|
10784
|
-
404: {
|
|
10785
|
-
headers: {
|
|
10786
|
-
[name: string]: unknown;
|
|
10787
|
-
};
|
|
10788
|
-
content: {
|
|
10789
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10790
|
-
};
|
|
10791
|
-
};
|
|
10792
|
-
/** @description customer_has_active_subscriptions */
|
|
10793
|
-
409: {
|
|
10794
|
-
headers: {
|
|
10795
|
-
[name: string]: unknown;
|
|
10796
|
-
};
|
|
10797
|
-
content: {
|
|
10798
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10799
|
-
};
|
|
10800
|
-
};
|
|
10801
11519
|
/** @description Client error. */
|
|
10802
11520
|
"4XX": {
|
|
10803
11521
|
headers: {
|
|
@@ -10818,29 +11536,31 @@ interface operations {
|
|
|
10818
11536
|
};
|
|
10819
11537
|
};
|
|
10820
11538
|
};
|
|
10821
|
-
|
|
11539
|
+
Subscriptions_create: {
|
|
10822
11540
|
parameters: {
|
|
10823
|
-
query?:
|
|
10824
|
-
|
|
10825
|
-
|
|
10826
|
-
|
|
10827
|
-
limit?: number;
|
|
11541
|
+
query?: never;
|
|
11542
|
+
header?: {
|
|
11543
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
11544
|
+
"Idempotency-Key"?: string;
|
|
10828
11545
|
};
|
|
10829
|
-
header?: never;
|
|
10830
11546
|
path?: never;
|
|
10831
11547
|
cookie?: never;
|
|
10832
11548
|
};
|
|
10833
|
-
requestBody
|
|
11549
|
+
requestBody: {
|
|
11550
|
+
content: {
|
|
11551
|
+
"application/json": components["schemas"]["CreateSubscriptionDto"];
|
|
11552
|
+
};
|
|
11553
|
+
};
|
|
10834
11554
|
responses: {
|
|
10835
|
-
|
|
11555
|
+
201: {
|
|
10836
11556
|
headers: {
|
|
10837
11557
|
[name: string]: unknown;
|
|
10838
11558
|
};
|
|
10839
11559
|
content: {
|
|
10840
|
-
"application/json": components["schemas"]["
|
|
11560
|
+
"application/json": components["schemas"]["SubscriptionResponseDto"];
|
|
10841
11561
|
};
|
|
10842
11562
|
};
|
|
10843
|
-
/** @description Validation failure. */
|
|
11563
|
+
/** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
|
|
10844
11564
|
400: {
|
|
10845
11565
|
headers: {
|
|
10846
11566
|
[name: string]: unknown;
|
|
@@ -10867,6 +11587,14 @@ interface operations {
|
|
|
10867
11587
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10868
11588
|
};
|
|
10869
11589
|
};
|
|
11590
|
+
404: {
|
|
11591
|
+
headers: {
|
|
11592
|
+
[name: string]: unknown;
|
|
11593
|
+
};
|
|
11594
|
+
content: {
|
|
11595
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11596
|
+
};
|
|
11597
|
+
};
|
|
10870
11598
|
/** @description Client error. */
|
|
10871
11599
|
"4XX": {
|
|
10872
11600
|
headers: {
|
|
@@ -10887,31 +11615,26 @@ interface operations {
|
|
|
10887
11615
|
};
|
|
10888
11616
|
};
|
|
10889
11617
|
};
|
|
10890
|
-
|
|
11618
|
+
Subscriptions_retrieve: {
|
|
10891
11619
|
parameters: {
|
|
10892
11620
|
query?: never;
|
|
10893
|
-
header?:
|
|
10894
|
-
|
|
10895
|
-
|
|
11621
|
+
header?: never;
|
|
11622
|
+
path: {
|
|
11623
|
+
id: string;
|
|
10896
11624
|
};
|
|
10897
|
-
path?: never;
|
|
10898
11625
|
cookie?: never;
|
|
10899
11626
|
};
|
|
10900
|
-
requestBody
|
|
10901
|
-
content: {
|
|
10902
|
-
"application/json": components["schemas"]["CreatePriceDto"];
|
|
10903
|
-
};
|
|
10904
|
-
};
|
|
11627
|
+
requestBody?: never;
|
|
10905
11628
|
responses: {
|
|
10906
|
-
|
|
11629
|
+
200: {
|
|
10907
11630
|
headers: {
|
|
10908
11631
|
[name: string]: unknown;
|
|
10909
11632
|
};
|
|
10910
11633
|
content: {
|
|
10911
|
-
"application/json": components["schemas"]["
|
|
11634
|
+
"application/json": components["schemas"]["SubscriptionResponseDto"];
|
|
10912
11635
|
};
|
|
10913
11636
|
};
|
|
10914
|
-
/** @description Validation failure. */
|
|
11637
|
+
/** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
|
|
10915
11638
|
400: {
|
|
10916
11639
|
headers: {
|
|
10917
11640
|
[name: string]: unknown;
|
|
@@ -10946,15 +11669,6 @@ interface operations {
|
|
|
10946
11669
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10947
11670
|
};
|
|
10948
11671
|
};
|
|
10949
|
-
/** @description amount_below_minimum */
|
|
10950
|
-
422: {
|
|
10951
|
-
headers: {
|
|
10952
|
-
[name: string]: unknown;
|
|
10953
|
-
};
|
|
10954
|
-
content: {
|
|
10955
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10956
|
-
};
|
|
10957
|
-
};
|
|
10958
11672
|
/** @description Client error. */
|
|
10959
11673
|
"4XX": {
|
|
10960
11674
|
headers: {
|
|
@@ -10975,26 +11689,33 @@ interface operations {
|
|
|
10975
11689
|
};
|
|
10976
11690
|
};
|
|
10977
11691
|
};
|
|
10978
|
-
|
|
11692
|
+
Subscriptions_update: {
|
|
10979
11693
|
parameters: {
|
|
10980
11694
|
query?: never;
|
|
10981
|
-
header?:
|
|
11695
|
+
header?: {
|
|
11696
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
11697
|
+
"Idempotency-Key"?: string;
|
|
11698
|
+
};
|
|
10982
11699
|
path: {
|
|
10983
11700
|
id: string;
|
|
10984
11701
|
};
|
|
10985
11702
|
cookie?: never;
|
|
10986
11703
|
};
|
|
10987
|
-
requestBody
|
|
11704
|
+
requestBody: {
|
|
11705
|
+
content: {
|
|
11706
|
+
"application/json": components["schemas"]["UpdateSubscriptionDto"];
|
|
11707
|
+
};
|
|
11708
|
+
};
|
|
10988
11709
|
responses: {
|
|
10989
11710
|
200: {
|
|
10990
11711
|
headers: {
|
|
10991
11712
|
[name: string]: unknown;
|
|
10992
11713
|
};
|
|
10993
11714
|
content: {
|
|
10994
|
-
"application/json": components["schemas"]["
|
|
11715
|
+
"application/json": components["schemas"]["SubscriptionResponseDto"];
|
|
10995
11716
|
};
|
|
10996
11717
|
};
|
|
10997
|
-
/** @description Validation failure. */
|
|
11718
|
+
/** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
|
|
10998
11719
|
400: {
|
|
10999
11720
|
headers: {
|
|
11000
11721
|
[name: string]: unknown;
|
|
@@ -11049,33 +11770,26 @@ interface operations {
|
|
|
11049
11770
|
};
|
|
11050
11771
|
};
|
|
11051
11772
|
};
|
|
11052
|
-
|
|
11773
|
+
Subscriptions_cancel: {
|
|
11053
11774
|
parameters: {
|
|
11054
11775
|
query?: never;
|
|
11055
|
-
header?:
|
|
11056
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
11057
|
-
"Idempotency-Key"?: string;
|
|
11058
|
-
};
|
|
11776
|
+
header?: never;
|
|
11059
11777
|
path: {
|
|
11060
11778
|
id: string;
|
|
11061
11779
|
};
|
|
11062
11780
|
cookie?: never;
|
|
11063
11781
|
};
|
|
11064
|
-
requestBody
|
|
11065
|
-
content: {
|
|
11066
|
-
"application/json": components["schemas"]["UpdatePriceDto"];
|
|
11067
|
-
};
|
|
11068
|
-
};
|
|
11782
|
+
requestBody?: never;
|
|
11069
11783
|
responses: {
|
|
11070
11784
|
200: {
|
|
11071
11785
|
headers: {
|
|
11072
11786
|
[name: string]: unknown;
|
|
11073
11787
|
};
|
|
11074
11788
|
content: {
|
|
11075
|
-
"application/json": components["schemas"]["
|
|
11789
|
+
"application/json": components["schemas"]["SubscriptionResponseDto"];
|
|
11076
11790
|
};
|
|
11077
11791
|
};
|
|
11078
|
-
/** @description Validation failure. */
|
|
11792
|
+
/** @description Validation failure or a billing rule (price_inactive, customer_email_required, automatic_charging_unavailable…). */
|
|
11079
11793
|
400: {
|
|
11080
11794
|
headers: {
|
|
11081
11795
|
[name: string]: unknown;
|
|
@@ -11130,12 +11844,12 @@ interface operations {
|
|
|
11130
11844
|
};
|
|
11131
11845
|
};
|
|
11132
11846
|
};
|
|
11133
|
-
|
|
11847
|
+
Invoices_list: {
|
|
11134
11848
|
parameters: {
|
|
11135
11849
|
query?: {
|
|
11136
11850
|
customer?: string;
|
|
11137
|
-
|
|
11138
|
-
status?: "
|
|
11851
|
+
subscription?: string;
|
|
11852
|
+
status?: "open" | "paid" | "void" | "uncollectible";
|
|
11139
11853
|
cursor?: string;
|
|
11140
11854
|
limit?: number;
|
|
11141
11855
|
};
|
|
@@ -11150,10 +11864,10 @@ interface operations {
|
|
|
11150
11864
|
[name: string]: unknown;
|
|
11151
11865
|
};
|
|
11152
11866
|
content: {
|
|
11153
|
-
"application/json": components["schemas"]["
|
|
11867
|
+
"application/json": components["schemas"]["InvoiceListResponseDto"];
|
|
11154
11868
|
};
|
|
11155
11869
|
};
|
|
11156
|
-
/** @description Validation failure or
|
|
11870
|
+
/** @description Validation failure or invoice_not_open. */
|
|
11157
11871
|
400: {
|
|
11158
11872
|
headers: {
|
|
11159
11873
|
[name: string]: unknown;
|
|
@@ -11200,31 +11914,26 @@ interface operations {
|
|
|
11200
11914
|
};
|
|
11201
11915
|
};
|
|
11202
11916
|
};
|
|
11203
|
-
|
|
11917
|
+
Invoices_retrieve: {
|
|
11204
11918
|
parameters: {
|
|
11205
11919
|
query?: never;
|
|
11206
|
-
header?:
|
|
11207
|
-
|
|
11208
|
-
|
|
11920
|
+
header?: never;
|
|
11921
|
+
path: {
|
|
11922
|
+
id: string;
|
|
11209
11923
|
};
|
|
11210
|
-
path?: never;
|
|
11211
11924
|
cookie?: never;
|
|
11212
11925
|
};
|
|
11213
|
-
requestBody
|
|
11214
|
-
content: {
|
|
11215
|
-
"application/json": components["schemas"]["CreateSubscriptionDto"];
|
|
11216
|
-
};
|
|
11217
|
-
};
|
|
11926
|
+
requestBody?: never;
|
|
11218
11927
|
responses: {
|
|
11219
|
-
|
|
11928
|
+
200: {
|
|
11220
11929
|
headers: {
|
|
11221
11930
|
[name: string]: unknown;
|
|
11222
11931
|
};
|
|
11223
11932
|
content: {
|
|
11224
|
-
"application/json": components["schemas"]["
|
|
11933
|
+
"application/json": components["schemas"]["InvoiceResponseDto"];
|
|
11225
11934
|
};
|
|
11226
11935
|
};
|
|
11227
|
-
/** @description Validation failure or
|
|
11936
|
+
/** @description Validation failure or invoice_not_open. */
|
|
11228
11937
|
400: {
|
|
11229
11938
|
headers: {
|
|
11230
11939
|
[name: string]: unknown;
|
|
@@ -11279,10 +11988,13 @@ interface operations {
|
|
|
11279
11988
|
};
|
|
11280
11989
|
};
|
|
11281
11990
|
};
|
|
11282
|
-
|
|
11991
|
+
Invoices_void: {
|
|
11283
11992
|
parameters: {
|
|
11284
11993
|
query?: never;
|
|
11285
|
-
header?:
|
|
11994
|
+
header?: {
|
|
11995
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
11996
|
+
"Idempotency-Key"?: string;
|
|
11997
|
+
};
|
|
11286
11998
|
path: {
|
|
11287
11999
|
id: string;
|
|
11288
12000
|
};
|
|
@@ -11295,10 +12007,10 @@ interface operations {
|
|
|
11295
12007
|
[name: string]: unknown;
|
|
11296
12008
|
};
|
|
11297
12009
|
content: {
|
|
11298
|
-
"application/json": components["schemas"]["
|
|
12010
|
+
"application/json": components["schemas"]["InvoiceResponseDto"];
|
|
11299
12011
|
};
|
|
11300
12012
|
};
|
|
11301
|
-
/** @description Validation failure or
|
|
12013
|
+
/** @description Validation failure or invoice_not_open. */
|
|
11302
12014
|
400: {
|
|
11303
12015
|
headers: {
|
|
11304
12016
|
[name: string]: unknown;
|
|
@@ -11353,7 +12065,7 @@ interface operations {
|
|
|
11353
12065
|
};
|
|
11354
12066
|
};
|
|
11355
12067
|
};
|
|
11356
|
-
|
|
12068
|
+
Invoices_markUncollectible: {
|
|
11357
12069
|
parameters: {
|
|
11358
12070
|
query?: never;
|
|
11359
12071
|
header?: {
|
|
@@ -11365,21 +12077,17 @@ interface operations {
|
|
|
11365
12077
|
};
|
|
11366
12078
|
cookie?: never;
|
|
11367
12079
|
};
|
|
11368
|
-
requestBody
|
|
11369
|
-
content: {
|
|
11370
|
-
"application/json": components["schemas"]["UpdateSubscriptionDto"];
|
|
11371
|
-
};
|
|
11372
|
-
};
|
|
12080
|
+
requestBody?: never;
|
|
11373
12081
|
responses: {
|
|
11374
12082
|
200: {
|
|
11375
12083
|
headers: {
|
|
11376
12084
|
[name: string]: unknown;
|
|
11377
12085
|
};
|
|
11378
12086
|
content: {
|
|
11379
|
-
"application/json": components["schemas"]["
|
|
12087
|
+
"application/json": components["schemas"]["InvoiceResponseDto"];
|
|
11380
12088
|
};
|
|
11381
12089
|
};
|
|
11382
|
-
/** @description Validation failure or
|
|
12090
|
+
/** @description Validation failure or invoice_not_open. */
|
|
11383
12091
|
400: {
|
|
11384
12092
|
headers: {
|
|
11385
12093
|
[name: string]: unknown;
|
|
@@ -11434,26 +12142,33 @@ interface operations {
|
|
|
11434
12142
|
};
|
|
11435
12143
|
};
|
|
11436
12144
|
};
|
|
11437
|
-
|
|
12145
|
+
Invoices_pay: {
|
|
11438
12146
|
parameters: {
|
|
11439
12147
|
query?: never;
|
|
11440
|
-
header?:
|
|
12148
|
+
header?: {
|
|
12149
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
12150
|
+
"Idempotency-Key"?: string;
|
|
12151
|
+
};
|
|
11441
12152
|
path: {
|
|
11442
12153
|
id: string;
|
|
11443
12154
|
};
|
|
11444
12155
|
cookie?: never;
|
|
11445
12156
|
};
|
|
11446
|
-
requestBody
|
|
12157
|
+
requestBody: {
|
|
12158
|
+
content: {
|
|
12159
|
+
"application/json": components["schemas"]["PayInvoiceDto"];
|
|
12160
|
+
};
|
|
12161
|
+
};
|
|
11447
12162
|
responses: {
|
|
11448
12163
|
200: {
|
|
11449
12164
|
headers: {
|
|
11450
12165
|
[name: string]: unknown;
|
|
11451
12166
|
};
|
|
11452
12167
|
content: {
|
|
11453
|
-
"application/json": components["schemas"]["
|
|
12168
|
+
"application/json": components["schemas"]["InvoiceResponseDto"];
|
|
11454
12169
|
};
|
|
11455
12170
|
};
|
|
11456
|
-
/** @description Validation failure or
|
|
12171
|
+
/** @description Validation failure or invoice_not_open. */
|
|
11457
12172
|
400: {
|
|
11458
12173
|
headers: {
|
|
11459
12174
|
[name: string]: unknown;
|
|
@@ -11508,30 +12223,31 @@ interface operations {
|
|
|
11508
12223
|
};
|
|
11509
12224
|
};
|
|
11510
12225
|
};
|
|
11511
|
-
|
|
12226
|
+
SetupSessions_create: {
|
|
11512
12227
|
parameters: {
|
|
11513
|
-
query?:
|
|
11514
|
-
|
|
11515
|
-
|
|
11516
|
-
|
|
11517
|
-
cursor?: string;
|
|
11518
|
-
limit?: number;
|
|
12228
|
+
query?: never;
|
|
12229
|
+
header?: {
|
|
12230
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
12231
|
+
"Idempotency-Key"?: string;
|
|
11519
12232
|
};
|
|
11520
|
-
header?: never;
|
|
11521
12233
|
path?: never;
|
|
11522
12234
|
cookie?: never;
|
|
11523
12235
|
};
|
|
11524
|
-
requestBody
|
|
12236
|
+
requestBody: {
|
|
12237
|
+
content: {
|
|
12238
|
+
"application/json": components["schemas"]["CreateSetupSessionDto"];
|
|
12239
|
+
};
|
|
12240
|
+
};
|
|
11525
12241
|
responses: {
|
|
11526
|
-
|
|
12242
|
+
201: {
|
|
11527
12243
|
headers: {
|
|
11528
12244
|
[name: string]: unknown;
|
|
11529
12245
|
};
|
|
11530
12246
|
content: {
|
|
11531
|
-
"application/json": components["schemas"]["
|
|
12247
|
+
"application/json": components["schemas"]["SetupSessionResponseDto"];
|
|
11532
12248
|
};
|
|
11533
12249
|
};
|
|
11534
|
-
/** @description Validation failure or
|
|
12250
|
+
/** @description Validation failure, method_not_allowed or automatic_charging_unavailable. */
|
|
11535
12251
|
400: {
|
|
11536
12252
|
headers: {
|
|
11537
12253
|
[name: string]: unknown;
|
|
@@ -11558,6 +12274,14 @@ interface operations {
|
|
|
11558
12274
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11559
12275
|
};
|
|
11560
12276
|
};
|
|
12277
|
+
404: {
|
|
12278
|
+
headers: {
|
|
12279
|
+
[name: string]: unknown;
|
|
12280
|
+
};
|
|
12281
|
+
content: {
|
|
12282
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12283
|
+
};
|
|
12284
|
+
};
|
|
11561
12285
|
/** @description Client error. */
|
|
11562
12286
|
"4XX": {
|
|
11563
12287
|
headers: {
|
|
@@ -11578,7 +12302,7 @@ interface operations {
|
|
|
11578
12302
|
};
|
|
11579
12303
|
};
|
|
11580
12304
|
};
|
|
11581
|
-
|
|
12305
|
+
SetupSessions_retrieve: {
|
|
11582
12306
|
parameters: {
|
|
11583
12307
|
query?: never;
|
|
11584
12308
|
header?: never;
|
|
@@ -11594,10 +12318,10 @@ interface operations {
|
|
|
11594
12318
|
[name: string]: unknown;
|
|
11595
12319
|
};
|
|
11596
12320
|
content: {
|
|
11597
|
-
"application/json": components["schemas"]["
|
|
12321
|
+
"application/json": components["schemas"]["SetupSessionResponseDto"];
|
|
11598
12322
|
};
|
|
11599
12323
|
};
|
|
11600
|
-
/** @description Validation failure or
|
|
12324
|
+
/** @description Validation failure, method_not_allowed or automatic_charging_unavailable. */
|
|
11601
12325
|
400: {
|
|
11602
12326
|
headers: {
|
|
11603
12327
|
[name: string]: unknown;
|
|
@@ -11652,13 +12376,10 @@ interface operations {
|
|
|
11652
12376
|
};
|
|
11653
12377
|
};
|
|
11654
12378
|
};
|
|
11655
|
-
|
|
12379
|
+
PaymentMethods_retrieve: {
|
|
11656
12380
|
parameters: {
|
|
11657
12381
|
query?: never;
|
|
11658
|
-
header?:
|
|
11659
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
11660
|
-
"Idempotency-Key"?: string;
|
|
11661
|
-
};
|
|
12382
|
+
header?: never;
|
|
11662
12383
|
path: {
|
|
11663
12384
|
id: string;
|
|
11664
12385
|
};
|
|
@@ -11671,16 +12392,7 @@ interface operations {
|
|
|
11671
12392
|
[name: string]: unknown;
|
|
11672
12393
|
};
|
|
11673
12394
|
content: {
|
|
11674
|
-
"application/json": components["schemas"]["
|
|
11675
|
-
};
|
|
11676
|
-
};
|
|
11677
|
-
/** @description Validation failure or invoice_not_open. */
|
|
11678
|
-
400: {
|
|
11679
|
-
headers: {
|
|
11680
|
-
[name: string]: unknown;
|
|
11681
|
-
};
|
|
11682
|
-
content: {
|
|
11683
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12395
|
+
"application/json": components["schemas"]["PaymentMethodResponseDto"];
|
|
11684
12396
|
};
|
|
11685
12397
|
};
|
|
11686
12398
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -11729,13 +12441,10 @@ interface operations {
|
|
|
11729
12441
|
};
|
|
11730
12442
|
};
|
|
11731
12443
|
};
|
|
11732
|
-
|
|
12444
|
+
PaymentMethods_detach: {
|
|
11733
12445
|
parameters: {
|
|
11734
12446
|
query?: never;
|
|
11735
|
-
header?:
|
|
11736
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
11737
|
-
"Idempotency-Key"?: string;
|
|
11738
|
-
};
|
|
12447
|
+
header?: never;
|
|
11739
12448
|
path: {
|
|
11740
12449
|
id: string;
|
|
11741
12450
|
};
|
|
@@ -11748,16 +12457,7 @@ interface operations {
|
|
|
11748
12457
|
[name: string]: unknown;
|
|
11749
12458
|
};
|
|
11750
12459
|
content: {
|
|
11751
|
-
"application/json": components["schemas"]["
|
|
11752
|
-
};
|
|
11753
|
-
};
|
|
11754
|
-
/** @description Validation failure or invoice_not_open. */
|
|
11755
|
-
400: {
|
|
11756
|
-
headers: {
|
|
11757
|
-
[name: string]: unknown;
|
|
11758
|
-
};
|
|
11759
|
-
content: {
|
|
11760
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12460
|
+
"application/json": components["schemas"]["PaymentMethodResponseDto"];
|
|
11761
12461
|
};
|
|
11762
12462
|
};
|
|
11763
12463
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -11806,39 +12506,26 @@ interface operations {
|
|
|
11806
12506
|
};
|
|
11807
12507
|
};
|
|
11808
12508
|
};
|
|
11809
|
-
|
|
12509
|
+
PaymentMethods_list: {
|
|
11810
12510
|
parameters: {
|
|
11811
|
-
query?:
|
|
11812
|
-
|
|
11813
|
-
|
|
11814
|
-
"Idempotency-Key"?: string;
|
|
12511
|
+
query?: {
|
|
12512
|
+
cursor?: string;
|
|
12513
|
+
limit?: number;
|
|
11815
12514
|
};
|
|
12515
|
+
header?: never;
|
|
11816
12516
|
path: {
|
|
11817
12517
|
id: string;
|
|
11818
12518
|
};
|
|
11819
12519
|
cookie?: never;
|
|
11820
12520
|
};
|
|
11821
|
-
requestBody
|
|
11822
|
-
content: {
|
|
11823
|
-
"application/json": components["schemas"]["PayInvoiceDto"];
|
|
11824
|
-
};
|
|
11825
|
-
};
|
|
12521
|
+
requestBody?: never;
|
|
11826
12522
|
responses: {
|
|
11827
12523
|
200: {
|
|
11828
12524
|
headers: {
|
|
11829
12525
|
[name: string]: unknown;
|
|
11830
12526
|
};
|
|
11831
12527
|
content: {
|
|
11832
|
-
"application/json": components["schemas"]["
|
|
11833
|
-
};
|
|
11834
|
-
};
|
|
11835
|
-
/** @description Validation failure or invoice_not_open. */
|
|
11836
|
-
400: {
|
|
11837
|
-
headers: {
|
|
11838
|
-
[name: string]: unknown;
|
|
11839
|
-
};
|
|
11840
|
-
content: {
|
|
11841
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12528
|
+
"application/json": components["schemas"]["PaymentMethodListResponseDto"];
|
|
11842
12529
|
};
|
|
11843
12530
|
};
|
|
11844
12531
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -11887,31 +12574,27 @@ interface operations {
|
|
|
11887
12574
|
};
|
|
11888
12575
|
};
|
|
11889
12576
|
};
|
|
11890
|
-
|
|
12577
|
+
TestClocks_list: {
|
|
11891
12578
|
parameters: {
|
|
11892
|
-
query?:
|
|
11893
|
-
|
|
11894
|
-
|
|
11895
|
-
"Idempotency-Key"?: string;
|
|
12579
|
+
query?: {
|
|
12580
|
+
cursor?: string;
|
|
12581
|
+
limit?: number;
|
|
11896
12582
|
};
|
|
12583
|
+
header?: never;
|
|
11897
12584
|
path?: never;
|
|
11898
12585
|
cookie?: never;
|
|
11899
12586
|
};
|
|
11900
|
-
requestBody
|
|
11901
|
-
content: {
|
|
11902
|
-
"application/json": components["schemas"]["CreateSetupSessionDto"];
|
|
11903
|
-
};
|
|
11904
|
-
};
|
|
12587
|
+
requestBody?: never;
|
|
11905
12588
|
responses: {
|
|
11906
|
-
|
|
12589
|
+
200: {
|
|
11907
12590
|
headers: {
|
|
11908
12591
|
[name: string]: unknown;
|
|
11909
12592
|
};
|
|
11910
12593
|
content: {
|
|
11911
|
-
"application/json": components["schemas"]["
|
|
12594
|
+
"application/json": components["schemas"]["TestClockListResponseDto"];
|
|
11912
12595
|
};
|
|
11913
12596
|
};
|
|
11914
|
-
/** @description Validation failure,
|
|
12597
|
+
/** @description Validation failure, or test_mode_only on a live-mode tenant. */
|
|
11915
12598
|
400: {
|
|
11916
12599
|
headers: {
|
|
11917
12600
|
[name: string]: unknown;
|
|
@@ -11938,14 +12621,6 @@ interface operations {
|
|
|
11938
12621
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11939
12622
|
};
|
|
11940
12623
|
};
|
|
11941
|
-
404: {
|
|
11942
|
-
headers: {
|
|
11943
|
-
[name: string]: unknown;
|
|
11944
|
-
};
|
|
11945
|
-
content: {
|
|
11946
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
11947
|
-
};
|
|
11948
|
-
};
|
|
11949
12624
|
/** @description Client error. */
|
|
11950
12625
|
"4XX": {
|
|
11951
12626
|
headers: {
|
|
@@ -11966,26 +12641,31 @@ interface operations {
|
|
|
11966
12641
|
};
|
|
11967
12642
|
};
|
|
11968
12643
|
};
|
|
11969
|
-
|
|
12644
|
+
TestClocks_create: {
|
|
11970
12645
|
parameters: {
|
|
11971
12646
|
query?: never;
|
|
11972
|
-
header?:
|
|
11973
|
-
|
|
11974
|
-
|
|
12647
|
+
header?: {
|
|
12648
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
12649
|
+
"Idempotency-Key"?: string;
|
|
11975
12650
|
};
|
|
12651
|
+
path?: never;
|
|
11976
12652
|
cookie?: never;
|
|
11977
12653
|
};
|
|
11978
|
-
requestBody
|
|
12654
|
+
requestBody: {
|
|
12655
|
+
content: {
|
|
12656
|
+
"application/json": components["schemas"]["CreateTestClockDto"];
|
|
12657
|
+
};
|
|
12658
|
+
};
|
|
11979
12659
|
responses: {
|
|
11980
|
-
|
|
12660
|
+
201: {
|
|
11981
12661
|
headers: {
|
|
11982
12662
|
[name: string]: unknown;
|
|
11983
12663
|
};
|
|
11984
12664
|
content: {
|
|
11985
|
-
"application/json": components["schemas"]["
|
|
12665
|
+
"application/json": components["schemas"]["TestClockResponseDto"];
|
|
11986
12666
|
};
|
|
11987
12667
|
};
|
|
11988
|
-
/** @description Validation failure,
|
|
12668
|
+
/** @description Validation failure, or test_mode_only on a live-mode tenant. */
|
|
11989
12669
|
400: {
|
|
11990
12670
|
headers: {
|
|
11991
12671
|
[name: string]: unknown;
|
|
@@ -12012,14 +12692,6 @@ interface operations {
|
|
|
12012
12692
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12013
12693
|
};
|
|
12014
12694
|
};
|
|
12015
|
-
404: {
|
|
12016
|
-
headers: {
|
|
12017
|
-
[name: string]: unknown;
|
|
12018
|
-
};
|
|
12019
|
-
content: {
|
|
12020
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12021
|
-
};
|
|
12022
|
-
};
|
|
12023
12695
|
/** @description Client error. */
|
|
12024
12696
|
"4XX": {
|
|
12025
12697
|
headers: {
|
|
@@ -12040,7 +12712,7 @@ interface operations {
|
|
|
12040
12712
|
};
|
|
12041
12713
|
};
|
|
12042
12714
|
};
|
|
12043
|
-
|
|
12715
|
+
TestClocks_retrieve: {
|
|
12044
12716
|
parameters: {
|
|
12045
12717
|
query?: never;
|
|
12046
12718
|
header?: never;
|
|
@@ -12056,7 +12728,16 @@ interface operations {
|
|
|
12056
12728
|
[name: string]: unknown;
|
|
12057
12729
|
};
|
|
12058
12730
|
content: {
|
|
12059
|
-
"application/json": components["schemas"]["
|
|
12731
|
+
"application/json": components["schemas"]["TestClockResponseDto"];
|
|
12732
|
+
};
|
|
12733
|
+
};
|
|
12734
|
+
/** @description Validation failure, or test_mode_only on a live-mode tenant. */
|
|
12735
|
+
400: {
|
|
12736
|
+
headers: {
|
|
12737
|
+
[name: string]: unknown;
|
|
12738
|
+
};
|
|
12739
|
+
content: {
|
|
12740
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12060
12741
|
};
|
|
12061
12742
|
};
|
|
12062
12743
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -12105,7 +12786,7 @@ interface operations {
|
|
|
12105
12786
|
};
|
|
12106
12787
|
};
|
|
12107
12788
|
};
|
|
12108
|
-
|
|
12789
|
+
TestClocks_remove: {
|
|
12109
12790
|
parameters: {
|
|
12110
12791
|
query?: never;
|
|
12111
12792
|
header?: never;
|
|
@@ -12121,7 +12802,16 @@ interface operations {
|
|
|
12121
12802
|
[name: string]: unknown;
|
|
12122
12803
|
};
|
|
12123
12804
|
content: {
|
|
12124
|
-
"application/json": components["schemas"]["
|
|
12805
|
+
"application/json": components["schemas"]["DeletedObjectResponseDto"];
|
|
12806
|
+
};
|
|
12807
|
+
};
|
|
12808
|
+
/** @description Validation failure, or test_mode_only on a live-mode tenant. */
|
|
12809
|
+
400: {
|
|
12810
|
+
headers: {
|
|
12811
|
+
[name: string]: unknown;
|
|
12812
|
+
};
|
|
12813
|
+
content: {
|
|
12814
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12125
12815
|
};
|
|
12126
12816
|
};
|
|
12127
12817
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -12150,6 +12840,15 @@ interface operations {
|
|
|
12150
12840
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12151
12841
|
};
|
|
12152
12842
|
};
|
|
12843
|
+
/** @description test_clock_advancing */
|
|
12844
|
+
409: {
|
|
12845
|
+
headers: {
|
|
12846
|
+
[name: string]: unknown;
|
|
12847
|
+
};
|
|
12848
|
+
content: {
|
|
12849
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12850
|
+
};
|
|
12851
|
+
};
|
|
12153
12852
|
/** @description Client error. */
|
|
12154
12853
|
"4XX": {
|
|
12155
12854
|
headers: {
|
|
@@ -12170,26 +12869,39 @@ interface operations {
|
|
|
12170
12869
|
};
|
|
12171
12870
|
};
|
|
12172
12871
|
};
|
|
12173
|
-
|
|
12872
|
+
TestClocks_advance: {
|
|
12174
12873
|
parameters: {
|
|
12175
|
-
query?:
|
|
12176
|
-
|
|
12177
|
-
|
|
12874
|
+
query?: never;
|
|
12875
|
+
header?: {
|
|
12876
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
12877
|
+
"Idempotency-Key"?: string;
|
|
12178
12878
|
};
|
|
12179
|
-
header?: never;
|
|
12180
12879
|
path: {
|
|
12181
12880
|
id: string;
|
|
12182
12881
|
};
|
|
12183
12882
|
cookie?: never;
|
|
12184
12883
|
};
|
|
12185
|
-
requestBody
|
|
12884
|
+
requestBody: {
|
|
12885
|
+
content: {
|
|
12886
|
+
"application/json": components["schemas"]["AdvanceTestClockDto"];
|
|
12887
|
+
};
|
|
12888
|
+
};
|
|
12186
12889
|
responses: {
|
|
12187
12890
|
200: {
|
|
12188
12891
|
headers: {
|
|
12189
12892
|
[name: string]: unknown;
|
|
12190
12893
|
};
|
|
12191
12894
|
content: {
|
|
12192
|
-
"application/json": components["schemas"]["
|
|
12895
|
+
"application/json": components["schemas"]["TestClockResponseDto"];
|
|
12896
|
+
};
|
|
12897
|
+
};
|
|
12898
|
+
/** @description Validation failure, or test_mode_only on a live-mode tenant. */
|
|
12899
|
+
400: {
|
|
12900
|
+
headers: {
|
|
12901
|
+
[name: string]: unknown;
|
|
12902
|
+
};
|
|
12903
|
+
content: {
|
|
12904
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12193
12905
|
};
|
|
12194
12906
|
};
|
|
12195
12907
|
/** @description Missing or invalid tenant API key. */
|
|
@@ -12218,6 +12930,15 @@ interface operations {
|
|
|
12218
12930
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12219
12931
|
};
|
|
12220
12932
|
};
|
|
12933
|
+
/** @description test_clock_advancing */
|
|
12934
|
+
409: {
|
|
12935
|
+
headers: {
|
|
12936
|
+
[name: string]: unknown;
|
|
12937
|
+
};
|
|
12938
|
+
content: {
|
|
12939
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
12940
|
+
};
|
|
12941
|
+
};
|
|
12221
12942
|
/** @description Client error. */
|
|
12222
12943
|
"4XX": {
|
|
12223
12944
|
headers: {
|
|
@@ -12270,7 +12991,7 @@ declare class PagePromise<Page extends CursorPage<Item>, Item = Page['items'][nu
|
|
|
12270
12991
|
|
|
12271
12992
|
type OperationId = keyof operations;
|
|
12272
12993
|
|
|
12273
|
-
/** Every request/response schema in the
|
|
12994
|
+
/** Every request/response schema in the VEX Pay API, e.g. `Schemas['PaymentReceiptDto']`. */
|
|
12274
12995
|
type Schemas = components['schemas'];
|
|
12275
12996
|
type Params<O extends OperationId> = operations[O]['parameters'];
|
|
12276
12997
|
type PathParams<O extends OperationId> = NonNullable<Params<O>['path']>;
|
|
@@ -12481,6 +13202,8 @@ declare class Balance extends APIResource {
|
|
|
12481
13202
|
heldVes?: string;
|
|
12482
13203
|
nextReleaseAt?: string | null;
|
|
12483
13204
|
availableVes: string;
|
|
13205
|
+
unconfirmedVes?: string;
|
|
13206
|
+
settlement?: components["schemas"]["BsSettlementStatusDto"];
|
|
12484
13207
|
platformAvailableVes: string;
|
|
12485
13208
|
sellerObligationsVes: string;
|
|
12486
13209
|
sellerPendingVes: string;
|
|
@@ -12495,7 +13218,7 @@ declare class Payouts extends APIResource {
|
|
|
12495
13218
|
create(params: RequestBody<'Payouts_create'>, options?: RequestOptions): Promise<{
|
|
12496
13219
|
payoutId: string;
|
|
12497
13220
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
12498
|
-
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
13221
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
12499
13222
|
reference?: string | null;
|
|
12500
13223
|
failureCode?: string | null;
|
|
12501
13224
|
externalRef?: string;
|
|
@@ -12519,7 +13242,7 @@ declare class Payouts extends APIResource {
|
|
|
12519
13242
|
createInstant(params: RequestBody<'Payouts_createInstant'>, options?: RequestOptions): Promise<{
|
|
12520
13243
|
payoutId: string;
|
|
12521
13244
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
12522
|
-
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
13245
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
12523
13246
|
reference?: string | null;
|
|
12524
13247
|
failureCode?: string | null;
|
|
12525
13248
|
externalRef?: string;
|
|
@@ -12552,7 +13275,7 @@ declare class Payouts extends APIResource {
|
|
|
12552
13275
|
}, {
|
|
12553
13276
|
payoutId: string;
|
|
12554
13277
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
12555
|
-
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
13278
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
12556
13279
|
reference?: string | null;
|
|
12557
13280
|
failureCode?: string | null;
|
|
12558
13281
|
externalRef?: string;
|
|
@@ -12575,7 +13298,7 @@ declare class Payouts extends APIResource {
|
|
|
12575
13298
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
12576
13299
|
payoutId: string;
|
|
12577
13300
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
12578
|
-
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
13301
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
12579
13302
|
reference?: string | null;
|
|
12580
13303
|
failureCode?: string | null;
|
|
12581
13304
|
externalRef?: string;
|
|
@@ -12598,7 +13321,7 @@ declare class Payouts extends APIResource {
|
|
|
12598
13321
|
retrieveByRef(externalRef: string, options?: RequestOptions): Promise<{
|
|
12599
13322
|
payoutId: string;
|
|
12600
13323
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
12601
|
-
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
13324
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
12602
13325
|
reference?: string | null;
|
|
12603
13326
|
failureCode?: string | null;
|
|
12604
13327
|
externalRef?: string;
|
|
@@ -12619,12 +13342,14 @@ declare class Payouts extends APIResource {
|
|
|
12619
13342
|
settledAt?: string | null;
|
|
12620
13343
|
}>;
|
|
12621
13344
|
}
|
|
12622
|
-
/** The account your own
|
|
13345
|
+
/** The account your own VEX Pay earnings are paid out to. */
|
|
12623
13346
|
declare class TenantPayoutAccount extends APIResource {
|
|
12624
13347
|
retrieve(options?: RequestOptions): Promise<{
|
|
12625
13348
|
accountId: string;
|
|
12626
13349
|
bankCode: string;
|
|
13350
|
+
type: "pago_movil" | "bank_account";
|
|
12627
13351
|
destination: string;
|
|
13352
|
+
holderName?: string | null;
|
|
12628
13353
|
identification: string;
|
|
12629
13354
|
eligibility: "pending_verification" | "verifying" | "cooling" | "eligible" | "rejected" | "locked";
|
|
12630
13355
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
@@ -12638,7 +13363,9 @@ declare class TenantPayoutAccount extends APIResource {
|
|
|
12638
13363
|
upsert(params: RequestBody<'TenantPayoutAccount_upsert'>, options?: RequestOptions): Promise<{
|
|
12639
13364
|
accountId: string;
|
|
12640
13365
|
bankCode: string;
|
|
13366
|
+
type: "pago_movil" | "bank_account";
|
|
12641
13367
|
destination: string;
|
|
13368
|
+
holderName?: string | null;
|
|
12642
13369
|
identification: string;
|
|
12643
13370
|
eligibility: "pending_verification" | "verifying" | "cooling" | "eligible" | "rejected" | "locked";
|
|
12644
13371
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
@@ -12652,7 +13379,9 @@ declare class TenantPayoutAccount extends APIResource {
|
|
|
12652
13379
|
create(params: RequestBody<'TenantPayoutAccount_upsertPost'>, options?: RequestOptions): Promise<{
|
|
12653
13380
|
accountId: string;
|
|
12654
13381
|
bankCode: string;
|
|
13382
|
+
type: "pago_movil" | "bank_account";
|
|
12655
13383
|
destination: string;
|
|
13384
|
+
holderName?: string | null;
|
|
12656
13385
|
identification: string;
|
|
12657
13386
|
eligibility: "pending_verification" | "verifying" | "cooling" | "eligible" | "rejected" | "locked";
|
|
12658
13387
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
@@ -12673,14 +13402,14 @@ declare class TenantPayoutAccount extends APIResource {
|
|
|
12673
13402
|
payoutEligibleAt: string;
|
|
12674
13403
|
}>;
|
|
12675
13404
|
}
|
|
12676
|
-
/** Where
|
|
13405
|
+
/** Where VEX Pay delivers signed webhooks. */
|
|
12677
13406
|
declare class WebhookEndpoints extends APIResource {
|
|
12678
13407
|
/** The response includes the signing `secret` — store it to verify deliveries. */
|
|
12679
13408
|
create(params: RequestBody<'Webhooks_createWebhook'>, options?: RequestOptions): Promise<{
|
|
12680
13409
|
id: string;
|
|
12681
13410
|
tenantId: string;
|
|
12682
13411
|
url: string;
|
|
12683
|
-
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")[];
|
|
13412
|
+
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" | "test_clock.advancing" | "test_clock.ready" | "notification.test")[];
|
|
12684
13413
|
isActive: boolean;
|
|
12685
13414
|
createdAt: string;
|
|
12686
13415
|
secret?: string;
|
|
@@ -12689,7 +13418,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
12689
13418
|
id: string;
|
|
12690
13419
|
tenantId: string;
|
|
12691
13420
|
url: string;
|
|
12692
|
-
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")[];
|
|
13421
|
+
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" | "test_clock.advancing" | "test_clock.ready" | "notification.test")[];
|
|
12693
13422
|
isActive: boolean;
|
|
12694
13423
|
createdAt: string;
|
|
12695
13424
|
secret?: string;
|
|
@@ -12698,7 +13427,7 @@ declare class WebhookEndpoints extends APIResource {
|
|
|
12698
13427
|
id: string;
|
|
12699
13428
|
tenantId: string;
|
|
12700
13429
|
url: string;
|
|
12701
|
-
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")[];
|
|
13430
|
+
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" | "test_clock.advancing" | "test_clock.ready" | "notification.test")[];
|
|
12702
13431
|
isActive: boolean;
|
|
12703
13432
|
createdAt: string;
|
|
12704
13433
|
secret?: string;
|
|
@@ -13119,7 +13848,7 @@ declare class Invoices extends APIResource {
|
|
|
13119
13848
|
createdAt: string;
|
|
13120
13849
|
livemode: boolean;
|
|
13121
13850
|
}>;
|
|
13122
|
-
/** Record an open invoice as paid outside
|
|
13851
|
+
/** Record an open invoice as paid outside VEX Pay (`paidOutOfBand: true`); no money moves. */
|
|
13123
13852
|
pay(id: string, params: RequestBody<'Invoices_pay'>, options?: RequestOptions): Promise<{
|
|
13124
13853
|
id: string;
|
|
13125
13854
|
object: string;
|
|
@@ -13206,6 +13935,67 @@ declare class PaymentMethods extends APIResource {
|
|
|
13206
13935
|
livemode: boolean;
|
|
13207
13936
|
}>;
|
|
13208
13937
|
}
|
|
13938
|
+
/**
|
|
13939
|
+
* Test mode only: freeze time for up to 3 customers and move it forward to see trials,
|
|
13940
|
+
* renewals, dunning and cancellations happen in minutes. Attach a customer with
|
|
13941
|
+
* `customers.create({ testClock })`.
|
|
13942
|
+
*/
|
|
13943
|
+
declare class TestClocks extends APIResource {
|
|
13944
|
+
/** `frozenTime` is an ISO 8601 time. */
|
|
13945
|
+
create(params: RequestBody<'TestClocks_create'>, options?: RequestOptions): Promise<{
|
|
13946
|
+
id: string;
|
|
13947
|
+
object: string;
|
|
13948
|
+
name: string | null;
|
|
13949
|
+
frozenTime: string;
|
|
13950
|
+
status: "ready" | "advancing" | "internal_failure";
|
|
13951
|
+
targetTime: string | null;
|
|
13952
|
+
createdAt: string;
|
|
13953
|
+
livemode: boolean;
|
|
13954
|
+
}>;
|
|
13955
|
+
/** Await for one page, or `for await` over every clock (newest first). */
|
|
13956
|
+
list(params?: QueryParams<'TestClocks_list'>, options?: RequestOptions): PagePromise<{
|
|
13957
|
+
items: components["schemas"]["TestClockResponseDto"][];
|
|
13958
|
+
nextCursor: string | null;
|
|
13959
|
+
}, {
|
|
13960
|
+
id: string;
|
|
13961
|
+
object: string;
|
|
13962
|
+
name: string | null;
|
|
13963
|
+
frozenTime: string;
|
|
13964
|
+
status: "ready" | "advancing" | "internal_failure";
|
|
13965
|
+
targetTime: string | null;
|
|
13966
|
+
createdAt: string;
|
|
13967
|
+
livemode: boolean;
|
|
13968
|
+
}>;
|
|
13969
|
+
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
13970
|
+
id: string;
|
|
13971
|
+
object: string;
|
|
13972
|
+
name: string | null;
|
|
13973
|
+
frozenTime: string;
|
|
13974
|
+
status: "ready" | "advancing" | "internal_failure";
|
|
13975
|
+
targetTime: string | null;
|
|
13976
|
+
createdAt: string;
|
|
13977
|
+
livemode: boolean;
|
|
13978
|
+
}>;
|
|
13979
|
+
/** Deletes the clock with its customers, subscriptions, invoices and payment methods. */
|
|
13980
|
+
delete(id: string, options?: RequestOptions): Promise<{
|
|
13981
|
+
id: string;
|
|
13982
|
+
deleted: boolean;
|
|
13983
|
+
}>;
|
|
13984
|
+
/**
|
|
13985
|
+
* Move the clock forward (at most two intervals of its shortest subscription). It returns at
|
|
13986
|
+
* once with `status: "advancing"`; poll `retrieve` or wait for `test_clock.ready`.
|
|
13987
|
+
*/
|
|
13988
|
+
advance(id: string, params: RequestBody<'TestClocks_advance'>, options?: RequestOptions): Promise<{
|
|
13989
|
+
id: string;
|
|
13990
|
+
object: string;
|
|
13991
|
+
name: string | null;
|
|
13992
|
+
frozenTime: string;
|
|
13993
|
+
status: "ready" | "advancing" | "internal_failure";
|
|
13994
|
+
targetTime: string | null;
|
|
13995
|
+
createdAt: string;
|
|
13996
|
+
livemode: boolean;
|
|
13997
|
+
}>;
|
|
13998
|
+
}
|
|
13209
13999
|
|
|
13210
14000
|
/** Single-purchase checkouts: redirect to `url`, or embed with @vexpay/js using `clientSecret`. */
|
|
13211
14001
|
declare class CheckoutSessions extends APIResource {
|
|
@@ -13398,7 +14188,7 @@ declare class ConversionSettings extends APIResource {
|
|
|
13398
14188
|
}
|
|
13399
14189
|
/**
|
|
13400
14190
|
* Convert available VES or COP into your USDT balance. Accepting a quote debits the source at once
|
|
13401
|
-
* (`conversion.created`); the conversion is `PENDING` until
|
|
14191
|
+
* (`conversion.created`); the conversion is `PENDING` until VEX Pay delivers the USDT
|
|
13402
14192
|
* (`conversion.completed`). Enabled per account.
|
|
13403
14193
|
*/
|
|
13404
14194
|
declare class Conversions extends APIResource {
|
|
@@ -13802,8 +14592,21 @@ declare class PayoutMethods extends APIResource {
|
|
|
13802
14592
|
payoutMethodId: string;
|
|
13803
14593
|
}>;
|
|
13804
14594
|
}
|
|
14595
|
+
/** Marketplace comercio auto-payout: the default for new merchants and the payout minimum. */
|
|
14596
|
+
declare class MarketplaceSettings extends APIResource {
|
|
14597
|
+
retrieve(options?: RequestOptions): Promise<{
|
|
14598
|
+
merchantAutoPayoutDefault: boolean;
|
|
14599
|
+
merchantAutoPayoutMinUsd?: string | null;
|
|
14600
|
+
}>;
|
|
14601
|
+
/** `merchantAutoPayoutDefault` and/or `merchantAutoPayoutMinUsd` (USD; null clears it). */
|
|
14602
|
+
update(params: RequestBody<'MarketplaceSettings_update'>, options?: RequestOptions): Promise<{
|
|
14603
|
+
merchantAutoPayoutDefault: boolean;
|
|
14604
|
+
merchantAutoPayoutMinUsd?: string | null;
|
|
14605
|
+
}>;
|
|
14606
|
+
}
|
|
13805
14607
|
declare class Merchants extends APIResource {
|
|
13806
14608
|
readonly payoutMethods: PayoutMethods;
|
|
14609
|
+
readonly marketplaceSettings: MarketplaceSettings;
|
|
13807
14610
|
/** `externalRef` is required and is the idempotency key for merchant creation. */
|
|
13808
14611
|
create(params: RequestBody<'Merchants_create'>, options?: RequestOptions): Promise<{
|
|
13809
14612
|
merchantId: string;
|
|
@@ -13970,6 +14773,7 @@ declare class Merchants extends APIResource {
|
|
|
13970
14773
|
description: string;
|
|
13971
14774
|
transferKey?: string;
|
|
13972
14775
|
paymentId?: string | null;
|
|
14776
|
+
splitReference?: string;
|
|
13973
14777
|
payoutId?: string | null;
|
|
13974
14778
|
availableAt?: string | null;
|
|
13975
14779
|
amountUsd?: string;
|
|
@@ -14038,6 +14842,7 @@ declare class C2p extends APIResource {
|
|
|
14038
14842
|
reversalRef?: string;
|
|
14039
14843
|
reversalTxId?: number;
|
|
14040
14844
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
14845
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14041
14846
|
intentId: string;
|
|
14042
14847
|
otpRequested: boolean;
|
|
14043
14848
|
}>;
|
|
@@ -14073,6 +14878,7 @@ declare class C2p extends APIResource {
|
|
|
14073
14878
|
reversalRef?: string;
|
|
14074
14879
|
reversalTxId?: number;
|
|
14075
14880
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
14881
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14076
14882
|
}>;
|
|
14077
14883
|
}
|
|
14078
14884
|
/** Card payments (VPOS). Prefer the hosted/embedded checkout so card data never touches your servers. */
|
|
@@ -14108,6 +14914,7 @@ declare class Vpos extends APIResource {
|
|
|
14108
14914
|
reversalRef?: string;
|
|
14109
14915
|
reversalTxId?: number;
|
|
14110
14916
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
14917
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14111
14918
|
}>;
|
|
14112
14919
|
}
|
|
14113
14920
|
/** Confirm a Pago Móvil the customer already sent to you. */
|
|
@@ -14157,6 +14964,7 @@ declare class PagoMovil extends APIResource {
|
|
|
14157
14964
|
reversalRef?: string;
|
|
14158
14965
|
reversalTxId?: number;
|
|
14159
14966
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
14967
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14160
14968
|
}>;
|
|
14161
14969
|
}
|
|
14162
14970
|
/** Débito inmediato (advanced payments, enabled per account). */
|
|
@@ -14300,6 +15108,7 @@ declare class Payments extends APIResource {
|
|
|
14300
15108
|
reversalRef?: string;
|
|
14301
15109
|
reversalTxId?: number;
|
|
14302
15110
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
15111
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14303
15112
|
}>;
|
|
14304
15113
|
/** Look up a payment by the `externalRef` you sent. */
|
|
14305
15114
|
retrieveByRef(externalRef: string, options?: RequestOptions): Promise<{
|
|
@@ -14333,6 +15142,7 @@ declare class Payments extends APIResource {
|
|
|
14333
15142
|
reversalRef?: string;
|
|
14334
15143
|
reversalTxId?: number;
|
|
14335
15144
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
15145
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14336
15146
|
}>;
|
|
14337
15147
|
/** Reverse a completed C2P payment. */
|
|
14338
15148
|
reverse(id: string, options?: RequestOptions): Promise<{
|
|
@@ -14366,10 +15176,11 @@ declare class Payments extends APIResource {
|
|
|
14366
15176
|
reversalRef?: string;
|
|
14367
15177
|
reversalTxId?: number;
|
|
14368
15178
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
15179
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14369
15180
|
}>;
|
|
14370
15181
|
}
|
|
14371
15182
|
|
|
14372
|
-
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"];
|
|
15183
|
+
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", "test_clock.advancing", "test_clock.ready", "notification.test"];
|
|
14373
15184
|
type WebhookEventName = (typeof WEBHOOK_EVENT_NAMES)[number];
|
|
14374
15185
|
/** `data` of every `payment.*` event. */
|
|
14375
15186
|
interface PaymentWebhookData {
|
|
@@ -14484,9 +15295,9 @@ declare class Webhooks {
|
|
|
14484
15295
|
}): string;
|
|
14485
15296
|
}
|
|
14486
15297
|
|
|
14487
|
-
declare const DEFAULT_BASE_URL = "https://api.
|
|
15298
|
+
declare const DEFAULT_BASE_URL = "https://api.vexpay.app";
|
|
14488
15299
|
interface VexPayOptions {
|
|
14489
|
-
/** API origin. Defaults to production (`https://api.
|
|
15300
|
+
/** API origin. Defaults to production (`https://api.vexpay.app`). */
|
|
14490
15301
|
baseUrl?: string;
|
|
14491
15302
|
/** Per-attempt timeout. Default 30 000 ms. */
|
|
14492
15303
|
timeoutMs?: number;
|
|
@@ -14526,6 +15337,8 @@ declare class VexPay {
|
|
|
14526
15337
|
readonly setupSessions: SetupSessions;
|
|
14527
15338
|
/** Billing: domiciliación payment methods (bolívar methods your account takes: `payments.methods()`). */
|
|
14528
15339
|
readonly paymentMethods: PaymentMethods;
|
|
15340
|
+
/** Billing, test mode only: simulated time for trials, renewals and dunning. */
|
|
15341
|
+
readonly testClocks: TestClocks;
|
|
14529
15342
|
/** Offline helpers: `constructEvent` verifies deliveries; no API calls. */
|
|
14530
15343
|
readonly webhooks: Webhooks;
|
|
14531
15344
|
constructor(apiKey: string, options?: VexPayOptions);
|
|
@@ -14566,7 +15379,7 @@ declare class VexPayConflictError extends VexPayError {
|
|
|
14566
15379
|
/** 429 — too many requests. Retried automatically before surfacing. */
|
|
14567
15380
|
declare class VexPayRateLimitError extends VexPayError {
|
|
14568
15381
|
}
|
|
14569
|
-
/** 5xx —
|
|
15382
|
+
/** 5xx — VEX Pay or an upstream bank failed. Retried automatically before surfacing. */
|
|
14570
15383
|
declare class VexPayAPIError extends VexPayError {
|
|
14571
15384
|
}
|
|
14572
15385
|
/** The request never got an HTTP answer (DNS, refused, reset). */
|
|
@@ -14579,6 +15392,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
14579
15392
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
14580
15393
|
}
|
|
14581
15394
|
|
|
14582
|
-
declare const VERSION = "0.
|
|
15395
|
+
declare const VERSION = "0.17.0";
|
|
14583
15396
|
|
|
14584
15397
|
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 };
|