← Volver al índice de esquemas

BeneficiaryImportPreviewResponse

Respuesta de `GET /v1/beneficiaries/imports/{id}/preview`. Filas parseadas paginadas con un snapshot del job en `meta`. Las CLABEs y celulares se muestran en claro al propietario del job; las tarjetas también van completas en la vista del propietario (la vista admin cross-user las enmascara).

Propiedades

Campo Tipo Descripción
type string Tipo del recurso JSON:API (siempre `beneficiary_import_row`).
id string ID numérico de la fila expresado como string (formato JSON:API).
attributes object Campos de la fila parseada.
row_index integer Posición 0-based de la fila en el archivo original. Permite al usuario localizar la fila en el documento fuente.
status string Bucket de clasificación: `valid` — lista para commit; `correctable` — corregida automáticamente, confirmable; `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 normalizado extraído del archivo. El propietario del job puede ver y editar este valor en la vista de preview; `null` si no fue posible extraer una cuenta.
parsed_account_type string | null Tipo de cuenta detectado. `null` si `parsed_account` es nulo.
parsed_bank_code string | null Código Banxico de 5 dígitos del banco receptor derivado de la cuenta parseada. `null` si no pudo resolverse.
parsed_bank_name string | null Nombre del banco receptor resuelto. `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 Overrides manuales del usuario enviados via `PATCH /v1/beneficiaries/imports/{id}/rows/{rowId}`. Tienen precedencia sobre los valores parseados en el commit.
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 ID del registro de beneficiario creado tras el commit. `null` hasta que el job completó y esta fila fue persistida.

Variantes

allOf

Usado en operaciones

  • GET /v1/beneficiaries/imports/{id}/preview