@vexpay/node 0.18.0 → 0.19.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 +4 -4
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +38 -29
- package/dist/index.d.ts +38 -29
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -251,10 +251,10 @@ interface components {
|
|
|
251
251
|
*/
|
|
252
252
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
253
253
|
/**
|
|
254
|
-
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
254
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `FIRST_PAYOUTS`: the first payout of a seller, or one in its first days of sales, when VEX Pay has turned that review on; rejected with `rejected_first_payouts` and the funds returned. `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
255
255
|
* @enum {string}
|
|
256
256
|
*/
|
|
257
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
257
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
258
258
|
/** @description Bank reference when available. */
|
|
259
259
|
reference?: string | null;
|
|
260
260
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -329,10 +329,10 @@ interface components {
|
|
|
329
329
|
*/
|
|
330
330
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
331
331
|
/**
|
|
332
|
-
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
332
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `FIRST_PAYOUTS`: the first payout of a seller, or one in its first days of sales, when VEX Pay has turned that review on; rejected with `rejected_first_payouts` and the funds returned. `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
333
333
|
* @enum {string}
|
|
334
334
|
*/
|
|
335
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
335
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
336
336
|
/** @description Bank reference when available. */
|
|
337
337
|
reference?: string | null;
|
|
338
338
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -566,7 +566,7 @@ interface components {
|
|
|
566
566
|
cedula: string;
|
|
567
567
|
/**
|
|
568
568
|
* @description Beneficiary Pago Móvil phone (58… or 0…). Required for `pago_movil`.
|
|
569
|
-
* @example
|
|
569
|
+
* @example 584121873562
|
|
570
570
|
*/
|
|
571
571
|
telefono?: string;
|
|
572
572
|
/**
|
|
@@ -712,7 +712,7 @@ interface components {
|
|
|
712
712
|
referencia: string;
|
|
713
713
|
/** @description Per-recipient credit results in request order. */
|
|
714
714
|
credits: {
|
|
715
|
-
/** @example
|
|
715
|
+
/** @example 584121873562 */
|
|
716
716
|
telefono: string;
|
|
717
717
|
/** @example ACCP */
|
|
718
718
|
code: string;
|
|
@@ -803,7 +803,7 @@ interface components {
|
|
|
803
803
|
monto: number;
|
|
804
804
|
/**
|
|
805
805
|
* @description Payer mobile: 58 + 10 digits, or 0 + 10 digits local form.
|
|
806
|
-
* @example
|
|
806
|
+
* @example 584121873562
|
|
807
807
|
*/
|
|
808
808
|
telefono: string;
|
|
809
809
|
/**
|
|
@@ -852,7 +852,7 @@ interface components {
|
|
|
852
852
|
monto: number;
|
|
853
853
|
/**
|
|
854
854
|
* @description Payer mobile: 58 + 10 digits, or 0 + 10 digits local form.
|
|
855
|
-
* @example
|
|
855
|
+
* @example 584121873562
|
|
856
856
|
*/
|
|
857
857
|
telefono: string;
|
|
858
858
|
/**
|
|
@@ -922,7 +922,7 @@ interface components {
|
|
|
922
922
|
cedula: string;
|
|
923
923
|
/**
|
|
924
924
|
* @description Beneficiary Pago Móvil phone (58… or 0…).
|
|
925
|
-
* @example
|
|
925
|
+
* @example 584121873562
|
|
926
926
|
*/
|
|
927
927
|
telefono: string;
|
|
928
928
|
/**
|
|
@@ -971,7 +971,7 @@ interface components {
|
|
|
971
971
|
cedula: string;
|
|
972
972
|
/**
|
|
973
973
|
* @description Recipient Pago Móvil phone.
|
|
974
|
-
* @example
|
|
974
|
+
* @example 584121873562
|
|
975
975
|
*/
|
|
976
976
|
telefono: string;
|
|
977
977
|
/**
|
|
@@ -1043,7 +1043,7 @@ interface components {
|
|
|
1043
1043
|
ChangePaymentDto: {
|
|
1044
1044
|
/**
|
|
1045
1045
|
* @description Customer phone that receives the change (vuelto).
|
|
1046
|
-
* @example
|
|
1046
|
+
* @example 584121873562
|
|
1047
1047
|
*/
|
|
1048
1048
|
telefonoDestino: string;
|
|
1049
1049
|
/**
|
|
@@ -1819,7 +1819,7 @@ interface components {
|
|
|
1819
1819
|
debtorId: string;
|
|
1820
1820
|
/**
|
|
1821
1821
|
* @description Country code 58 followed by 10 digits.
|
|
1822
|
-
* @example
|
|
1822
|
+
* @example 584121873562
|
|
1823
1823
|
*/
|
|
1824
1824
|
debtorCellPhone: string;
|
|
1825
1825
|
/**
|
|
@@ -1987,7 +1987,7 @@ interface components {
|
|
|
1987
1987
|
bankTxId?: number;
|
|
1988
1988
|
/** @example V12345678 */
|
|
1989
1989
|
debtorId?: string;
|
|
1990
|
-
/** @example
|
|
1990
|
+
/** @example 584121873562 */
|
|
1991
1991
|
debtorPhone?: string;
|
|
1992
1992
|
/** @example 102 */
|
|
1993
1993
|
debtorBankCode?: number;
|
|
@@ -2048,7 +2048,7 @@ interface components {
|
|
|
2048
2048
|
vesAmount?: number;
|
|
2049
2049
|
/** @example V12345678 */
|
|
2050
2050
|
debtorId: string;
|
|
2051
|
-
/** @example
|
|
2051
|
+
/** @example 584121873562 */
|
|
2052
2052
|
debtorCellPhone: string;
|
|
2053
2053
|
/**
|
|
2054
2054
|
* @description Venezuelan bank institution code (e.g. 102, 105, 134). Must match a bank from GET /v1/banks.
|
|
@@ -2141,7 +2141,7 @@ interface components {
|
|
|
2141
2141
|
bankTxId?: number;
|
|
2142
2142
|
/** @example V12345678 */
|
|
2143
2143
|
debtorId?: string;
|
|
2144
|
-
/** @example
|
|
2144
|
+
/** @example 584121873562 */
|
|
2145
2145
|
debtorPhone?: string;
|
|
2146
2146
|
/** @example 102 */
|
|
2147
2147
|
debtorBankCode?: number;
|
|
@@ -2280,7 +2280,7 @@ interface components {
|
|
|
2280
2280
|
bankName: string;
|
|
2281
2281
|
/**
|
|
2282
2282
|
* @description Phone the customer sends the Pago Móvil to (11 digits). Null when not configured.
|
|
2283
|
-
* @example
|
|
2283
|
+
* @example 04125550193
|
|
2284
2284
|
*/
|
|
2285
2285
|
phone: string | null;
|
|
2286
2286
|
/**
|
|
@@ -2527,7 +2527,7 @@ interface components {
|
|
|
2527
2527
|
identification: string;
|
|
2528
2528
|
/** @example maria@mail.com */
|
|
2529
2529
|
contactEmail: string;
|
|
2530
|
-
/** @example
|
|
2530
|
+
/** @example 04141873562 */
|
|
2531
2531
|
contactPhone: string;
|
|
2532
2532
|
/**
|
|
2533
2533
|
* @description Optional 4-digit SIMF bank code for the first Pago Móvil payout method. Provide together with phone, or omit both to create a merchant shell with no payout method.
|
|
@@ -2536,7 +2536,7 @@ interface components {
|
|
|
2536
2536
|
bankCode?: string;
|
|
2537
2537
|
/**
|
|
2538
2538
|
* @description Optional 11-digit local Pago Móvil phone for the first payout method. Provide together with bankCode, or omit both.
|
|
2539
|
-
* @example
|
|
2539
|
+
* @example 04145550193
|
|
2540
2540
|
*/
|
|
2541
2541
|
phone?: string;
|
|
2542
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}. */
|
|
@@ -2550,7 +2550,7 @@ interface components {
|
|
|
2550
2550
|
bankCode: string;
|
|
2551
2551
|
/**
|
|
2552
2552
|
* @description 11-digit local Pago Móvil phone
|
|
2553
|
-
* @example
|
|
2553
|
+
* @example 04145550193
|
|
2554
2554
|
*/
|
|
2555
2555
|
phone: string;
|
|
2556
2556
|
};
|
|
@@ -2799,6 +2799,11 @@ interface components {
|
|
|
2799
2799
|
* @example https://shop.example/carrito
|
|
2800
2800
|
*/
|
|
2801
2801
|
cancelUrl?: string;
|
|
2802
|
+
/**
|
|
2803
|
+
* @description Text of the button that takes the buyer to successUrl after paying (default «Continuar»). Plain text, 1–40 characters after trimming, one line. Requires successUrl.
|
|
2804
|
+
* @example Continuar para obtener tu voucher
|
|
2805
|
+
*/
|
|
2806
|
+
successButtonLabel?: string;
|
|
2802
2807
|
/**
|
|
2803
2808
|
* @description Origins allowed to embed this checkout with @vexpay/js. https only; http://localhost:* allowed for test tenants. Omit to allow the hosted URL only.
|
|
2804
2809
|
* @example [
|
|
@@ -2864,6 +2869,8 @@ interface components {
|
|
|
2864
2869
|
methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
|
|
2865
2870
|
successUrl?: string | null;
|
|
2866
2871
|
cancelUrl?: string | null;
|
|
2872
|
+
/** @description Text of the success button; null = default «Continuar». */
|
|
2873
|
+
successButtonLabel?: string | null;
|
|
2867
2874
|
/** @description Latest payment for this session, once one exists. */
|
|
2868
2875
|
paymentId?: string | null;
|
|
2869
2876
|
/** Format: date-time */
|
|
@@ -2975,7 +2982,7 @@ interface components {
|
|
|
2975
2982
|
amountVes: string;
|
|
2976
2983
|
/**
|
|
2977
2984
|
* @description Phone the Pago Móvil is sent from (Venezuelan mobile, 04XXXXXXXXX).
|
|
2978
|
-
* @example
|
|
2985
|
+
* @example 04121873562
|
|
2979
2986
|
*/
|
|
2980
2987
|
payerPhone: string;
|
|
2981
2988
|
/**
|
|
@@ -2995,7 +3002,7 @@ interface components {
|
|
|
2995
3002
|
* @example 0169
|
|
2996
3003
|
*/
|
|
2997
3004
|
bankCode: string;
|
|
2998
|
-
/** @example
|
|
3005
|
+
/** @example 04142093715 */
|
|
2999
3006
|
phone: string;
|
|
3000
3007
|
/** @example J-000000000 */
|
|
3001
3008
|
identification: string;
|
|
@@ -3072,7 +3079,7 @@ interface components {
|
|
|
3072
3079
|
email?: string | null;
|
|
3073
3080
|
/**
|
|
3074
3081
|
* @description Venezuelan mobile; stored as 11 digits starting with 04.
|
|
3075
|
-
* @example
|
|
3082
|
+
* @example 04141873562
|
|
3076
3083
|
*/
|
|
3077
3084
|
phone?: string | null;
|
|
3078
3085
|
/**
|
|
@@ -3126,7 +3133,7 @@ interface components {
|
|
|
3126
3133
|
email?: string | null;
|
|
3127
3134
|
/**
|
|
3128
3135
|
* @description Venezuelan mobile; stored as 11 digits starting with 04.
|
|
3129
|
-
* @example
|
|
3136
|
+
* @example 04141873562
|
|
3130
3137
|
*/
|
|
3131
3138
|
phone?: string | null;
|
|
3132
3139
|
/**
|
|
@@ -13183,7 +13190,7 @@ declare class Payouts extends APIResource {
|
|
|
13183
13190
|
create(params: RequestBody<'Payouts_create'>, options?: RequestOptions): Promise<{
|
|
13184
13191
|
payoutId: string;
|
|
13185
13192
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13186
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13193
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13187
13194
|
reference?: string | null;
|
|
13188
13195
|
failureCode?: string | null;
|
|
13189
13196
|
externalRef?: string;
|
|
@@ -13207,7 +13214,7 @@ declare class Payouts extends APIResource {
|
|
|
13207
13214
|
createInstant(params: RequestBody<'Payouts_createInstant'>, options?: RequestOptions): Promise<{
|
|
13208
13215
|
payoutId: string;
|
|
13209
13216
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13210
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13217
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13211
13218
|
reference?: string | null;
|
|
13212
13219
|
failureCode?: string | null;
|
|
13213
13220
|
externalRef?: string;
|
|
@@ -13240,7 +13247,7 @@ declare class Payouts extends APIResource {
|
|
|
13240
13247
|
}, {
|
|
13241
13248
|
payoutId: string;
|
|
13242
13249
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13243
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13250
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13244
13251
|
reference?: string | null;
|
|
13245
13252
|
failureCode?: string | null;
|
|
13246
13253
|
externalRef?: string;
|
|
@@ -13263,7 +13270,7 @@ declare class Payouts extends APIResource {
|
|
|
13263
13270
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
13264
13271
|
payoutId: string;
|
|
13265
13272
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13266
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13273
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13267
13274
|
reference?: string | null;
|
|
13268
13275
|
failureCode?: string | null;
|
|
13269
13276
|
externalRef?: string;
|
|
@@ -13286,7 +13293,7 @@ declare class Payouts extends APIResource {
|
|
|
13286
13293
|
retrieveByRef(externalRef: string, options?: RequestOptions): Promise<{
|
|
13287
13294
|
payoutId: string;
|
|
13288
13295
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13289
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13296
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13290
13297
|
reference?: string | null;
|
|
13291
13298
|
failureCode?: string | null;
|
|
13292
13299
|
externalRef?: string;
|
|
@@ -13983,6 +13990,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
13983
13990
|
methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
|
|
13984
13991
|
successUrl?: string | null;
|
|
13985
13992
|
cancelUrl?: string | null;
|
|
13993
|
+
successButtonLabel?: string | null;
|
|
13986
13994
|
paymentId?: string | null;
|
|
13987
13995
|
expiresAt: string;
|
|
13988
13996
|
createdAt: string;
|
|
@@ -14007,6 +14015,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
14007
14015
|
methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
|
|
14008
14016
|
successUrl?: string | null;
|
|
14009
14017
|
cancelUrl?: string | null;
|
|
14018
|
+
successButtonLabel?: string | null;
|
|
14010
14019
|
paymentId?: string | null;
|
|
14011
14020
|
expiresAt: string;
|
|
14012
14021
|
createdAt: string;
|
|
@@ -15350,6 +15359,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
15350
15359
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
15351
15360
|
}
|
|
15352
15361
|
|
|
15353
|
-
declare const VERSION = "0.
|
|
15362
|
+
declare const VERSION = "0.19.0";
|
|
15354
15363
|
|
|
15355
15364
|
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
|
@@ -251,10 +251,10 @@ interface components {
|
|
|
251
251
|
*/
|
|
252
252
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
253
253
|
/**
|
|
254
|
-
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
254
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `FIRST_PAYOUTS`: the first payout of a seller, or one in its first days of sales, when VEX Pay has turned that review on; rejected with `rejected_first_payouts` and the funds returned. `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
255
255
|
* @enum {string}
|
|
256
256
|
*/
|
|
257
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
257
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
258
258
|
/** @description Bank reference when available. */
|
|
259
259
|
reference?: string | null;
|
|
260
260
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -329,10 +329,10 @@ interface components {
|
|
|
329
329
|
*/
|
|
330
330
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
331
331
|
/**
|
|
332
|
-
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
332
|
+
* @description Why the payout was held for review. `NEW_ACCOUNT_LIMIT`: the tenant or merchant is new (first 30 days) and this payout would take its rolling 24h money-out above the new-account cap (default US$300 equivalent). `FIRST_PAYOUTS`: the first payout of a seller, or one in its first days of sales, when VEX Pay has turned that review on; rejected with `rejected_first_payouts` and the funds returned. `BANK_UNFUNDED`: VEX Pay could not send the transfer right away on its side; it is sent once reviewed, or rejected with `rejected_bank_unfunded` and the funds returned.
|
|
333
333
|
* @enum {string}
|
|
334
334
|
*/
|
|
335
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
335
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
336
336
|
/** @description Bank reference when available. */
|
|
337
337
|
reference?: string | null;
|
|
338
338
|
/** @description Machine-readable failure when status is failed (e.g. merchant_inactive, payout_method_not_verified). */
|
|
@@ -566,7 +566,7 @@ interface components {
|
|
|
566
566
|
cedula: string;
|
|
567
567
|
/**
|
|
568
568
|
* @description Beneficiary Pago Móvil phone (58… or 0…). Required for `pago_movil`.
|
|
569
|
-
* @example
|
|
569
|
+
* @example 584121873562
|
|
570
570
|
*/
|
|
571
571
|
telefono?: string;
|
|
572
572
|
/**
|
|
@@ -712,7 +712,7 @@ interface components {
|
|
|
712
712
|
referencia: string;
|
|
713
713
|
/** @description Per-recipient credit results in request order. */
|
|
714
714
|
credits: {
|
|
715
|
-
/** @example
|
|
715
|
+
/** @example 584121873562 */
|
|
716
716
|
telefono: string;
|
|
717
717
|
/** @example ACCP */
|
|
718
718
|
code: string;
|
|
@@ -803,7 +803,7 @@ interface components {
|
|
|
803
803
|
monto: number;
|
|
804
804
|
/**
|
|
805
805
|
* @description Payer mobile: 58 + 10 digits, or 0 + 10 digits local form.
|
|
806
|
-
* @example
|
|
806
|
+
* @example 584121873562
|
|
807
807
|
*/
|
|
808
808
|
telefono: string;
|
|
809
809
|
/**
|
|
@@ -852,7 +852,7 @@ interface components {
|
|
|
852
852
|
monto: number;
|
|
853
853
|
/**
|
|
854
854
|
* @description Payer mobile: 58 + 10 digits, or 0 + 10 digits local form.
|
|
855
|
-
* @example
|
|
855
|
+
* @example 584121873562
|
|
856
856
|
*/
|
|
857
857
|
telefono: string;
|
|
858
858
|
/**
|
|
@@ -922,7 +922,7 @@ interface components {
|
|
|
922
922
|
cedula: string;
|
|
923
923
|
/**
|
|
924
924
|
* @description Beneficiary Pago Móvil phone (58… or 0…).
|
|
925
|
-
* @example
|
|
925
|
+
* @example 584121873562
|
|
926
926
|
*/
|
|
927
927
|
telefono: string;
|
|
928
928
|
/**
|
|
@@ -971,7 +971,7 @@ interface components {
|
|
|
971
971
|
cedula: string;
|
|
972
972
|
/**
|
|
973
973
|
* @description Recipient Pago Móvil phone.
|
|
974
|
-
* @example
|
|
974
|
+
* @example 584121873562
|
|
975
975
|
*/
|
|
976
976
|
telefono: string;
|
|
977
977
|
/**
|
|
@@ -1043,7 +1043,7 @@ interface components {
|
|
|
1043
1043
|
ChangePaymentDto: {
|
|
1044
1044
|
/**
|
|
1045
1045
|
* @description Customer phone that receives the change (vuelto).
|
|
1046
|
-
* @example
|
|
1046
|
+
* @example 584121873562
|
|
1047
1047
|
*/
|
|
1048
1048
|
telefonoDestino: string;
|
|
1049
1049
|
/**
|
|
@@ -1819,7 +1819,7 @@ interface components {
|
|
|
1819
1819
|
debtorId: string;
|
|
1820
1820
|
/**
|
|
1821
1821
|
* @description Country code 58 followed by 10 digits.
|
|
1822
|
-
* @example
|
|
1822
|
+
* @example 584121873562
|
|
1823
1823
|
*/
|
|
1824
1824
|
debtorCellPhone: string;
|
|
1825
1825
|
/**
|
|
@@ -1987,7 +1987,7 @@ interface components {
|
|
|
1987
1987
|
bankTxId?: number;
|
|
1988
1988
|
/** @example V12345678 */
|
|
1989
1989
|
debtorId?: string;
|
|
1990
|
-
/** @example
|
|
1990
|
+
/** @example 584121873562 */
|
|
1991
1991
|
debtorPhone?: string;
|
|
1992
1992
|
/** @example 102 */
|
|
1993
1993
|
debtorBankCode?: number;
|
|
@@ -2048,7 +2048,7 @@ interface components {
|
|
|
2048
2048
|
vesAmount?: number;
|
|
2049
2049
|
/** @example V12345678 */
|
|
2050
2050
|
debtorId: string;
|
|
2051
|
-
/** @example
|
|
2051
|
+
/** @example 584121873562 */
|
|
2052
2052
|
debtorCellPhone: string;
|
|
2053
2053
|
/**
|
|
2054
2054
|
* @description Venezuelan bank institution code (e.g. 102, 105, 134). Must match a bank from GET /v1/banks.
|
|
@@ -2141,7 +2141,7 @@ interface components {
|
|
|
2141
2141
|
bankTxId?: number;
|
|
2142
2142
|
/** @example V12345678 */
|
|
2143
2143
|
debtorId?: string;
|
|
2144
|
-
/** @example
|
|
2144
|
+
/** @example 584121873562 */
|
|
2145
2145
|
debtorPhone?: string;
|
|
2146
2146
|
/** @example 102 */
|
|
2147
2147
|
debtorBankCode?: number;
|
|
@@ -2280,7 +2280,7 @@ interface components {
|
|
|
2280
2280
|
bankName: string;
|
|
2281
2281
|
/**
|
|
2282
2282
|
* @description Phone the customer sends the Pago Móvil to (11 digits). Null when not configured.
|
|
2283
|
-
* @example
|
|
2283
|
+
* @example 04125550193
|
|
2284
2284
|
*/
|
|
2285
2285
|
phone: string | null;
|
|
2286
2286
|
/**
|
|
@@ -2527,7 +2527,7 @@ interface components {
|
|
|
2527
2527
|
identification: string;
|
|
2528
2528
|
/** @example maria@mail.com */
|
|
2529
2529
|
contactEmail: string;
|
|
2530
|
-
/** @example
|
|
2530
|
+
/** @example 04141873562 */
|
|
2531
2531
|
contactPhone: string;
|
|
2532
2532
|
/**
|
|
2533
2533
|
* @description Optional 4-digit SIMF bank code for the first Pago Móvil payout method. Provide together with phone, or omit both to create a merchant shell with no payout method.
|
|
@@ -2536,7 +2536,7 @@ interface components {
|
|
|
2536
2536
|
bankCode?: string;
|
|
2537
2537
|
/**
|
|
2538
2538
|
* @description Optional 11-digit local Pago Móvil phone for the first payout method. Provide together with bankCode, or omit both.
|
|
2539
|
-
* @example
|
|
2539
|
+
* @example 04145550193
|
|
2540
2540
|
*/
|
|
2541
2541
|
phone?: string;
|
|
2542
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}. */
|
|
@@ -2550,7 +2550,7 @@ interface components {
|
|
|
2550
2550
|
bankCode: string;
|
|
2551
2551
|
/**
|
|
2552
2552
|
* @description 11-digit local Pago Móvil phone
|
|
2553
|
-
* @example
|
|
2553
|
+
* @example 04145550193
|
|
2554
2554
|
*/
|
|
2555
2555
|
phone: string;
|
|
2556
2556
|
};
|
|
@@ -2799,6 +2799,11 @@ interface components {
|
|
|
2799
2799
|
* @example https://shop.example/carrito
|
|
2800
2800
|
*/
|
|
2801
2801
|
cancelUrl?: string;
|
|
2802
|
+
/**
|
|
2803
|
+
* @description Text of the button that takes the buyer to successUrl after paying (default «Continuar»). Plain text, 1–40 characters after trimming, one line. Requires successUrl.
|
|
2804
|
+
* @example Continuar para obtener tu voucher
|
|
2805
|
+
*/
|
|
2806
|
+
successButtonLabel?: string;
|
|
2802
2807
|
/**
|
|
2803
2808
|
* @description Origins allowed to embed this checkout with @vexpay/js. https only; http://localhost:* allowed for test tenants. Omit to allow the hosted URL only.
|
|
2804
2809
|
* @example [
|
|
@@ -2864,6 +2869,8 @@ interface components {
|
|
|
2864
2869
|
methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
|
|
2865
2870
|
successUrl?: string | null;
|
|
2866
2871
|
cancelUrl?: string | null;
|
|
2872
|
+
/** @description Text of the success button; null = default «Continuar». */
|
|
2873
|
+
successButtonLabel?: string | null;
|
|
2867
2874
|
/** @description Latest payment for this session, once one exists. */
|
|
2868
2875
|
paymentId?: string | null;
|
|
2869
2876
|
/** Format: date-time */
|
|
@@ -2975,7 +2982,7 @@ interface components {
|
|
|
2975
2982
|
amountVes: string;
|
|
2976
2983
|
/**
|
|
2977
2984
|
* @description Phone the Pago Móvil is sent from (Venezuelan mobile, 04XXXXXXXXX).
|
|
2978
|
-
* @example
|
|
2985
|
+
* @example 04121873562
|
|
2979
2986
|
*/
|
|
2980
2987
|
payerPhone: string;
|
|
2981
2988
|
/**
|
|
@@ -2995,7 +3002,7 @@ interface components {
|
|
|
2995
3002
|
* @example 0169
|
|
2996
3003
|
*/
|
|
2997
3004
|
bankCode: string;
|
|
2998
|
-
/** @example
|
|
3005
|
+
/** @example 04142093715 */
|
|
2999
3006
|
phone: string;
|
|
3000
3007
|
/** @example J-000000000 */
|
|
3001
3008
|
identification: string;
|
|
@@ -3072,7 +3079,7 @@ interface components {
|
|
|
3072
3079
|
email?: string | null;
|
|
3073
3080
|
/**
|
|
3074
3081
|
* @description Venezuelan mobile; stored as 11 digits starting with 04.
|
|
3075
|
-
* @example
|
|
3082
|
+
* @example 04141873562
|
|
3076
3083
|
*/
|
|
3077
3084
|
phone?: string | null;
|
|
3078
3085
|
/**
|
|
@@ -3126,7 +3133,7 @@ interface components {
|
|
|
3126
3133
|
email?: string | null;
|
|
3127
3134
|
/**
|
|
3128
3135
|
* @description Venezuelan mobile; stored as 11 digits starting with 04.
|
|
3129
|
-
* @example
|
|
3136
|
+
* @example 04141873562
|
|
3130
3137
|
*/
|
|
3131
3138
|
phone?: string | null;
|
|
3132
3139
|
/**
|
|
@@ -13183,7 +13190,7 @@ declare class Payouts extends APIResource {
|
|
|
13183
13190
|
create(params: RequestBody<'Payouts_create'>, options?: RequestOptions): Promise<{
|
|
13184
13191
|
payoutId: string;
|
|
13185
13192
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13186
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13193
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13187
13194
|
reference?: string | null;
|
|
13188
13195
|
failureCode?: string | null;
|
|
13189
13196
|
externalRef?: string;
|
|
@@ -13207,7 +13214,7 @@ declare class Payouts extends APIResource {
|
|
|
13207
13214
|
createInstant(params: RequestBody<'Payouts_createInstant'>, options?: RequestOptions): Promise<{
|
|
13208
13215
|
payoutId: string;
|
|
13209
13216
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13210
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13217
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13211
13218
|
reference?: string | null;
|
|
13212
13219
|
failureCode?: string | null;
|
|
13213
13220
|
externalRef?: string;
|
|
@@ -13240,7 +13247,7 @@ declare class Payouts extends APIResource {
|
|
|
13240
13247
|
}, {
|
|
13241
13248
|
payoutId: string;
|
|
13242
13249
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13243
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13250
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13244
13251
|
reference?: string | null;
|
|
13245
13252
|
failureCode?: string | null;
|
|
13246
13253
|
externalRef?: string;
|
|
@@ -13263,7 +13270,7 @@ declare class Payouts extends APIResource {
|
|
|
13263
13270
|
retrieve(id: string, options?: RequestOptions): Promise<{
|
|
13264
13271
|
payoutId: string;
|
|
13265
13272
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13266
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13273
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13267
13274
|
reference?: string | null;
|
|
13268
13275
|
failureCode?: string | null;
|
|
13269
13276
|
externalRef?: string;
|
|
@@ -13286,7 +13293,7 @@ declare class Payouts extends APIResource {
|
|
|
13286
13293
|
retrieveByRef(externalRef: string, options?: RequestOptions): Promise<{
|
|
13287
13294
|
payoutId: string;
|
|
13288
13295
|
status: "completed" | "pending" | "failed" | "awaiting_approval";
|
|
13289
|
-
holdReason?: "NEW_ACCOUNT_LIMIT" | "BANK_UNFUNDED";
|
|
13296
|
+
holdReason?: "NEW_ACCOUNT_LIMIT" | "FIRST_PAYOUTS" | "BANK_UNFUNDED";
|
|
13290
13297
|
reference?: string | null;
|
|
13291
13298
|
failureCode?: string | null;
|
|
13292
13299
|
externalRef?: string;
|
|
@@ -13983,6 +13990,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
13983
13990
|
methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
|
|
13984
13991
|
successUrl?: string | null;
|
|
13985
13992
|
cancelUrl?: string | null;
|
|
13993
|
+
successButtonLabel?: string | null;
|
|
13986
13994
|
paymentId?: string | null;
|
|
13987
13995
|
expiresAt: string;
|
|
13988
13996
|
createdAt: string;
|
|
@@ -14007,6 +14015,7 @@ declare class CheckoutSessions extends APIResource {
|
|
|
14007
14015
|
methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
|
|
14008
14016
|
successUrl?: string | null;
|
|
14009
14017
|
cancelUrl?: string | null;
|
|
14018
|
+
successButtonLabel?: string | null;
|
|
14010
14019
|
paymentId?: string | null;
|
|
14011
14020
|
expiresAt: string;
|
|
14012
14021
|
createdAt: string;
|
|
@@ -15350,6 +15359,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
|
|
|
15350
15359
|
declare class VexPaySignatureVerificationError extends VexPayError {
|
|
15351
15360
|
}
|
|
15352
15361
|
|
|
15353
|
-
declare const VERSION = "0.
|
|
15362
|
+
declare const VERSION = "0.19.0";
|
|
15354
15363
|
|
|
15355
15364
|
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 };
|