API Docs Início Documentação Referência de API Copiar para LLM
CaaS Massificados · Consignado privado

Consignado privado — Erros e troubleshooting

Dado pessoal ou sensível deve ser mascarado em outputs, logs e exemplos. Todos os valores desta página são fictícios.

O que é

Os erros que aparecem de fato na integração do consignado privado, agrupados pela etapa em que aparecem, com causa e ação corretiva. Cada linha responde: por que aconteceu e o que fazer agora.

Quando usar

Erros por etapa

Autenticação

Sintoma Causa provável Ação corretiva
401 em qualquer rota Token expirado ou header ausente. Emita um token novo e reenvie. Ver Autenticação.
403 em todas as rotas do Crédito do Trabalhador Ambiente do parceiro sem habilitação do Crédito do Trabalhador. Acione a UY3: a habilitação é por ambiente, não por chamada.

Autorização de margem

Sintoma Causa provável Ação corretiva
400 ao registrar a autorização additionalData enviado sem ip, geoLocation ou deviceModel. Complete o objeto ou não o envie. Ver 2.1 Autorização de margem.
Autorização parada em Pending O trabalhador ainda não concluiu o aceite no canal. Aguardar. Se o canal é LinkWeb, confirme que o link foi entregue.
Autorização Refused O trabalhador recusou, ou a validação do canal falhou — em geral porque o telefone informado não é o dele. Confira o telefone e colete novo consentimento.
Tentativa de informar personId na autorização O corpo da autorização não tem esse campo: ela se identifica por CPF e telefone. Remova. A autorização vem antes do cadastro do tomador, por desenho. Ver 2. Pré-requisitos e cadastros.

Consulta de margem

Sintoma Causa provável Ação corretiva
Consulta recusada por falta de autorização Não existe autorização Approved para o CPF, ou a autorização existente já não é aceita. Confirme o status na listagem. Se estiver Approved e a consulta continuar recusando, a autorização venceu: colete novo consentimento e registre outra.
Margem retornada zerada ou insuficiente Trabalhador sem margem livre — em geral por outros contratos consignados ativos — ou vínculo encerrado. Não há operação possível agora. Reconsulte mais tarde; não force a proposta.
Vínculo não encontrado CNPJ do empregador ausente na consulta, ou empregador sem registro na averbadora. Envie employerRegistrationNumber e confirme com a UY3 se o empregador está integrado.
Consulta por personId devolve vazio, por CPF funciona O personId informado é de outro correspondente, ou o cadastro não existe ainda. Antes do cadastro, consulte por registrationNumber. Depois dele, por personId.

Simulação

Duas coisas diferentes se parecem aqui, e confundi-las custa tempo. Não haver oferta elegível e não haver resultado para uma simulação específica têm causas e ações distintas.

Sem oferta elegível Sem resultado para esta simulação
O que aconteceu Nenhum produto habilitado atende àquele trabalhador, com aquela margem e aquele vínculo. Existem ofertas para o trabalhador, mas nenhuma com os parâmetros que você pediu.
Como identificar Uma simulação sem restrição de valor nem de prazo também volta vazia. Uma simulação sem restrição volta com ofertas; a sua, com filtros, volta vazia.
Causa típica Margem insuficiente, vínculo não localizado, nenhum produto Price habilitado para a categoria. Valor pedido acima do que a margem suporta, prazo fora da faixa do produto, taxa fixada fora da faixa.
Ação Reveja margem e vínculo. Se estiverem certos, é caso de habilitação de produto — acione a UY3. Ajuste os parâmetros. Nenhuma chamada à UY3 é necessária.

Como diagnosticar, na prática: repita a simulação sem requestedValue, sem rangePaymentAmounts, sem rangeNumberOfPayments, sem productIds e sem interestRate — só com CPF e vínculo. Essa chamada responde a pergunta "existe alguma oferta para este trabalhador?". Se ela volta com ofertas, o problema estava nos seus filtros; se volta vazia, o problema é elegibilidade.

Por que a etapa de ofertas parecia contradizer isso. A simulação de ofertas devolve as condições possíveis para os parâmetros informados. Quando ela volta vazia, isso não significa que o trabalhador não tenha oferta nenhuma — significa que não há oferta naquele recorte. É por isso que a chamada sem filtros acima é o teste que separa os dois casos.

Sintoma Causa provável Ação corretiva
Simulação vazia com filtros, cheia sem filtros Filtros estreitos demais. Amplie rangeNumberOfPayments, reduza requestedValue ou remova productIds e interestRate.
Simulação vazia também sem filtros Margem insuficiente, vínculo não localizado, ou nenhum produto habilitado atende. Reveja o passo de margem. Persistindo, é habilitação de produto — acione a UY3.
Simulação vazia só ao pedir um valor O valor pedido não cabe na margem, ainda que a margem exista. Reduza requestedValue, ou simule por parcela com calculateByValue: "Payment".
400 na simulação por valor calculateByValue é Gross/Liquid sem requestedValue, ou Payment sem rangePaymentAmounts. Preencha o par correspondente ao modo escolhido.
Simulação sempre no valor máximo Nenhum valor pedido foi informado: o comportamento padrão é usar a margem total. Informe calculateByValue + requestedValue para simular abaixo da margem — ver 3. Operação.
Nenhuma oferta apesar de o produto estar habilitado O produto não é do modelo de cálculo Price. As rotas de oferta do Crédito do Trabalhador listam só produtos Price. Confirme o modelo de cálculo do produto contratado com a UY3, ou use a simulação por amortização (POST /v1/Amortization).

Proposta

Sintoma Causa provável Ação corretiva
Proposta recusada por expiração expirationDate no passado, ou empregador aceitou depois do prazo. Gere nova proposta com validade futura.
Parcela recusada na revalidação da oferta de leilão A margem caiu entre a proposta e o aceite do empregador. Reconsulte a margem e refaça a simulação com o valor novo.
400 com reforço FGTS hasWarranty marcado como true sem o saldo FGTS informado. Informe fgtsBalanceInCents (e a multa rescisória, quando houver) ou desligue o reforço.

Criação da operação

Sintoma Causa provável Ação corretiva
Tomador não vinculado ao usuário ou correspondente selecionado O personId existe, mas pertence a outro correspondente ou grupo. Use um tomador do seu escopo, ou solicite a atribuição do cadastro ao seu correspondente.
400 de periodicidade paymentPeriodicity diferente de { "every": 1, "periodicity": "Monthly" }. O consignado privado é mensal a cada 1 mês, porque o desconto acompanha a folha. Corrija o objeto.
400 de modelo de cálculo não suportado amortizationType divergente do modelo do produto contratado, ou valor legado consignado. Envie price ou sac, conforme o produto.
400 em calculationType Envio de Price ou SAC nesse campo. calculationType é o critério de contagem de dias (V360DiasCorridos e afins). O modelo vai em amortizationType.
400 de taxa fora da faixa apr fora da faixa de taxa do produto, ou igual a zero. Use a taxa devolvida pela simulação. apr é mensal, em porcentagem.
400 de prazo fora da faixa numberOfPayments fora da faixa de prazo do produto. Use o prazo devolvido pela simulação.
Valor da operação cem vezes menor que o esperado requestedAmount enviado em reais e não em centavos. 500000 são R$ 5.000,00. Ver Convenções de dados.
Garantia com valor absurdo totalValue enviado em centavos. Ao contrário de requestedAmount, ele é em reais. 6840.00 são R$ 6.840,00. Os dois campos convivem no mesmo corpo com unidades diferentes.
400 na competência de desconto dataprev_DiscountStartPeriod enviado como 2026-10 ou 10/2026. Envie a data civil completa, com dia, mês e ano: 2026-10-01.
400 com campos de outro modelo de cálculo Envio de paymentDay, termInMonths, periodicity, daysInYear ou paymentMonth. Remova. Esses campos pertencem a outros modelos — ver 3. Operação.
400 na conta de liquidação liquidationType é EletronicTransfer sem bankAccountId. Informe a conta cadastrada.
Averbação não localiza o vínculo Cadastro do tomador sem workplaceCompanyRegistrationNumber, employeeNumber ou admissionDate. Complete os campos de vínculo em 2.3 Cadastro do tomador, usando os valores da consulta de margem.

Envio para aprovação e garantia

Sintoma Causa provável Ação corretiva
É necessário informar ao menos uma garantia para enviar a operação para aprovação Operação sem garantia, em produto que exige lastro. Anexe a garantia de margem por PUT /v1/CreditNote/{id}/warranty e reenvie.
409 ao reenviar submitapproval A operação já saiu do rascunho: depois do envio ela não aceita alteração até o fim da análise. Consulte o status antes de repetir. Ver 4.1 Eventos e notificações.
Operação parada em Warranty por muito tempo Averbação aguardando retorno do empregador ou da averbadora. Aguardar. Se passar da janela combinada, acione a UY3 com o id.
Operação em WarrantyRevision A mesa devolveu a garantia: dado do empregador, competência de desconto ou margem divergentes. Corrija a garantia e encerre a revisão com POST /v1/CreditNote/{id}/doneWarrantyRevision.
Documento obrigatório ausente Falta o termo de autorização de margem ou outro documento exigido pelo produto. Anexe por PUT /v1/CreditNote/{id}/upload e reenvie.
Documento assinado enviado em rascunho não foi aproveitado A coleção uploads foi enviada vazia, ou com fileType que não identifica o documento assinado. Envie o item com fileType: "SignedContract". Coleção vazia não reserva lugar — ver 3. Operação.
Documento duplicado no dossiê O mesmo arquivo foi reenviado em mais de uma etapa. Envie uma vez. O documento permanece vinculado à operação.

Assinatura e liquidação

Sintoma Causa provável Ação corretiva
Sem URL de assinatura A operação ainda não chegou a Signatures. Aguarde a aprovação do instrumento e reconsulte SignUrl.
Operação em PaymentRevision Conta de liquidação inválida ou titularidade divergente do CPF do tomador. Corrija a conta em 2.2 Conta de liquidação. Chave Pix de terceiro é recusada.
Sem comprovante de transferência A liquidação ainda não ocorreu. Aguarde Liquidation/Finished e reconsulte.

Cancelamento

Sintoma Causa provável Ação corretiva
Nova operação para o mesmo trabalhador recusada por falta de margem, logo após um cancelamento O cancelamento ainda está em processamento: a margem só volta a ficar livre quando ele conclui. Acompanhe a operação anterior até Canceled antes de recontratar.
400 ao excluir a operação Exclusão só é permitida em Draft, Revision, Disapproved e Canceled. Cancele primeiro e depois exclua, se necessário.

Como reagir a cada erro

Ordem de diagnóstico, do mais provável ao menos:

  1. Releia a mensagem da resposta. As validações de negócio do consignado privado (periodicidade, faixa de taxa, faixa de prazo, margem) vêm com texto explícito.
  2. Confira o status atual com GET /v1/CreditNote/{id}. Boa parte dos 400 e 409 é ação certa no status errado — ver 4.1 Eventos e notificações.
  3. Confira a unidade e o formato. Valor em centavos contra valor em reais, e competência com dia, mês e ano. É a causa mais frequente de operação criada com número errado. Ver Convenções de dados.
  4. Confira os identificadores contra os cadastros: personId, bankAccountId, productId — e o CPF, que é o que liga a autorização ao cadastro.
  5. Isole a simulação. Antes de concluir que não há oferta, rode a simulação sem filtros. Separa elegibilidade de parâmetro em uma chamada.
  6. Só então acione a UY3, com o id da operação, o horário da chamada e o corpo enviado — com os dados pessoais mascarados.

Orientação técnica. A classificação de dado pessoal, a base legal do tratamento e a guarda de documentos de consentimento são competência do Compliance/Jurídico da UY3 (LGPD, Lei 13.709/2018, art. 7º e art. 37). Esta página não substitui parecer.

O que acontece depois

Erro corrigido no rascunho: reenvie para aprovação e a operação retoma o fluxo. Erro corrigido depois de uma devolução para revisão: encerre a revisão pela rota indicada e a operação volta para a etapa seguinte da esteira, sem recomeçar.

Antes desta etapa

Próxima etapa

Downloads