← Volver al índice de esquemas

PatchBeneficiaryImportRowResponse

Respuesta de `PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}`: la fila ya corregida y reprocesada. Su grupo de clasificación (`status`) puede haber cambiado con la corrección.

Propiedades

CampoTipoDescripción
dataobjectPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
typestringTipo del recurso JSON:API. Siempre `beneficiary_import_row`.
idstringIdentificador numérico de la fila (expresado como string).
attributesobjectDatos de la fila interpretada.
row_indexintegerPosición de la fila dentro del archivo original, empezando en `0`. Permite localizar la fila en el documento original.
statusstringGrupo 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_accountstring | nullNú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` cuando no fue posible extraer una cuenta.
parsed_account_typestring | nullTipo de cuenta detectado. Los tipos son `clabe`, `card` y `phone`. Además de `null` cuando `parsed_account` es nulo.
parsed_bank_codestring | nullCódigo SPEI (5 dígitos) del banco resuelto, derivado de \ `parsed_account`. Es `null` cuando no pudo resolverse.
parsed_bank_namestring | nullNombre oficial del banco resuelto resuelto. Es `null` cuando no pudo resolverse.
parsed_labelstring | nullEtiqueta/alias extraída del archivo (o asignada automáticamente). `null` cuando no fue posible extraer una etiqueta y no se asignó automáticamente.
error_codesarrayCódigos de error estables de la fila (p.ej. `clabe_checksum_failed`, `alias_missing`). Vacío para filas `valid`.
corrections_appliedobjectAuto-correcciones que el sistema aplicó a esta fila (p.ej. `{ "alias_auto_assigned": "Proveedor 001" }`). Vacío si no hubo correcciones.
user_overridesobjectCorrecciones manuales del usuario enviadas mediante `PATCH /v1/beneficiaries/imports/{id}/rows/{rowId}`. Tienen precedencia sobre los valores parseados en la confirmación.
raw_previewobjectFragmento del archivo original para diagnóstico. Las series de 13 a 19 dígitos que no son una CLABE (18 dígitos) aparecen enmascaradas (`••••` y los últimos cuatro), igual que un número de celular de 10 dígitos cuando lo precede una etiqueta como «cuenta» o «celular», para evitar exposición de números de tarjeta en los cuerpos de depuración.
created_beneficiary_idinteger | nullIdentificador numérico del beneficiario creado tras la confirmación. `null` hasta que la importación completó y esta fila fue persistida.
metaobjectMetadatos 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.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor 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*stringSiempre `UTC`: La zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601`: Sufijo `Z` explícito en cada datetime.
linksobjectEnlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

  • PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}