← Volver al índice de esquemas

ValidationPurgePrepareResponse

Respuesta de `POST /v1/validations/{id}/purge/prepare`: lo que borraría el borrado definitivo, lo que conservaría y el token que lo confirma. Todavía no ha cambiado nada.

Propiedades

CampoTipoDescripción
data*objectRecurso JSON:API de la preparación. Su `id` es el de la validación.
type*stringTipo del recurso, fijo para esta operación. Forma parte de su identidad en la envoltura JSON:API. Siempre `validation_purge`.
id*string (uuid)Identificador de la validación que se borraría.
attributes*objectResumen del borrado y token de confirmación.
confirmation_token*stringToken de un solo uso, atado a la cuenta y a esta validación, que `POST /v1/validations/{id}/purge/execute` exige para borrar. Caduca en `expires_in` segundos.
expires_in*integerSegundos de vigencia del token.
irreversible*boolean`true` siempre: el borrado no se puede deshacer. Un respaldo de infraestructura no lo revierte para el cliente.
will_delete*objectLo que borraría el borrado definitivo.
image*boolean`true` cuando hay un archivo del comprobante (imagen o PDF) que se borraría.
cep*boolean`true` cuando hay un CEP (el XML o el PDF) que se borraría.
stored_data*arrayCampos de la validación con contenido que se vaciarían. De `normalized_data` se conserva únicamente el monto.
retry_attempts*integerCantidad de intentos de reintento que se borrarían.
probe_attempts*integerCantidad de sondeos de cuenta candidata que se borrarían.
webhook_deliveries*integerCantidad de entregas de webhook de esta validación a las que se les quitaría el cuerpo enviado y la respuesta del receptor. El registro de cada entrega se conserva.
notifications*integerCantidad de entregas de notificación de esta validación cuyo contenido se vaciaría. Las notificaciones de la bandeja de la cuenta se borrarían.
idempotency_responses*integerCantidad de respuestas guardadas de `Idempotency-Key` que se borrarían.
audit_traces*boolean`true` siempre: los cuerpos de las filas de auditoría que nombran la validación se quitarían, y el contexto libre de sus eventos de seguridad se reduciría a ids y códigos.
will_keep*arrayCampos que conserva la lápida en que queda la validación: bastan para que la cuota, las estadísticas, finanzas y el historial sigan cuadrando.
cancels_pending_retries*boolean`true` cuando la validación tiene un ciclo de reintentos abierto, que el borrado cancela.
refunds_quota*boolean`false` siempre: el borrado no devuelve cuota ni cambia lo cobrado.
same_image_validation_ids*arrayIdentificadores de otras validaciones de la misma cuenta con el mismo comprobante (hasta 20). No se tocan: cada una guarda su propia copia de lo extraído y se borra por separado.

Usado en operaciones

  • POST /v1/validations/{id}/purge/prepare