← Volver al índice de esquemas
PublicValidationListItem
Recurso JSON:API resumido de una validación en el historial de la cuenta.
ExtiendeJsonApiResourceBase
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
type* | string | Tipo del recurso. Es un valor fijo por recurso y no varía entre respuestas; permite distinguir recursos cuando una colección mezcla varios. |
id* | string (uuid) | Identificador del recurso, único dentro de su `type`. Viaja siempre como cadena, incluso cuando su origen es una columna autonumérica. |
attributes* | object | Datos mostrados en el historial de validaciones. |
bank_name | string | 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 el valor guardado cuando no es una clave numérica, o `Banco no identificado` (en inglés, `Unidentified bank`). |
bank_code | string | null | 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. |
beneficiary_label | string | null | Etiqueta del beneficiario receptor registrado (si existe). |
amount | number | null | Importe de la transferencia (en pesos mexicanos — MXN). |
tracking_key | string | Identificador asignado por el banco emisor de la transferencia (clave de rastreo). |
referencia_numerica | string | Serie numérica de hasta 7 dígitos que identifica la transferencia (no es único, puede repetirse). |
beneficiary_account | string | Número de cuenta (CLABE, tarjeta o celular/DiMo) receptor de la transferencia. |
status | string | Estado del ciclo de vida — `queued`: Pendiente de procesamiento; `processing`: En proceso; `valid`: El CEP fue encontrado y cuadra; `not_found`: Banxico no encuentra la operación; `cep_unavailable`: Banxico reconoce la transacción pero el CEP no está disponible; `invalid`: Banxico no devolvió un veredicto reconocible; `returned`: la operación se liquidó y después se devolvió; `failed`: La validación se detuvo por un problema en los datos enviados; `error`: La validación se detuvo por un fallo del servicio. |
banxico_status | string | Veredicto reportado por Banxico. |
validation_type | string | Modalidad de validación — `direct`: Captura manual de los campos; `ocr`: Lectura de la imagen del comprobante. |
is_playground | boolean | `true` cuando la validación pertenece al banco de pruebas (Playground). |
created_at | string (date-time) | Timestamp ISO 8601 en UTC con sufijo `Z` explícito; por ejemplo, `"2026-05-01T05:14:38Z"`. Los campos `*_at`, `*_end`, `*_start` y `*_date` adoptan esta forma. `meta.datetime` describe el mismo contrato en la respuesta. |
deleted_at | TimestampUTC | null | Fecha de retiro del historial, en ISO 8601 UTC. |
purged_at | object | Fecha y hora, en ISO 8601 UTC, en que la validación se purgó. Solo aparece en una validación purgada, que queda como una lápida con su veredicto, sus fechas y su monto. |
retry_state | object | Estado resumido del ciclo de reintentos, con la configuración representada como `null`. |
enabled | boolean | `true` cuando la validación tiene reintentos configurados, aunque su ciclo ya haya terminado (`terminal_state`). |
max_retries | integer | null | Siempre `null` en esta forma. |
interval_seconds | integer | null | Siempre `null` en esta forma. |
outcomes | array | null | Siempre `null` en esta forma. |
attempts_completed | integer | Cantidad de reintentos completados hasta el momento. |
next_attempt_at | TimestampUTC | null | Fecha del próximo reintento; `null` cuando no hay uno programado. |
resolved_at | TimestampUTC | null | Fecha en que un reintento obtuvo `valid`; `null` mientras no ocurra. |
exhausted_at | TimestampUTC | null | Fecha en que se agotaron los intentos; `null` mientras no ocurra. |
cancelled_at | TimestampUTC | null | Fecha de cancelación del ciclo; `null` mientras no ocurra. |
terminal_state | string | null | Situación del ciclo: `pending`, `resolved`, `exhausted` o `cancelled`. Es `null` cuando la validación no tiene un ciclo de reintentos. |
client_ref | string | Referencia propia enviada al validar (`client_ref`), devuelta tal cual. Solo aparece cuando la petición la incluyó. |
Usado en operaciones
GET /v1/validations