GEThttps://api.veriko.mx/v1/validations

Listar validaciones

Audiencia
public
Autenticación
API key
Permiso
validations:read
Guía de uso →

Devuelve el historial paginado de validaciones del usuario autenticado.

Los filtros se combinan entre sí. Por ejemplo:

  • status: Acepta un estado, o varios separados por comas.
  • with_deleted: Distingue entre los registros activos y los retirados.
  • Los demás acotan por: modalidad, fecha, contenido, banco, importe, origen, referencia propia (client_ref) y ciclo de reintentos.

La forma de la respuesta está descrita en la paginación.

Para el registro completo de una validación, con el estado detallado de sus reintentos, está GET /v1/validations/{id}.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
amount_maxquerynumber (float)opcional

Filtro — Importe máximo inclusivo, como número. Mismas reglas de tolerancia de formato y de error que amount_min. Se aplica de forma independiente de amount_min.

p. ej. 50000
amount_minquerynumber (float)opcional

Filtro — Importe mínimo inclusivo, como número. El servidor también tolera enviarlo como texto con separador de miles o símbolo de moneda ("1,000.50", "$500") y lo normaliza con el mismo algoritmo que el resto de la plataforma, pero el contrato es un número: un cliente tipado debe mandarlo así. Un valor no vacío que no se reconozca como número devuelve un estado HTTP 422 con invalid_filter, en vez de ignorarse en silencio. Se aplica de forma independiente de amount_max.

p. ej. 1000.5
bankquerystringopcional

Filtro — Clave SPEI del banco emisor o receptor en la petición original. Los valores que no tengan de 1 a 5 dígitos se ignoran; enviarlo como lista (bank[]=) devuelve un estado HTTP 422 con invalid_filter.

p. ej. 012
batch_idqueryintegeropcional

Filtro — Identificador del trabajo de importación que generó las validaciones. Enviarlo como lista (batch_id[]=) devuelve un estado HTTP 422 con invalid_filter en vez de ignorarse.

p. ej. 42
client_refquerystringopcional

Coincidencia exacta con la client_ref enviada al validar. Distingue mayúsculas, acentos y espacios internos. Un valor vacío o que no cumple las reglas de client_ref devuelve un estado HTTP 422 (con invalid_filter en el cuerpo).

p. ej. orden-4812
fromquerystring (date)opcional

Filtro — Fecha inicial inclusiva, aplicada sobre la creación de la validación. Enviarlo como lista (from[]=) devuelve un estado HTTP 422 con invalid_filter.

p. ej. 2025-01-01
pagequeryintegeropcional

Filtro — Página solicitada; los valores menores que 1 se ajustan a 1.

Predeterminado: 1

p. ej. 1
per_pagequeryintegeropcional

Filtro — Elementos por página; se ajusta al intervalo de 1 a 50.

Predeterminado: 10

p. ej. 10
playgroundquerystringopcional

Filtro — Muestra solo las validaciones del banco de pruebas (Playground). Si se envía, el único valor admitido es 1; cualquier otro devuelve un estado HTTP 422.

p. ej. 1
retry_statequerystringopcional

Filtro — Estado del ciclo de reintentos: pending, resolved, exhausted o cancelled. Otro valor devuelve un estado HTTP 422 con invalid_filter.

p. ej. pending
searchquerystringopcional

Filtro — Texto buscado, sin distinguir mayúsculas y minúsculas, en los datos enviados, normalizados y devueltos por Banxico. % y _ se tratan como caracteres literales, y los 100 caracteres se cuentan por carácter (no por byte), así que un acento no se parte a la mitad. Si el texto, sin espacios ni guiones, queda compuesto sólo por dígitos, también se busca esa forma sin separadores contra la cuenta beneficiaria.

p. ej. scotiabank
statusquerystringopcional

Filtro — Estado del ciclo de vida. Acepta un valor o una lista separada por comas: queued, processing, valid, not_found, cep_unavailable, invalid, returned, failed o error. Los valores no admitidos se ignoran.

p. ej. valid
toquerystring (date)opcional

Filtro — Fecha final inclusiva, aplicada sobre la creación de la validación. Enviarlo como lista (to[]=) devuelve un estado HTTP 422 con invalid_filter.

p. ej. 2025-03-31
typequerystringopcional

Filtro — Modalidad: direct para validación manual u ocr para validación a partir de una imagen.

p. ej. direct
with_deletedquerystringopcional

Filtro — Alcance de los registros retirados: omitido incluye activos y retirados; 0 muestra solo activos y 1 solo retirados.

p. ej. 0
Petición
curl -X GET 'https://api.veriko.mx/v1/validations' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200PublicValidationListItem — Lista paginada de validaciones con metadatos de paginación.
CampoTipoDescripció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.

p. ej. validation
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_namestring

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_codestring | nullanulable

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_labelstring | nullanulable

Etiqueta del beneficiario receptor registrado (si existe).

amountnumber | nullanulable

Importe de la transferencia (en pesos mexicanos — MXN).

tracking_keystring

Identificador asignado por el banco emisor de la transferencia (clave de rastreo).

referencia_numericastring

Serie numérica de hasta 7 dígitos que identifica la transferencia (no es único, puede repetirse).

beneficiary_accountstring

Número de cuenta (CLABE, tarjeta o celular/DiMo) receptor de la transferencia.

statusstring

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_statusstring

Veredicto reportado por Banxico.

validation_typestring

Modalidad de validación — direct: Captura manual de los campos; ocr: Lectura de la imagen del comprobante.

is_playgroundboolean

true cuando la validación pertenece al banco de pruebas (Playground).

created_atstring (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.

p. ej. 2026-05-01T05:14:38Z
deleted_atTimestampUTC | null

Fecha de retiro del historial, en ISO 8601 UTC.

purged_atobject

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_stateobject

Estado resumido del ciclo de reintentos, con la configuración representada como null.

enabledboolean

true cuando la validación tiene reintentos configurados, aunque su ciclo ya haya terminado (terminal_state).

p. ej. true
max_retriesinteger | nullanulable

Siempre null en esta forma.

p. ej. null
interval_secondsinteger | nullanulable

Siempre null en esta forma.

p. ej. null
outcomesarray | nullanulable

Siempre null en esta forma.

p. ej. null
attempts_completedinteger

Cantidad de reintentos completados hasta el momento.

p. ej. 2
next_attempt_atTimestampUTC | null

Fecha del próximo reintento; null cuando no hay uno programado.

resolved_atTimestampUTC | null

Fecha en que un reintento obtuvo valid; null mientras no ocurra.

exhausted_atTimestampUTC | null

Fecha en que se agotaron los intentos; null mientras no ocurra.

cancelled_atTimestampUTC | null

Fecha de cancelación del ciclo; null mientras no ocurra.

terminal_statestring | nullanulable

Situación del ciclo: pending, resolved, exhausted o cancelled. Es null cuando la validación no tiene un ciclo de reintentos.

p. ej. pending
client_refstring

Referencia propia enviada al validar (client_ref), devuelta tal cual. Solo aparece cuando la petición la incluyó.

p. ej. orden-4812
Códigos de respuestaGET /v1/validations
CódigoClaseDescripciónCuerpo
2002xxLista paginada de validaciones con metadatos de paginación.PublicValidationListItem
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4224xxUn filtro no se pudo aplicar (código invalid_filter): valor no admitido en retry_state, playground o amount_min/amount_max con formato irreconocible; o tipo incorrecto en from, to, search, bank o batch_id (por ejemplo, enviados como lista from[]=).ErrorResponse
Errores de GET /v1/validations
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c