@vexpay/node 0.15.0 → 0.18.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 +17 -31
- package/dist/index.cjs +23 -13
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +694 -462
- package/dist/index.d.ts +694 -462
- package/dist/index.js +23 -13
- package/dist/index.js.map +1 -1
- package/package.json +7 -3
package/dist/index.d.cts
CHANGED
|
@@ -50,18 +50,73 @@ 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
|
+
};
|
|
53
108
|
BsSettlementStatusDto: {
|
|
54
109
|
/**
|
|
55
|
-
* @description True when your available Bs is settled automatically
|
|
110
|
+
* @description True when your available Bs is settled automatically as soon as the bank confirms each sale.
|
|
56
111
|
* @example true
|
|
57
112
|
*/
|
|
58
113
|
enabled: boolean;
|
|
59
114
|
/**
|
|
60
|
-
* @description `active` = settling; `no_payout_account` / `payout_account_unverified` = add and verify a payout account; `payout_account_cooling` = destination changed recently; `paused` = paused by
|
|
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.
|
|
61
116
|
* @example active
|
|
62
117
|
* @enum {string}
|
|
63
118
|
*/
|
|
64
|
-
status: "active" | "no_payout_account" | "payout_account_unverified" | "payout_account_cooling" | "paused" | "
|
|
119
|
+
status: "active" | "no_payout_account" | "payout_account_unverified" | "payout_account_cooling" | "paused" | "disbursements" | "test_mode";
|
|
65
120
|
/**
|
|
66
121
|
* @description Smallest available Bs amount that is settled.
|
|
67
122
|
* @example 100.00
|
|
@@ -94,7 +149,7 @@ interface components {
|
|
|
94
149
|
/** @example 8650.00 */
|
|
95
150
|
ledgerNetVes: string;
|
|
96
151
|
/**
|
|
97
|
-
* @description VES under a balance hold set by
|
|
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.
|
|
98
153
|
* @example 0.00
|
|
99
154
|
*/
|
|
100
155
|
heldVes?: string;
|
|
@@ -132,7 +187,7 @@ interface components {
|
|
|
132
187
|
/** @example 0.00 */
|
|
133
188
|
feeFixedUsd: string;
|
|
134
189
|
/**
|
|
135
|
-
* @description Hours each incoming credit is held before payouts can spend it (0 = no hold, the default). Set by
|
|
190
|
+
* @description Hours each incoming credit is held before payouts can spend it (0 = no hold, the default). Set by VEX Pay.
|
|
136
191
|
* @example 0
|
|
137
192
|
*/
|
|
138
193
|
balanceHoldHours?: number;
|
|
@@ -184,61 +239,6 @@ interface components {
|
|
|
184
239
|
/** @description Pass as `cursor` to get the next (older) page; null on the last page. */
|
|
185
240
|
nextCursor: string | null;
|
|
186
241
|
};
|
|
187
|
-
CreateWebhookDto: {
|
|
188
|
-
/**
|
|
189
|
-
* Format: uri
|
|
190
|
-
* @example https://merchant.example.com/webhooks/vexpay
|
|
191
|
-
*/
|
|
192
|
-
url: string;
|
|
193
|
-
/**
|
|
194
|
-
* @description Signing secret. If omitted, a random secret is generated and returned once.
|
|
195
|
-
* @example replace-with-a-long-random-secret
|
|
196
|
-
*/
|
|
197
|
-
secret?: string;
|
|
198
|
-
/**
|
|
199
|
-
* @example [
|
|
200
|
-
* "payment.completed",
|
|
201
|
-
* "payment.failed"
|
|
202
|
-
* ]
|
|
203
|
-
*/
|
|
204
|
-
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")[];
|
|
205
|
-
};
|
|
206
|
-
WebhookEndpointDto: {
|
|
207
|
-
/** Format: uuid */
|
|
208
|
-
id: string;
|
|
209
|
-
/** Format: uuid */
|
|
210
|
-
tenantId: string;
|
|
211
|
-
/** Format: uri */
|
|
212
|
-
url: string;
|
|
213
|
-
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")[];
|
|
214
|
-
isActive: boolean;
|
|
215
|
-
/** Format: date-time */
|
|
216
|
-
createdAt: string;
|
|
217
|
-
/** @description Returned only when the endpoint is created. Store it securely; list responses omit it. */
|
|
218
|
-
secret?: string;
|
|
219
|
-
};
|
|
220
|
-
UpdateWebhookDto: {
|
|
221
|
-
/**
|
|
222
|
-
* Format: uri
|
|
223
|
-
* @example https://merchant.example.com/webhooks/vexpay
|
|
224
|
-
*/
|
|
225
|
-
url?: string;
|
|
226
|
-
/**
|
|
227
|
-
* @description Replaces the full event subscription list when provided.
|
|
228
|
-
* @example [
|
|
229
|
-
* "payment.completed",
|
|
230
|
-
* "payment.failed",
|
|
231
|
-
* "payout.completed"
|
|
232
|
-
* ]
|
|
233
|
-
*/
|
|
234
|
-
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")[];
|
|
235
|
-
/** @example true */
|
|
236
|
-
isActive?: boolean;
|
|
237
|
-
};
|
|
238
|
-
DeleteWebhookResponseDto: {
|
|
239
|
-
/** @example true */
|
|
240
|
-
deleted: boolean;
|
|
241
|
-
};
|
|
242
242
|
PayoutResponseDto: {
|
|
243
243
|
/**
|
|
244
244
|
* Format: uuid
|
|
@@ -489,8 +489,12 @@ interface components {
|
|
|
489
489
|
accountId: string;
|
|
490
490
|
/** @example 0163 */
|
|
491
491
|
bankCode: string;
|
|
492
|
-
/** @
|
|
492
|
+
/** @enum {string} */
|
|
493
|
+
type: "pago_movil" | "bank_account";
|
|
494
|
+
/** @description Masked destination: phone `…5555` (Pago Móvil) or account `••••6789` (bank_account). */
|
|
493
495
|
destination: string;
|
|
496
|
+
/** @description Account holder name (bank_account only). */
|
|
497
|
+
holderName?: string | null;
|
|
494
498
|
/** @example V12345678 */
|
|
495
499
|
identification: string;
|
|
496
500
|
/**
|
|
@@ -523,6 +527,14 @@ interface components {
|
|
|
523
527
|
expiresAt: string;
|
|
524
528
|
/** Format: uuid */
|
|
525
529
|
accountId: string;
|
|
530
|
+
/**
|
|
531
|
+
* @description Test mode only: the two sandbox micro-deposit amounts to confirm (no money is sent in Test). Never present in live mode.
|
|
532
|
+
* @example [
|
|
533
|
+
* "0.13",
|
|
534
|
+
* "0.27"
|
|
535
|
+
* ]
|
|
536
|
+
*/
|
|
537
|
+
testAmounts?: string[];
|
|
526
538
|
};
|
|
527
539
|
TenantPayoutAccountVerifyConfirmResponseDto: {
|
|
528
540
|
/**
|
|
@@ -537,20 +549,36 @@ interface components {
|
|
|
537
549
|
};
|
|
538
550
|
UpsertTenantPayoutAccountDto: {
|
|
539
551
|
/**
|
|
540
|
-
* @description
|
|
552
|
+
* @description `pago_movil` (bank + phone) or `bank_account` (20-digit checking account). Switching type is a destination change.
|
|
553
|
+
* @default pago_movil
|
|
554
|
+
* @enum {string}
|
|
555
|
+
*/
|
|
556
|
+
type?: "pago_movil" | "bank_account";
|
|
557
|
+
/**
|
|
558
|
+
* @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.
|
|
541
559
|
* @example 0163
|
|
542
560
|
*/
|
|
543
|
-
banco
|
|
561
|
+
banco?: string;
|
|
544
562
|
/**
|
|
545
|
-
* @description Beneficiary cédula/RIF.
|
|
563
|
+
* @description Beneficiary (account holder) cédula/RIF.
|
|
546
564
|
* @example V12345678
|
|
547
565
|
*/
|
|
548
566
|
cedula: string;
|
|
549
567
|
/**
|
|
550
|
-
* @description Beneficiary Pago Móvil phone (58… or 0…).
|
|
568
|
+
* @description Beneficiary Pago Móvil phone (58… or 0…). Required for `pago_movil`.
|
|
551
569
|
* @example 584121234567
|
|
552
570
|
*/
|
|
553
|
-
telefono
|
|
571
|
+
telefono?: string;
|
|
572
|
+
/**
|
|
573
|
+
* @description 20-digit checking account number. Required for `bank_account`.
|
|
574
|
+
* @example 01160123450123456789
|
|
575
|
+
*/
|
|
576
|
+
cuenta?: string;
|
|
577
|
+
/**
|
|
578
|
+
* @description Account holder name. Required for `bank_account`.
|
|
579
|
+
* @example Rival Plus C.A.
|
|
580
|
+
*/
|
|
581
|
+
titular?: string;
|
|
554
582
|
};
|
|
555
583
|
ConfirmTenantPayoutAccountVerifyDto: {
|
|
556
584
|
/**
|
|
@@ -629,7 +657,7 @@ interface components {
|
|
|
629
657
|
success?: boolean;
|
|
630
658
|
/**
|
|
631
659
|
* Format: uuid
|
|
632
|
-
* @description
|
|
660
|
+
* @description VEX Pay payment id for this débito inmediato (method DEBITO_INMEDIATO).
|
|
633
661
|
* @example 3fd84b2d-9ad1-4f74-a2d9-0f2f56984db5
|
|
634
662
|
*/
|
|
635
663
|
paymentId: string;
|
|
@@ -784,6 +812,33 @@ interface components {
|
|
|
784
812
|
*/
|
|
785
813
|
cedula: string;
|
|
786
814
|
};
|
|
815
|
+
SplitShareDto: {
|
|
816
|
+
/**
|
|
817
|
+
* @description A merchant of your account (UUID or `mrc_…` id). Each merchant at most once per payment.
|
|
818
|
+
* @example mrc_3f2b9c1e0a7d4e6f8b1c2d3e4f5a6b7c
|
|
819
|
+
*/
|
|
820
|
+
merchantId: string;
|
|
821
|
+
/**
|
|
822
|
+
* @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).
|
|
823
|
+
* @example 6000.00
|
|
824
|
+
*/
|
|
825
|
+
amount: string | number;
|
|
826
|
+
/**
|
|
827
|
+
* @description Your commission on this share, in VES (exactly two decimals). Not with applicationFeePercent.
|
|
828
|
+
* @example 1200.00
|
|
829
|
+
*/
|
|
830
|
+
applicationFeeVes?: string;
|
|
831
|
+
/**
|
|
832
|
+
* @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.
|
|
833
|
+
* @example 20
|
|
834
|
+
*/
|
|
835
|
+
applicationFeePercent?: number;
|
|
836
|
+
/**
|
|
837
|
+
* @description Free text returned as sent.
|
|
838
|
+
* @example order-1042/provider-a
|
|
839
|
+
*/
|
|
840
|
+
reference?: string;
|
|
841
|
+
};
|
|
787
842
|
ImmediateDebitDto: {
|
|
788
843
|
/**
|
|
789
844
|
* @description 3–4 digit bank code (padded to 4 digits when sent to the network). Prefer codes from GET /v1/banks.
|
|
@@ -837,6 +892,8 @@ interface components {
|
|
|
837
892
|
* @example 10
|
|
838
893
|
*/
|
|
839
894
|
applicationFeePercent?: number;
|
|
895
|
+
/** @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. */
|
|
896
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
840
897
|
};
|
|
841
898
|
ManualOperationPollDto: {
|
|
842
899
|
/**
|
|
@@ -1297,7 +1354,7 @@ interface components {
|
|
|
1297
1354
|
merchantId?: string;
|
|
1298
1355
|
idempotencyKey: string;
|
|
1299
1356
|
txHash?: string;
|
|
1300
|
-
/** @description Settled inside
|
|
1357
|
+
/** @description Settled inside VEX Pay (destination is one of your own deposit addresses). */
|
|
1301
1358
|
internal: boolean;
|
|
1302
1359
|
failureReason?: string;
|
|
1303
1360
|
/** Format: date-time */
|
|
@@ -1307,13 +1364,13 @@ interface components {
|
|
|
1307
1364
|
};
|
|
1308
1365
|
CopChannelDto: {
|
|
1309
1366
|
/**
|
|
1310
|
-
* @example
|
|
1367
|
+
* @example nequi
|
|
1311
1368
|
* @enum {string}
|
|
1312
1369
|
*/
|
|
1313
|
-
channel: "breb" | "nequi" | "daviplata"
|
|
1370
|
+
channel: "breb" | "nequi" | "daviplata";
|
|
1314
1371
|
/**
|
|
1315
1372
|
* @description Buyer-facing name (Spanish).
|
|
1316
|
-
* @example
|
|
1373
|
+
* @example Nequi
|
|
1317
1374
|
*/
|
|
1318
1375
|
label: string;
|
|
1319
1376
|
/**
|
|
@@ -1321,37 +1378,11 @@ interface components {
|
|
|
1321
1378
|
* @example true
|
|
1322
1379
|
*/
|
|
1323
1380
|
needsBuyer: boolean;
|
|
1324
|
-
/**
|
|
1325
|
-
* @description Show the buyer the `terms` links and send `buyer.termsAccepted: true`.
|
|
1326
|
-
* @example true
|
|
1327
|
-
*/
|
|
1328
|
-
needsTermsAcceptance: boolean;
|
|
1329
|
-
/**
|
|
1330
|
-
* @description Only through the hosted checkout (checkout sessions or payment links), never `POST /v1/cop/payments`.
|
|
1331
|
-
* @example false
|
|
1332
|
-
*/
|
|
1333
|
-
checkoutOnly: boolean;
|
|
1334
1381
|
/** @example 20000 */
|
|
1335
1382
|
minAmountCop: number;
|
|
1336
1383
|
};
|
|
1337
|
-
CopPseBankDto: {
|
|
1338
|
-
/** @example 1007 */
|
|
1339
|
-
code: string;
|
|
1340
|
-
/** @example Bancolombia */
|
|
1341
|
-
name: string;
|
|
1342
|
-
};
|
|
1343
|
-
CopTermsDto: {
|
|
1344
|
-
/** @description Terms and conditions the buyer accepts. */
|
|
1345
|
-
termsUrl: string;
|
|
1346
|
-
/** @description Personal data processing authorization the buyer accepts. */
|
|
1347
|
-
personalDataUrl: string;
|
|
1348
|
-
};
|
|
1349
1384
|
CopChannelsDto: {
|
|
1350
1385
|
channels: components["schemas"]["CopChannelDto"][];
|
|
1351
|
-
/** @description Present when `pse` is listed: banks for `pse.bankCode`. */
|
|
1352
|
-
pseBanks?: components["schemas"]["CopPseBankDto"][];
|
|
1353
|
-
/** @description Present when a listed channel needs terms acceptance. */
|
|
1354
|
-
terms?: components["schemas"]["CopTermsDto"];
|
|
1355
1386
|
};
|
|
1356
1387
|
CopBuyerDto: {
|
|
1357
1388
|
/** @example Juan */
|
|
@@ -1379,37 +1410,19 @@ interface components {
|
|
|
1379
1410
|
* @example 1234567890
|
|
1380
1411
|
*/
|
|
1381
1412
|
documentNumber?: string;
|
|
1382
|
-
/**
|
|
1383
|
-
* @description PSE only (required): `natural` person or `juridica` (company).
|
|
1384
|
-
* @example natural
|
|
1385
|
-
* @enum {string}
|
|
1386
|
-
*/
|
|
1387
|
-
personType?: "natural" | "juridica";
|
|
1388
|
-
/**
|
|
1389
|
-
* @description Required (`true`) for channels the channel catalog marks `needsTermsAcceptance`: confirms you showed the buyer the catalog `terms` links.
|
|
1390
|
-
* @example true
|
|
1391
|
-
*/
|
|
1392
|
-
termsAccepted?: boolean;
|
|
1393
|
-
};
|
|
1394
|
-
CopPseDto: {
|
|
1395
|
-
/**
|
|
1396
|
-
* @description Bank code from `GET /v1/cop/channels` → `pseBanks`.
|
|
1397
|
-
* @example 1007
|
|
1398
|
-
*/
|
|
1399
|
-
bankCode: string;
|
|
1400
1413
|
};
|
|
1401
1414
|
CreateCopPaymentDto: {
|
|
1402
1415
|
/**
|
|
1403
|
-
* @description Amount in whole Colombian pesos. At least
|
|
1416
|
+
* @description Amount in whole Colombian pesos. At least 20,000 (`amount_below_minimum` otherwise).
|
|
1404
1417
|
* @example 100000
|
|
1405
1418
|
*/
|
|
1406
1419
|
amountCop: number;
|
|
1407
1420
|
/**
|
|
1408
|
-
* @description `breb`: QR code / transfer key the buyer pays from any Colombian bank app. `nequi`: push to the buyer's Nequi app. `daviplata`: SMS code the buyer reads to you
|
|
1421
|
+
* @description `breb`: QR code / transfer key the buyer pays from any Colombian bank app. `nequi`: push to the buyer's Nequi app. `daviplata`: SMS code the buyer reads to you.
|
|
1409
1422
|
* @example breb
|
|
1410
1423
|
* @enum {string}
|
|
1411
1424
|
*/
|
|
1412
|
-
channel: "breb" | "nequi" | "daviplata"
|
|
1425
|
+
channel: "breb" | "nequi" | "daviplata";
|
|
1413
1426
|
/**
|
|
1414
1427
|
* @description Shown to the buyer.
|
|
1415
1428
|
* @example Order 1042
|
|
@@ -1431,24 +1444,15 @@ interface components {
|
|
|
1431
1444
|
};
|
|
1432
1445
|
/** @description Required for every channel except `breb`. */
|
|
1433
1446
|
buyer?: components["schemas"]["CopBuyerDto"];
|
|
1434
|
-
/** @description Required for `pse`. */
|
|
1435
|
-
pse?: components["schemas"]["CopPseDto"];
|
|
1436
1447
|
};
|
|
1437
1448
|
CopNextActionDto: {
|
|
1438
1449
|
/**
|
|
1439
|
-
* @description `
|
|
1450
|
+
* @description `show_qr`: Bre-B QR / transfer key. `approve_in_app`: the buyer approves the Nequi push. `submit_otp`: send the Daviplata SMS code.
|
|
1440
1451
|
* @enum {string}
|
|
1441
1452
|
*/
|
|
1442
|
-
type: "show_qr" | "approve_in_app" | "submit_otp"
|
|
1453
|
+
type: "show_qr" | "approve_in_app" | "submit_otp";
|
|
1443
1454
|
/** @description Bre-B: base64 PNG of the payment QR. Returned only when the payment is created. */
|
|
1444
1455
|
qrPngBase64?: string;
|
|
1445
|
-
/** @description Bancolombia QR: base64 SVG of the payment QR. */
|
|
1446
|
-
qrSvgBase64?: string;
|
|
1447
|
-
/**
|
|
1448
|
-
* @description `redirect`: where the buyer authorizes the payment.
|
|
1449
|
-
* @example https://…
|
|
1450
|
-
*/
|
|
1451
|
-
url?: string;
|
|
1452
1456
|
/** @description Bre-B: transfer key the buyer can enter instead of scanning. */
|
|
1453
1457
|
transferKey?: string;
|
|
1454
1458
|
/**
|
|
@@ -1465,7 +1469,7 @@ interface components {
|
|
|
1465
1469
|
/** @enum {string} */
|
|
1466
1470
|
method: "COP";
|
|
1467
1471
|
/** @enum {string} */
|
|
1468
|
-
channel: "breb" | "nequi" | "daviplata"
|
|
1472
|
+
channel: "breb" | "nequi" | "daviplata";
|
|
1469
1473
|
/** @example 100000 */
|
|
1470
1474
|
amountCop: number;
|
|
1471
1475
|
/**
|
|
@@ -1488,27 +1492,16 @@ interface components {
|
|
|
1488
1492
|
metadata: {
|
|
1489
1493
|
[key: string]: string;
|
|
1490
1494
|
};
|
|
1491
|
-
/**
|
|
1492
|
-
|
|
1493
|
-
* @enum {string}
|
|
1494
|
-
*/
|
|
1495
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown" | "chargeback";
|
|
1495
|
+
/** @enum {string} */
|
|
1496
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
1496
1497
|
/** Format: date-time */
|
|
1497
1498
|
expiresAt?: string;
|
|
1498
1499
|
/** Format: date-time */
|
|
1499
1500
|
createdAt: string;
|
|
1500
1501
|
/** Format: date-time */
|
|
1501
1502
|
completedAt?: string;
|
|
1502
|
-
/** @description What the buyer must do next. Returned when the payment is created
|
|
1503
|
+
/** @description What the buyer must do next. Returned when the payment is created. */
|
|
1503
1504
|
next?: components["schemas"]["CopNextActionDto"];
|
|
1504
|
-
/**
|
|
1505
|
-
* @description Card payments: brand and last 4 digits, once known.
|
|
1506
|
-
* @example {
|
|
1507
|
-
* "brand": "VISA",
|
|
1508
|
-
* "last4": "4242"
|
|
1509
|
-
* }
|
|
1510
|
-
*/
|
|
1511
|
-
card?: Record<string, never>;
|
|
1512
1505
|
};
|
|
1513
1506
|
SubmitCopOtpDto: {
|
|
1514
1507
|
/**
|
|
@@ -1853,6 +1846,8 @@ interface components {
|
|
|
1853
1846
|
applicationFeePercent?: number;
|
|
1854
1847
|
/** @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. */
|
|
1855
1848
|
onwardPayout?: components["schemas"]["OnwardPayoutDto"];
|
|
1849
|
+
/** @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. */
|
|
1850
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
1856
1851
|
};
|
|
1857
1852
|
OnwardPayoutStatusDto: {
|
|
1858
1853
|
/**
|
|
@@ -1901,6 +1896,41 @@ interface components {
|
|
|
1901
1896
|
/** Format: date-time */
|
|
1902
1897
|
updatedAt: string;
|
|
1903
1898
|
};
|
|
1899
|
+
PaymentSplitViewDto: {
|
|
1900
|
+
/** Format: uuid */
|
|
1901
|
+
merchantId: string;
|
|
1902
|
+
/**
|
|
1903
|
+
* @description The merchant's account id (same as the payment-level accountId).
|
|
1904
|
+
* @example acct_3f2b9c1e0a7d4e6f8b1c2d3e4f5a6b7c
|
|
1905
|
+
*/
|
|
1906
|
+
accountId: string;
|
|
1907
|
+
/**
|
|
1908
|
+
* @description The merchant's externalRef.
|
|
1909
|
+
* @example planazo-comercio-17
|
|
1910
|
+
*/
|
|
1911
|
+
merchantExternalRef?: string | null;
|
|
1912
|
+
/** @example 6000.00 */
|
|
1913
|
+
amountVes: string;
|
|
1914
|
+
/**
|
|
1915
|
+
* @description Your commission on this share.
|
|
1916
|
+
* @example 1200.00
|
|
1917
|
+
*/
|
|
1918
|
+
applicationFeeVes: string;
|
|
1919
|
+
/** @example 20.0000 */
|
|
1920
|
+
applicationFeePercent?: string | null;
|
|
1921
|
+
/**
|
|
1922
|
+
* @description This share's part of the VEX Pay fee (null until completed).
|
|
1923
|
+
* @example 180.00
|
|
1924
|
+
*/
|
|
1925
|
+
feeVes?: string | null;
|
|
1926
|
+
/**
|
|
1927
|
+
* @description Credited to the merchant (null until completed; 0.00 when the share nets nothing).
|
|
1928
|
+
* @example 4620.00
|
|
1929
|
+
*/
|
|
1930
|
+
netVes?: string | null;
|
|
1931
|
+
/** @example order-1042/provider-a */
|
|
1932
|
+
reference?: string | null;
|
|
1933
|
+
};
|
|
1904
1934
|
C2pIntentResponseDto: {
|
|
1905
1935
|
/**
|
|
1906
1936
|
* Format: uuid
|
|
@@ -1990,6 +2020,8 @@ interface components {
|
|
|
1990
2020
|
reversalTxId?: number;
|
|
1991
2021
|
/** @description Present when the pay-in was sent with `onwardPayout`. */
|
|
1992
2022
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
2023
|
+
/** @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. */
|
|
2024
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
1993
2025
|
/**
|
|
1994
2026
|
* Format: uuid
|
|
1995
2027
|
* @description Use this value as intentId when executing the C2P charge.
|
|
@@ -2050,6 +2082,8 @@ interface components {
|
|
|
2050
2082
|
applicationFeePercent?: number;
|
|
2051
2083
|
/** @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. */
|
|
2052
2084
|
onwardPayout?: components["schemas"]["OnwardPayoutDto"];
|
|
2085
|
+
/** @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. */
|
|
2086
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
2053
2087
|
};
|
|
2054
2088
|
PaymentReceiptDto: {
|
|
2055
2089
|
/**
|
|
@@ -2140,6 +2174,8 @@ interface components {
|
|
|
2140
2174
|
reversalTxId?: number;
|
|
2141
2175
|
/** @description Present when the pay-in was sent with `onwardPayout`. */
|
|
2142
2176
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
2177
|
+
/** @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. */
|
|
2178
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
2143
2179
|
};
|
|
2144
2180
|
VposPaymentDto: {
|
|
2145
2181
|
/**
|
|
@@ -2206,6 +2242,8 @@ interface components {
|
|
|
2206
2242
|
* @example 10
|
|
2207
2243
|
*/
|
|
2208
2244
|
applicationFeePercent?: number;
|
|
2245
|
+
/** @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. */
|
|
2246
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
2209
2247
|
};
|
|
2210
2248
|
PaymentMethodAvailabilityDto: {
|
|
2211
2249
|
/**
|
|
@@ -2293,6 +2331,8 @@ interface components {
|
|
|
2293
2331
|
debtorCellPhone?: string;
|
|
2294
2332
|
/** @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. */
|
|
2295
2333
|
onwardPayout?: components["schemas"]["OnwardPayoutDto"];
|
|
2334
|
+
/** @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. */
|
|
2335
|
+
splits?: components["schemas"]["SplitShareDto"][];
|
|
2296
2336
|
};
|
|
2297
2337
|
PayoutMethodResponseDto: {
|
|
2298
2338
|
/** Format: uuid */
|
|
@@ -2415,6 +2455,14 @@ interface components {
|
|
|
2415
2455
|
expiresAt: string;
|
|
2416
2456
|
/** Format: uuid */
|
|
2417
2457
|
payoutMethodId?: string;
|
|
2458
|
+
/**
|
|
2459
|
+
* @description Test mode only: the two sandbox micro-deposit amounts to confirm (no money is sent in Test). Never present in live mode.
|
|
2460
|
+
* @example [
|
|
2461
|
+
* "0.13",
|
|
2462
|
+
* "0.27"
|
|
2463
|
+
* ]
|
|
2464
|
+
*/
|
|
2465
|
+
testAmounts?: string[];
|
|
2418
2466
|
};
|
|
2419
2467
|
VerifyConfirmResponseDto: {
|
|
2420
2468
|
/** @example verified */
|
|
@@ -2491,6 +2539,8 @@ interface components {
|
|
|
2491
2539
|
* @example 04145555555
|
|
2492
2540
|
*/
|
|
2493
2541
|
phone?: string;
|
|
2542
|
+
/** @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}. */
|
|
2543
|
+
autoPayoutEnabled?: boolean;
|
|
2494
2544
|
};
|
|
2495
2545
|
CreatePayoutMethodDto: {
|
|
2496
2546
|
/**
|
|
@@ -2614,6 +2664,11 @@ interface components {
|
|
|
2614
2664
|
transferKey?: string;
|
|
2615
2665
|
/** Format: uuid */
|
|
2616
2666
|
paymentId?: string | null;
|
|
2667
|
+
/**
|
|
2668
|
+
* @description `credit` rows of a multi-merchant split payment: the share `reference` sent with the payment.
|
|
2669
|
+
* @example order-1042/provider-a
|
|
2670
|
+
*/
|
|
2671
|
+
splitReference?: string;
|
|
2617
2672
|
/** Format: uuid */
|
|
2618
2673
|
payoutId?: string | null;
|
|
2619
2674
|
/**
|
|
@@ -2679,12 +2734,46 @@ interface components {
|
|
|
2679
2734
|
*/
|
|
2680
2735
|
applicationFeePercent?: number | null;
|
|
2681
2736
|
};
|
|
2737
|
+
MarketplaceSettingsDto: {
|
|
2738
|
+
/**
|
|
2739
|
+
* @description When true, merchants you create without `autoPayoutEnabled` start with auto-payout on. Existing merchants keep their setting.
|
|
2740
|
+
* @example true
|
|
2741
|
+
*/
|
|
2742
|
+
merchantAutoPayoutDefault: boolean;
|
|
2743
|
+
/**
|
|
2744
|
+
* @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).
|
|
2745
|
+
* @example 10.00
|
|
2746
|
+
*/
|
|
2747
|
+
merchantAutoPayoutMinUsd?: string | null;
|
|
2748
|
+
};
|
|
2749
|
+
UpdateMarketplaceSettingsDto: {
|
|
2750
|
+
/** @example true */
|
|
2751
|
+
merchantAutoPayoutDefault?: boolean;
|
|
2752
|
+
/**
|
|
2753
|
+
* @description USD with at most two decimals (string or number), 0–100000. null or 0 clears the minimum.
|
|
2754
|
+
* @example 10.00
|
|
2755
|
+
*/
|
|
2756
|
+
merchantAutoPayoutMinUsd?: string | null;
|
|
2757
|
+
};
|
|
2758
|
+
NotificationTestResponseDto: {
|
|
2759
|
+
/** @example true */
|
|
2760
|
+
sent: boolean;
|
|
2761
|
+
/** @example notification.test */
|
|
2762
|
+
event: string;
|
|
2763
|
+
/** Format: uuid */
|
|
2764
|
+
tenantId: string;
|
|
2765
|
+
};
|
|
2682
2766
|
CreateCheckoutSessionDto: {
|
|
2683
2767
|
/**
|
|
2684
|
-
* @description USD amount, up to 2 decimals.
|
|
2768
|
+
* @description USD amount, up to 2 decimals. Send exactly one of `amountUsd` or `amountVes`.
|
|
2685
2769
|
* @example 25
|
|
2686
2770
|
*/
|
|
2687
|
-
amountUsd
|
|
2771
|
+
amountUsd?: number;
|
|
2772
|
+
/**
|
|
2773
|
+
* @description Exact bolívar amount, up to 2 decimals: Pago Móvil, Débito Inmediato and card charge exactly this, whatever the rate. `amountUsd` is then derived at your Bolívar rate. Send exactly one of `amountUsd` or `amountVes`; `cop` is not offered.
|
|
2774
|
+
* @example 2000
|
|
2775
|
+
*/
|
|
2776
|
+
amountVes?: number;
|
|
2688
2777
|
/**
|
|
2689
2778
|
* @description Buyer-facing label on the checkout.
|
|
2690
2779
|
* @example Pedido #1042
|
|
@@ -2756,8 +2845,16 @@ interface components {
|
|
|
2756
2845
|
clientSecret?: string;
|
|
2757
2846
|
/** @example https://pay.vexpay.app/pay/cs-9f2a4b7c1d3e */
|
|
2758
2847
|
url: string;
|
|
2759
|
-
/**
|
|
2848
|
+
/**
|
|
2849
|
+
* @description USD amount; for a bolívar-priced session, `amountVes` at your Bolívar rate when it was created.
|
|
2850
|
+
* @example 25.00
|
|
2851
|
+
*/
|
|
2760
2852
|
amountUsd: string;
|
|
2853
|
+
/**
|
|
2854
|
+
* @description Exact bolívar amount charged, for a session created with `amountVes`; null otherwise.
|
|
2855
|
+
* @example 2000.00
|
|
2856
|
+
*/
|
|
2857
|
+
amountVes?: string | null;
|
|
2761
2858
|
description?: string | null;
|
|
2762
2859
|
reference?: string | null;
|
|
2763
2860
|
metadata: {
|
|
@@ -2827,7 +2924,7 @@ interface components {
|
|
|
2827
2924
|
items: components["schemas"]["PaymentLinkResponseDto"][];
|
|
2828
2925
|
};
|
|
2829
2926
|
CreateProductDto: {
|
|
2830
|
-
/** @example Camiseta
|
|
2927
|
+
/** @example Camiseta VEX Pay */
|
|
2831
2928
|
name: string;
|
|
2832
2929
|
description?: string;
|
|
2833
2930
|
/** @example https://cdn.example/shirt.png */
|
|
@@ -2968,14 +3065,6 @@ interface components {
|
|
|
2968
3065
|
/** @example 2500.00 */
|
|
2969
3066
|
monthRemainingUsd: string;
|
|
2970
3067
|
};
|
|
2971
|
-
NotificationTestResponseDto: {
|
|
2972
|
-
/** @example true */
|
|
2973
|
-
sent: boolean;
|
|
2974
|
-
/** @example notification.test */
|
|
2975
|
-
event: string;
|
|
2976
|
-
/** Format: uuid */
|
|
2977
|
-
tenantId: string;
|
|
2978
|
-
};
|
|
2979
3068
|
CreateCustomerDto: {
|
|
2980
3069
|
/** @example Ana Pérez */
|
|
2981
3070
|
name?: string | null;
|
|
@@ -3248,7 +3337,7 @@ interface components {
|
|
|
3248
3337
|
};
|
|
3249
3338
|
PayInvoiceDto: {
|
|
3250
3339
|
/**
|
|
3251
|
-
* @description Mark the invoice paid outside
|
|
3340
|
+
* @description Mark the invoice paid outside VEX Pay (cash, transfer). No balance change.
|
|
3252
3341
|
* @example true
|
|
3253
3342
|
*/
|
|
3254
3343
|
paidOutOfBand: boolean;
|
|
@@ -3350,7 +3439,7 @@ interface components {
|
|
|
3350
3439
|
pathItems: never;
|
|
3351
3440
|
}
|
|
3352
3441
|
interface operations {
|
|
3353
|
-
|
|
3442
|
+
Webhooks_listWebhooks: {
|
|
3354
3443
|
parameters: {
|
|
3355
3444
|
query?: never;
|
|
3356
3445
|
header?: never;
|
|
@@ -3364,7 +3453,7 @@ interface operations {
|
|
|
3364
3453
|
[name: string]: unknown;
|
|
3365
3454
|
};
|
|
3366
3455
|
content: {
|
|
3367
|
-
"application/json": components["schemas"]["
|
|
3456
|
+
"application/json": components["schemas"]["WebhookEndpointDto"][];
|
|
3368
3457
|
};
|
|
3369
3458
|
};
|
|
3370
3459
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -3405,45 +3494,28 @@ interface operations {
|
|
|
3405
3494
|
};
|
|
3406
3495
|
};
|
|
3407
3496
|
};
|
|
3408
|
-
|
|
3497
|
+
Webhooks_createWebhook: {
|
|
3409
3498
|
parameters: {
|
|
3410
|
-
query?:
|
|
3411
|
-
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
from?: string;
|
|
3415
|
-
/** @description Only movements of this payout. */
|
|
3416
|
-
payoutId?: string;
|
|
3417
|
-
/** @description Only movements of this payment. */
|
|
3418
|
-
paymentId?: string;
|
|
3419
|
-
/** @description One or more types (repeat or comma-separate). */
|
|
3420
|
-
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")[];
|
|
3421
|
-
/** @description `nextCursor` from the previous page. */
|
|
3422
|
-
cursor?: string;
|
|
3423
|
-
/** @description 1–100, default 50. */
|
|
3424
|
-
limit?: number;
|
|
3499
|
+
query?: never;
|
|
3500
|
+
header?: {
|
|
3501
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
3502
|
+
"Idempotency-Key"?: string;
|
|
3425
3503
|
};
|
|
3426
|
-
header?: never;
|
|
3427
3504
|
path?: never;
|
|
3428
3505
|
cookie?: never;
|
|
3429
3506
|
};
|
|
3430
|
-
requestBody
|
|
3431
|
-
|
|
3432
|
-
|
|
3433
|
-
headers: {
|
|
3434
|
-
[name: string]: unknown;
|
|
3435
|
-
};
|
|
3436
|
-
content: {
|
|
3437
|
-
"application/json": components["schemas"]["BalanceTransactionListDto"];
|
|
3438
|
-
};
|
|
3507
|
+
requestBody: {
|
|
3508
|
+
content: {
|
|
3509
|
+
"application/json": components["schemas"]["CreateWebhookDto"];
|
|
3439
3510
|
};
|
|
3440
|
-
|
|
3441
|
-
|
|
3511
|
+
};
|
|
3512
|
+
responses: {
|
|
3513
|
+
201: {
|
|
3442
3514
|
headers: {
|
|
3443
3515
|
[name: string]: unknown;
|
|
3444
3516
|
};
|
|
3445
3517
|
content: {
|
|
3446
|
-
"application/json": components["schemas"]["
|
|
3518
|
+
"application/json": components["schemas"]["WebhookEndpointDto"];
|
|
3447
3519
|
};
|
|
3448
3520
|
};
|
|
3449
3521
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -3484,11 +3556,13 @@ interface operations {
|
|
|
3484
3556
|
};
|
|
3485
3557
|
};
|
|
3486
3558
|
};
|
|
3487
|
-
|
|
3559
|
+
Webhooks_deleteWebhook: {
|
|
3488
3560
|
parameters: {
|
|
3489
3561
|
query?: never;
|
|
3490
3562
|
header?: never;
|
|
3491
|
-
path
|
|
3563
|
+
path: {
|
|
3564
|
+
id: string;
|
|
3565
|
+
};
|
|
3492
3566
|
cookie?: never;
|
|
3493
3567
|
};
|
|
3494
3568
|
requestBody?: never;
|
|
@@ -3498,7 +3572,7 @@ interface operations {
|
|
|
3498
3572
|
[name: string]: unknown;
|
|
3499
3573
|
};
|
|
3500
3574
|
content: {
|
|
3501
|
-
"application/json": components["schemas"]["
|
|
3575
|
+
"application/json": components["schemas"]["DeleteWebhookResponseDto"];
|
|
3502
3576
|
};
|
|
3503
3577
|
};
|
|
3504
3578
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -3519,6 +3593,14 @@ interface operations {
|
|
|
3519
3593
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3520
3594
|
};
|
|
3521
3595
|
};
|
|
3596
|
+
404: {
|
|
3597
|
+
headers: {
|
|
3598
|
+
[name: string]: unknown;
|
|
3599
|
+
};
|
|
3600
|
+
content: {
|
|
3601
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3602
|
+
};
|
|
3603
|
+
};
|
|
3522
3604
|
/** @description Client error. */
|
|
3523
3605
|
"4XX": {
|
|
3524
3606
|
headers: {
|
|
@@ -3539,23 +3621,22 @@ interface operations {
|
|
|
3539
3621
|
};
|
|
3540
3622
|
};
|
|
3541
3623
|
};
|
|
3542
|
-
|
|
3624
|
+
Webhooks_updateWebhook: {
|
|
3543
3625
|
parameters: {
|
|
3544
3626
|
query?: never;
|
|
3545
|
-
header?:
|
|
3546
|
-
|
|
3547
|
-
|
|
3627
|
+
header?: never;
|
|
3628
|
+
path: {
|
|
3629
|
+
id: string;
|
|
3548
3630
|
};
|
|
3549
|
-
path?: never;
|
|
3550
3631
|
cookie?: never;
|
|
3551
3632
|
};
|
|
3552
3633
|
requestBody: {
|
|
3553
3634
|
content: {
|
|
3554
|
-
"application/json": components["schemas"]["
|
|
3635
|
+
"application/json": components["schemas"]["UpdateWebhookDto"];
|
|
3555
3636
|
};
|
|
3556
3637
|
};
|
|
3557
3638
|
responses: {
|
|
3558
|
-
|
|
3639
|
+
200: {
|
|
3559
3640
|
headers: {
|
|
3560
3641
|
[name: string]: unknown;
|
|
3561
3642
|
};
|
|
@@ -3563,6 +3644,14 @@ interface operations {
|
|
|
3563
3644
|
"application/json": components["schemas"]["WebhookEndpointDto"];
|
|
3564
3645
|
};
|
|
3565
3646
|
};
|
|
3647
|
+
400: {
|
|
3648
|
+
headers: {
|
|
3649
|
+
[name: string]: unknown;
|
|
3650
|
+
};
|
|
3651
|
+
content: {
|
|
3652
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3653
|
+
};
|
|
3654
|
+
};
|
|
3566
3655
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
3567
3656
|
401: {
|
|
3568
3657
|
headers: {
|
|
@@ -3581,6 +3670,14 @@ interface operations {
|
|
|
3581
3670
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3582
3671
|
};
|
|
3583
3672
|
};
|
|
3673
|
+
404: {
|
|
3674
|
+
headers: {
|
|
3675
|
+
[name: string]: unknown;
|
|
3676
|
+
};
|
|
3677
|
+
content: {
|
|
3678
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3679
|
+
};
|
|
3680
|
+
};
|
|
3584
3681
|
/** @description Client error. */
|
|
3585
3682
|
"4XX": {
|
|
3586
3683
|
headers: {
|
|
@@ -3601,13 +3698,11 @@ interface operations {
|
|
|
3601
3698
|
};
|
|
3602
3699
|
};
|
|
3603
3700
|
};
|
|
3604
|
-
|
|
3701
|
+
Balance_getBalance: {
|
|
3605
3702
|
parameters: {
|
|
3606
3703
|
query?: never;
|
|
3607
3704
|
header?: never;
|
|
3608
|
-
path
|
|
3609
|
-
id: string;
|
|
3610
|
-
};
|
|
3705
|
+
path?: never;
|
|
3611
3706
|
cookie?: never;
|
|
3612
3707
|
};
|
|
3613
3708
|
requestBody?: never;
|
|
@@ -3617,7 +3712,7 @@ interface operations {
|
|
|
3617
3712
|
[name: string]: unknown;
|
|
3618
3713
|
};
|
|
3619
3714
|
content: {
|
|
3620
|
-
"application/json": components["schemas"]["
|
|
3715
|
+
"application/json": components["schemas"]["PlatformBalanceDto"];
|
|
3621
3716
|
};
|
|
3622
3717
|
};
|
|
3623
3718
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -3638,14 +3733,6 @@ interface operations {
|
|
|
3638
3733
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3639
3734
|
};
|
|
3640
3735
|
};
|
|
3641
|
-
404: {
|
|
3642
|
-
headers: {
|
|
3643
|
-
[name: string]: unknown;
|
|
3644
|
-
};
|
|
3645
|
-
content: {
|
|
3646
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3647
|
-
};
|
|
3648
|
-
};
|
|
3649
3736
|
/** @description Client error. */
|
|
3650
3737
|
"4XX": {
|
|
3651
3738
|
headers: {
|
|
@@ -3666,29 +3753,39 @@ interface operations {
|
|
|
3666
3753
|
};
|
|
3667
3754
|
};
|
|
3668
3755
|
};
|
|
3669
|
-
|
|
3756
|
+
Balance_listTransactions: {
|
|
3670
3757
|
parameters: {
|
|
3671
|
-
query?:
|
|
3672
|
-
|
|
3673
|
-
|
|
3674
|
-
|
|
3675
|
-
|
|
3676
|
-
|
|
3677
|
-
|
|
3678
|
-
|
|
3679
|
-
|
|
3680
|
-
|
|
3758
|
+
query?: {
|
|
3759
|
+
/** @description ISO 8601, exclusive (createdAt). */
|
|
3760
|
+
to?: string;
|
|
3761
|
+
/** @description ISO 8601, inclusive (createdAt). */
|
|
3762
|
+
from?: string;
|
|
3763
|
+
/** @description Only movements of this payout. */
|
|
3764
|
+
payoutId?: string;
|
|
3765
|
+
/** @description Only movements of this payment. */
|
|
3766
|
+
paymentId?: string;
|
|
3767
|
+
/** @description One or more types (repeat or comma-separate). */
|
|
3768
|
+
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")[];
|
|
3769
|
+
/** @description `nextCursor` from the previous page. */
|
|
3770
|
+
cursor?: string;
|
|
3771
|
+
/** @description 1–100, default 50. */
|
|
3772
|
+
limit?: number;
|
|
3681
3773
|
};
|
|
3774
|
+
header?: never;
|
|
3775
|
+
path?: never;
|
|
3776
|
+
cookie?: never;
|
|
3682
3777
|
};
|
|
3778
|
+
requestBody?: never;
|
|
3683
3779
|
responses: {
|
|
3684
3780
|
200: {
|
|
3685
3781
|
headers: {
|
|
3686
3782
|
[name: string]: unknown;
|
|
3687
3783
|
};
|
|
3688
3784
|
content: {
|
|
3689
|
-
"application/json": components["schemas"]["
|
|
3785
|
+
"application/json": components["schemas"]["BalanceTransactionListDto"];
|
|
3690
3786
|
};
|
|
3691
3787
|
};
|
|
3788
|
+
/** @description `invalid_data` — a parameter is invalid. */
|
|
3692
3789
|
400: {
|
|
3693
3790
|
headers: {
|
|
3694
3791
|
[name: string]: unknown;
|
|
@@ -3715,14 +3812,6 @@ interface operations {
|
|
|
3715
3812
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3716
3813
|
};
|
|
3717
3814
|
};
|
|
3718
|
-
404: {
|
|
3719
|
-
headers: {
|
|
3720
|
-
[name: string]: unknown;
|
|
3721
|
-
};
|
|
3722
|
-
content: {
|
|
3723
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3724
|
-
};
|
|
3725
|
-
};
|
|
3726
3815
|
/** @description Client error. */
|
|
3727
3816
|
"4XX": {
|
|
3728
3817
|
headers: {
|
|
@@ -4744,7 +4833,7 @@ interface operations {
|
|
|
4744
4833
|
};
|
|
4745
4834
|
};
|
|
4746
4835
|
responses: {
|
|
4747
|
-
/** @description Network payload plus
|
|
4836
|
+
/** @description Network payload plus VEX Pay `paymentId` (and `externalRef` when sent). */
|
|
4748
4837
|
200: {
|
|
4749
4838
|
headers: {
|
|
4750
4839
|
[name: string]: unknown;
|
|
@@ -6051,7 +6140,7 @@ interface operations {
|
|
|
6051
6140
|
"application/json": components["schemas"]["CopPaymentDto"];
|
|
6052
6141
|
};
|
|
6053
6142
|
};
|
|
6054
|
-
/** @description `invalid_data` (names the field), `amount_below_minimum
|
|
6143
|
+
/** @description `invalid_data` (names the field), `amount_below_minimum` or `amount_out_of_range`. */
|
|
6055
6144
|
400: {
|
|
6056
6145
|
headers: {
|
|
6057
6146
|
[name: string]: unknown;
|
|
@@ -8489,7 +8578,250 @@ interface operations {
|
|
|
8489
8578
|
};
|
|
8490
8579
|
Merchants_getBalance: {
|
|
8491
8580
|
parameters: {
|
|
8492
|
-
query?: never;
|
|
8581
|
+
query?: never;
|
|
8582
|
+
header?: never;
|
|
8583
|
+
path: {
|
|
8584
|
+
id: string;
|
|
8585
|
+
};
|
|
8586
|
+
cookie?: never;
|
|
8587
|
+
};
|
|
8588
|
+
requestBody?: never;
|
|
8589
|
+
responses: {
|
|
8590
|
+
200: {
|
|
8591
|
+
headers: {
|
|
8592
|
+
[name: string]: unknown;
|
|
8593
|
+
};
|
|
8594
|
+
content: {
|
|
8595
|
+
"application/json": components["schemas"]["MerchantBalanceDto"];
|
|
8596
|
+
};
|
|
8597
|
+
};
|
|
8598
|
+
/** @description Validation failure. */
|
|
8599
|
+
400: {
|
|
8600
|
+
headers: {
|
|
8601
|
+
[name: string]: unknown;
|
|
8602
|
+
};
|
|
8603
|
+
content: {
|
|
8604
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8605
|
+
};
|
|
8606
|
+
};
|
|
8607
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
8608
|
+
401: {
|
|
8609
|
+
headers: {
|
|
8610
|
+
[name: string]: unknown;
|
|
8611
|
+
};
|
|
8612
|
+
content: {
|
|
8613
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8614
|
+
};
|
|
8615
|
+
};
|
|
8616
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
8617
|
+
403: {
|
|
8618
|
+
headers: {
|
|
8619
|
+
[name: string]: unknown;
|
|
8620
|
+
};
|
|
8621
|
+
content: {
|
|
8622
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8623
|
+
};
|
|
8624
|
+
};
|
|
8625
|
+
404: {
|
|
8626
|
+
headers: {
|
|
8627
|
+
[name: string]: unknown;
|
|
8628
|
+
};
|
|
8629
|
+
content: {
|
|
8630
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8631
|
+
};
|
|
8632
|
+
};
|
|
8633
|
+
/** @description Client error. */
|
|
8634
|
+
"4XX": {
|
|
8635
|
+
headers: {
|
|
8636
|
+
[name: string]: unknown;
|
|
8637
|
+
};
|
|
8638
|
+
content: {
|
|
8639
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8640
|
+
};
|
|
8641
|
+
};
|
|
8642
|
+
/** @description Server or upstream bank error. */
|
|
8643
|
+
"5XX": {
|
|
8644
|
+
headers: {
|
|
8645
|
+
[name: string]: unknown;
|
|
8646
|
+
};
|
|
8647
|
+
content: {
|
|
8648
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8649
|
+
};
|
|
8650
|
+
};
|
|
8651
|
+
};
|
|
8652
|
+
};
|
|
8653
|
+
Merchants_transfer: {
|
|
8654
|
+
parameters: {
|
|
8655
|
+
query?: never;
|
|
8656
|
+
header?: {
|
|
8657
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
8658
|
+
"Idempotency-Key"?: string;
|
|
8659
|
+
};
|
|
8660
|
+
path: {
|
|
8661
|
+
id: string;
|
|
8662
|
+
};
|
|
8663
|
+
cookie?: never;
|
|
8664
|
+
};
|
|
8665
|
+
requestBody: {
|
|
8666
|
+
content: {
|
|
8667
|
+
"application/json": components["schemas"]["CreateMerchantTransferDto"];
|
|
8668
|
+
};
|
|
8669
|
+
};
|
|
8670
|
+
responses: {
|
|
8671
|
+
200: {
|
|
8672
|
+
headers: {
|
|
8673
|
+
[name: string]: unknown;
|
|
8674
|
+
};
|
|
8675
|
+
content: {
|
|
8676
|
+
"application/json": components["schemas"]["MerchantTransferResponseDto"];
|
|
8677
|
+
};
|
|
8678
|
+
};
|
|
8679
|
+
/** @description Validation failure. */
|
|
8680
|
+
400: {
|
|
8681
|
+
headers: {
|
|
8682
|
+
[name: string]: unknown;
|
|
8683
|
+
};
|
|
8684
|
+
content: {
|
|
8685
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8686
|
+
};
|
|
8687
|
+
};
|
|
8688
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
8689
|
+
401: {
|
|
8690
|
+
headers: {
|
|
8691
|
+
[name: string]: unknown;
|
|
8692
|
+
};
|
|
8693
|
+
content: {
|
|
8694
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8695
|
+
};
|
|
8696
|
+
};
|
|
8697
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
8698
|
+
403: {
|
|
8699
|
+
headers: {
|
|
8700
|
+
[name: string]: unknown;
|
|
8701
|
+
};
|
|
8702
|
+
content: {
|
|
8703
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8704
|
+
};
|
|
8705
|
+
};
|
|
8706
|
+
404: {
|
|
8707
|
+
headers: {
|
|
8708
|
+
[name: string]: unknown;
|
|
8709
|
+
};
|
|
8710
|
+
content: {
|
|
8711
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8712
|
+
};
|
|
8713
|
+
};
|
|
8714
|
+
/** @description Client error. */
|
|
8715
|
+
"4XX": {
|
|
8716
|
+
headers: {
|
|
8717
|
+
[name: string]: unknown;
|
|
8718
|
+
};
|
|
8719
|
+
content: {
|
|
8720
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8721
|
+
};
|
|
8722
|
+
};
|
|
8723
|
+
/** @description Server or upstream bank error. */
|
|
8724
|
+
"5XX": {
|
|
8725
|
+
headers: {
|
|
8726
|
+
[name: string]: unknown;
|
|
8727
|
+
};
|
|
8728
|
+
content: {
|
|
8729
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8730
|
+
};
|
|
8731
|
+
};
|
|
8732
|
+
};
|
|
8733
|
+
};
|
|
8734
|
+
Merchants_listTransactions: {
|
|
8735
|
+
parameters: {
|
|
8736
|
+
query?: {
|
|
8737
|
+
/** @description ISO 8601, exclusive (createdAt). */
|
|
8738
|
+
to?: string;
|
|
8739
|
+
/** @description ISO 8601, inclusive (createdAt). */
|
|
8740
|
+
from?: string;
|
|
8741
|
+
/** @description `nextCursor` from the previous page. */
|
|
8742
|
+
cursor?: string;
|
|
8743
|
+
/** @description 1–100, default 50. */
|
|
8744
|
+
limit?: number;
|
|
8745
|
+
};
|
|
8746
|
+
header?: never;
|
|
8747
|
+
path: {
|
|
8748
|
+
id: string;
|
|
8749
|
+
};
|
|
8750
|
+
cookie?: never;
|
|
8751
|
+
};
|
|
8752
|
+
requestBody?: never;
|
|
8753
|
+
responses: {
|
|
8754
|
+
200: {
|
|
8755
|
+
headers: {
|
|
8756
|
+
[name: string]: unknown;
|
|
8757
|
+
};
|
|
8758
|
+
content: {
|
|
8759
|
+
"application/json": components["schemas"]["MerchantMovementListDto"];
|
|
8760
|
+
};
|
|
8761
|
+
};
|
|
8762
|
+
/** @description Validation failure. */
|
|
8763
|
+
400: {
|
|
8764
|
+
headers: {
|
|
8765
|
+
[name: string]: unknown;
|
|
8766
|
+
};
|
|
8767
|
+
content: {
|
|
8768
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8769
|
+
};
|
|
8770
|
+
};
|
|
8771
|
+
/** @description Missing, invalid, or inactive tenant API key. */
|
|
8772
|
+
401: {
|
|
8773
|
+
headers: {
|
|
8774
|
+
[name: string]: unknown;
|
|
8775
|
+
};
|
|
8776
|
+
content: {
|
|
8777
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8778
|
+
};
|
|
8779
|
+
};
|
|
8780
|
+
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
8781
|
+
403: {
|
|
8782
|
+
headers: {
|
|
8783
|
+
[name: string]: unknown;
|
|
8784
|
+
};
|
|
8785
|
+
content: {
|
|
8786
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8787
|
+
};
|
|
8788
|
+
};
|
|
8789
|
+
404: {
|
|
8790
|
+
headers: {
|
|
8791
|
+
[name: string]: unknown;
|
|
8792
|
+
};
|
|
8793
|
+
content: {
|
|
8794
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8795
|
+
};
|
|
8796
|
+
};
|
|
8797
|
+
/** @description Client error. */
|
|
8798
|
+
"4XX": {
|
|
8799
|
+
headers: {
|
|
8800
|
+
[name: string]: unknown;
|
|
8801
|
+
};
|
|
8802
|
+
content: {
|
|
8803
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8804
|
+
};
|
|
8805
|
+
};
|
|
8806
|
+
/** @description Server or upstream bank error. */
|
|
8807
|
+
"5XX": {
|
|
8808
|
+
headers: {
|
|
8809
|
+
[name: string]: unknown;
|
|
8810
|
+
};
|
|
8811
|
+
content: {
|
|
8812
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8813
|
+
};
|
|
8814
|
+
};
|
|
8815
|
+
};
|
|
8816
|
+
};
|
|
8817
|
+
Merchants_statement: {
|
|
8818
|
+
parameters: {
|
|
8819
|
+
query: {
|
|
8820
|
+
/** @description YYYY-MM. */
|
|
8821
|
+
month: string;
|
|
8822
|
+
/** @description Default json. */
|
|
8823
|
+
format?: "json" | "csv";
|
|
8824
|
+
};
|
|
8493
8825
|
header?: never;
|
|
8494
8826
|
path: {
|
|
8495
8827
|
id: string;
|
|
@@ -8503,7 +8835,7 @@ interface operations {
|
|
|
8503
8835
|
[name: string]: unknown;
|
|
8504
8836
|
};
|
|
8505
8837
|
content: {
|
|
8506
|
-
"application/json": components["schemas"]["
|
|
8838
|
+
"application/json": components["schemas"]["MerchantStatementDto"];
|
|
8507
8839
|
};
|
|
8508
8840
|
};
|
|
8509
8841
|
/** @description Validation failure. */
|
|
@@ -8561,30 +8893,23 @@ interface operations {
|
|
|
8561
8893
|
};
|
|
8562
8894
|
};
|
|
8563
8895
|
};
|
|
8564
|
-
|
|
8896
|
+
Merchants_getById: {
|
|
8565
8897
|
parameters: {
|
|
8566
8898
|
query?: never;
|
|
8567
|
-
header?:
|
|
8568
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
8569
|
-
"Idempotency-Key"?: string;
|
|
8570
|
-
};
|
|
8899
|
+
header?: never;
|
|
8571
8900
|
path: {
|
|
8572
8901
|
id: string;
|
|
8573
8902
|
};
|
|
8574
8903
|
cookie?: never;
|
|
8575
8904
|
};
|
|
8576
|
-
requestBody
|
|
8577
|
-
content: {
|
|
8578
|
-
"application/json": components["schemas"]["CreateMerchantTransferDto"];
|
|
8579
|
-
};
|
|
8580
|
-
};
|
|
8905
|
+
requestBody?: never;
|
|
8581
8906
|
responses: {
|
|
8582
8907
|
200: {
|
|
8583
8908
|
headers: {
|
|
8584
8909
|
[name: string]: unknown;
|
|
8585
8910
|
};
|
|
8586
8911
|
content: {
|
|
8587
|
-
"application/json": components["schemas"]["
|
|
8912
|
+
"application/json": components["schemas"]["MerchantResponseDto"];
|
|
8588
8913
|
};
|
|
8589
8914
|
};
|
|
8590
8915
|
/** @description Validation failure. */
|
|
@@ -8642,18 +8967,9 @@ interface operations {
|
|
|
8642
8967
|
};
|
|
8643
8968
|
};
|
|
8644
8969
|
};
|
|
8645
|
-
|
|
8970
|
+
Merchants_remove: {
|
|
8646
8971
|
parameters: {
|
|
8647
|
-
query?:
|
|
8648
|
-
/** @description ISO 8601, exclusive (createdAt). */
|
|
8649
|
-
to?: string;
|
|
8650
|
-
/** @description ISO 8601, inclusive (createdAt). */
|
|
8651
|
-
from?: string;
|
|
8652
|
-
/** @description `nextCursor` from the previous page. */
|
|
8653
|
-
cursor?: string;
|
|
8654
|
-
/** @description 1–100, default 50. */
|
|
8655
|
-
limit?: number;
|
|
8656
|
-
};
|
|
8972
|
+
query?: never;
|
|
8657
8973
|
header?: never;
|
|
8658
8974
|
path: {
|
|
8659
8975
|
id: string;
|
|
@@ -8667,7 +8983,7 @@ interface operations {
|
|
|
8667
8983
|
[name: string]: unknown;
|
|
8668
8984
|
};
|
|
8669
8985
|
content: {
|
|
8670
|
-
"application/json": components["schemas"]["
|
|
8986
|
+
"application/json": components["schemas"]["DeleteMerchantResponseDto"];
|
|
8671
8987
|
};
|
|
8672
8988
|
};
|
|
8673
8989
|
/** @description Validation failure. */
|
|
@@ -8697,6 +9013,7 @@ interface operations {
|
|
|
8697
9013
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8698
9014
|
};
|
|
8699
9015
|
};
|
|
9016
|
+
/** @description Merchant not found for this tenant. */
|
|
8700
9017
|
404: {
|
|
8701
9018
|
headers: {
|
|
8702
9019
|
[name: string]: unknown;
|
|
@@ -8705,6 +9022,15 @@ interface operations {
|
|
|
8705
9022
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8706
9023
|
};
|
|
8707
9024
|
};
|
|
9025
|
+
/** @description merchant_has_payouts — merchant has payout history; deactivate instead. */
|
|
9026
|
+
409: {
|
|
9027
|
+
headers: {
|
|
9028
|
+
[name: string]: unknown;
|
|
9029
|
+
};
|
|
9030
|
+
content: {
|
|
9031
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9032
|
+
};
|
|
9033
|
+
};
|
|
8708
9034
|
/** @description Client error. */
|
|
8709
9035
|
"4XX": {
|
|
8710
9036
|
headers: {
|
|
@@ -8725,28 +9051,27 @@ interface operations {
|
|
|
8725
9051
|
};
|
|
8726
9052
|
};
|
|
8727
9053
|
};
|
|
8728
|
-
|
|
9054
|
+
Merchants_update: {
|
|
8729
9055
|
parameters: {
|
|
8730
|
-
query
|
|
8731
|
-
/** @description YYYY-MM. */
|
|
8732
|
-
month: string;
|
|
8733
|
-
/** @description Default json. */
|
|
8734
|
-
format?: "json" | "csv";
|
|
8735
|
-
};
|
|
9056
|
+
query?: never;
|
|
8736
9057
|
header?: never;
|
|
8737
9058
|
path: {
|
|
8738
9059
|
id: string;
|
|
8739
9060
|
};
|
|
8740
9061
|
cookie?: never;
|
|
8741
9062
|
};
|
|
8742
|
-
requestBody
|
|
9063
|
+
requestBody: {
|
|
9064
|
+
content: {
|
|
9065
|
+
"application/json": components["schemas"]["UpdateMerchantDto"];
|
|
9066
|
+
};
|
|
9067
|
+
};
|
|
8743
9068
|
responses: {
|
|
8744
9069
|
200: {
|
|
8745
9070
|
headers: {
|
|
8746
9071
|
[name: string]: unknown;
|
|
8747
9072
|
};
|
|
8748
9073
|
content: {
|
|
8749
|
-
"application/json": components["schemas"]["
|
|
9074
|
+
"application/json": components["schemas"]["MerchantResponseDto"];
|
|
8750
9075
|
};
|
|
8751
9076
|
};
|
|
8752
9077
|
/** @description Validation failure. */
|
|
@@ -8804,7 +9129,7 @@ interface operations {
|
|
|
8804
9129
|
};
|
|
8805
9130
|
};
|
|
8806
9131
|
};
|
|
8807
|
-
|
|
9132
|
+
Merchants_listAuditEvents: {
|
|
8808
9133
|
parameters: {
|
|
8809
9134
|
query?: never;
|
|
8810
9135
|
header?: never;
|
|
@@ -8820,7 +9145,7 @@ interface operations {
|
|
|
8820
9145
|
[name: string]: unknown;
|
|
8821
9146
|
};
|
|
8822
9147
|
content: {
|
|
8823
|
-
"application/json": components["schemas"]["
|
|
9148
|
+
"application/json": components["schemas"]["MerchantAuditEventListDto"];
|
|
8824
9149
|
};
|
|
8825
9150
|
};
|
|
8826
9151
|
/** @description Validation failure. */
|
|
@@ -8878,10 +9203,13 @@ interface operations {
|
|
|
8878
9203
|
};
|
|
8879
9204
|
};
|
|
8880
9205
|
};
|
|
8881
|
-
|
|
9206
|
+
Merchants_startVerify: {
|
|
8882
9207
|
parameters: {
|
|
8883
9208
|
query?: never;
|
|
8884
|
-
header?:
|
|
9209
|
+
header?: {
|
|
9210
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9211
|
+
"Idempotency-Key"?: string;
|
|
9212
|
+
};
|
|
8885
9213
|
path: {
|
|
8886
9214
|
id: string;
|
|
8887
9215
|
};
|
|
@@ -8889,12 +9217,12 @@ interface operations {
|
|
|
8889
9217
|
};
|
|
8890
9218
|
requestBody?: never;
|
|
8891
9219
|
responses: {
|
|
8892
|
-
|
|
9220
|
+
202: {
|
|
8893
9221
|
headers: {
|
|
8894
9222
|
[name: string]: unknown;
|
|
8895
9223
|
};
|
|
8896
9224
|
content: {
|
|
8897
|
-
"application/json": components["schemas"]["
|
|
9225
|
+
"application/json": components["schemas"]["VerifyStartResponseDto"];
|
|
8898
9226
|
};
|
|
8899
9227
|
};
|
|
8900
9228
|
/** @description Validation failure. */
|
|
@@ -8924,7 +9252,6 @@ interface operations {
|
|
|
8924
9252
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8925
9253
|
};
|
|
8926
9254
|
};
|
|
8927
|
-
/** @description Merchant not found for this tenant. */
|
|
8928
9255
|
404: {
|
|
8929
9256
|
headers: {
|
|
8930
9257
|
[name: string]: unknown;
|
|
@@ -8933,15 +9260,6 @@ interface operations {
|
|
|
8933
9260
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8934
9261
|
};
|
|
8935
9262
|
};
|
|
8936
|
-
/** @description merchant_has_payouts — merchant has payout history; deactivate instead. */
|
|
8937
|
-
409: {
|
|
8938
|
-
headers: {
|
|
8939
|
-
[name: string]: unknown;
|
|
8940
|
-
};
|
|
8941
|
-
content: {
|
|
8942
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
8943
|
-
};
|
|
8944
|
-
};
|
|
8945
9263
|
/** @description Client error. */
|
|
8946
9264
|
"4XX": {
|
|
8947
9265
|
headers: {
|
|
@@ -8962,10 +9280,13 @@ interface operations {
|
|
|
8962
9280
|
};
|
|
8963
9281
|
};
|
|
8964
9282
|
};
|
|
8965
|
-
|
|
9283
|
+
Merchants_confirmVerify: {
|
|
8966
9284
|
parameters: {
|
|
8967
9285
|
query?: never;
|
|
8968
|
-
header?:
|
|
9286
|
+
header?: {
|
|
9287
|
+
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9288
|
+
"Idempotency-Key"?: string;
|
|
9289
|
+
};
|
|
8969
9290
|
path: {
|
|
8970
9291
|
id: string;
|
|
8971
9292
|
};
|
|
@@ -8973,7 +9294,7 @@ interface operations {
|
|
|
8973
9294
|
};
|
|
8974
9295
|
requestBody: {
|
|
8975
9296
|
content: {
|
|
8976
|
-
"application/json": components["schemas"]["
|
|
9297
|
+
"application/json": components["schemas"]["ConfirmMerchantVerifyDto"];
|
|
8977
9298
|
};
|
|
8978
9299
|
};
|
|
8979
9300
|
responses: {
|
|
@@ -8982,7 +9303,7 @@ interface operations {
|
|
|
8982
9303
|
[name: string]: unknown;
|
|
8983
9304
|
};
|
|
8984
9305
|
content: {
|
|
8985
|
-
"application/json": components["schemas"]["
|
|
9306
|
+
"application/json": components["schemas"]["VerifyConfirmResponseDto"];
|
|
8986
9307
|
};
|
|
8987
9308
|
};
|
|
8988
9309
|
/** @description Validation failure. */
|
|
@@ -9040,13 +9361,11 @@ interface operations {
|
|
|
9040
9361
|
};
|
|
9041
9362
|
};
|
|
9042
9363
|
};
|
|
9043
|
-
|
|
9364
|
+
MarketplaceSettings_get: {
|
|
9044
9365
|
parameters: {
|
|
9045
9366
|
query?: never;
|
|
9046
9367
|
header?: never;
|
|
9047
|
-
path
|
|
9048
|
-
id: string;
|
|
9049
|
-
};
|
|
9368
|
+
path?: never;
|
|
9050
9369
|
cookie?: never;
|
|
9051
9370
|
};
|
|
9052
9371
|
requestBody?: never;
|
|
@@ -9056,16 +9375,7 @@ interface operations {
|
|
|
9056
9375
|
[name: string]: unknown;
|
|
9057
9376
|
};
|
|
9058
9377
|
content: {
|
|
9059
|
-
"application/json": components["schemas"]["
|
|
9060
|
-
};
|
|
9061
|
-
};
|
|
9062
|
-
/** @description Validation failure. */
|
|
9063
|
-
400: {
|
|
9064
|
-
headers: {
|
|
9065
|
-
[name: string]: unknown;
|
|
9066
|
-
};
|
|
9067
|
-
content: {
|
|
9068
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9378
|
+
"application/json": components["schemas"]["MarketplaceSettingsDto"];
|
|
9069
9379
|
};
|
|
9070
9380
|
};
|
|
9071
9381
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -9086,14 +9396,6 @@ interface operations {
|
|
|
9086
9396
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9087
9397
|
};
|
|
9088
9398
|
};
|
|
9089
|
-
404: {
|
|
9090
|
-
headers: {
|
|
9091
|
-
[name: string]: unknown;
|
|
9092
|
-
};
|
|
9093
|
-
content: {
|
|
9094
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9095
|
-
};
|
|
9096
|
-
};
|
|
9097
9399
|
/** @description Client error. */
|
|
9098
9400
|
"4XX": {
|
|
9099
9401
|
headers: {
|
|
@@ -9114,29 +9416,28 @@ interface operations {
|
|
|
9114
9416
|
};
|
|
9115
9417
|
};
|
|
9116
9418
|
};
|
|
9117
|
-
|
|
9419
|
+
MarketplaceSettings_update: {
|
|
9118
9420
|
parameters: {
|
|
9119
9421
|
query?: never;
|
|
9120
|
-
header?:
|
|
9121
|
-
|
|
9122
|
-
"Idempotency-Key"?: string;
|
|
9123
|
-
};
|
|
9124
|
-
path: {
|
|
9125
|
-
id: string;
|
|
9126
|
-
};
|
|
9422
|
+
header?: never;
|
|
9423
|
+
path?: never;
|
|
9127
9424
|
cookie?: never;
|
|
9128
9425
|
};
|
|
9129
|
-
requestBody
|
|
9426
|
+
requestBody: {
|
|
9427
|
+
content: {
|
|
9428
|
+
"application/json": components["schemas"]["UpdateMarketplaceSettingsDto"];
|
|
9429
|
+
};
|
|
9430
|
+
};
|
|
9130
9431
|
responses: {
|
|
9131
|
-
|
|
9432
|
+
200: {
|
|
9132
9433
|
headers: {
|
|
9133
9434
|
[name: string]: unknown;
|
|
9134
9435
|
};
|
|
9135
9436
|
content: {
|
|
9136
|
-
"application/json": components["schemas"]["
|
|
9437
|
+
"application/json": components["schemas"]["MarketplaceSettingsDto"];
|
|
9137
9438
|
};
|
|
9138
9439
|
};
|
|
9139
|
-
/** @description
|
|
9440
|
+
/** @description `invalid_data` — unknown field or invalid value. */
|
|
9140
9441
|
400: {
|
|
9141
9442
|
headers: {
|
|
9142
9443
|
[name: string]: unknown;
|
|
@@ -9163,14 +9464,6 @@ interface operations {
|
|
|
9163
9464
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9164
9465
|
};
|
|
9165
9466
|
};
|
|
9166
|
-
404: {
|
|
9167
|
-
headers: {
|
|
9168
|
-
[name: string]: unknown;
|
|
9169
|
-
};
|
|
9170
|
-
content: {
|
|
9171
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9172
|
-
};
|
|
9173
|
-
};
|
|
9174
9467
|
/** @description Client error. */
|
|
9175
9468
|
"4XX": {
|
|
9176
9469
|
headers: {
|
|
@@ -9191,39 +9484,25 @@ interface operations {
|
|
|
9191
9484
|
};
|
|
9192
9485
|
};
|
|
9193
9486
|
};
|
|
9194
|
-
|
|
9487
|
+
Notifications_sendTest: {
|
|
9195
9488
|
parameters: {
|
|
9196
9489
|
query?: never;
|
|
9197
9490
|
header?: {
|
|
9198
9491
|
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
9199
9492
|
"Idempotency-Key"?: string;
|
|
9200
9493
|
};
|
|
9201
|
-
path
|
|
9202
|
-
id: string;
|
|
9203
|
-
};
|
|
9494
|
+
path?: never;
|
|
9204
9495
|
cookie?: never;
|
|
9205
9496
|
};
|
|
9206
|
-
requestBody
|
|
9207
|
-
content: {
|
|
9208
|
-
"application/json": components["schemas"]["ConfirmMerchantVerifyDto"];
|
|
9209
|
-
};
|
|
9210
|
-
};
|
|
9497
|
+
requestBody?: never;
|
|
9211
9498
|
responses: {
|
|
9212
|
-
|
|
9213
|
-
|
|
9214
|
-
[name: string]: unknown;
|
|
9215
|
-
};
|
|
9216
|
-
content: {
|
|
9217
|
-
"application/json": components["schemas"]["VerifyConfirmResponseDto"];
|
|
9218
|
-
};
|
|
9219
|
-
};
|
|
9220
|
-
/** @description Validation failure. */
|
|
9221
|
-
400: {
|
|
9499
|
+
/** @description Test event queued/delivered to matching endpoints. */
|
|
9500
|
+
202: {
|
|
9222
9501
|
headers: {
|
|
9223
9502
|
[name: string]: unknown;
|
|
9224
9503
|
};
|
|
9225
9504
|
content: {
|
|
9226
|
-
"application/json": components["schemas"]["
|
|
9505
|
+
"application/json": components["schemas"]["NotificationTestResponseDto"];
|
|
9227
9506
|
};
|
|
9228
9507
|
};
|
|
9229
9508
|
/** @description Missing, invalid, or inactive tenant API key. */
|
|
@@ -9244,7 +9523,8 @@ interface operations {
|
|
|
9244
9523
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
9245
9524
|
};
|
|
9246
9525
|
};
|
|
9247
|
-
|
|
9526
|
+
/** @description More than 10 test notifications in 10 minutes. */
|
|
9527
|
+
429: {
|
|
9248
9528
|
headers: {
|
|
9249
9529
|
[name: string]: unknown;
|
|
9250
9530
|
};
|
|
@@ -10462,74 +10742,6 @@ interface operations {
|
|
|
10462
10742
|
};
|
|
10463
10743
|
};
|
|
10464
10744
|
};
|
|
10465
|
-
Notifications_sendTest: {
|
|
10466
|
-
parameters: {
|
|
10467
|
-
query?: never;
|
|
10468
|
-
header?: {
|
|
10469
|
-
/** @description Optional. Same key + same body within 24h replays the stored response (`Idempotent-Replayed: true`); a different body returns 409 `idempotency_key_reused`. */
|
|
10470
|
-
"Idempotency-Key"?: string;
|
|
10471
|
-
};
|
|
10472
|
-
path?: never;
|
|
10473
|
-
cookie?: never;
|
|
10474
|
-
};
|
|
10475
|
-
requestBody?: never;
|
|
10476
|
-
responses: {
|
|
10477
|
-
/** @description Test event queued/delivered to matching endpoints. */
|
|
10478
|
-
202: {
|
|
10479
|
-
headers: {
|
|
10480
|
-
[name: string]: unknown;
|
|
10481
|
-
};
|
|
10482
|
-
content: {
|
|
10483
|
-
"application/json": components["schemas"]["NotificationTestResponseDto"];
|
|
10484
|
-
};
|
|
10485
|
-
};
|
|
10486
|
-
/** @description Missing, invalid, or inactive tenant API key. */
|
|
10487
|
-
401: {
|
|
10488
|
-
headers: {
|
|
10489
|
-
[name: string]: unknown;
|
|
10490
|
-
};
|
|
10491
|
-
content: {
|
|
10492
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10493
|
-
};
|
|
10494
|
-
};
|
|
10495
|
-
/** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
|
|
10496
|
-
403: {
|
|
10497
|
-
headers: {
|
|
10498
|
-
[name: string]: unknown;
|
|
10499
|
-
};
|
|
10500
|
-
content: {
|
|
10501
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10502
|
-
};
|
|
10503
|
-
};
|
|
10504
|
-
/** @description More than 10 test notifications in 10 minutes. */
|
|
10505
|
-
429: {
|
|
10506
|
-
headers: {
|
|
10507
|
-
[name: string]: unknown;
|
|
10508
|
-
};
|
|
10509
|
-
content: {
|
|
10510
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10511
|
-
};
|
|
10512
|
-
};
|
|
10513
|
-
/** @description Client error. */
|
|
10514
|
-
"4XX": {
|
|
10515
|
-
headers: {
|
|
10516
|
-
[name: string]: unknown;
|
|
10517
|
-
};
|
|
10518
|
-
content: {
|
|
10519
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10520
|
-
};
|
|
10521
|
-
};
|
|
10522
|
-
/** @description Server or upstream bank error. */
|
|
10523
|
-
"5XX": {
|
|
10524
|
-
headers: {
|
|
10525
|
-
[name: string]: unknown;
|
|
10526
|
-
};
|
|
10527
|
-
content: {
|
|
10528
|
-
"application/json": components["schemas"]["ApiErrorDto"];
|
|
10529
|
-
};
|
|
10530
|
-
};
|
|
10531
|
-
};
|
|
10532
|
-
};
|
|
10533
10745
|
Customers_list: {
|
|
10534
10746
|
parameters: {
|
|
10535
10747
|
query?: {
|
|
@@ -12744,7 +12956,7 @@ declare class PagePromise<Page extends CursorPage<Item>, Item = Page['items'][nu
|
|
|
12744
12956
|
|
|
12745
12957
|
type OperationId = keyof operations;
|
|
12746
12958
|
|
|
12747
|
-
/** Every request/response schema in the
|
|
12959
|
+
/** Every request/response schema in the VEX Pay API, e.g. `Schemas['PaymentReceiptDto']`. */
|
|
12748
12960
|
type Schemas = components['schemas'];
|
|
12749
12961
|
type Params<O extends OperationId> = operations[O]['parameters'];
|
|
12750
12962
|
type PathParams<O extends OperationId> = NonNullable<Params<O>['path']>;
|
|
@@ -13095,12 +13307,14 @@ declare class Payouts extends APIResource {
|
|
|
13095
13307
|
settledAt?: string | null;
|
|
13096
13308
|
}>;
|
|
13097
13309
|
}
|
|
13098
|
-
/** The account your own
|
|
13310
|
+
/** The account your own VEX Pay earnings are paid out to. */
|
|
13099
13311
|
declare class TenantPayoutAccount extends APIResource {
|
|
13100
13312
|
retrieve(options?: RequestOptions): Promise<{
|
|
13101
13313
|
accountId: string;
|
|
13102
13314
|
bankCode: string;
|
|
13315
|
+
type: "pago_movil" | "bank_account";
|
|
13103
13316
|
destination: string;
|
|
13317
|
+
holderName?: string | null;
|
|
13104
13318
|
identification: string;
|
|
13105
13319
|
eligibility: "pending_verification" | "verifying" | "cooling" | "eligible" | "rejected" | "locked";
|
|
13106
13320
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
@@ -13114,7 +13328,9 @@ declare class TenantPayoutAccount extends APIResource {
|
|
|
13114
13328
|
upsert(params: RequestBody<'TenantPayoutAccount_upsert'>, options?: RequestOptions): Promise<{
|
|
13115
13329
|
accountId: string;
|
|
13116
13330
|
bankCode: string;
|
|
13331
|
+
type: "pago_movil" | "bank_account";
|
|
13117
13332
|
destination: string;
|
|
13333
|
+
holderName?: string | null;
|
|
13118
13334
|
identification: string;
|
|
13119
13335
|
eligibility: "pending_verification" | "verifying" | "cooling" | "eligible" | "rejected" | "locked";
|
|
13120
13336
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
@@ -13128,7 +13344,9 @@ declare class TenantPayoutAccount extends APIResource {
|
|
|
13128
13344
|
create(params: RequestBody<'TenantPayoutAccount_upsertPost'>, options?: RequestOptions): Promise<{
|
|
13129
13345
|
accountId: string;
|
|
13130
13346
|
bankCode: string;
|
|
13347
|
+
type: "pago_movil" | "bank_account";
|
|
13131
13348
|
destination: string;
|
|
13349
|
+
holderName?: string | null;
|
|
13132
13350
|
identification: string;
|
|
13133
13351
|
eligibility: "pending_verification" | "verifying" | "cooling" | "eligible" | "rejected" | "locked";
|
|
13134
13352
|
status: "pending_verification" | "verifying" | "verified" | "rejected";
|
|
@@ -13142,6 +13360,7 @@ declare class TenantPayoutAccount extends APIResource {
|
|
|
13142
13360
|
status: "verifying";
|
|
13143
13361
|
expiresAt: string;
|
|
13144
13362
|
accountId: string;
|
|
13363
|
+
testAmounts?: string[];
|
|
13145
13364
|
}>;
|
|
13146
13365
|
confirmVerification(params: RequestBody<'TenantPayoutAccount_confirmVerify'>, options?: RequestOptions): Promise<{
|
|
13147
13366
|
status: "eligible" | "cooling";
|
|
@@ -13149,7 +13368,7 @@ declare class TenantPayoutAccount extends APIResource {
|
|
|
13149
13368
|
payoutEligibleAt: string;
|
|
13150
13369
|
}>;
|
|
13151
13370
|
}
|
|
13152
|
-
/** Where
|
|
13371
|
+
/** Where VEX Pay delivers signed webhooks. */
|
|
13153
13372
|
declare class WebhookEndpoints extends APIResource {
|
|
13154
13373
|
/** The response includes the signing `secret` — store it to verify deliveries. */
|
|
13155
13374
|
create(params: RequestBody<'Webhooks_createWebhook'>, options?: RequestOptions): Promise<{
|
|
@@ -13595,7 +13814,7 @@ declare class Invoices extends APIResource {
|
|
|
13595
13814
|
createdAt: string;
|
|
13596
13815
|
livemode: boolean;
|
|
13597
13816
|
}>;
|
|
13598
|
-
/** Record an open invoice as paid outside
|
|
13817
|
+
/** Record an open invoice as paid outside VEX Pay (`paidOutOfBand: true`); no money moves. */
|
|
13599
13818
|
pay(id: string, params: RequestBody<'Invoices_pay'>, options?: RequestOptions): Promise<{
|
|
13600
13819
|
id: string;
|
|
13601
13820
|
object: string;
|
|
@@ -13754,6 +13973,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
13754
13973
|
clientSecret?: string;
|
|
13755
13974
|
url: string;
|
|
13756
13975
|
amountUsd: string;
|
|
13976
|
+
amountVes?: string | null;
|
|
13757
13977
|
description?: string | null;
|
|
13758
13978
|
reference?: string | null;
|
|
13759
13979
|
metadata: {
|
|
@@ -13777,6 +13997,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
13777
13997
|
clientSecret?: string;
|
|
13778
13998
|
url: string;
|
|
13779
13999
|
amountUsd: string;
|
|
14000
|
+
amountVes?: string | null;
|
|
13780
14001
|
description?: string | null;
|
|
13781
14002
|
reference?: string | null;
|
|
13782
14003
|
metadata: {
|
|
@@ -13935,7 +14156,7 @@ declare class ConversionSettings extends APIResource {
|
|
|
13935
14156
|
}
|
|
13936
14157
|
/**
|
|
13937
14158
|
* Convert available VES or COP into your USDT balance. Accepting a quote debits the source at once
|
|
13938
|
-
* (`conversion.created`); the conversion is `PENDING` until
|
|
14159
|
+
* (`conversion.created`); the conversion is `PENDING` until VEX Pay delivers the USDT
|
|
13939
14160
|
* (`conversion.completed`). Enabled per account.
|
|
13940
14161
|
*/
|
|
13941
14162
|
declare class Conversions extends APIResource {
|
|
@@ -14030,24 +14251,21 @@ declare class Conversions extends APIResource {
|
|
|
14030
14251
|
}
|
|
14031
14252
|
|
|
14032
14253
|
/**
|
|
14033
|
-
* Colombian peso payments:
|
|
14034
|
-
*
|
|
14035
|
-
* the hosted checkout. Payments complete asynchronously — listen for `payment.completed` /
|
|
14254
|
+
* Colombian peso payments: Bre-B (QR / transfer key), Nequi (push approval) or Daviplata (SMS
|
|
14255
|
+
* code). Payments complete asynchronously — listen for `payment.completed` /
|
|
14036
14256
|
* `payment.failed`. COP must be enabled on your account (403 `method_not_allowed` otherwise).
|
|
14037
14257
|
*/
|
|
14038
14258
|
declare class CopPayments extends APIResource {
|
|
14039
14259
|
/**
|
|
14040
|
-
* Create a payment in whole pesos. `buyer` is required for every channel except `breb
|
|
14041
|
-
*
|
|
14042
|
-
* `pse.bankCode`. The response `next` says what the buyer does: `show_qr`, `approve_in_app`,
|
|
14043
|
-
* `submit_otp`, `redirect` (send them to `next.url`) or `redirect_pending` (retrieve again shortly).
|
|
14260
|
+
* Create a payment in whole pesos. `buyer` is required for every channel except `breb`. The
|
|
14261
|
+
* response `next` says what the buyer does: `show_qr`, `approve_in_app` or `submit_otp`.
|
|
14044
14262
|
* Pass `idempotencyKey` in options to retry safely.
|
|
14045
14263
|
*/
|
|
14046
14264
|
create(params: RequestBody<'CopPayments_create'>, options?: RequestOptions): Promise<{
|
|
14047
14265
|
id: string;
|
|
14048
14266
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
14049
14267
|
method: "COP";
|
|
14050
|
-
channel: "breb" | "nequi" | "daviplata"
|
|
14268
|
+
channel: "breb" | "nequi" | "daviplata";
|
|
14051
14269
|
amountCop: number;
|
|
14052
14270
|
feeCop?: number;
|
|
14053
14271
|
amountUsd?: string;
|
|
@@ -14056,18 +14274,17 @@ declare class CopPayments extends APIResource {
|
|
|
14056
14274
|
metadata: {
|
|
14057
14275
|
[key: string]: string;
|
|
14058
14276
|
};
|
|
14059
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown"
|
|
14277
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
14060
14278
|
expiresAt?: string;
|
|
14061
14279
|
createdAt: string;
|
|
14062
14280
|
completedAt?: string;
|
|
14063
14281
|
next?: components["schemas"]["CopNextActionDto"];
|
|
14064
|
-
card?: Record<string, never>;
|
|
14065
14282
|
}>;
|
|
14066
14283
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
14067
14284
|
id: string;
|
|
14068
14285
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
14069
14286
|
method: "COP";
|
|
14070
|
-
channel: "breb" | "nequi" | "daviplata"
|
|
14287
|
+
channel: "breb" | "nequi" | "daviplata";
|
|
14071
14288
|
amountCop: number;
|
|
14072
14289
|
feeCop?: number;
|
|
14073
14290
|
amountUsd?: string;
|
|
@@ -14076,19 +14293,18 @@ declare class CopPayments extends APIResource {
|
|
|
14076
14293
|
metadata: {
|
|
14077
14294
|
[key: string]: string;
|
|
14078
14295
|
};
|
|
14079
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown"
|
|
14296
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
14080
14297
|
expiresAt?: string;
|
|
14081
14298
|
createdAt: string;
|
|
14082
14299
|
completedAt?: string;
|
|
14083
14300
|
next?: components["schemas"]["CopNextActionDto"];
|
|
14084
|
-
card?: Record<string, never>;
|
|
14085
14301
|
}>;
|
|
14086
14302
|
/** Daviplata with `next.type: "submit_otp"`: submit the code the buyer received by SMS. A wrong code fails with `invalid_otp`. */
|
|
14087
14303
|
submitOtp(id: string, params: RequestBody<'CopPayments_submitOtp'>, options?: RequestOptions): Promise<{
|
|
14088
14304
|
id: string;
|
|
14089
14305
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
14090
14306
|
method: "COP";
|
|
14091
|
-
channel: "breb" | "nequi" | "daviplata"
|
|
14307
|
+
channel: "breb" | "nequi" | "daviplata";
|
|
14092
14308
|
amountCop: number;
|
|
14093
14309
|
feeCop?: number;
|
|
14094
14310
|
amountUsd?: string;
|
|
@@ -14097,19 +14313,18 @@ declare class CopPayments extends APIResource {
|
|
|
14097
14313
|
metadata: {
|
|
14098
14314
|
[key: string]: string;
|
|
14099
14315
|
};
|
|
14100
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown"
|
|
14316
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
14101
14317
|
expiresAt?: string;
|
|
14102
14318
|
createdAt: string;
|
|
14103
14319
|
completedAt?: string;
|
|
14104
14320
|
next?: components["schemas"]["CopNextActionDto"];
|
|
14105
|
-
card?: Record<string, never>;
|
|
14106
14321
|
}>;
|
|
14107
14322
|
/** Cancel a pending payment. */
|
|
14108
14323
|
cancel(id: string, options?: RequestOptions): Promise<{
|
|
14109
14324
|
id: string;
|
|
14110
14325
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
14111
14326
|
method: "COP";
|
|
14112
|
-
channel: "breb" | "nequi" | "daviplata"
|
|
14327
|
+
channel: "breb" | "nequi" | "daviplata";
|
|
14113
14328
|
amountCop: number;
|
|
14114
14329
|
feeCop?: number;
|
|
14115
14330
|
amountUsd?: string;
|
|
@@ -14118,22 +14333,21 @@ declare class CopPayments extends APIResource {
|
|
|
14118
14333
|
metadata: {
|
|
14119
14334
|
[key: string]: string;
|
|
14120
14335
|
};
|
|
14121
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown"
|
|
14336
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
14122
14337
|
expiresAt?: string;
|
|
14123
14338
|
createdAt: string;
|
|
14124
14339
|
completedAt?: string;
|
|
14125
14340
|
next?: components["schemas"]["CopNextActionDto"];
|
|
14126
|
-
card?: Record<string, never>;
|
|
14127
14341
|
}>;
|
|
14128
14342
|
/**
|
|
14129
|
-
* Full refund of a completed payment, within
|
|
14130
|
-
*
|
|
14343
|
+
* Full refund of a completed payment, within 96 hours of completion. A payment that can no
|
|
14344
|
+
* longer be refunded through the API fails with `refund_not_supported`.
|
|
14131
14345
|
*/
|
|
14132
14346
|
refund(id: string, options?: RequestOptions): Promise<{
|
|
14133
14347
|
id: string;
|
|
14134
14348
|
status: "pending" | "completed" | "failed" | "canceled" | "refunded";
|
|
14135
14349
|
method: "COP";
|
|
14136
|
-
channel: "breb" | "nequi" | "daviplata"
|
|
14350
|
+
channel: "breb" | "nequi" | "daviplata";
|
|
14137
14351
|
amountCop: number;
|
|
14138
14352
|
feeCop?: number;
|
|
14139
14353
|
amountUsd?: string;
|
|
@@ -14142,12 +14356,11 @@ declare class CopPayments extends APIResource {
|
|
|
14142
14356
|
metadata: {
|
|
14143
14357
|
[key: string]: string;
|
|
14144
14358
|
};
|
|
14145
|
-
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown"
|
|
14359
|
+
failureCode?: "expired" | "rejected" | "processor_error" | "processor_unknown";
|
|
14146
14360
|
expiresAt?: string;
|
|
14147
14361
|
createdAt: string;
|
|
14148
14362
|
completedAt?: string;
|
|
14149
14363
|
next?: components["schemas"]["CopNextActionDto"];
|
|
14150
|
-
card?: Record<string, never>;
|
|
14151
14364
|
}>;
|
|
14152
14365
|
}
|
|
14153
14366
|
/** Your COP balance, in whole pesos. Kept apart from VES and stablecoins. */
|
|
@@ -14160,15 +14373,13 @@ declare class CopBalance extends APIResource {
|
|
|
14160
14373
|
asOf: string;
|
|
14161
14374
|
}>;
|
|
14162
14375
|
}
|
|
14163
|
-
/** Collect Colombian pesos (
|
|
14376
|
+
/** Collect Colombian pesos (Bre-B, Nequi, Daviplata). */
|
|
14164
14377
|
declare class Cop extends APIResource {
|
|
14165
14378
|
readonly payments: CopPayments;
|
|
14166
14379
|
readonly balance: CopBalance;
|
|
14167
|
-
/** Channels you can use right now, with what each needs
|
|
14380
|
+
/** Channels you can use right now, with what each needs. */
|
|
14168
14381
|
channels(options?: RequestOptions): Promise<{
|
|
14169
14382
|
channels: components["schemas"]["CopChannelDto"][];
|
|
14170
|
-
pseBanks?: components["schemas"]["CopPseBankDto"][];
|
|
14171
|
-
terms?: components["schemas"]["CopTermsDto"];
|
|
14172
14383
|
}>;
|
|
14173
14384
|
}
|
|
14174
14385
|
|
|
@@ -14332,6 +14543,7 @@ declare class PayoutMethods extends APIResource {
|
|
|
14332
14543
|
status: string;
|
|
14333
14544
|
expiresAt: string;
|
|
14334
14545
|
payoutMethodId?: string;
|
|
14546
|
+
testAmounts?: string[];
|
|
14335
14547
|
}>;
|
|
14336
14548
|
/** Confirm the micro-deposit amounts the merchant saw. */
|
|
14337
14549
|
confirmVerification(merchantId: string, methodId: string, params: RequestBody<'Merchants_confirmVerifyMethod'>, options?: RequestOptions): Promise<{
|
|
@@ -14339,8 +14551,21 @@ declare class PayoutMethods extends APIResource {
|
|
|
14339
14551
|
payoutMethodId: string;
|
|
14340
14552
|
}>;
|
|
14341
14553
|
}
|
|
14554
|
+
/** Marketplace comercio auto-payout: the default for new merchants and the payout minimum. */
|
|
14555
|
+
declare class MarketplaceSettings extends APIResource {
|
|
14556
|
+
retrieve(options?: RequestOptions): Promise<{
|
|
14557
|
+
merchantAutoPayoutDefault: boolean;
|
|
14558
|
+
merchantAutoPayoutMinUsd?: string | null;
|
|
14559
|
+
}>;
|
|
14560
|
+
/** `merchantAutoPayoutDefault` and/or `merchantAutoPayoutMinUsd` (USD; null clears it). */
|
|
14561
|
+
update(params: RequestBody<'MarketplaceSettings_update'>, options?: RequestOptions): Promise<{
|
|
14562
|
+
merchantAutoPayoutDefault: boolean;
|
|
14563
|
+
merchantAutoPayoutMinUsd?: string | null;
|
|
14564
|
+
}>;
|
|
14565
|
+
}
|
|
14342
14566
|
declare class Merchants extends APIResource {
|
|
14343
14567
|
readonly payoutMethods: PayoutMethods;
|
|
14568
|
+
readonly marketplaceSettings: MarketplaceSettings;
|
|
14344
14569
|
/** `externalRef` is required and is the idempotency key for merchant creation. */
|
|
14345
14570
|
create(params: RequestBody<'Merchants_create'>, options?: RequestOptions): Promise<{
|
|
14346
14571
|
merchantId: string;
|
|
@@ -14507,6 +14732,7 @@ declare class Merchants extends APIResource {
|
|
|
14507
14732
|
description: string;
|
|
14508
14733
|
transferKey?: string;
|
|
14509
14734
|
paymentId?: string | null;
|
|
14735
|
+
splitReference?: string;
|
|
14510
14736
|
payoutId?: string | null;
|
|
14511
14737
|
availableAt?: string | null;
|
|
14512
14738
|
amountUsd?: string;
|
|
@@ -14534,6 +14760,7 @@ declare class Merchants extends APIResource {
|
|
|
14534
14760
|
status: string;
|
|
14535
14761
|
expiresAt: string;
|
|
14536
14762
|
payoutMethodId?: string;
|
|
14763
|
+
testAmounts?: string[];
|
|
14537
14764
|
}>;
|
|
14538
14765
|
confirmVerification(id: string, params: RequestBody<'Merchants_confirmVerify'>, options?: RequestOptions): Promise<{
|
|
14539
14766
|
status: string;
|
|
@@ -14575,6 +14802,7 @@ declare class C2p extends APIResource {
|
|
|
14575
14802
|
reversalRef?: string;
|
|
14576
14803
|
reversalTxId?: number;
|
|
14577
14804
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
14805
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14578
14806
|
intentId: string;
|
|
14579
14807
|
otpRequested: boolean;
|
|
14580
14808
|
}>;
|
|
@@ -14610,6 +14838,7 @@ declare class C2p extends APIResource {
|
|
|
14610
14838
|
reversalRef?: string;
|
|
14611
14839
|
reversalTxId?: number;
|
|
14612
14840
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
14841
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14613
14842
|
}>;
|
|
14614
14843
|
}
|
|
14615
14844
|
/** Card payments (VPOS). Prefer the hosted/embedded checkout so card data never touches your servers. */
|
|
@@ -14645,6 +14874,7 @@ declare class Vpos extends APIResource {
|
|
|
14645
14874
|
reversalRef?: string;
|
|
14646
14875
|
reversalTxId?: number;
|
|
14647
14876
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
14877
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14648
14878
|
}>;
|
|
14649
14879
|
}
|
|
14650
14880
|
/** Confirm a Pago Móvil the customer already sent to you. */
|
|
@@ -14694,6 +14924,7 @@ declare class PagoMovil extends APIResource {
|
|
|
14694
14924
|
reversalRef?: string;
|
|
14695
14925
|
reversalTxId?: number;
|
|
14696
14926
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
14927
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14697
14928
|
}>;
|
|
14698
14929
|
}
|
|
14699
14930
|
/** Débito inmediato (advanced payments, enabled per account). */
|
|
@@ -14837,6 +15068,7 @@ declare class Payments extends APIResource {
|
|
|
14837
15068
|
reversalRef?: string;
|
|
14838
15069
|
reversalTxId?: number;
|
|
14839
15070
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
15071
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14840
15072
|
}>;
|
|
14841
15073
|
/** Look up a payment by the `externalRef` you sent. */
|
|
14842
15074
|
retrieveByRef(externalRef: string, options?: RequestOptions): Promise<{
|
|
@@ -14870,6 +15102,7 @@ declare class Payments extends APIResource {
|
|
|
14870
15102
|
reversalRef?: string;
|
|
14871
15103
|
reversalTxId?: number;
|
|
14872
15104
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
15105
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14873
15106
|
}>;
|
|
14874
15107
|
/** Reverse a completed C2P payment. */
|
|
14875
15108
|
reverse(id: string, options?: RequestOptions): Promise<{
|
|
@@ -14903,6 +15136,7 @@ declare class Payments extends APIResource {
|
|
|
14903
15136
|
reversalRef?: string;
|
|
14904
15137
|
reversalTxId?: number;
|
|
14905
15138
|
onwardPayout?: components["schemas"]["OnwardPayoutStatusDto"];
|
|
15139
|
+
splits?: components["schemas"]["PaymentSplitViewDto"][];
|
|
14906
15140
|
}>;
|
|
14907
15141
|
}
|
|
14908
15142
|
|
|
@@ -14917,6 +15151,11 @@ interface PaymentWebhookData {
|
|
|
14917
15151
|
method: 'C2P' | 'VPOS' | 'PAGO_MOVIL' | 'DEBITO_INMEDIATO' | 'COP';
|
|
14918
15152
|
usdAmount: number;
|
|
14919
15153
|
vesAmount: number;
|
|
15154
|
+
/**
|
|
15155
|
+
* Pago Móvil only, present when the payer sent more than asked (up to Bs 500 more is accepted):
|
|
15156
|
+
* the bolívar amount originally asked. `vesAmount` and `usdAmount` are then what arrived.
|
|
15157
|
+
*/
|
|
15158
|
+
requestedVesAmount?: number;
|
|
14920
15159
|
/** Official BCV rate (Bs per $1) when the payment was created. */
|
|
14921
15160
|
bcvRate: number;
|
|
14922
15161
|
/** Rate the payment was priced at: `bcvRate` for BCV accounts, the market rate for MARKET accounts. */
|
|
@@ -14961,22 +15200,15 @@ interface CopPaymentWebhookData {
|
|
|
14961
15200
|
method: 'COP';
|
|
14962
15201
|
currency: 'COP';
|
|
14963
15202
|
status: 'pending' | 'completed' | 'failed' | 'canceled' | 'refunded';
|
|
14964
|
-
channel: 'breb' | 'nequi' | 'daviplata'
|
|
15203
|
+
channel: 'breb' | 'nequi' | 'daviplata';
|
|
14965
15204
|
amountCop: number;
|
|
14966
|
-
/** Card payments: brand and last 4 digits. */
|
|
14967
|
-
card?: {
|
|
14968
|
-
brand: string;
|
|
14969
|
-
last4: string;
|
|
14970
|
-
};
|
|
14971
15205
|
feeCop?: number;
|
|
14972
15206
|
amountUsd?: string;
|
|
14973
15207
|
copRate?: string;
|
|
14974
15208
|
reference?: string;
|
|
14975
15209
|
externalRef?: string;
|
|
14976
15210
|
metadata: Record<string, string>;
|
|
14977
|
-
failureCode?: 'expired' | 'rejected' | 'processor_error' | 'processor_unknown'
|
|
14978
|
-
/** `payment.reversed` from a card dispute: `"chargeback"` (the amount was debited from your COP balance). */
|
|
14979
|
-
reason?: 'chargeback';
|
|
15211
|
+
failureCode?: 'expired' | 'rejected' | 'processor_error' | 'processor_unknown';
|
|
14980
15212
|
expiresAt?: string;
|
|
14981
15213
|
createdAt: string;
|
|
14982
15214
|
completedAt?: string;
|
|
@@ -15105,7 +15337,7 @@ declare class VexPayConflictError extends VexPayError {
|
|
|
15105
15337
|
/** 429 — too many requests. Retried automatically before surfacing. */
|
|
15106
15338
|
declare class VexPayRateLimitError extends VexPayError {
|
|
15107
15339
|
}
|
|
15108
|
-
/** 5xx —
|
|
15340
|
+
/** 5xx — VEX Pay or an upstream bank failed. Retried automatically before surfacing. */
|
|
15109
15341
|
declare class VexPayAPIError extends VexPayError {
|
|
15110
15342
|
}
|
|
15111
15343
|
/** The request never got an HTTP answer (DNS, refused, reset). */
|
|
@@ -15118,6 +15350,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
15118
15350
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
15119
15351
|
}
|
|
15120
15352
|
|
|
15121
|
-
declare const VERSION = "0.
|
|
15353
|
+
declare const VERSION = "0.18.0";
|
|
15122
15354
|
|
|
15123
15355
|
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 };
|