PATCHhttps://api.veriko.mx/v1/beneficiaries/imports/{id}/rows/{row_id}

Editar una fila de la vista previa

Audiencia
public
Autenticación
API key
Permiso
beneficiaries:create
Guía de uso →

Permite corregir una fila de la vista previa antes de confirmar la persistencia de un trabajo de importación. Acepta envoltorio JSON:API o un objeto plano. Todos los atributos son opcionales; solo se sobreescriben los presentes.

Campos editables:

  • parsed_account
  • parsed_label
  • parsed_account_type
  • parsed_bank_code
  • parsed_bank_name

Tras persistir la corrección el servidor re-procesa la fila (re-deriva banco a partir del prefijo CLABE / BIN nuevos) para que los contadores de la importación y la columna Banco de la vista previa queden sincronizados sin esperar a la confirmación.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
id*pathintegerobligatorio

ID numérico del trabajo de importación.

p. ej. 42
row_id*pathintegerobligatorio

ID numérico de la fila dentro de la importación.

p. ej. 102
Parámetros
ParámetroTipoObligatorioDescripción
parsed_accountstring (patrón, ?–32)opcional

Número de cuenta corregido por el usuario. Acepta hasta 32 caracteres de dígitos. Se re-normaliza al re-procesar.

p. ej. 012180004412345678
parsed_labelstring (?–100)opcional

Etiqueta libre corregida.

p. ej. Mamá
parsed_account_typestring (enumeración)opcional

Tipo de cuenta corregido. clabe: CLABE (18 dígitos); card: tarjeta (16 dígitos); phone: celular/DiMo (10 dígitos).

p. ej. clabe
parsed_bank_codestring (patrón)opcional

Código SPEI corregido (5 dígitos). Útil para cuentas tipo phone que necesitan reasignación de banco. Para CLABE/card se sobrescribe en su re-derivación.

p. ej. 40012
parsed_bank_namestring (?–50)opcional

Nombre del banco corregido. Puede sobrescribirse durante la re-derivación.

p. ej. BBVA MEXICO
Petición
curl -X PATCH 'https://api.veriko.mx/v1/beneficiaries/imports/{id}/rows/{row_id}' \
  -H 'Authorization: Bearer veriko_••••' \
  -H 'Content-Type: application/json' \
  -d '{
    "parsed_account": "0121-8000-4412-3456-78"
  }'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200PatchBeneficiaryImportRowResponse — Fila actualizada con la corrección aplicado y re-procesada.
CampoTipoDescripción
dataobject

Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con type, id, attributes).

typestring

Tipo del recurso JSON:API (siempre beneficiary_import_row).

p. ej. beneficiary_import_row
idstring

Identificador numérico de la fila (expresado como string).

p. ej. 123
attributesobject

Campos de la fila analizada.

row_indexinteger

Posición (desde el 0) de la fila en el archivo original. Permite al usuario localizar la fila en el documento fuente.

p. ej. 5
statusstring

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.

p. ej. valid
parsed_accountstring | nullanulable

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.

p. ej. 012180004412345678
parsed_account_typestring | nullanulable

Tipo de cuenta detectado. Los tipos son clabe, card y phone. Además de null si parsed_account es nulo.

p. ej. clabe
parsed_bank_codestring | nullanulable

Código SPEI (5 dígitos) del banco resuelto, derivado de
parsed_account. Es null si no pudo resolverse.

p. ej. 40012
parsed_bank_namestring | nullanulable

Nombre oficial del banco resuelto resuelto. Es null si no pudo resolverse.

p. ej. BBVA MEXICO
parsed_labelstring | nullanulable

Etiqueta/alias extraída del archivo (o asignada automáticamente). null si no fue posible extraer una etiqueta y no se asignó automáticamente.

p. ej. Proveedor ABC
error_codesarray

Códigos de error estables de la fila (p.ej. clabe_checksum_failed, alias_missing). Vacío para filas valid.

p. ej. []
corrections_appliedobject

Auto-correcciones que el sistema aplicó a esta fila (p.ej. { "alias_auto_assigned": "Proveedor 001" }). Vacío si no hubo correcciones.

p. ej. {}
user_overridesobject

Correcciones manuales del usuario enviadas mediante PATCH /v1/beneficiaries/imports/{id}/rows/{rowId}. Tienen precedencia sobre los valores parseados en la confirmación.

p. ej. {}
raw_previewobject

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.

p. ej. {}
created_beneficiary_idinteger | nullanulable

Identificador numérico del beneficiario creado tras la confirmación. null hasta que la importación completó y esta fila fue persistida.

p. ej. null
metaobject

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.

versionstring

Versión de la API que procesó la petición.

p. ej. 1.47.0
api_versionstring

Versión del prefijo de ruta de la API (ej. v1).

p. ej. v1
request_idstring

Identificador único de la petición (hex).

p. ej. a1b2c3d4e5f6
datetimeobject

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.

p. ej. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Siempre UTC — la zona canónica para cada campo datetime del cuerpo.

p. ej. UTC
format*string

Siempre ISO 8601 — sufijo Z explícito en cada datetime.

p. ej. ISO 8601
linksobject

Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Códigos de respuestaPATCH /v1/beneficiaries/imports/{id}/rows/{row_id}
CódigoClaseDescripciónCuerpo
2002xxFila actualizada con la corrección aplicado y re-procesada.PatchBeneficiaryImportRowResponse
4004xxEl cuerpo de la petición está vacío o no es JSON válido.ErrorResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
4044xxEl recurso no existe o no es visible para el clienteError
4134xxEl cuerpo de la petición supera el tamaño máximo admitido (body_too_large).ErrorResponse
4224xxFalló la validación o la importación no es editable. Códigos: invalid_account (pattern violation), invalid_account_type, invalid_bank_code, no_valid_fields, job_not_editable.ErrorResponse
Errores de PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}
CódigoClaveEjemplo
400body_empty

El cuerpo de la petición está vacío.

Envelope
meta.request_id
a5b6c7d8e9f0
400invalid_json

El cuerpo no es JSON válido.

Envelope
meta.request_id
b6c7d8e9f0a1
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c0
413body_too_large

El cuerpo de la petición es demasiado grande.

Envelope
meta.request_id
1a2b3c4d5e6f
422invalid_account_type

`parsed_account_type` debe ser `clabe`, `card` o `phone`.

Envelope
meta.request_id
e3f4a5b6c7d8
422job_not_editable

El lote no está en estado `preview_ready`.

Envelope
meta.request_id
d2e3f4a5b6c7