@vexpay/node 0.10.0 → 0.11.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 +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +88 -16
- package/dist/index.d.ts +88 -16
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -221,10 +221,15 @@ interface components {
|
|
|
221
221
|
*/
|
|
222
222
|
payoutId: string;
|
|
223
223
|
/**
|
|
224
|
-
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id.
|
|
224
|
+
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit`, funds returned) when rejected.
|
|
225
225
|
* @enum {string}
|
|
226
226
|
*/
|
|
227
|
-
status: "completed" | "pending" | "failed";
|
|
227
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
228
|
+
/**
|
|
229
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent).
|
|
230
|
+
* @enum {string}
|
|
231
|
+
*/
|
|
232
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
228
233
|
/** @description Bank reference when available. */
|
|
229
234
|
reference?: string | null;
|
|
230
235
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -288,10 +293,15 @@ interface components {
|
|
|
288
293
|
*/
|
|
289
294
|
payoutId: string;
|
|
290
295
|
/**
|
|
291
|
-
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id.
|
|
296
|
+
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit`, funds returned) when rejected.
|
|
292
297
|
* @enum {string}
|
|
293
298
|
*/
|
|
294
|
-
status: "completed" | "pending" | "failed";
|
|
299
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
300
|
+
/**
|
|
301
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent).
|
|
302
|
+
* @enum {string}
|
|
303
|
+
*/
|
|
304
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
295
305
|
/** @description Bank reference when available. */
|
|
296
306
|
reference?: string | null;
|
|
297
307
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -774,7 +784,7 @@ interface components {
|
|
|
774
784
|
*/
|
|
775
785
|
concepto: string;
|
|
776
786
|
/**
|
|
777
|
-
* @description Tenant correlation value for recovery lookup (GET /v1/payments/by-ref/:externalRef). Not an idempotency key.
|
|
787
|
+
* @description Tenant correlation value for recovery lookup (GET /v1/payments/by-ref/:externalRef). Not an idempotency key; a ref that already has a COMPLETED payment is refused (409 external_ref_already_paid).
|
|
778
788
|
* @example fine_736a0b42-0b6e-454c-b87e-7f3c0e47057b
|
|
779
789
|
*/
|
|
780
790
|
externalRef?: string;
|
|
@@ -1617,7 +1627,7 @@ interface components {
|
|
|
1617
1627
|
*/
|
|
1618
1628
|
debtorBankCode: number;
|
|
1619
1629
|
/**
|
|
1620
|
-
* @description Correlation value; not an idempotency key. When present, any other PENDING C2P intent for this tenant + externalRef is canceled (superseded) before the new intent is created.
|
|
1630
|
+
* @description Correlation value; not an idempotency key. A ref that already has a COMPLETED payment is refused (409 external_ref_already_paid). When present, any other PENDING C2P intent for this tenant + externalRef is canceled (superseded) before the new intent is created.
|
|
1621
1631
|
* @example order-1042
|
|
1622
1632
|
*/
|
|
1623
1633
|
externalRef?: string;
|
|
@@ -1811,7 +1821,7 @@ interface components {
|
|
|
1811
1821
|
*/
|
|
1812
1822
|
token: string;
|
|
1813
1823
|
/**
|
|
1814
|
-
* @description Correlation value; not an idempotency key.
|
|
1824
|
+
* @description Correlation value; not an idempotency key. A ref that already has a COMPLETED payment is refused (409 external_ref_already_paid).
|
|
1815
1825
|
* @example order-1042
|
|
1816
1826
|
*/
|
|
1817
1827
|
externalRef?: string;
|
|
@@ -1967,7 +1977,7 @@ interface components {
|
|
|
1967
1977
|
*/
|
|
1968
1978
|
cardType: 1 | 2 | 3;
|
|
1969
1979
|
/**
|
|
1970
|
-
* @description Correlation value; not an idempotency key.
|
|
1980
|
+
* @description Correlation value; not an idempotency key. A ref that already has a COMPLETED payment is refused (409 external_ref_already_paid).
|
|
1971
1981
|
* @example order-1042
|
|
1972
1982
|
*/
|
|
1973
1983
|
externalRef?: string;
|
|
@@ -2375,6 +2385,16 @@ interface components {
|
|
|
2375
2385
|
metadata?: {
|
|
2376
2386
|
[key: string]: string;
|
|
2377
2387
|
};
|
|
2388
|
+
/**
|
|
2389
|
+
* @description Split the payment with one of your merchants (UUID or `mrc_` id). The merchant's share is credited to its VES balance when the payment completes. Only bolívar methods (`c2p`, `pago_movil`, `vpos`) are offered.
|
|
2390
|
+
* @example 3fd84b2d-9ad1-4f74-a2d9-0f2f56984db5
|
|
2391
|
+
*/
|
|
2392
|
+
merchantId?: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* @description Commission percent you keep when `merchantId` is set. Omit to use the merchant's commission, then your default commission.
|
|
2395
|
+
* @example 3
|
|
2396
|
+
*/
|
|
2397
|
+
applicationFeePercent?: number;
|
|
2378
2398
|
};
|
|
2379
2399
|
CheckoutSessionResponseDto: {
|
|
2380
2400
|
/** @example cs_4f0c6f1e2b7d4c1a9e3f5a6b7c8d9e0f */
|
|
@@ -2410,6 +2430,13 @@ interface components {
|
|
|
2410
2430
|
expiresAt: string;
|
|
2411
2431
|
/** Format: date-time */
|
|
2412
2432
|
createdAt: string;
|
|
2433
|
+
/** @description Merchant the payment is split with. */
|
|
2434
|
+
merchantId?: string | null;
|
|
2435
|
+
/**
|
|
2436
|
+
* @description Commission percent set on the session; null = merchant or tenant default at payment time.
|
|
2437
|
+
* @example 3
|
|
2438
|
+
*/
|
|
2439
|
+
applicationFeePercent?: string | null;
|
|
2413
2440
|
/** @description false for test-mode tenants. */
|
|
2414
2441
|
livemode: boolean;
|
|
2415
2442
|
};
|
|
@@ -2912,8 +2939,8 @@ interface operations {
|
|
|
2912
2939
|
Payouts_list: {
|
|
2913
2940
|
parameters: {
|
|
2914
2941
|
query?: {
|
|
2915
|
-
/** @description Optional status filter. */
|
|
2916
|
-
status?: "pending" | "completed" | "failed";
|
|
2942
|
+
/** @description Optional status filter. `awaiting_approval` lists payouts held for VEX Pay review. */
|
|
2943
|
+
status?: "pending" | "awaiting_approval" | "completed" | "failed";
|
|
2917
2944
|
/** @description Opaque cursor from a previous `nextCursor`. */
|
|
2918
2945
|
cursor?: string;
|
|
2919
2946
|
/** @description Page size 1–100 (default 25). */
|
|
@@ -3928,6 +3955,15 @@ interface operations {
|
|
|
3928
3955
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3929
3956
|
};
|
|
3930
3957
|
};
|
|
3958
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
3959
|
+
409: {
|
|
3960
|
+
headers: {
|
|
3961
|
+
[name: string]: unknown;
|
|
3962
|
+
};
|
|
3963
|
+
content: {
|
|
3964
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3965
|
+
};
|
|
3966
|
+
};
|
|
3931
3967
|
/** @description The banking network rejected the operation. */
|
|
3932
3968
|
422: {
|
|
3933
3969
|
headers: {
|
|
@@ -6178,6 +6214,15 @@ interface operations {
|
|
|
6178
6214
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6179
6215
|
};
|
|
6180
6216
|
};
|
|
6217
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
6218
|
+
409: {
|
|
6219
|
+
headers: {
|
|
6220
|
+
[name: string]: unknown;
|
|
6221
|
+
};
|
|
6222
|
+
content: {
|
|
6223
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6224
|
+
};
|
|
6225
|
+
};
|
|
6181
6226
|
/** @description Client error. */
|
|
6182
6227
|
"4XX": {
|
|
6183
6228
|
headers: {
|
|
@@ -6259,6 +6304,15 @@ interface operations {
|
|
|
6259
6304
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6260
6305
|
};
|
|
6261
6306
|
};
|
|
6307
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
6308
|
+
409: {
|
|
6309
|
+
headers: {
|
|
6310
|
+
[name: string]: unknown;
|
|
6311
|
+
};
|
|
6312
|
+
content: {
|
|
6313
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6314
|
+
};
|
|
6315
|
+
};
|
|
6262
6316
|
/** @description The provider rejected the charge. */
|
|
6263
6317
|
422: {
|
|
6264
6318
|
headers: {
|
|
@@ -6339,6 +6393,15 @@ interface operations {
|
|
|
6339
6393
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6340
6394
|
};
|
|
6341
6395
|
};
|
|
6396
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
6397
|
+
409: {
|
|
6398
|
+
headers: {
|
|
6399
|
+
[name: string]: unknown;
|
|
6400
|
+
};
|
|
6401
|
+
content: {
|
|
6402
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6403
|
+
};
|
|
6404
|
+
};
|
|
6342
6405
|
/** @description The provider rejected the charge. */
|
|
6343
6406
|
422: {
|
|
6344
6407
|
headers: {
|
|
@@ -9170,7 +9233,8 @@ declare class Balance extends APIResource {
|
|
|
9170
9233
|
declare class Payouts extends APIResource {
|
|
9171
9234
|
create(params: RequestBody<'Payouts_create'>, options?: RequestOptions): Promise<{
|
|
9172
9235
|
payoutId: string;
|
|
9173
|
-
status: "completed" | "pending" | "failed";
|
|
9236
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9237
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9174
9238
|
reference?: string | null;
|
|
9175
9239
|
failureCode?: string | null;
|
|
9176
9240
|
externalRef?: string;
|
|
@@ -9192,7 +9256,8 @@ declare class Payouts extends APIResource {
|
|
|
9192
9256
|
/** Pay out immediately (crédito inmediato). */
|
|
9193
9257
|
createInstant(params: RequestBody<'Payouts_createInstant'>, options?: RequestOptions): Promise<{
|
|
9194
9258
|
payoutId: string;
|
|
9195
|
-
status: "completed" | "pending" | "failed";
|
|
9259
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9260
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9196
9261
|
reference?: string | null;
|
|
9197
9262
|
failureCode?: string | null;
|
|
9198
9263
|
externalRef?: string;
|
|
@@ -9223,7 +9288,8 @@ declare class Payouts extends APIResource {
|
|
|
9223
9288
|
nextCursor?: string | null;
|
|
9224
9289
|
}, {
|
|
9225
9290
|
payoutId: string;
|
|
9226
|
-
status: "completed" | "pending" | "failed";
|
|
9291
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9292
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9227
9293
|
reference?: string | null;
|
|
9228
9294
|
failureCode?: string | null;
|
|
9229
9295
|
externalRef?: string;
|
|
@@ -9244,7 +9310,8 @@ declare class Payouts extends APIResource {
|
|
|
9244
9310
|
}>;
|
|
9245
9311
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
9246
9312
|
payoutId: string;
|
|
9247
|
-
status: "completed" | "pending" | "failed";
|
|
9313
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9314
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9248
9315
|
reference?: string | null;
|
|
9249
9316
|
failureCode?: string | null;
|
|
9250
9317
|
externalRef?: string;
|
|
@@ -9265,7 +9332,8 @@ declare class Payouts extends APIResource {
|
|
|
9265
9332
|
}>;
|
|
9266
9333
|
retrieveByRef(externalRef: string, options?: RequestOptions): Promise<{
|
|
9267
9334
|
payoutId: string;
|
|
9268
|
-
status: "completed" | "pending" | "failed";
|
|
9335
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9336
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9269
9337
|
reference?: string | null;
|
|
9270
9338
|
failureCode?: string | null;
|
|
9271
9339
|
externalRef?: string;
|
|
@@ -9402,6 +9470,8 @@ declare class CheckoutSessions extends APIResource {
|
|
|
9402
9470
|
paymentId?: string | null;
|
|
9403
9471
|
expiresAt: string;
|
|
9404
9472
|
createdAt: string;
|
|
9473
|
+
merchantId?: string | null;
|
|
9474
|
+
applicationFeePercent?: string | null;
|
|
9405
9475
|
livemode: boolean;
|
|
9406
9476
|
}>;
|
|
9407
9477
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
@@ -9423,6 +9493,8 @@ declare class CheckoutSessions extends APIResource {
|
|
|
9423
9493
|
paymentId?: string | null;
|
|
9424
9494
|
expiresAt: string;
|
|
9425
9495
|
createdAt: string;
|
|
9496
|
+
merchantId?: string | null;
|
|
9497
|
+
applicationFeePercent?: string | null;
|
|
9426
9498
|
livemode: boolean;
|
|
9427
9499
|
}>;
|
|
9428
9500
|
}
|
|
@@ -10654,6 +10726,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
10654
10726
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
10655
10727
|
}
|
|
10656
10728
|
|
|
10657
|
-
declare const VERSION = "0.
|
|
10729
|
+
declare const VERSION = "0.11.0";
|
|
10658
10730
|
|
|
10659
10731
|
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -221,10 +221,15 @@ interface components {
|
|
|
221
221
|
*/
|
|
222
222
|
payoutId: string;
|
|
223
223
|
/**
|
|
224
|
-
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id.
|
|
224
|
+
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit`, funds returned) when rejected.
|
|
225
225
|
* @enum {string}
|
|
226
226
|
*/
|
|
227
|
-
status: "completed" | "pending" | "failed";
|
|
227
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
228
|
+
/**
|
|
229
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent).
|
|
230
|
+
* @enum {string}
|
|
231
|
+
*/
|
|
232
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
228
233
|
/** @description Bank reference when available. */
|
|
229
234
|
reference?: string | null;
|
|
230
235
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -288,10 +293,15 @@ interface components {
|
|
|
288
293
|
*/
|
|
289
294
|
payoutId: string;
|
|
290
295
|
/**
|
|
291
|
-
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id.
|
|
296
|
+
* @description `pending` means the credit is still reconciling (AC00); subscribe to payout webhooks or poll GET /v1/payouts/:id. `awaiting_approval` means the funds are reserved but the payout is held for VEX Pay review (see `holdReason`) and has not been sent; it later becomes `pending`/`completed` when approved or `failed` (`rejected_new_account_limit`, funds returned) when rejected.
|
|
292
297
|
* @enum {string}
|
|
293
298
|
*/
|
|
294
|
-
status: "completed" | "pending" | "failed";
|
|
299
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
300
|
+
/**
|
|
301
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent).
|
|
302
|
+
* @enum {string}
|
|
303
|
+
*/
|
|
304
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
295
305
|
/** @description Bank reference when available. */
|
|
296
306
|
reference?: string | null;
|
|
297
307
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -774,7 +784,7 @@ interface components {
|
|
|
774
784
|
*/
|
|
775
785
|
concepto: string;
|
|
776
786
|
/**
|
|
777
|
-
* @description Tenant correlation value for recovery lookup (GET /v1/payments/by-ref/:externalRef). Not an idempotency key.
|
|
787
|
+
* @description Tenant correlation value for recovery lookup (GET /v1/payments/by-ref/:externalRef). Not an idempotency key; a ref that already has a COMPLETED payment is refused (409 external_ref_already_paid).
|
|
778
788
|
* @example fine_736a0b42-0b6e-454c-b87e-7f3c0e47057b
|
|
779
789
|
*/
|
|
780
790
|
externalRef?: string;
|
|
@@ -1617,7 +1627,7 @@ interface components {
|
|
|
1617
1627
|
*/
|
|
1618
1628
|
debtorBankCode: number;
|
|
1619
1629
|
/**
|
|
1620
|
-
* @description Correlation value; not an idempotency key. When present, any other PENDING C2P intent for this tenant + externalRef is canceled (superseded) before the new intent is created.
|
|
1630
|
+
* @description Correlation value; not an idempotency key. A ref that already has a COMPLETED payment is refused (409 external_ref_already_paid). When present, any other PENDING C2P intent for this tenant + externalRef is canceled (superseded) before the new intent is created.
|
|
1621
1631
|
* @example order-1042
|
|
1622
1632
|
*/
|
|
1623
1633
|
externalRef?: string;
|
|
@@ -1811,7 +1821,7 @@ interface components {
|
|
|
1811
1821
|
*/
|
|
1812
1822
|
token: string;
|
|
1813
1823
|
/**
|
|
1814
|
-
* @description Correlation value; not an idempotency key.
|
|
1824
|
+
* @description Correlation value; not an idempotency key. A ref that already has a COMPLETED payment is refused (409 external_ref_already_paid).
|
|
1815
1825
|
* @example order-1042
|
|
1816
1826
|
*/
|
|
1817
1827
|
externalRef?: string;
|
|
@@ -1967,7 +1977,7 @@ interface components {
|
|
|
1967
1977
|
*/
|
|
1968
1978
|
cardType: 1 | 2 | 3;
|
|
1969
1979
|
/**
|
|
1970
|
-
* @description Correlation value; not an idempotency key.
|
|
1980
|
+
* @description Correlation value; not an idempotency key. A ref that already has a COMPLETED payment is refused (409 external_ref_already_paid).
|
|
1971
1981
|
* @example order-1042
|
|
1972
1982
|
*/
|
|
1973
1983
|
externalRef?: string;
|
|
@@ -2375,6 +2385,16 @@ interface components {
|
|
|
2375
2385
|
metadata?: {
|
|
2376
2386
|
[key: string]: string;
|
|
2377
2387
|
};
|
|
2388
|
+
/**
|
|
2389
|
+
* @description Split the payment with one of your merchants (UUID or `mrc_` id). The merchant's share is credited to its VES balance when the payment completes. Only bolívar methods (`c2p`, `pago_movil`, `vpos`) are offered.
|
|
2390
|
+
* @example 3fd84b2d-9ad1-4f74-a2d9-0f2f56984db5
|
|
2391
|
+
*/
|
|
2392
|
+
merchantId?: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* @description Commission percent you keep when `merchantId` is set. Omit to use the merchant's commission, then your default commission.
|
|
2395
|
+
* @example 3
|
|
2396
|
+
*/
|
|
2397
|
+
applicationFeePercent?: number;
|
|
2378
2398
|
};
|
|
2379
2399
|
CheckoutSessionResponseDto: {
|
|
2380
2400
|
/** @example cs_4f0c6f1e2b7d4c1a9e3f5a6b7c8d9e0f */
|
|
@@ -2410,6 +2430,13 @@ interface components {
|
|
|
2410
2430
|
expiresAt: string;
|
|
2411
2431
|
/** Format: date-time */
|
|
2412
2432
|
createdAt: string;
|
|
2433
|
+
/** @description Merchant the payment is split with. */
|
|
2434
|
+
merchantId?: string | null;
|
|
2435
|
+
/**
|
|
2436
|
+
* @description Commission percent set on the session; null = merchant or tenant default at payment time.
|
|
2437
|
+
* @example 3
|
|
2438
|
+
*/
|
|
2439
|
+
applicationFeePercent?: string | null;
|
|
2413
2440
|
/** @description false for test-mode tenants. */
|
|
2414
2441
|
livemode: boolean;
|
|
2415
2442
|
};
|
|
@@ -2912,8 +2939,8 @@ interface operations {
|
|
|
2912
2939
|
Payouts_list: {
|
|
2913
2940
|
parameters: {
|
|
2914
2941
|
query?: {
|
|
2915
|
-
/** @description Optional status filter. */
|
|
2916
|
-
status?: "pending" | "completed" | "failed";
|
|
2942
|
+
/** @description Optional status filter. `awaiting_approval` lists payouts held for VEX Pay review. */
|
|
2943
|
+
status?: "pending" | "awaiting_approval" | "completed" | "failed";
|
|
2917
2944
|
/** @description Opaque cursor from a previous `nextCursor`. */
|
|
2918
2945
|
cursor?: string;
|
|
2919
2946
|
/** @description Page size 1–100 (default 25). */
|
|
@@ -3928,6 +3955,15 @@ interface operations {
|
|
|
3928
3955
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3929
3956
|
};
|
|
3930
3957
|
};
|
|
3958
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
3959
|
+
409: {
|
|
3960
|
+
headers: {
|
|
3961
|
+
[name: string]: unknown;
|
|
3962
|
+
};
|
|
3963
|
+
content: {
|
|
3964
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
3965
|
+
};
|
|
3966
|
+
};
|
|
3931
3967
|
/** @description The banking network rejected the operation. */
|
|
3932
3968
|
422: {
|
|
3933
3969
|
headers: {
|
|
@@ -6178,6 +6214,15 @@ interface operations {
|
|
|
6178
6214
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6179
6215
|
};
|
|
6180
6216
|
};
|
|
6217
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
6218
|
+
409: {
|
|
6219
|
+
headers: {
|
|
6220
|
+
[name: string]: unknown;
|
|
6221
|
+
};
|
|
6222
|
+
content: {
|
|
6223
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6224
|
+
};
|
|
6225
|
+
};
|
|
6181
6226
|
/** @description Client error. */
|
|
6182
6227
|
"4XX": {
|
|
6183
6228
|
headers: {
|
|
@@ -6259,6 +6304,15 @@ interface operations {
|
|
|
6259
6304
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6260
6305
|
};
|
|
6261
6306
|
};
|
|
6307
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
6308
|
+
409: {
|
|
6309
|
+
headers: {
|
|
6310
|
+
[name: string]: unknown;
|
|
6311
|
+
};
|
|
6312
|
+
content: {
|
|
6313
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6314
|
+
};
|
|
6315
|
+
};
|
|
6262
6316
|
/** @description The provider rejected the charge. */
|
|
6263
6317
|
422: {
|
|
6264
6318
|
headers: {
|
|
@@ -6339,6 +6393,15 @@ interface operations {
|
|
|
6339
6393
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6340
6394
|
};
|
|
6341
6395
|
};
|
|
6396
|
+
/** @description externalRef already has a COMPLETED payment (external_ref_already_paid; body includes paymentId). */
|
|
6397
|
+
409: {
|
|
6398
|
+
headers: {
|
|
6399
|
+
[name: string]: unknown;
|
|
6400
|
+
};
|
|
6401
|
+
content: {
|
|
6402
|
+
"application/json": components["schemas"]["ApiErrorDto"];
|
|
6403
|
+
};
|
|
6404
|
+
};
|
|
6342
6405
|
/** @description The provider rejected the charge. */
|
|
6343
6406
|
422: {
|
|
6344
6407
|
headers: {
|
|
@@ -9170,7 +9233,8 @@ declare class Balance extends APIResource {
|
|
|
9170
9233
|
declare class Payouts extends APIResource {
|
|
9171
9234
|
create(params: RequestBody<'Payouts_create'>, options?: RequestOptions): Promise<{
|
|
9172
9235
|
payoutId: string;
|
|
9173
|
-
status: "completed" | "pending" | "failed";
|
|
9236
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9237
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9174
9238
|
reference?: string | null;
|
|
9175
9239
|
failureCode?: string | null;
|
|
9176
9240
|
externalRef?: string;
|
|
@@ -9192,7 +9256,8 @@ declare class Payouts extends APIResource {
|
|
|
9192
9256
|
/** Pay out immediately (crédito inmediato). */
|
|
9193
9257
|
createInstant(params: RequestBody<'Payouts_createInstant'>, options?: RequestOptions): Promise<{
|
|
9194
9258
|
payoutId: string;
|
|
9195
|
-
status: "completed" | "pending" | "failed";
|
|
9259
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9260
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9196
9261
|
reference?: string | null;
|
|
9197
9262
|
failureCode?: string | null;
|
|
9198
9263
|
externalRef?: string;
|
|
@@ -9223,7 +9288,8 @@ declare class Payouts extends APIResource {
|
|
|
9223
9288
|
nextCursor?: string | null;
|
|
9224
9289
|
}, {
|
|
9225
9290
|
payoutId: string;
|
|
9226
|
-
status: "completed" | "pending" | "failed";
|
|
9291
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9292
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9227
9293
|
reference?: string | null;
|
|
9228
9294
|
failureCode?: string | null;
|
|
9229
9295
|
externalRef?: string;
|
|
@@ -9244,7 +9310,8 @@ declare class Payouts extends APIResource {
|
|
|
9244
9310
|
}>;
|
|
9245
9311
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
9246
9312
|
payoutId: string;
|
|
9247
|
-
status: "completed" | "pending" | "failed";
|
|
9313
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9314
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9248
9315
|
reference?: string | null;
|
|
9249
9316
|
failureCode?: string | null;
|
|
9250
9317
|
externalRef?: string;
|
|
@@ -9265,7 +9332,8 @@ declare class Payouts extends APIResource {
|
|
|
9265
9332
|
}>;
|
|
9266
9333
|
retrieveByRef(externalRef: string, options?: RequestOptions): Promise<{
|
|
9267
9334
|
payoutId: string;
|
|
9268
|
-
status: "completed" | "pending" | "failed";
|
|
9335
|
+
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
9336
|
+
holdReason?: "NEW_ACCOUNT_LIMIT";
|
|
9269
9337
|
reference?: string | null;
|
|
9270
9338
|
failureCode?: string | null;
|
|
9271
9339
|
externalRef?: string;
|
|
@@ -9402,6 +9470,8 @@ declare class CheckoutSessions extends APIResource {
|
|
|
9402
9470
|
paymentId?: string | null;
|
|
9403
9471
|
expiresAt: string;
|
|
9404
9472
|
createdAt: string;
|
|
9473
|
+
merchantId?: string | null;
|
|
9474
|
+
applicationFeePercent?: string | null;
|
|
9405
9475
|
livemode: boolean;
|
|
9406
9476
|
}>;
|
|
9407
9477
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
@@ -9423,6 +9493,8 @@ declare class CheckoutSessions extends APIResource {
|
|
|
9423
9493
|
paymentId?: string | null;
|
|
9424
9494
|
expiresAt: string;
|
|
9425
9495
|
createdAt: string;
|
|
9496
|
+
merchantId?: string | null;
|
|
9497
|
+
applicationFeePercent?: string | null;
|
|
9426
9498
|
livemode: boolean;
|
|
9427
9499
|
}>;
|
|
9428
9500
|
}
|
|
@@ -10654,6 +10726,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
10654
10726
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
10655
10727
|
}
|
|
10656
10728
|
|
|
10657
|
-
declare const VERSION = "0.
|
|
10729
|
+
declare const VERSION = "0.11.0";
|
|
10658
10730
|
|
|
10659
10731
|
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 };
|