← Back to schema index

ValidationListItem

Abbreviated validation for list views. Wrapped under `{ type, id, attributes }` following JSON:API format; the fields below describe the `attributes` block. Soft-deleted rows are also included — `is_deleted` and `deleted_at` allow the UI to distinguish them without an extra request.

Properties

FieldTypeDescription
idstring (uuid)Unique identifier of the validation (UUID v4).
typestringJSON:API resource type. Always `validation`.
validation_typestringValidation type: `direct` for text parameters, `ocr` for receipt image.
statusstringResult status. See `Validation.attributes.status` for the full description of each value. `queued` — waiting; `processing` — under way; `valid` — the receipt exists and matches; `not_found` — Banxico cannot find it; `cep_unavailable` — the service could not deliver it; `invalid` — the data does not match; `failed` — the attempt could not be completed; `error` — the system failed while processing it.
fechastring (date)Transfer date (YYYY-MM-DD).
montonumber (double)Transfer amount in Mexican pesos (MXN).
clave_rastreostringKey the bank identifies the transfer with before the payment system.
emisorstringSending bank of the transfer.
receptorstringReceiving bank of the transfer.
playgroundbooleanWhether the validation was executed in sandbox mode.
created_atstring (date-time)ISO 8601 timestamp in UTC with explicit `Z` suffix. Example: `"2026-05-01T05:14:38Z"`. Every datetime field uses this shape. The descriptor at `meta.datetime` makes the contract runtime-assertable.
completed_atTimestampUTC | nullTimestamp when the validation completed. `null` while status is `queued` or `processing`.
deleted_atTimestampUTC | nullSoft-delete timestamp. `null` if the validation has not been deleted.
is_deletedboolean`true` if and only if `deleted_at` is set; convenience field for UI filtering.
retry_stateobjectCompact retry cycle state. Policy fields (`max_retries`, `interval_seconds`, `outcomes`) are always `null` in this view; use `GET /v1/validations/{id}` for the full state.
enabledbooleanWhether the retry cycle is active for this validation.
max_retriesinteger | nullAlways `null` in the compact shape. See `RetryStateFull` for the value.
interval_secondsinteger | nullAlways `null` in the compact shape. See `RetryStateFull` for the value.
outcomesarray | nullAlways `null` in the compact shape. See `RetryStateFull` for the value.
attempts_completedintegerNumber of retries completed so far.
next_attempt_atTimestampUTC | nullTimestamp of the next scheduled retry. `null` if the cycle is in a terminal state or if no retries are active.
resolved_atTimestampUTC | nullTimestamp when a retry resolved the validation to `valid`. `null` if the cycle has not ended by resolution.
exhausted_atTimestampUTC | nullTimestamp when retries were exhausted without resolution. `null` if the cycle has not ended by exhaustion.
cancelled_atTimestampUTC | nullTimestamp when the cycle was explicitly cancelled. `null` if not cancelled.
terminal_statestring | nullTerminal state of the cycle: `pending` — active, no final result yet; `resolved` — a retry obtained `valid`; `exhausted` — all attempts used; `cancelled` — cancelled by the user. `null` if the validation has no retry cycle.

Used in operations

  • GET /v1/validations
  • GET /v1/admin/validations
  • GET /v1/admin/validations/recent