POSThttps://api.veriko.mx/v1/validations/{id}/cancel-retries

Cancelar reintentos pendientes

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

Cancela el ciclo activo de reintentos automáticos de una validación y devuelve terminal_state="cancelled".

Si el ciclo ya no está activo, responde con un estado HTTP 422 (con retry_not_active en el cuerpo).

La cabecera opcional Idempotency-Key permite repetir la misma petición sin duplicar la cancelación.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
id*pathstring (uuid)obligatorio

Identificador (UUID) de la validación

Idempotency-Keyheaderstringopcional

Llave opcional que garantiza que la petición se procese exactamente una vez dentro de un TTL de 24 horas. Los reintentos con la misma llave y el mismo cuerpo devuelven la respuesta cacheada con la cabecera Idempotent-Replayed: true (sin re-disparar webhooks) y sin crear una nueva validación.

p. ej. 11111111-2222-3333-4444-555555555555
Petición
curl -X POST 'https://api.veriko.mx/v1/validations/{id}/cancel-retries' \
  -H 'Authorization: Bearer veriko_••••' \
  -H 'Content-Type: application/json'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200CancelValidationRetriesAttributes — Ciclo de reintentos cancelado. `retry_state.terminal_state` queda `cancelled`.
CampoTipoDescripción
retry_stateobject

Estado completo del ciclo de reintentos, con configuración, avance y situación actual.

enabledboolean

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

p. ej. true
max_retriesinteger | nullanulable

Número máximo de reintentos configurado; null cuando enabled es false.

p. ej. 3
interval_secondsinteger | nullanulable

Intervalo en segundos entre reintentos, de 300 a 86400; null cuando enabled es false.

p. ej. 600
outcomesarray | nullanulable

Resultados que originan un reintento: not_found, cep_unavailable y error; null cuando enabled es false.

p. ej. ["not_found","cep_unavailable","error"]
attempts_completedinteger

Cantidad de reintentos completados hasta el momento.

p. ej. 1
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
Códigos de respuestaPOST /v1/validations/{id}/cancel-retries
CódigoClaseDescripciónCuerpo
2002xxCiclo de reintentos cancelado. retry_state.terminal_state queda cancelled.CancelValidationRetriesAttributes
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
4044xxValidación no encontrada o ajena a la cuenta de usuario (not_found).ErrorResponse
4104xxLa validación se purgó y este recurso ya no existe (validation_purged).ErrorResponse
4224xxNo hay ciclo de reintentos activo que cancelar (código retry_not_active). UUID inválido (invalid_uuid).ErrorResponse
Cabeceras de respuesta200
CabeceraTipoDescripción
Idempotent-ReplayedstringSolo está presente cuando la petición incluyó Idempotency-Key. true indica que la respuesta se reutilizó desde el caché de idempotencia, cuya vigencia es de 24 horas por cuenta, endpoint y clave.
Errores de POST /v1/validations/{id}/cancel-retries
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d
410validation_purged

La validación se purgó y este recurso ya no existe.

Envelope
meta.request_id
1a2b3c4d5e6ff6e5d4c3b2a1