@vexpay/node 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1520,8 +1520,16 @@ interface components {
1520
1520
  };
1521
1521
  };
1522
1522
  C2pRequestDto: {
1523
- /** @example 25 */
1524
- usdAmount: number;
1523
+ /**
1524
+ * @description USD amount. Required unless vesAmount is set. When only usdAmount is set, VES is derived at the live BCV rate.
1525
+ * @example 25
1526
+ */
1527
+ usdAmount?: number;
1528
+ /**
1529
+ * @description VES amount debited at the bank. When set, locks the bolívar charge and derives USD at BCV (it wins over usdAmount). The intent keeps this amount until it is executed.
1530
+ * @example 50
1531
+ */
1532
+ vesAmount?: number;
1525
1533
  /** @example V12345678 */
1526
1534
  debtorId: string;
1527
1535
  /**
@@ -1639,8 +1647,16 @@ interface components {
1639
1647
  * @description Pending intent returned by POST /v1/payments/c2p/request.
1640
1648
  */
1641
1649
  intentId?: string;
1642
- /** @example 25 */
1643
- usdAmount: number;
1650
+ /**
1651
+ * @description USD amount. Required unless vesAmount or intentId is set. When only usdAmount is set, VES is derived at the live BCV rate.
1652
+ * @example 25
1653
+ */
1654
+ usdAmount?: number;
1655
+ /**
1656
+ * @description VES amount debited at the bank. When set, locks the bolívar charge and derives USD at BCV (it wins over usdAmount). With intentId the amount locked on the intent is charged; amounts sent here must match it (±0.01 Bs / ±$0.01).
1657
+ * @example 50
1658
+ */
1659
+ vesAmount?: number;
1644
1660
  /** @example V12345678 */
1645
1661
  debtorId: string;
1646
1662
  /** @example 584121234567 */
@@ -1811,6 +1827,25 @@ interface components {
1811
1827
  */
1812
1828
  applicationFeePercent?: number;
1813
1829
  };
1830
+ PaymentMethodAvailabilityDto: {
1831
+ /**
1832
+ * @description `pago_movil`: the customer sends a Pago Móvil (verify). `c2p`: bank debit with the customer's OTP. `vpos`: card.
1833
+ * @enum {string}
1834
+ */
1835
+ method: "pago_movil" | "c2p" | "vpos";
1836
+ /** @description Whether your account can take this method right now. */
1837
+ available: boolean;
1838
+ /**
1839
+ * @description Only when available is false. `not_enabled`: the method is not enabled on your account. `receiving_account_not_configured`: Pago Móvil receiving details are not set up yet. `provider_not_configured`: temporarily unavailable in this mode — contact support.
1840
+ * @enum {string}
1841
+ */
1842
+ reason?: "not_enabled" | "receiving_account_not_configured" | "provider_not_configured";
1843
+ };
1844
+ PaymentMethodsResponseDto: {
1845
+ /** @description false for test keys. */
1846
+ livemode: boolean;
1847
+ methods: components["schemas"]["PaymentMethodAvailabilityDto"][];
1848
+ };
1814
1849
  PagoMovilReceivingAccountDto: {
1815
1850
  /**
1816
1851
  * @description Provider Pago Móvil verify uses for this tenant (same routing as POST /v1/payments/pago-movil/verify).
@@ -2136,8 +2171,8 @@ interface components {
2136
2171
  * ]
2137
2172
  */
2138
2173
  allowedOrigins?: string[];
2139
- /** @description Payment methods offered. Defaults to every method your account can accept. `cop` (Colombian pesos: Bre-B, Nequi, Daviplata) needs the COP method on your account. */
2140
- methods?: ("c2p" | "vpos" | "usdt" | "usdc" | "cop")[];
2174
+ /** @description Payment methods offered. Defaults to every method your account can accept. `c2p` is the bank pull shown as Débito Inmediato; `pago_movil` is a Pago Móvil the buyer sends from their bank app (needs Pago Móvil enabled on your account). `cop` (Colombian pesos: Bre-B, Nequi, Daviplata) needs the COP method on your account. */
2175
+ methods?: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
2141
2176
  /**
2142
2177
  * @description Up to 20 string key/value pairs (keys ≤ 40 chars, values ≤ 500 chars).
2143
2178
  * @example {
@@ -2173,7 +2208,7 @@ interface components {
2173
2208
  [key: string]: string;
2174
2209
  };
2175
2210
  allowedOrigins: string[];
2176
- methods: ("c2p" | "vpos" | "usdt" | "usdc" | "cop")[];
2211
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
2177
2212
  successUrl?: string | null;
2178
2213
  cancelUrl?: string | null;
2179
2214
  /** @description Latest payment for this session, once one exists. */
@@ -6149,6 +6184,70 @@ interface operations {
6149
6184
  };
6150
6185
  };
6151
6186
  };
6187
+ Payments_listPaymentMethods: {
6188
+ parameters: {
6189
+ query?: never;
6190
+ header?: never;
6191
+ path?: never;
6192
+ cookie?: never;
6193
+ };
6194
+ requestBody?: never;
6195
+ responses: {
6196
+ 200: {
6197
+ headers: {
6198
+ [name: string]: unknown;
6199
+ };
6200
+ content: {
6201
+ "application/json": components["schemas"]["PaymentMethodsResponseDto"];
6202
+ };
6203
+ };
6204
+ /** @description Invalid request or unsupported operation. */
6205
+ 400: {
6206
+ headers: {
6207
+ [name: string]: unknown;
6208
+ };
6209
+ content: {
6210
+ "application/json": components["schemas"]["ApiErrorDto"];
6211
+ };
6212
+ };
6213
+ /** @description Missing, invalid, or inactive tenant API key. */
6214
+ 401: {
6215
+ headers: {
6216
+ [name: string]: unknown;
6217
+ };
6218
+ content: {
6219
+ "application/json": components["schemas"]["ApiErrorDto"];
6220
+ };
6221
+ };
6222
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
6223
+ 403: {
6224
+ headers: {
6225
+ [name: string]: unknown;
6226
+ };
6227
+ content: {
6228
+ "application/json": components["schemas"]["ApiErrorDto"];
6229
+ };
6230
+ };
6231
+ /** @description Client error. */
6232
+ "4XX": {
6233
+ headers: {
6234
+ [name: string]: unknown;
6235
+ };
6236
+ content: {
6237
+ "application/json": components["schemas"]["ApiErrorDto"];
6238
+ };
6239
+ };
6240
+ /** @description Server or upstream bank error. */
6241
+ "5XX": {
6242
+ headers: {
6243
+ [name: string]: unknown;
6244
+ };
6245
+ content: {
6246
+ "application/json": components["schemas"]["ApiErrorDto"];
6247
+ };
6248
+ };
6249
+ };
6250
+ };
6152
6251
  Payments_getPagoMovilReceivingAccount: {
6153
6252
  parameters: {
6154
6253
  query?: never;
@@ -9089,7 +9188,7 @@ declare class CheckoutSessions extends APIResource {
9089
9188
  [key: string]: string;
9090
9189
  };
9091
9190
  allowedOrigins: string[];
9092
- methods: ("c2p" | "vpos" | "usdt" | "usdc" | "cop")[];
9191
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
9093
9192
  successUrl?: string | null;
9094
9193
  cancelUrl?: string | null;
9095
9194
  paymentId?: string | null;
@@ -9110,7 +9209,7 @@ declare class CheckoutSessions extends APIResource {
9110
9209
  [key: string]: string;
9111
9210
  };
9112
9211
  allowedOrigins: string[];
9113
- methods: ("c2p" | "vpos" | "usdt" | "usdc" | "cop")[];
9212
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
9114
9213
  successUrl?: string | null;
9115
9214
  cancelUrl?: string | null;
9116
9215
  paymentId?: string | null;
@@ -10031,6 +10130,11 @@ declare class Payments extends APIResource {
10031
10130
  readonly operations: Operations;
10032
10131
  readonly dispersals: Dispersals;
10033
10132
  readonly change: Change;
10133
+ /** Bolívar methods your account can take now (`pago_movil`, `c2p`, `vpos`), with a reason when unavailable. */
10134
+ methods(options?: RequestOptions): Promise<{
10135
+ livemode: boolean;
10136
+ methods: components["schemas"]["PaymentMethodAvailabilityDto"][];
10137
+ }>;
10034
10138
  retrieve(id: string, options?: RequestOptions): Promise<{
10035
10139
  paymentId: string;
10036
10140
  externalRef?: string;
@@ -10309,6 +10413,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
10309
10413
  declare class VexPaySignatureVerificationError extends VexPayError {
10310
10414
  }
10311
10415
 
10312
- declare const VERSION = "0.7.0";
10416
+ declare const VERSION = "0.8.0";
10313
10417
 
10314
10418
  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
@@ -1520,8 +1520,16 @@ interface components {
1520
1520
  };
1521
1521
  };
1522
1522
  C2pRequestDto: {
1523
- /** @example 25 */
1524
- usdAmount: number;
1523
+ /**
1524
+ * @description USD amount. Required unless vesAmount is set. When only usdAmount is set, VES is derived at the live BCV rate.
1525
+ * @example 25
1526
+ */
1527
+ usdAmount?: number;
1528
+ /**
1529
+ * @description VES amount debited at the bank. When set, locks the bolívar charge and derives USD at BCV (it wins over usdAmount). The intent keeps this amount until it is executed.
1530
+ * @example 50
1531
+ */
1532
+ vesAmount?: number;
1525
1533
  /** @example V12345678 */
1526
1534
  debtorId: string;
1527
1535
  /**
@@ -1639,8 +1647,16 @@ interface components {
1639
1647
  * @description Pending intent returned by POST /v1/payments/c2p/request.
1640
1648
  */
1641
1649
  intentId?: string;
1642
- /** @example 25 */
1643
- usdAmount: number;
1650
+ /**
1651
+ * @description USD amount. Required unless vesAmount or intentId is set. When only usdAmount is set, VES is derived at the live BCV rate.
1652
+ * @example 25
1653
+ */
1654
+ usdAmount?: number;
1655
+ /**
1656
+ * @description VES amount debited at the bank. When set, locks the bolívar charge and derives USD at BCV (it wins over usdAmount). With intentId the amount locked on the intent is charged; amounts sent here must match it (±0.01 Bs / ±$0.01).
1657
+ * @example 50
1658
+ */
1659
+ vesAmount?: number;
1644
1660
  /** @example V12345678 */
1645
1661
  debtorId: string;
1646
1662
  /** @example 584121234567 */
@@ -1811,6 +1827,25 @@ interface components {
1811
1827
  */
1812
1828
  applicationFeePercent?: number;
1813
1829
  };
1830
+ PaymentMethodAvailabilityDto: {
1831
+ /**
1832
+ * @description `pago_movil`: the customer sends a Pago Móvil (verify). `c2p`: bank debit with the customer's OTP. `vpos`: card.
1833
+ * @enum {string}
1834
+ */
1835
+ method: "pago_movil" | "c2p" | "vpos";
1836
+ /** @description Whether your account can take this method right now. */
1837
+ available: boolean;
1838
+ /**
1839
+ * @description Only when available is false. `not_enabled`: the method is not enabled on your account. `receiving_account_not_configured`: Pago Móvil receiving details are not set up yet. `provider_not_configured`: temporarily unavailable in this mode — contact support.
1840
+ * @enum {string}
1841
+ */
1842
+ reason?: "not_enabled" | "receiving_account_not_configured" | "provider_not_configured";
1843
+ };
1844
+ PaymentMethodsResponseDto: {
1845
+ /** @description false for test keys. */
1846
+ livemode: boolean;
1847
+ methods: components["schemas"]["PaymentMethodAvailabilityDto"][];
1848
+ };
1814
1849
  PagoMovilReceivingAccountDto: {
1815
1850
  /**
1816
1851
  * @description Provider Pago Móvil verify uses for this tenant (same routing as POST /v1/payments/pago-movil/verify).
@@ -2136,8 +2171,8 @@ interface components {
2136
2171
  * ]
2137
2172
  */
2138
2173
  allowedOrigins?: string[];
2139
- /** @description Payment methods offered. Defaults to every method your account can accept. `cop` (Colombian pesos: Bre-B, Nequi, Daviplata) needs the COP method on your account. */
2140
- methods?: ("c2p" | "vpos" | "usdt" | "usdc" | "cop")[];
2174
+ /** @description Payment methods offered. Defaults to every method your account can accept. `c2p` is the bank pull shown as Débito Inmediato; `pago_movil` is a Pago Móvil the buyer sends from their bank app (needs Pago Móvil enabled on your account). `cop` (Colombian pesos: Bre-B, Nequi, Daviplata) needs the COP method on your account. */
2175
+ methods?: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
2141
2176
  /**
2142
2177
  * @description Up to 20 string key/value pairs (keys ≤ 40 chars, values ≤ 500 chars).
2143
2178
  * @example {
@@ -2173,7 +2208,7 @@ interface components {
2173
2208
  [key: string]: string;
2174
2209
  };
2175
2210
  allowedOrigins: string[];
2176
- methods: ("c2p" | "vpos" | "usdt" | "usdc" | "cop")[];
2211
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
2177
2212
  successUrl?: string | null;
2178
2213
  cancelUrl?: string | null;
2179
2214
  /** @description Latest payment for this session, once one exists. */
@@ -6149,6 +6184,70 @@ interface operations {
6149
6184
  };
6150
6185
  };
6151
6186
  };
6187
+ Payments_listPaymentMethods: {
6188
+ parameters: {
6189
+ query?: never;
6190
+ header?: never;
6191
+ path?: never;
6192
+ cookie?: never;
6193
+ };
6194
+ requestBody?: never;
6195
+ responses: {
6196
+ 200: {
6197
+ headers: {
6198
+ [name: string]: unknown;
6199
+ };
6200
+ content: {
6201
+ "application/json": components["schemas"]["PaymentMethodsResponseDto"];
6202
+ };
6203
+ };
6204
+ /** @description Invalid request or unsupported operation. */
6205
+ 400: {
6206
+ headers: {
6207
+ [name: string]: unknown;
6208
+ };
6209
+ content: {
6210
+ "application/json": components["schemas"]["ApiErrorDto"];
6211
+ };
6212
+ };
6213
+ /** @description Missing, invalid, or inactive tenant API key. */
6214
+ 401: {
6215
+ headers: {
6216
+ [name: string]: unknown;
6217
+ };
6218
+ content: {
6219
+ "application/json": components["schemas"]["ApiErrorDto"];
6220
+ };
6221
+ };
6222
+ /** @description Live mode not activated (`live_mode_not_activated`): the live account is pending VEX Pay review or suspended. Test keys are unaffected. */
6223
+ 403: {
6224
+ headers: {
6225
+ [name: string]: unknown;
6226
+ };
6227
+ content: {
6228
+ "application/json": components["schemas"]["ApiErrorDto"];
6229
+ };
6230
+ };
6231
+ /** @description Client error. */
6232
+ "4XX": {
6233
+ headers: {
6234
+ [name: string]: unknown;
6235
+ };
6236
+ content: {
6237
+ "application/json": components["schemas"]["ApiErrorDto"];
6238
+ };
6239
+ };
6240
+ /** @description Server or upstream bank error. */
6241
+ "5XX": {
6242
+ headers: {
6243
+ [name: string]: unknown;
6244
+ };
6245
+ content: {
6246
+ "application/json": components["schemas"]["ApiErrorDto"];
6247
+ };
6248
+ };
6249
+ };
6250
+ };
6152
6251
  Payments_getPagoMovilReceivingAccount: {
6153
6252
  parameters: {
6154
6253
  query?: never;
@@ -9089,7 +9188,7 @@ declare class CheckoutSessions extends APIResource {
9089
9188
  [key: string]: string;
9090
9189
  };
9091
9190
  allowedOrigins: string[];
9092
- methods: ("c2p" | "vpos" | "usdt" | "usdc" | "cop")[];
9191
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
9093
9192
  successUrl?: string | null;
9094
9193
  cancelUrl?: string | null;
9095
9194
  paymentId?: string | null;
@@ -9110,7 +9209,7 @@ declare class CheckoutSessions extends APIResource {
9110
9209
  [key: string]: string;
9111
9210
  };
9112
9211
  allowedOrigins: string[];
9113
- methods: ("c2p" | "vpos" | "usdt" | "usdc" | "cop")[];
9212
+ methods: ("c2p" | "pago_movil" | "vpos" | "usdt" | "usdc" | "cop")[];
9114
9213
  successUrl?: string | null;
9115
9214
  cancelUrl?: string | null;
9116
9215
  paymentId?: string | null;
@@ -10031,6 +10130,11 @@ declare class Payments extends APIResource {
10031
10130
  readonly operations: Operations;
10032
10131
  readonly dispersals: Dispersals;
10033
10132
  readonly change: Change;
10133
+ /** Bolívar methods your account can take now (`pago_movil`, `c2p`, `vpos`), with a reason when unavailable. */
10134
+ methods(options?: RequestOptions): Promise<{
10135
+ livemode: boolean;
10136
+ methods: components["schemas"]["PaymentMethodAvailabilityDto"][];
10137
+ }>;
10034
10138
  retrieve(id: string, options?: RequestOptions): Promise<{
10035
10139
  paymentId: string;
10036
10140
  externalRef?: string;
@@ -10309,6 +10413,6 @@ declare class VexPayTimeoutError extends VexPayConnectionError {
10309
10413
  declare class VexPaySignatureVerificationError extends VexPayError {
10310
10414
  }
10311
10415
 
10312
- declare const VERSION = "0.7.0";
10416
+ declare const VERSION = "0.8.0";
10313
10417
 
10314
10418
  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.js CHANGED
@@ -62,7 +62,7 @@ function errorFromResponse(status, body, requestId) {
62
62
  }
63
63
 
64
64
  // src/version.ts
65
- var VERSION = "0.7.0";
65
+ var VERSION = "0.8.0";
66
66
 
67
67
  // src/core.ts
68
68
  var INITIAL_RETRY_DELAY_MS = 500;
@@ -262,6 +262,7 @@ var ROUTES = {
262
262
  Payments_getPayment: { method: "GET", path: "/v1/payments/{id}" },
263
263
  Payments_getPaymentByRef: { method: "GET", path: "/v1/payments/by-ref/{externalRef}" },
264
264
  Payments_getQuote: { method: "GET", path: "/v1/quote" },
265
+ Payments_listPaymentMethods: { method: "GET", path: "/v1/payment-methods" },
265
266
  Payments_requestC2p: { method: "POST", path: "/v1/payments/c2p/request" },
266
267
  Payments_reversePayment: { method: "POST", path: "/v1/payments/{id}/reverse" },
267
268
  Payments_verifyPagoMovil: { method: "POST", path: "/v1/payments/pago-movil/verify" },
@@ -732,6 +733,10 @@ var Payments = class extends APIResource {
732
733
  operations = new Operations(this.http);
733
734
  dispersals = new Dispersals(this.http);
734
735
  change = new Change(this.http);
736
+ /** Bolívar methods your account can take now (`pago_movil`, `c2p`, `vpos`), with a reason when unavailable. */
737
+ methods(options) {
738
+ return this.call("Payments_listPaymentMethods", {}, options);
739
+ }
735
740
  retrieve(id, options) {
736
741
  return this.call("Payments_getPayment", { path: { id } }, options);
737
742
  }