@veriko-mx/sdk 0.4.6 → 0.4.7
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/CHANGELOG.md +8 -0
- package/README.md +8 -0
- package/dist/cjs/client.d.ts +1 -1
- package/dist/cjs/client.js +1 -1
- package/dist/cjs/generated/openapi.d.ts +69 -3
- package/dist/cjs/generated/openapi.d.ts.map +1 -1
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/types.d.ts +34 -1
- package/dist/cjs/types.d.ts.map +1 -1
- package/dist/cjs/types.js.map +1 -1
- package/dist/cjs/webhooks.d.ts.map +1 -1
- package/dist/esm/client.d.ts +1 -1
- package/dist/esm/client.js +1 -1
- package/dist/esm/generated/openapi.d.ts +69 -3
- package/dist/esm/generated/openapi.d.ts.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/types.d.ts +34 -1
- package/dist/esm/types.d.ts.map +1 -1
- package/dist/esm/types.js.map +1 -1
- package/dist/esm/webhooks.d.ts.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,14 @@ versiones según [SemVer](https://semver.org/lang/es/).
|
|
|
7
7
|
|
|
8
8
|
Sin cambios todavía.
|
|
9
9
|
|
|
10
|
+
## [0.4.7] — 2026-09-26
|
|
11
|
+
|
|
12
|
+
### Añadido
|
|
13
|
+
|
|
14
|
+
- El webhook de validación trae `data.attributes.banxico_confirmed` cuando
|
|
15
|
+
Banxico ya confirmó el pago: monto, fecha, clave de rastreo, ambos bancos y
|
|
16
|
+
la cuenta del beneficiario enmascarada.
|
|
17
|
+
|
|
10
18
|
## [0.4.6] — 2026-09-24
|
|
11
19
|
|
|
12
20
|
### Cambiado
|
package/README.md
CHANGED
|
@@ -370,6 +370,14 @@ para decidir el código de respuesta aparte. La comparación es en tiempo consta
|
|
|
370
370
|
|
|
371
371
|
El receptor completo está en [`examples/express-webhook.mjs`](examples/express-webhook.mjs).
|
|
372
372
|
|
|
373
|
+
### Lo que Banxico confirmó
|
|
374
|
+
|
|
375
|
+
Cuando `banxico_status` es `valid`, o `returned` con CEP descargado, `evento.data.attributes`
|
|
376
|
+
trae además `banxico_confirmed`: el monto, la fecha, la clave de rastreo, ambos bancos y la cuenta
|
|
377
|
+
del beneficiario (enmascarada a los últimos 4 dígitos), tal como los confirmó Banxico. Compáralo
|
|
378
|
+
contra el pedido antes de liberar la mercancía: la imagen de un comprobante puede mostrar un monto
|
|
379
|
+
distinto al que Banxico confirmó.
|
|
380
|
+
|
|
373
381
|
### Las cuatro cabeceras de una entrega
|
|
374
382
|
|
|
375
383
|
| cabecera | contenido |
|
package/dist/cjs/client.d.ts
CHANGED
|
@@ -7,7 +7,7 @@ export declare const DEFAULT_TIMEOUT_MS = 30000;
|
|
|
7
7
|
export declare const API_KEY_ENV_VAR = "VERIKO_API_KEY";
|
|
8
8
|
export declare const BASE_URL_ENV_VAR = "VERIKO_BASE_URL";
|
|
9
9
|
/** La versión que viaja en el `User-Agent`. `test/client.test.ts` la compara con `package.json`. */
|
|
10
|
-
export declare const VERSION = "0.4.
|
|
10
|
+
export declare const VERSION = "0.4.7";
|
|
11
11
|
export interface VerikoOptions {
|
|
12
12
|
/** La clave de API. Por omisión, `VERIKO_API_KEY`. */
|
|
13
13
|
apiKey?: string;
|
package/dist/cjs/client.js
CHANGED
|
@@ -9,7 +9,7 @@ exports.DEFAULT_TIMEOUT_MS = 30_000;
|
|
|
9
9
|
exports.API_KEY_ENV_VAR = 'VERIKO_API_KEY';
|
|
10
10
|
exports.BASE_URL_ENV_VAR = 'VERIKO_BASE_URL';
|
|
11
11
|
/** La versión que viaja en el `User-Agent`. `test/client.test.ts` la compara con `package.json`. */
|
|
12
|
-
exports.VERSION = '0.4.
|
|
12
|
+
exports.VERSION = '0.4.7';
|
|
13
13
|
/**
|
|
14
14
|
* Cliente de la API de Veriko.
|
|
15
15
|
*
|
|
@@ -642,6 +642,7 @@ export interface paths {
|
|
|
642
642
|
/**
|
|
643
643
|
* Iniciar importación masiva de beneficiarios
|
|
644
644
|
* @description Sube un archivo (CSV, XLS, XLSX, TXT o PDF) de hasta 20 MB y abre con él un trabajo de importación.
|
|
645
|
+
* Las hojas XLSX/XLS admiten hasta 10 000 filas y 64 columnas. Las fórmulas XLSX se leen como texto, sin ejecutarlas. Los PDF admiten hasta 50 páginas y limitan a 8 MiB la descompresión de cada flujo.
|
|
645
646
|
*
|
|
646
647
|
* El modo de lectura decide cuánto trabajo hace el archivo y cuánto el servidor:
|
|
647
648
|
*
|
|
@@ -2361,13 +2362,76 @@ export interface components {
|
|
|
2361
2362
|
/** @description Indica si el número de tarjeta está enmascarado en el comprobante cargado (solo si `validation_type` es del tipo `ocr`). */
|
|
2362
2363
|
is_masked?: boolean | null;
|
|
2363
2364
|
/**
|
|
2364
|
-
* @description Datos devueltos por Banxico.
|
|
2365
|
+
* @description Datos devueltos por Banxico. Las propiedades tipadas abajo son las 20 que declara el esquema oficial del complemento SPEI.
|
|
2365
2366
|
*
|
|
2366
2367
|
* `_ocr_correction` conserva los campos corregidos, su lectura original (`requested`), el valor consultado (`used`) y la confirmación (`confirmed_by`). `status_query` indica una hipótesis confirmada por la consulta de estado; `cep` indica que también se obtuvo el comprobante. La consulta de estado por sí sola no verifica una transferencia.
|
|
2367
2368
|
*/
|
|
2368
|
-
banxico_result?: {
|
|
2369
|
+
banxico_result?: ({
|
|
2370
|
+
/**
|
|
2371
|
+
* @description Fecha de la operación tal como la reporta el CEP de Banxico (`DD-MM-AAAA`).
|
|
2372
|
+
* @example 15-03-2025
|
|
2373
|
+
*/
|
|
2374
|
+
operationDate?: string;
|
|
2375
|
+
/**
|
|
2376
|
+
* @description Hora de la operación tal como la reporta el CEP de Banxico (`HH:MM:SS`).
|
|
2377
|
+
* @example 14:22:10
|
|
2378
|
+
*/
|
|
2379
|
+
processingTime?: string;
|
|
2380
|
+
/** @description Clave de la operación dentro del sistema SPEI (`ClaveSPEI` del CEP). Distinta de la clave de rastreo. */
|
|
2381
|
+
speiKey?: string;
|
|
2382
|
+
/**
|
|
2383
|
+
* @description Clave de rastreo de la operación SPEI — la misma que se envía en la petición de validación.
|
|
2384
|
+
* @example MBAN01002503151422ABCDEF
|
|
2385
|
+
*/
|
|
2386
|
+
trackingKey?: string;
|
|
2387
|
+
/** @description Sello digital del CEP (`sello`) — la firma que Banxico calcula sobre la operación. */
|
|
2388
|
+
digitalSignature?: string;
|
|
2389
|
+
/** @description Número del certificado digital que Banxico usó para sellar el CEP. */
|
|
2390
|
+
certificateNumber?: string;
|
|
2391
|
+
/** @description Cadena original de la operación (`cadenaCDA`): los 47 campos que la institución envió a Banxico, separados por `|`, incluidas ambas fechas (operación y captura) y el tipo de pago. Permite auditar el CEP sin volver a pedirlo. */
|
|
2392
|
+
cadenaCda?: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* @description Banco emisor de la operación, tal como lo identifica el CEP.
|
|
2395
|
+
* @example BBVA
|
|
2396
|
+
*/
|
|
2397
|
+
senderBank?: string;
|
|
2398
|
+
/** @description Nombre del ordenante de la operación, tal como lo reporta el CEP. */
|
|
2399
|
+
senderName?: string;
|
|
2400
|
+
/** @description Tipo de cuenta del ordenante (por ejemplo, CLABE o tarjeta), tal como lo reporta el CEP. */
|
|
2401
|
+
senderAccountType?: string;
|
|
2402
|
+
/** @description Cuenta del ordenante, tal como la reporta el CEP, sin enmascarar en este recurso (consulta privada, propia del dueño de la validación). */
|
|
2403
|
+
senderAccount?: string;
|
|
2404
|
+
/** @description RFC del ordenante, tal como lo reporta el CEP. */
|
|
2405
|
+
senderRfc?: string;
|
|
2406
|
+
/**
|
|
2407
|
+
* @description Banco receptor de la operación, tal como lo identifica el CEP.
|
|
2408
|
+
* @example STP
|
|
2409
|
+
*/
|
|
2410
|
+
receiverBank?: string;
|
|
2411
|
+
/** @description Nombre del beneficiario de la operación, tal como lo reporta el CEP. */
|
|
2412
|
+
beneficiaryName?: string;
|
|
2413
|
+
/** @description Tipo de cuenta del beneficiario (por ejemplo, CLABE o tarjeta), tal como lo reporta el CEP. */
|
|
2414
|
+
beneficiaryAccountType?: string;
|
|
2415
|
+
/** @description Cuenta del beneficiario, tal como la reporta el CEP, sin enmascarar en este recurso (consulta privada, propia del dueño de la validación). Los webhooks salientes sí la enmascaran a los últimos 4 dígitos en `banxico_confirmed.beneficiaryAccount` (ver la guía de webhooks). */
|
|
2416
|
+
beneficiaryAccount?: string;
|
|
2417
|
+
/** @description RFC del beneficiario, tal como lo reporta el CEP. */
|
|
2418
|
+
beneficiaryRfc?: string;
|
|
2419
|
+
/**
|
|
2420
|
+
* Format: float
|
|
2421
|
+
* @description Monto de la operación que Banxico confirmó por el CEP, en pesos.
|
|
2422
|
+
* @example 1500
|
|
2423
|
+
*/
|
|
2424
|
+
amount?: number;
|
|
2425
|
+
/**
|
|
2426
|
+
* Format: float
|
|
2427
|
+
* @description IVA de la operación reportado por el CEP, en pesos.
|
|
2428
|
+
*/
|
|
2429
|
+
iva?: number;
|
|
2430
|
+
/** @description Concepto de pago de la operación, tal como lo reporta el CEP. */
|
|
2431
|
+
paymentConcept?: string;
|
|
2432
|
+
} & {
|
|
2369
2433
|
[key: string]: unknown;
|
|
2370
|
-
} | null;
|
|
2434
|
+
}) | null;
|
|
2371
2435
|
/**
|
|
2372
2436
|
* @description Mensaje legible del error terminal (si aplica).
|
|
2373
2437
|
* @example Banxico no respondió tras tres intentos.
|
|
@@ -2540,6 +2604,8 @@ export interface components {
|
|
|
2540
2604
|
attributes: {
|
|
2541
2605
|
/** @description Nombre del banco de la contraparte. Prioriza `receptor_name` o `emisor_name` guardado; si falta, intenta resolver el código de receptor o emisor. Si tampoco puede resolverlo, devuelve ese código o `Banco no identificado`. */
|
|
2542
2606
|
bank_name?: string;
|
|
2607
|
+
/** @description Clave Banxico canónica (3-5 dígitos) del banco de la contraparte, resuelta por la autoridad del dominio. `null` cuando el banco no pudo resolverse. Es aditiva respecto de `bank_name`: sirve para resolver recursos/avatares por clave, nunca por el nombre visible. */
|
|
2608
|
+
bank_code?: string | null;
|
|
2543
2609
|
/** @description Etiqueta del beneficiario receptor registrado (si existe). */
|
|
2544
2610
|
beneficiary_label?: string | null;
|
|
2545
2611
|
/** @description Importe de la transferencia (en pesos mexicanos — MXN). */
|