Lista de errores de Consignado

Formato de error Lerian Consignado devuelve los errores como detalles de problema RFC 9457 con el tipo de contenido application/problem+json:

{
  "code": "CLT-0006",
  "detail": "The worker's authorization is outside its validity window, so their payroll data can no longer be read under it. Obtain a fresh worker authorization and send its evidence; repeating this request cannot succeed.",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "https://errors.lerian.studio/v1/CLT-0006"
}

Definiciones de campos

type – Un URI que identifica el error en el catálogo de errores de Lerian. Se construye como https://errors.lerian.studio/v1/<code>.
title – El texto del estado HTTP (por ejemplo, Unprocessable Entity).
status – El código de estado HTTP.
detail – Una explicación legible de esta ocurrencia. En una respuesta 5xx, Consignado sanea el detail a internal error, de modo que una causa interna no queda expuesta en el cuerpo. Un código 5xx que nombra una falla upstream o un resultado desconocido conserva un detail escrito para ti, como DATAPREV_TIMEOUT. Distingue por code y por el estado, no por el detail.
code – Un identificador estable para el error. Las tablas siguientes muestran los códigos CLT-NNNN y los códigos con nombre que comparten varias operaciones. Algunas operaciones responden con códigos propios, como CURSOR_EXPIRED en el barrido del inventario de registros. Consulta Códigos por operación. Una solicitud que no supera la validación de esquema no lleva code: responde 422 con el detail validation failed, o 400 cuando el cuerpo no se puede interpretar, y la lista errors nombra cada campo.
errors – Lista opcional de detalles de error individuales, cada uno con un location, un message y un value.
instance – El trace ID de la solicitud, cuando el gateway la rastreó. Indícalo cuando reportes una falla a Lerian.
upstream – El error que devolvió un sistema upstream y que el gateway retransmite. Viene de Dataprev en las operaciones del riel, y del Streaming Hub en las operaciones de suscripción. Contiene el code y el message de ese sistema, y sobrevive al saneamiento 5xx que borra detail. Consulta Códigos de motivo de Dataprev.
refusal – En un rechazo de oferta: el motivo que el gateway registró para la oferta, con su source, field, rule y detail. Un rechazo de Dataprev también lleva el code de Dataprev.

400: Solicitud incorrecta

`code`	Descripción	`detail`
CLT-0001	Solicitud no válida. Por ejemplo, una solicitud de credenciales envía un código de solicitante que no tiene tres dígitos, o un certificado y una clave que no forman un par PEM válido. Una solicitud con una clave `X-Idempotency` más larga de lo que acepta la operación también recibe este código. Una confirmación de desembolso, una ejecución de garantía FGTS, una corrección de contrato y un comando que responde códigos `RAIL_COMMAND_*` responden a una clave demasiado larga con `422`. Una importación de contrato con contabilización acepta una clave de hasta 121 bytes: una clave de 122 a 128 bytes responde `422` `CLT-0006`. Una solicitud que no supera la validación de esquema no lleva código.	—
CLT-0011	Solicitud fallida. El código de reserva para un rechazo del lado del cliente sin una entrada propia.	Nombra el rechazo.

401: No autorizado

`code`	Descripción	`detail`
CLT-0003	No autorizado. La solicitud no llevaba un token bearer válido, o el gateway no pudo resolver un tenant a partir de ella.	`Unauthorized`, o una frase que nombra la causa, como `The bearer token was not accepted.`

403: Prohibido

`code`	Descripción	`detail`
CLT-0004	Prohibido. El solicitante autenticado no tiene permiso para esta operación. Un solicitante que actúa por un originador o por un fondo también recibe este código en un contrato que pertenece a otra parte.	`Forbidden`

404: No encontrado

`code`	Descripción	`detail`
CLT-0005	No encontrado. El registro que nombra la solicitud no existe para este tenant. Un artefacto retenido que pertenece a otro tenant responde de la misma manera.	`Not Found`, `The requested resource was not found.`, o una frase que nombra lo que falta, como `contract is not an averbação of this tenant`

409: Conflicto

`code`	Descripción	`detail`
CLT-0007	Conflicto. La solicitud entra en conflicto con el estado actual del registro.	`Conflict`, o la frase para el conflicto, como `an identical request is already in flight`.

CLT-0007 con el detail an identical request is already in flight marca una solicitud que el gateway no ha terminado. Reintenta esa solicitud con la misma clave de idempotencia. Los conflictos de comando responden con un código propio en lugar de CLT-0007, de modo que un cliente pueda distinguirlos. Lee code y detail juntos antes de reintentar. Estas grafías de código son parte del contrato de transmisión y no cambian.

Después de DATAPREV_CREDENTIAL_REQUIRED, carga el certificado de Dataprev, las credenciales de OAuth y el código de solicitante del tenant, y luego envía la solicitud de nuevo. Después de DATAPREV_CREDENTIAL_REVOKED, carga un nuevo certificado y un nuevo cliente de OAuth juntos con PUT /v1/credentials/dataprev. Después de DATAPREV_CREDENTIAL_REJECTED, corrige las credenciales de cliente OAuth del tenant, y luego envía una lectura de nuevo. Una escritura puede haber dejado su comando detenido: consulta Operar Lerian Consignado antes de enviarla de nuevo.

410: Ya no disponible

El barrido paginado del inventario de registros emite un cursor con una ventana de reintento limitada.

`code`	Descripción	`detail`
CURSOR_EXPIRED	Ya no disponible. La ventana de reintento del cursor pasó, por lo que el barrido al que pertenecía no puede continuar. Inicia un barrido nuevo en su lugar.	La ventana de reintento del cursor expiró.

413: Entidad de la solicitud demasiado grande

`code`	Descripción	`detail`
CLT-0010	Entidad de la solicitud demasiado grande. El payload de la solicitud es más grande de lo que acepta el endpoint, o el cuerpo de un comando contiene más tokens JSON de los que acepta el comando.	Nombra el límite que la solicitud superó, en bytes o en tokens JSON.

Un cuerpo de averbação que lleva la CCB firmada, el paquete de evidencias, la evidencia de firma o data_hora_assinatura se rechaza. Responde 413 con 1 MiB o más, y 422 con el detail validation failed por debajo de eso. Envíalos a POST /v1/consignado/contracts/{numero_contrato}/ccb-attachment cuando Dataprev acepte la averbação.

422: Entidad no procesable

`code`	Descripción	`detail`
CLT-0006	Entidad no procesable. El gateway leyó la solicitud y la rechaza en su forma actual. Un rechazo determinístico de Dataprev también responde aquí, y lleva `upstream`.	El motivo sobre el que actuar, como obtener una autorización de trabajador vigente.

Algunos rechazos responden con un código con nombre en lugar de CLT-0006. Nada llegó a Dataprev. La descripción dice qué hacer a continuación.

`code`	Descripción	`detail`
IDEMPOTENCY_KEY_REUSE	La clave `X-Idempotency` ya se consumió en una solicitud diferente. Envía la solicitud modificada con una clave nueva.	La clave X-Idempotency ya se usó con una solicitud diferente; envía una clave nueva para una solicitud modificada.
FUNDO_NOT_REGISTERED	`fundo_ref` no nombra un fondo registrado para este tenant. Corrige `fundo_ref`.	fundo_ref no nombra un fondo registrado para este tenant
FUNDO_DEACTIVATED	El fondo que nombra `fundo_ref` ya no acepta crédito nuevo.	el fondo nombrado está desactivado y no acepta crédito nuevo
FIRST_DEDUCTION_BEFORE_COMPETENCIA	`data_primeiro_desconto` cae en un mes anterior a `first_deduction_competencia`. Corrige las fechas.	Nombra la regla.
DECLARED_DATES_OUT_OF_ORDER	Las fechas declaradas rompen un orden que la contabilización exige. Corrige las fechas.	Nombra la regla.
FORMALIZATION_DEADLINE_EXCEEDED	`data_hora_assinatura` es posterior a `formalization_deadline`. Cuando la documentación responde este código, excluye la averbação y luego formaliza el contrato de nuevo.	Nombra la regla.
BOOKING_FIELD_INVALID	Lender no puede leer un campo del bloque de contabilización.	Nombra el campo.
DECLARED_TERMS_INCONSISTENT	Los montos o las tasas declarados se contradicen. Corrige los términos.	Nombra la regla.
MARGIN_SNAPSHOT_INCONSISTENT	`margin_snapshot` no cubre `installment_amount`. Lee el margen de nuevo o vuelve a fijar el precio del contrato.	Nombra la regla.
CONTRACT_NOT_BOOKABLE	Lender no puede contabilizar este contrato de ninguna forma. Envía la solicitud sin el bloque de contabilización.	Nombra la regla.
RATE_OUTSIDE_PRODUCT_RANGE	`monthly_rate` por 12 queda fuera del rango de tasa anual de la versión de producto de Lender que `loan_product_version` nombra. El gateway no verifica una versión que no recibió de Lender.	Nombra el rango.
BID_ORIGINADOR_UNKNOWN	El originador para el que se hace la oferta no está registrado para este tenant.	El originador para el que se hace esta oferta no está registrado para este tenant. Un bancarizador lo nombra en originadorRef; una credencial de originador oferta con su propia referencia, que debe estar registrada antes de ofertar.
BID_ORIGINADOR_INACTIVE	El originador para el que se hace la oferta ya no puede actuar por este tenant.	Puede que el originador para el que se hace esta oferta ya no actúe por este tenant. Un bancarizador lo nombra en originadorRef; una credencial de originador oferta con su propia referencia, que debe reactivarse antes de ofertar de nuevo.
BID_SOLICITACAO_UNKNOWN	El gateway no guarda ninguna solicitação descubierta con este identificador. Reintenta cuando llegue su evento `consignado.solicitacao.received`.	El gateway no guarda ninguna solicitação descubierta con este identificador. Reintenta cuando llegue su evento consignado_solicitacao.received; no se registró nada.
BID_NO_PROPOSTA_LEFT	Una oferta reanudada ya no tiene proposta para enviar de nuevo. Haz una oferta nueva.	No queda proposta para reintentar con esta clave de idempotencia: o su validadeProposta pasó y Dataprev ya no la acepta, o la retención de este servicio ya borró su payload guardado. Haz una oferta nueva si la solicitação sigue abierta.
PORTABILIDADE_WINDOW_EXPIRED	La ventana de la portabilidad pasó: los 20 días corridos para completar una portabilidad de salida, o la vigencia de la solicitação a la que responde una respuesta a la subasta de portabilidad.	Nombra la ventana.

Los códigos de contabilización, de FIRST_DEDUCTION_BEFORE_COMPETENCIA a CONTRACT_NOT_BOOKABLE, aplican solo a un contrato enviado con el bloque de contabilización. Una averbação responde todos los códigos de contabilización, excepto FORMALIZATION_DEADLINE_EXCEEDED. Su documentación responde solo DECLARED_DATES_OUT_OF_ORDER y FORMALIZATION_DEADLINE_EXCEEDED. Una importación de contrato con booking responde todos los códigos de contabilización, excepto FIRST_DEDUCTION_BEFORE_COMPETENCIA. Una averbação con el bloque de contabilización también responde RATE_OUTSIDE_PRODUCT_RANGE. Un comando enviado de nuevo con una clave de idempotencia que una solicitud anterior ya consumió puede responder uno de cuatro códigos con nombre. La solicitud anterior puede haber llegado ya a Dataprev. No envíes el comando de nuevo, ni con esta clave ni con una nueva. Lee el estado actual del registro que el comando cambia. La respuesta a la subasta de portabilidad es la excepción: su referencia explica cómo un reenvío con una clave nueva revela el resultado.

`code`	Descripción	`detail`
IDEMPOTENCY_STATE_UNRECOGNISED	El registro guardado bajo esta clave lo escribió una versión más nueva del servicio.	Una solicitud anterior consumió esta clave de idempotencia con un registro escrito por una versión más nueva de este servicio; concilia la solicitud original y no reintentes con una clave nueva.
IDEMPOTENCY_RECORD_UNREADABLE	El registro guardado bajo esta clave no se puede leer.	Una solicitud anterior consumió esta clave de idempotencia con un registro que este servicio no puede leer; concilia la solicitud original y no reintentes con una clave nueva.
IDEMPOTENCY_OUTCOME_UNRECORDED	La solicitud anterior bajo esta clave no tiene un resultado registrado.	Una solicitud anterior consumió esta clave de idempotencia y su resultado no se registró; concilia la solicitud original y no reintentes con una clave nueva.
IDEMPOTENCY_REPLAY_UNAVAILABLE	La solicitud anterior bajo esta clave se completó, y su respuesta no se puede reproducir.	Una solicitud anterior con esta clave de idempotencia se completó y su respuesta se entregó una vez, pero no se puede reproducir; no reenvíes, concilia el recurso que el comando modifica, y no reintentes con una clave nueva.

429: Demasiadas solicitudes

`code`	Descripción	`detail`
CLT-0009	Demasiadas solicitudes. El llamador superó su presupuesto de solicitudes.	`Too many requests were sent in a given amount of time.`

Espera el tiempo que indica el header Retry-After y luego envía la solicitud de nuevo.

500: Error interno del servidor

`code`	Descripción	`detail`
CLT-0002	Error interno del servidor. Un fallo inesperado dentro del gateway.	`internal error`

501: No implementado

Un 501 responde a una operación que tu despliegue no habilitó. Las rutas permanecen montadas, de modo que la respuesta llega por solicitud en lugar de como una ruta ausente. Estas operaciones responden 501 hasta que tu despliegue las habilite:

las descargas de artefactos de contrato
las correcciones de contrato
el envío de ofertas
las operaciones que llegan a Dataprev

La revocación de credenciales de Dataprev responde 501 en un despliegue cuyas credenciales son estáticas. El detail muestra internal error, porque Consignado sanea el detail en una respuesta 5xx. La revocación de credenciales es la excepción: su detail dice que las credenciales son estáticas. Distingue por el estado.

502: Gateway incorrecto

`code`	Descripción	`detail`
DATAPREV_INVALID_RESPONSE	Dataprev devolvió, para una lectura, datos que el gateway no puede usar. Nada cambió. Reintenta más tarde, o acota la ventana de la lectura.	Dataprev devolvió datos para esta lectura que el gateway no pudo usar; no se cambió nada. Reintenta más tarde o acota la ventana, e indica este instance si el problema persiste.

503: Servicio no disponible

`code`	Descripción	`detail`
CLT-0008	Servicio no disponible. El gateway no puede atender la solicitud ahora. Su almacenamiento propio o su custodia de credenciales no está disponible, o su control de ritmo de las llamadas a Dataprev retuvo la solicitud más allá de su plazo. Envía la misma solicitud de nuevo en breve, con la misma clave de idempotencia.	Una frase que nombra la causa, o `internal error`.
DATAPREV_UNAVAILABLE	Dataprev respondió con un fallo de reintentar más tarde, o no respondió. Reintenta más tarde con la misma clave de idempotencia.	Dataprev no está disponible para esta solicitud ahora; el miembro upstream lleva su propio código cuando envió uno. Reintenta más tarde, y reutiliza la misma clave X-Idempotency en un comando.
OUTCOME_UNKNOWN	El gateway no sabe si la solicitud tuvo efecto. No pudo registrar el resultado, o el acuse de Dataprev para una oferta fue ambiguo. Reintenta solo con la misma clave de idempotencia.	El gateway no pudo registrar el resultado de esta solicitud, por lo que no se sabe si tuvo efecto. Nunca la reenvíes con una clave nueva: reintenta con la MISMA clave X-Idempotency y, si ese reintento responde IDEMPOTENCY_OUTCOME_UNRECORDED, concilia la solicitud original.
STREAMING_HUB_UNAVAILABLE	El Streaming Hub detrás de las operaciones de suscripción no está disponible.	El streaming hub no está disponible. Reintenta más tarde, y reutiliza la misma clave X-Idempotency en un cambio.
TENANT_MANAGER_UNAVAILABLE	El Tenant Manager no está disponible, por lo que el gateway no puede resolver tu tenant. Solo un despliegue multi-tenant responde este código.	el tenant manager no está disponible; reintenta la solicitud más tarde
AUT-0033	El Access Manager no decidió sobre esta solicitud.	El Access Manager no decidió esta solicitud. Espera un momento y vuelve a intentarlo.

Una respuesta DATAPREV_UNAVAILABLE o DATAPREV_TIMEOUT también lleva upstream cuando Dataprev envió su propio código y mensaje.

504: Timeout del gateway

`code`	Descripción	`detail`
DATAPREV_TIMEOUT	Dataprev no respondió a tiempo. Si la solicitud cambia el estado en Dataprev, su resultado es desconocido. Reintenta solo con la misma clave de idempotencia.	Dataprev no respondió a tiempo, por lo que, si esta solicitud cambia el estado en Dataprev, su resultado es desconocido. Nunca la reenvíes con una clave nueva: reintenta con la MISMA clave X-Idempotency y, si ese reintento responde IDEMPOTENCY_OUTCOME_UNRECORDED, concilia la solicitud original.
STREAMING_HUB_TIMEOUT	El Streaming Hub detrás de las operaciones de suscripción no respondió a tiempo.	El streaming hub no respondió a tiempo. Reintenta, y reutiliza la misma clave X-Idempotency en un cambio.
TENANT_MANAGER_TIMEOUT	El Tenant Manager no respondió a tiempo. Solo un despliegue multi-tenant responde este código.	el tenant manager no respondió a tiempo; reintenta la solicitud
AUT-1021	El Access Manager no respondió a tiempo.	El Access Manager no respondió a tiempo. Vuelve a intentarlo.

Códigos por operación

Algunas operaciones responden con códigos propios, nombrados a partir de la operación: FUNDO_*, ORIGINADOR_*, CESSAO_*, CEDED_CREDIT_*, SALDO_DEVEDOR_*, REGISTRO_B3_*, y los códigos de cursor y de filtro de las operaciones de listado. La referencia de la API enumera todos los códigos en el campo code de su esquema de error. Las operaciones del código de instrumento B3, GET y PATCH /v1/consignado/contracts/{numero_contrato}/registro-b3, responden con estos códigos.

`code`	Estado	Descripción	`detail`
REGISTRO_B3_CONTRATO_NAO_ENCONTRADO	404	Este tenant no tiene ningún contrato con este número.	No se encontró ese contrato para este tenant.
REGISTRO_B3_NAO_INFORMADO	404	El contrato todavía no tiene código de instrumento B3.	El contrato todavía no tiene registro B3.
REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA	409	La averbação del contrato no está confirmada. El gateway acepta el código solo después de que se confirma la averbação.	La averbação del contrato no está confirmada.
REGISTRO_B3_JA_INFORMADO	409	El contrato ya tiene otro código u otra fecha de registro. La API no ofrece corrección. Enviar el mismo registro de nuevo responde `200`.	El contrato ya tiene un registro B3 diferente.
REGISTRO_B3_DATA_REGISTRO_INVALIDA	422	`dataRegistro` está en el futuro o es anterior a la averbação.	dataRegistro no puede estar en el futuro ni ser anterior a la averbação.
REGISTRO_B3_INTERNAL	500	Un fallo inesperado.	`internal error`
REGISTRO_B3_UNWIRED	501	Este despliegue no registra el código de instrumento B3.	`internal error`
REGISTRO_B3_UNAVAILABLE	503	El almacenamiento del código de instrumento B3 no está disponible. Envía la solicitud de nuevo en breve.	`internal error`

Códigos de motivo de Dataprev

Consignado retransmite los códigos de motivo de Dataprev en lugar de asignarlos a códigos propios. Esto mantiene un rechazo legible frente a lo que Dataprev dijo. Lee cada código de motivo contra la especificación de Dataprev, no contra esta página. Dataprev puede publicar un código que esta página no incluye, y el gateway igual te lo entrega. Te llegan en dos lugares. En un rechazo. El miembro upstream lleva el code y el message propios de Dataprev. Un rechazo con varios códigos los lista separados por comas. El miembro contiene los códigos y las frases de Dataprev, con longitud acotada, no un cuerpo de respuesta. Un 422 lo lleva para un rechazo determinístico. DATAPREV_UNAVAILABLE y DATAPREV_TIMEOUT lo llevan para un fallo de reintentar más tarde. Un rechazo de Dataprev a un comando en upstream queda retenido bajo su clave de idempotencia. Un refusal de oferta también, sea cual sea su source. La misma clave devuelve el mismo rechazo, así que envía una solicitud corregida con una clave nueva. Una oferta rechazada con source dataprev también retiene su solicitação, así que cualquier oferta nueva para esa solicitação responde BID_SOLICITACAO_TAKEN. Un rechazo que el gateway hace por su cuenta, sin upstream y sin miembro refusal de oferta, no retiene la clave, así que una solicitud corregida puede ir con la misma clave. Una ejecución de garantía FGTS y un comando que responde códigos RAIL_COMMAND_* son la excepción: retienen la clave desde antes de llamar a Dataprev. Cuando un reenvío responde que una solicitud anterior ya tiene la clave, como IDEMPOTENCY_KEY_REUSE o RAIL_COMMAND_PAYLOAD_MISMATCH, sigue la instrucción de ese código. En las respuestas de contrato y margen. Varios campos de respuesta emparejan un código de motivo de Dataprev con la etiqueta propia de Dataprev para él. Una lectura de margen publica blockType y ineligibilityReason, que forman el par code y description. Una lectura de contrato publica motivo_exclusao, origem_averbacao, origem_exclusao, portabilidade_situacao, y situacao_bloqueio_garantia, que lo forman como codigo y descricao. Cada campo contiene un código numérico y el texto que Dataprev devolvió junto a él. Trata el conjunto como abierto. Asigna los códigos de motivo sobre los que actúa tu integración, y transmite el resto con sus etiquetas, de modo que un código que aún no hayas asignado siga siendo legible para un operador.

Configuración del tenant y credenciales

Datos del trabajador y margen

Subastas y propuestas

Registro y documentos del contrato

Correcciones del contrato

Ciclo de vida del contrato

Refinanciación, renegociación y portabilidad

Contratos legados

Garantías del FGTS

Conciliación y calendario

Fondos y cesiones

Acceso de socio del fondo

Acceso de socio del originador

Capacidad

Monitoreo

Suscripciones de eventos

Manejo de errores

Eventos

Lista de errores de Consignado

400: Solicitud incorrecta

401: No autorizado

403: Prohibido

404: No encontrado

409: Conflicto

410: Ya no disponible

413: Entidad de la solicitud demasiado grande

422: Entidad no procesable

429: Demasiadas solicitudes

500: Error interno del servidor

501: No implementado

502: Gateway incorrecto

503: Servicio no disponible

504: Timeout del gateway

Códigos por operación

Códigos de motivo de Dataprev

​400: Solicitud incorrecta

​401: No autorizado

​403: Prohibido

​404: No encontrado

​409: Conflicto

​410: Ya no disponible

​413: Entidad de la solicitud demasiado grande

​422: Entidad no procesable

​429: Demasiadas solicitudes

​500: Error interno del servidor

​501: No implementado

​502: Gateway incorrecto

​503: Servicio no disponible

​504: Timeout del gateway

​Códigos por operación

​Códigos de motivo de Dataprev

400: Solicitud incorrecta

401: No autorizado

403: Prohibido

404: No encontrado

409: Conflicto

410: Ya no disponible

413: Entidad de la solicitud demasiado grande

422: Entidad no procesable

429: Demasiadas solicitudes

500: Error interno del servidor

501: No implementado

502: Gateway incorrecto

503: Servicio no disponible

504: Timeout del gateway

Códigos por operación

Códigos de motivo de Dataprev