Lista de errores de Consignado

Lerian Consignado devuelve respuestas de error estructuradas. Consulta cada código de error CLT, su significado y los códigos de motivo que provienen directamente de Dataprev.

Formato de error

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

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.
• existing_id – En un rechazo subscription_name_taken, el id de la suscripción activa en tu alcance que tiene ese nombre.
• error_class y status_code – En una edición de suscripción que responde 422 con upstream.code destination_probe_failed, la clase de la sonda que falló y, cuando el destino respondió, su estado HTTP.

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
ORIGINADOR_DEACTIVATED	El bancarizador desactivó al originador por el que actúa la credencial de socio. Toda ruta de socio originador rechaza la credencial hasta que el bancarizador reactive al originador.	El originador por el que actúa esta credencial de socio está desactivado. El bancarizador debe reactivarlo antes de que el socio pueda actuar de nuevo.
FUNDO_PARTNER_DEACTIVATED	El bancarizador desactivó al fondo por el que actúa la credencial de socio. Toda ruta de socio fondo rechaza la credencial hasta que el bancarizador reactive al fondo. Un crédito nuevo que nombra un fondo desactivado responde 422 FUNDO_DEACTIVATED.	El fondo por el que actúa esta credencial de socio está desactivado. El bancarizador debe reactivarlo antes de que el socio pueda actuar de nuevo.
AUT-1022	Alcance de socio ambiguo. Una credencial de socio originador llamó a una ruta sin el id del originador en la ruta (/v1/consignado/originador o una ruta bajo él), y su alcance incluye más de un originador.	el socio de esta credencial alcanza más de un valor de originador para este producto, y esta ruta necesita exactamente uno; llama a una ruta que nombre el valor, o restringe el alcance del socio en el Access Manager

Un gateway cuya licencia de Lerian falló rechaza toda solicitud nueva en el puerto principal con 403 mientras se apaga, excepto /health y /version. Ese cuerpo no es problem details: es un JSON con code, title y message. Para sus códigos, consulta la lista de errores del License Manager. En un despliegue BYOC, revisa LICENSE_KEY o LICENSE_FILE_PATH.

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

Una primera corrección de CCB para un número de contrato que el tenant nunca registró ni importó responde este código, y el gateway no retiene nada. Un contrato que salió del registro todavía acepta correcciones.

Una exclusión de un contrato que tiene una averbação contabilizada en el gateway, pero salió del registro, responde este código con el detalle the gateway holds neither a booked averbação nor a live M015 obligation of this contract for this tenant. No se envía nada a Dataprev.

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.

code	Descripción	detail
FGTS_EXECUTION_PAYLOAD_MISMATCH	Esta clave de idempotencia ya contiene una ejecución de garantía FGTS diferente.	Esta clave de idempotencia ya contiene una ejecución de garantía FGTS diferente. Reenvía la solicitud original con esta clave para reproducirla, o usa una clave nueva para una ejecución diferente.
FGTS_EXECUTION_OUTCOME_UNRESOLVED	La ejecución retenida bajo esta clave de idempotencia todavía no tiene un resultado conocido, por lo que no se puede reproducir.	La ejecución de la garantía FGTS retenida bajo esta clave de idempotencia todavía no tiene un resultado conocido, por lo que no se puede reproducir. Ejecutar el mismo contrato con una clave nueva arriesga mover el dinero dos veces.
FGTS_EXECUTION_ALREADY_REFUSED	La ejecución retenida bajo esta clave de idempotencia fue rechazada, por lo que una solicitud corregida necesita una clave nueva.	La ejecución de la garantía FGTS retenida bajo esta clave de idempotencia fue rechazada. Esta clave solo puede devolver ese rechazo, por lo que una solicitud corregida necesita una clave nueva.
FGTS_EXECUTION_CONTRACT_TAKEN	Otra clave de idempotencia ya mantiene una ejecución de la garantía FGTS de este contrato: ejecutada, en curso o sin resultado conocido. Esta solicitud no se ejecutó. Lee GET /v1/consignado/contracts/{numero_contrato}/fgts-garantia/execucao antes de tratar la garantía como ejecutada.	La garantía FGTS de este contrato ya se ejecutó con otra clave de idempotencia, y una garantía se ejecuta una sola vez. Esta solicitud no se ejecutó.
BID_SOLICITACAO_TAKEN	Esta solicitação ya lleva una oferta de esta institución.	Esta solicitação ya lleva una oferta de esta institución, y una solicitação admite una. Consulta el libro de ofertas para conocer el resultado de la oferta que la retiene.
BID_PROPOSAL_SLOT_TAKEN	Un envío anterior ocupa la posición de la propuesta, por lo que esta oferta no se registró.	Una posición de propuesta en esta oferta ya está ocupada por un envío anterior, por lo que esta oferta no se registró. Consulta el libro de ofertas para conocer el resultado del envío que la ocupa.
AVERBACAO_CLAIM_CONFLICT	La averbação de este contrato ya está reclamada con otra clave de idempotencia.	La averbação de este contrato ya está reclamada con otra clave de idempotencia. Sigue el reclamo existente en lugar de abrir uno segundo.
AVERBACAO_ARTIFACT_CONFLICT	Ya hay un documento diferente retenido para la averbação de este contrato. Esta solicitud no se aplicó.	Ya hay un documento diferente retenido para la averbação de este contrato, y un documento retenido nunca se reemplaza. Esta solicitud no se aplicó.
AVERBACAO_NOT_ACCEPTED	La documentación necesita una averbação que Dataprev aceptó, y este contrato no tiene ninguna. El rechazo es definitivo solo cuando la averbação lee rejected. La credencial del tenant la lee en GET .../averbacao. Una credencial de originador o de fondo reenvía el mismo cuerpo de la averbação con una clave nueva.	La documentación necesita una averbação aceptada por Dataprev, y este contrato no tiene ninguna: consulta GET …/averbacao. No se envió nada a Dataprev.
AVERBACAO_DOCUMENTATION_CONFLICT	Este contrato tiene una documentación que Dataprev aceptó o que está en camino, o su propuesta de subasta ya se resolvió. Un contrato admite una única documentación aceptada, y una propuesta resuelta no admite ninguna.	Este contrato tiene una documentación que Dataprev aceptó o que está en camino (sigue la existente), o su propuesta de subasta ya se resolvió y no se acepta documentación para él. No se envió nada a Dataprev.
AVERBACAO_EXCLUDED	Se solicitó una exclusión de esta averbação, o el contrato salió del registro, por lo que el gateway no acepta documentación para ella. Si Dataprev rechaza la exclusión, la misma documentación pasa.	Se solicitó una exclusión de este contrato y Dataprev no la rechazó (consulta GET …/exclusion), o el contrato salió del registro: un refinanciamiento, una renegociación o una exclusión de portabilidad registrados aquí lo sacaron, o Dataprev lo mostró excluido o terminado fuera de este gateway (consulta dataprev_follow_up en GET …/averbacao). No se acepta documentación para él, y no se envió nada a Dataprev.
AVERBACAO_HELD_BY_ANOTHER_SENDER	Una credencial de otro tipo envió esta misma solicitud primero, y no llegó a Dataprev. Solo una credencial de ese tipo puede reanudarla, enviándola de nuevo.	Una credencial de otra naturaleza (bancarizador, fondo u originador) envió esta misma solicitud primero y no llegó a Dataprev: solo una credencial de esa naturaleza la reanuda, enviándola de nuevo. No se envió nada a Dataprev.
EXCLUSION_AUTHORITY_CONFLICT	La exclusión de este contrato ya está registrada bajo otra autoridad. Esta solicitud no se aplicó.	La exclusión de este contrato ya está registrada bajo otra autoridad, y una exclusión no tiene deshacer. Esta solicitud no se aplicó.
EXCLUSION_DOCUMENTATION_UNDERWAY	Una llamada de documentación a Dataprev está en curso para este contrato, por lo que no está confirmado y no se puede excluir ahora. Lo mismo vale para el nuevo contrato que creó una renegociación, mientras corre su llamada de documentación. Una documentación que el gateway registró pero todavía no envió no bloquea la exclusión: la exclusión la descarta.	La documentación de este contrato está en camino a Dataprev, por lo que todavía no está confirmado y no se puede excluir ahora. Envía la exclusión de nuevo cuando GET /v1/consignado/averbacao-operations liste el contrato como confirmed o attachment_pending, o cuando su attachment_invocation_deadline_at haya pasado. No se envió nada a Dataprev.
EXCLUSION_RENEGOTIATION_UNDERWAY	Una renegociación que reemplaza este contrato todavía no tiene respuesta de Dataprev, por lo que el contrato no se puede excluir ahora.	La renegociación de este contrato todavía no fue respondida por Dataprev, por lo que el contrato puede ser reemplazado y no se puede excluir ahora. Envía la exclusión de nuevo cuando GET /v1/consignado/rail-commands muestre la renegociación aceptada o rechazada. No se envió nada a Dataprev.
RENEGOTIATION_EXCLUSION_UNDERWAY	Se solicitó una exclusión del contrato cerrado y Dataprev no la rechazó, por lo que la renegociación no se puede enviar ahora.	Se solicitó una exclusión del contrato cerrado y Dataprev no la rechazó (lee GET /v1/consignado/contracts//exclusion), por lo que no se puede renegociar ahora. No se envió nada a Dataprev; envía la renegociación de nuevo solo si esa exclusión termina rechazada.
EXCLUSION_BOOKING_IDENTITY_INCOMPLETE	Los datos de contabilización que el gateway guarda para este contrato no tienen la identidad del trabajador o del empleador que exige el Manual 003. Ninguna solicitud puede corregirlos: informa a Lerian con el instance.	El booking que el gateway guarda para este contrato no tiene la identidad del trabajador o del empleador que exige el M003, por lo que la exclusión no se puede enviar. Corrige el booking; ningún cambio en esta solicitud puede tener éxito.
RAIL_COMMAND_CLAIM_CONFLICT	Este comando ya está reclamado para este contrato con otra clave de idempotencia.	Este comando ya está reclamado para este contrato con otra clave de idempotencia. Sigue el reclamo existente en lugar de abrir uno segundo.
RAIL_COMMAND_PAYLOAD_MISMATCH	Esta clave de idempotencia ya contiene un comando diferente para este contrato.	Esta clave de idempotencia ya contiene un comando diferente para este contrato. Reenvía la solicitud original con esta clave para reproducirla, o usa una clave nueva para un comando diferente.
RAIL_COMMAND_ALREADY_REFUSED	El comando retenido bajo esta clave de idempotencia fue rechazado, por Dataprev o antes de llegar a Dataprev. Una solicitud corregida necesita una clave nueva.	El comando retenido bajo esta clave de idempotencia fue rechazado, por Dataprev o antes de llegar a Dataprev. Esta clave solo puede devolver ese rechazo, por lo que una solicitud corregida necesita una clave nueva.
RAIL_COMMAND_OUTCOME_UNRESOLVED	El comando retenido bajo esta clave de idempotencia todavía no tiene un resultado conocido. No lo envíes con una clave nueva.	El comando retenido bajo esta clave de idempotencia todavía no tiene un resultado conocido, por lo que no se puede reproducir. Consulta GET /v1/consignado/rail-commands; no lo envíes con una clave nueva.
RAIL_COMMAND_ANSWER_NOT_RETAINED	Este comando ya se confirmó para este contrato, y su respuesta original no se conservó.	Este comando ya se confirmó para este contrato, pero su respuesta original no se conservó, por lo que no hay nada que reproducir. Consulta el estado actual del contrato en lugar de volver a enviarlo.
RAIL_COMMAND_NOT_CLOSEABLE	El banco no puede cerrar este comando detenido ahora. El banco cierra solo un refinanciamento, renegociação, alteração de termos, renegociação de legado o exclusión por portabilidad que esté detenido en outcome_unknown.	El banco cierra solo un refinanciamento, renegociação, alteração de termos, renegociação de legado o exclusión por portabilidad detenido en outcome_unknown, una sola vez. Este es de otro tipo, no está detenido, se detuvo hace menos de cinco minutos, ya está cerrado con otra respuesta, es una alteração sustituida o sin términos declarados, o lo retiene otro contrato vigente hasta que se registre la reversión de ese contrato. Lee GET /v1/consignado/rail-commands.
RAIL_COMMAND_CLOSE_CONTRADICTED	La única lectura del contrato por Dataprev contradice la declaración del banco de que el comando fue aceptado. No se escribió nada.	La lectura del contrato por Dataprev contradice un cierre como aceptado: el contrato no existe, es otro, no está vigente (o, para una exclusión por portabilidad, no está excluido por portabilidad), tiene antecipações, o lleva términos que el informe de saldo devedor no puede contener. No se escribió nada; la operação Lerian lo resuelve.
REVERSAO_WINDOW_EXPIRED	La ventana para revertir este refinanciamiento se cerró, por lo que ninguna corrección la reabre.	La ventana para revertir este refinanciamiento se cerró, por lo que la reversión ya no se puede solicitar. Ninguna corrección de esta solicitud puede reabrirla.
DISBURSEMENT_PAYMENT_CONFLICT	Esta referencia de pago ya contiene una confirmación con otro monto u otra hora de pago. Registra una corrección de desembolso para cambiarla.	Este payment_reference ya contiene una confirmación con un amount o un paid_at diferente, y una confirmación es inmutable. Registra una corrección de desembolso (correction_type=disbursement) para cambiarla.
CONTRACT_ALREADY_REGISTERED	La importación de contrato nombra un contrato que este tenant ya tiene: en su libro de saldo devedor, para una importación sin contabilización, o en su libro de averbações, para una importación con contabilización. Una averbação lo responde cuando su número de contrato ya es un contrato en este gateway. Ese contrato vino de un refinanciamiento, una renegociación, una importación o una portabilidad.	Para una importación, nombra el libro que contiene el contrato y el siguiente paso: lee la obligación que existe, o reenvía la importación original para reproducirla. Para una averbação: este número de contrato ya es un contrato en este gateway, creado por un refinanciamiento o una renegociación, importado, o recibido por portabilidad. No se puede averbar de nuevo. No se escribió nada y no se envió nada a Dataprev.
DATAPREV_CREDENTIAL_REQUIRED	El tenant no tiene una credencial de Dataprev en custodia, por lo que ninguna operación del riel puede ejecutarse para él.	Este tenant no tiene una credencial de Dataprev en custodia, por lo que el gateway no puede actuar por él en el riel. Aprovisiona la credencial primero; ninguna corrección de esta solicitud puede tener éxito hasta entonces.
DATAPREV_CREDENTIAL_REJECTED	Dataprev rechazó las credenciales de cliente OAuth del tenant.	Dataprev rechazó las credenciales de cliente OAuth de este tenant. Corrígelas en la custodia de credenciales del gateway; reintentar sin cambios no puede tener éxito.
DATAPREV_CREDENTIAL_REVOKED	Las credenciales de Dataprev del tenant fueron revocadas. Las operaciones del riel responden este código, y también las cargas de certificado, de credenciales OAuth y de código de solicitante. Una carga completa que lleva el certificado revocado, o un secreto de cliente OAuth que una revocación retiró, también lo responde.	Las credenciales de Dataprev de este tenant fueron revocadas, y el material revocado nunca se usa de nuevo. La custodia vuelve solo a través de una carga completa, el certificado y el cliente de OAuth juntos: PUT /v1/credentials/dataprev con certPem, keyPem, clientId y clientSecret. Un secreto de cliente retirado responde una frase que indica generar de nuevo el secreto en Dataprev.

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. El client id puede seguir siendo el mismo, pero el secreto del cliente debe generarse de nuevo en 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ó.

412: Precondición fallida

---

code	Descripción	detail
CLT-0012	Precondición fallida. Una edición de suscripción envió un ETag en If-Match, y la suscripción cambió después de esa lectura. El upstream.code es subscription_changed. Lee la suscripción de nuevo y envía la edición de nuevo con el nuevo ETag.	Nombra la causa.

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	La tasa anual efectiva de monthly_rate, (1 + monthly_rate/100)^12 − 1, queda fuera del rango de tasa anual de la versión de producto de Lender que loan_product_version nombra. El rango incluye sus límites.	Nombra el rango.
LOAN_PRODUCT_VERSION_UNKNOWN	loan_product_version nombra una versión que el gateway no recibió de Lender. Una versión creada hace instantes puede estar todavía en camino, así que envía la solicitud de nuevo más tarde. Una versión creada antes de que el gateway se vinculara al tenant nunca llega: crea una nueva versión en Lender. Un tenant sin versión de Lender no se verifica.	Nombra la regla.
VERSION_ADMITS_NO_PESSOA_FISICA	Lender publicó la versión que loan_product_version nombra como una que no admite pessoaFisica. Una versión publicada sin los tipos de tomador admitidos no se verifica.	Nombra la regla.
MATRICULA_DIFFERS_FROM_PROPOSAL	La matricula de la averbação difiere de aquella para la que se ganó su numero_proposta. Corrige la matricula. Una propuesta que el gateway no tiene, o una guardada sin matricula, pasa.	Nombra la regla.
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.
PRELEILAO_WORKER_UNAVAILABLE	El gateway no ejecuta el worker de la presubasta. Rechaza una configuración con ativo igual a true y una cotización, y no registra nada.	La presubasta no puede correr en este despliegue ahora: reintenta más tarde; no se registró nada.
PRELEILAO_POLICY_INVALID	Una política de fondo tiene un mínimo por encima del máximo, o un horario cuyo fin no es posterior al inicio. Corrige la política.	Nombra la regla.
BID_FUND_REQUIRED	La solicitud de préstamo tiene una ventana de presubasta, y la cotización no nombra un fondo. Envía fundoRef.	Esta solicitud está bajo la presubasta: nombra en fundoRef el fondo que financia la cotización.
BID_FUND_NOT_ACCEPTED	La solicitud de préstamo no tiene ventana de presubasta, así que la oferta no nombra un fondo. Envía la oferta sin fundoRef.	Esta solicitud no está bajo la presubasta, así que una cotización no nombra fondo: envía la oferta sin fundoRef.
BID_FUND_NOT_IN_PRELEILAO	La política del fondo define participa como false. Cotiza en otro fondo, o pide al bancarizador que active la participación.	La política de presubasta del fondo tiene participa igual a false, así que no recibe cotizaciones: cotiza en otro fondo, o pide al bancarizador que vuelva a activar la participación.
BID_FUND_OUTSIDE_HOURS	El fondo está fuera de su horario. Envía la cotización dentro del horario del fondo.	El fondo está fuera de su horario de presubasta ahora: envía la cotización dentro de la ventana del fondo.
BID_FUND_POLICY_VIOLATION	Un término de la cotización está fuera de las restricciones del fondo.	Nombra el término y el límite.
BID_FUND_OUTSIDE_MANDATE	El fondo no está en el mandato del originador. Una cotización y un rechazo responden este código. Pide al bancarizador que agregue el fondo, o usa otro fondo.	El fondo no está en el mandato de este originador: pide al bancarizador que lo agregue, o cotiza en otro fondo.
BID_QUOTE_UNSECURED_REQUIRED	Las propuestas de la cotización no incluyen ninguna sin garantía. Agrega una con temGarantias igual a false.	La cotización necesita una propuesta sin garantías: agrega una con temGarantias false.
BID_QUOTE_WINDOW_CLOSED	La ventana de cotización de la presubasta está cerrada. La elección decide el ganador.	La ventana de cotización de esta presubasta está cerrada: la elección decide el ganador, no se acepta ninguna cotización.
BID_QUOTE_REVISION_LIMIT	El originador y el fondo ya usaron las 10 revisiones de cotización de esta solicitud de préstamo.	Este par de originador y fondo ya usó sus 10 revisiones de cotización de esta solicitud.
BID_QUOTE_NOT_IN_PRELEILAO	Un rechazo nombra una solicitud de préstamo sin ventana de presubasta.	Esta solicitud no tiene presubasta: no hay nada que rechazar.
FUNDO_DIFFERS_FROM_QUOTE	La averbação cita el número de una cotización y nombra otro fondo. Nombra el fondo de la cotización. Nada llega a Dataprev.	Nombra la regla.
FUNDO_POLICY_VIOLATION	Un término de la averbação está fuera de las restricciones del fondo. Nada llega a Dataprev.	Nombra el término y el límite.
REVERSAO_ORIGINAL_NOT_REPLACED	numeroContratoOriginal nombra un contrato que el refinanciamiento no reemplazó. Corrígelo u omítelo. El gateway no registra nada.	Nombra la regla.
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 VERSION_ADMITS_NO_PESSOA_FISICA, aplican solo a una solicitud enviada con el bloque de contabilización. El gateway verifica la versión en este orden: LOAN_PRODUCT_VERSION_UNKNOWN, VERSION_ADMITS_NO_PESSOA_FISICA y luego RATE_OUTSIDE_PRODUCT_RANGE. MATRICULA_DIFFERS_FROM_PROPOSAL aplica a una averbação con o sin el bloque de contabilización.

Cada superficie responde estos códigos de contabilización:

• Una averbação: todos los códigos de contabilización, excepto FORMALIZATION_DEADLINE_EXCEEDED.
• La documentación de una averbação: solo DECLARED_DATES_OUT_OF_ORDER y FORMALIZATION_DEADLINE_EXCEEDED.
• Una importación de contrato con booking: todos los códigos de contabilización, excepto FIRST_DEDUCTION_BEFORE_COMPETENCIA.
• Un refinanciamento con booking: todos los códigos de contabilización, excepto FORMALIZATION_DEADLINE_EXCEEDED.
• Una averbação de portabilidad con booking: todos los códigos de contabilización, excepto FIRST_DEDUCTION_BEFORE_COMPETENCIA y FORMALIZATION_DEADLINE_EXCEEDED.

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. Un cambio de suscripción que el Streaming Hub pudo haber confirmado sin registrar su resultado también responde este código, con upstream.code idempotency_outcome_unrecorded. Lee la suscripción antes de enviar el cambio de nuevo, con esta clave o con una nueva.	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. Cuando el detalle dice que el gateway cerró el comando como rechazado, no se ejecutó nada en Dataprev: envía el comando de nuevo con una clave nueva.	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, el acuse de Dataprev para una oferta fue ambiguo, o la respuesta de Dataprev a un comando del riel no lo resolvió. Reintenta solo con la misma clave de idempotencia, excepto en un comando del riel y en una averbação de portabilidad cuyo detalle diga que no se envió de nuevo.	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, DATAPREV_TIMEOUT u OUTCOME_UNKNOWN también lleva upstream cuando Dataprev envió su propio código y mensaje.

Un comando del riel que responde OUTCOME_UNKNOWN está detenido. Dataprev respondió con un código que no es rechazo ni aceptación, no respondió a tiempo, o respondió sin su sobre. No lo envíes de nuevo, ni con una clave nueva ni con la misma, porque la misma clave responde RAIL_COMMAND_OUTCOME_UNRESOLVED. Lee GET /v1/consignado/rail-commands para ver el resultado. Una suspensão, reativação, o inclusión o exclusión de legado detenida sigue en outcome_unknown: confirma su efecto en el portal de Dataprev.

Una averbação de portabilidad lo responde mientras el gateway resuelve el contrato en Dataprev. Reenviar con cualquier clave es seguro, y no llega nada de nuevo a Dataprev hasta que el resultado se resuelva.

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. Un comando del riel no responde este código: responde OUTCOME_UNKNOWN.	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_*, CEDED_CREDIT_*, SALDO_DEVEDOR_*, REGISTRO_B3_*, HELD_REPASSE_*, 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, o Dataprev rechazó su averbação. En el GET, una averbação que todavía no tiene respuesta de Dataprev también responde este código.	No se encontró ese contrato para este tenant.
REGISTRO_B3_NAO_INFORMADO	404	Dataprev aceptó la averbação del contrato, y 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 sigue en curso, o fue aceptada pero no 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. Un registro diferente responde este código aunque su fecha fuera inválida.	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. El gateway solo la verifica mientras el contrato no tiene código.	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

La liberación de repasse retenido, POST /v1/consignado/reconciliation/held-repasses/{id}/release, responde estos códigos. En todo 409, el repasse sigue retenido en el panel.

code	Status	Descripción	detail
HELD_REPASSE_NOT_FOUND	404	Ningún repasse retenido tiene este id, o ya fue liberado.	Este tenant no tiene ningún repasse retenido con este id.
HELD_REPASSE_UNATTRIBUTABLE	409	Ninguna expectativa de esa competencia da el empleador del repasse.	Ninguna promesa de ese mes da el empleador de este repasse: no existe ninguna para este contrato, o ninguna nombra al empleador. El repasse sigue retenido en el panel.
HELD_REPASSE_MONTH_MISMATCH	409	El repasse tiene su propia competencia, y solo esa competencia lo libera.	Este repasse tiene su propio mes (el del riel, o el mes anterior al pago de la guía, hora de Brasilia), y solo ese mes lo libera. El repasse sigue retenido en el panel.
HELD_REPASSE_MONTH_CLOSED	409	Otro repasse ya cerró la expectativa de esa competencia.	Otro repasse ya cerró la promesa de ese mes y este no se registró en ella. El repasse sigue retenido en el panel.

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 tres 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, y OUTCOME_UNKNOWN lo lleva para un comando del riel detenido.

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.

En un comando del riel. El response_code de un comando en GET /v1/consignado/rail-commands también trae códigos que el propio gateway escribe, y empiezan con GW-. Los códigos de rechazo de abajo también llegan al reason_code de los hechos de rechazo.

• GW-NAO-ENVIADO: la llamada no salió del gateway, así que no se ejecutó nada en Dataprev. El comando se cierra como rechazado. Envíalo de nuevo con una clave nueva.
• GW-BANCO-RECUSADO: el banco cerró el comando detenido como rechazado, según lo que muestra el portal de Dataprev.
• GW-M005-NAO-EXECUTADO: una lectura del contrato en Dataprev muestra que el comando no se ejecutó.

Los demás valores GW- marcan un comando que el gateway o el banco cerró como aceptado.

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.