← Back to schema index

PublicValidationListItem

Summary JSON:API resource for a validation in the account history.

ExtendsJsonApiResourceBase

Properties

FieldTypeDescription
type*stringResource type. It is a fixed value per resource and does not vary between responses; it tells resources apart when a collection mixes several.
id*string (uuid)Resource identifier, unique within its `type`. It always travels as a string, even when it originates from an auto-increment column.
attributes*objectData shown in the validation history.
bank_namestringCounterparty bank name. It first uses the stored `receptor_name` or `emisor_name`; if absent, it tries to resolve the receiver or sender code. If resolution also fails, it returns the stored value when it is not a numeric code, or `Unidentified bank` (in Spanish, `Banco no identificado`).
bank_codestring | nullCanonical Banxico key (3-5 digits) of the counterparty bank, resolved by the domain authority. `null` when the bank could not be resolved. Additive to `bank_name`: it is used to resolve resources/avatars by key, never by the visible name.
beneficiary_labelstring | nullRegistered beneficiary label, when available.
amountnumber | nullTransfer amount in Mexican pesos (MXN).
tracking_keystringIdentifier assigned by the sending bank of the transfer (tracking key).
referencia_numericastringNumeric series of up to 7 digits that identifies the transfer. It is not unique and may repeat.
beneficiary_accountstringCLABE, card, or mobile number that received the transfer.
statusstringLifecycle state — `queued`: Awaiting processing; `processing`: In progress; `valid`: The CEP was found and matches; `not_found`: Banxico cannot find the operation; `cep_unavailable`: Banxico recognizes the transaction but the CEP is not available; `invalid`: Banxico did not return a recognizable verdict; `returned`: the transfer was settled and later returned; `failed`: The validation stopped because of a problem in the data sent; `error`: The validation stopped because of a service failure.
banxico_statusstringVerdict reported by Banxico.
validation_typestringValidation mode — `direct`: Manual entry of the fields; `ocr`: Reading of the receipt image.
is_playgroundboolean`true` when the validation belongs to the playground.
created_atstring (date-time)ISO 8601 timestamp in UTC with an explicit `Z` suffix; for example, `"2026-05-01T05:14:38Z"`. The `*_at`, `*_end`, `*_start`, and `*_date` fields follow this format. `meta.datetime` describes the same contract in the response.
deleted_atTimestampUTC | nullHistory withdrawal date in ISO 8601 UTC.
purged_atobjectDate and time, in ISO 8601 UTC, when the validation was purged. It only appears on a purged validation, which is left as a tombstone with its verdict, its dates, and its amount.
retry_stateobjectSummary retry cycle state with configuration represented as `null`.
enabledboolean`true` when the validation has retries configured, even if its cycle has already ended (`terminal_state`).
max_retriesinteger | nullAlways `null` in the summary shape.
interval_secondsinteger | nullAlways `null` in the summary shape.
outcomesarray | nullAlways `null` in the summary shape.
attempts_completedintegerNumber of retries completed so far.
next_attempt_atTimestampUTC | nullDate of the next retry; `null` when none is scheduled.
resolved_atTimestampUTC | nullDate when a retry produced `valid`; `null` until that occurs.
exhausted_atTimestampUTC | nullDate when attempts were exhausted; `null` until that occurs.
cancelled_atTimestampUTC | nullCycle cancellation date; `null` until that occurs.
terminal_statestring | nullCycle state: `pending`, `resolved`, `exhausted`, or `cancelled`. It is `null` when the validation has no retry cycle.
client_refstringReference of your own sent when validating (`client_ref`), returned as sent. It only appears when the request included it.

Used in operations

  • GET /v1/validations