← Volver al índice de esquemas
BeneficiaryImportPreviewResponse
Respuesta de `GET /v1/beneficiaries/imports/{id}/preview`. Filas parseadas paginadas con un snapshot de la importación en `meta`. Las CLABEs y celulares se muestran en claro al propietario de la importación; las tarjetas también van completas en la vista del propietario (la vista admin cross-user las enmascara).
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
data | array | Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`). |
type | string | Tipo del recurso JSON:API (siempre `beneficiary_import_row`). |
id | string | Identificador numérico de la fila (expresado como string). |
attributes | object | Campos de la fila analizada. |
row_index | integer | Posición (desde el 0) de la fila en el archivo original. Permite al usuario localizar la fila en el documento fuente. |
status | string | Grupo de clasificación — `valid`: Lista para confirmación; `correctable`: Corregida automáticamente; `fatal`: Error no corregible, se omite; `duplicate_account`: Cuenta ya registrada (se reactiva si estaba archivada); `duplicate_alias`: Alias duplicado, se persiste con sufijo. |
parsed_account | string | null | Número de cuenta extraído del archivo (normalizado). El propietario de la importación puede ver y editar este valor en la vista de vista previa; `null` si no fue posible extraer una cuenta. |
parsed_account_type | string | null | Tipo de cuenta detectado. Los tipos son `clabe`, `card` y `phone`. Además de `null` si `parsed_account` es nulo. |
parsed_bank_code | string | null | Código SPEI (5 dígitos) del banco resuelto, derivado de \ `parsed_account`. Es `null` si no pudo resolverse. |
parsed_bank_name | string | null | Nombre oficial del banco resuelto resuelto. Es `null` si no pudo resolverse. |
parsed_label | string | null | Etiqueta/alias extraída del archivo (o asignada automáticamente). `null` si no fue posible extraer una etiqueta y no se asignó automáticamente. |
error_codes | array | Códigos de error estables de la fila (p.ej. `clabe_checksum_failed`, `alias_missing`). Vacío para filas `valid`. |
corrections_applied | object | Auto-correcciones que el sistema aplicó a esta fila (p.ej. `{ "alias_auto_assigned": "Proveedor 001" }`). Vacío si no hubo correcciones. |
user_overrides | object | Correcciones manuales del usuario enviadas mediante `PATCH /v1/beneficiaries/imports/{id}/rows/{rowId}`. Tienen precedencia sobre los valores parseados en la confirmación. |
raw_preview | object | Fragmento del archivo original para diagnóstico. Los dígitos de 6 o más caracteres consecutivos aparecen enmascarados (`••••`) para evitar exposición de PANs en payloads de depuración. |
created_beneficiary_id | integer | null | Identificador numérico del beneficiario creado tras la confirmación. `null` hasta que la importación completó y esta fila fue persistida. |
meta | object | Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC. |
version | string | Versión de la API que procesó la petición. |
api_version | string | Versión del prefijo de ruta de la API (ej. `v1`). |
request_id | string | Identificador único de la petición (hex). |
datetime | object | Descriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec. |
timezone* | string | Siempre `UTC` — la zona canónica para cada campo datetime del cuerpo. |
format* | string | Siempre `ISO 8601` — sufijo `Z` explícito en cada datetime. |
links | object | Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada. |
Usado en operaciones
GET /v1/beneficiaries/imports/{id}/preview