Ir para o conteúdo

8.8. Status e Enumerações

Mapeamento de todos os códigos numéricos devolvidos pelos endpoints de antecipação automática: desfecho do ciclo, motivo de não contratação, origem da agenda e situação da atualização de taxa em lote.

Cada tabela traz, além do significado, a ação esperada — o que fazer ao receber aquele código.

Status da execução do ciclo

Devolvido em status, nos endpoints 8.4 (ultimaExecucao.status) e 8.7.

Valor Nome Significado Ação esperada
1 Em andamento O ciclo do dia começou e ainda não concluiu. Aguardar. Consultar novamente mais tarde no mesmo dia.
2 Contratado O ciclo gerou contrato com sucesso. Nenhuma. Use identificadorContrato para acompanhar o contrato.
3 Não contratado O ciclo executou normalmente, mas não havia o que contratar. Ler motivoNaoContratacao na tabela abaixo. Não é erro.
4 Falha O ciclo foi interrompido por erro técnico. Acionar o suporte informando a data e o idOperacao. O ciclo será reprocessado.

Motivo de não contratação

Devolvido em motivoNaoContratacao quando status é Não contratado (3).

Valor Nome Significado Ação esperada
1 Agenda vazia A registradora não retornou nenhuma unidade de recebível para o estabelecimento no período. Nenhuma. O estabelecimento não tem recebíveis a antecipar hoje.
2 Abaixo do valor mínimo O total elegível ficou abaixo do valorMinimo configurado. Se o piso está alto demais para o perfil do cedente, ajuste em 8.2.
3 Sem UR elegível Havia agenda, mas nenhuma UR atendeu aos arranjos, credenciadoras ou prazos configurados. Revisar arranjos e credenciadoras em 8.4.
4 Fora da janela O ciclo não pôde rodar no horário previsto — feriado, fim de semana ou janela já encerrada. Nenhuma. O ciclo volta no próximo dia útil.
5 Registradora indisponível A registradora não estava operacional no momento do ciclo. Nenhuma. A solicitação é retomada automaticamente.
6 Sem taxa configurada O vínculo cedente × operação não tem taxa, e sem taxa o contrato sairia sem deságio. Definir a taxa em 8.2 ou 8.6.

Origem da agenda

Devolvido em origemAgenda, nos endpoints 8.4 e 8.7.

Valor Nome Significado
1 BATCH O ciclo usou a agenda diária publicada pela registradora, já disponível no momento da execução.
2 ONLINE A agenda diária ainda não estava publicada, e o ciclo solicitou uma consulta pontual à registradora.

Por que a origem importa

O ciclo prefere sempre a agenda BATCH, que é publicada uma vez por dia útil e não gera consulta avulsa na registradora. A agenda ONLINE é o plano B: usada apenas quando a BATCH do dia ainda não saiu no horário do ciclo. Ver o comportamento completo em 8.9. Roteiro.

Status do processamento de taxa em lote

Devolvido em status na consulta de processamento de 8.5. Atualizar Taxa por Operação.

Valor Nome Significado Ação esperada
1 Em fila A solicitação foi aceita e aguarda processamento. Aguardar e consultar novamente.
2 Processando Os vínculos estão sendo atualizados em blocos. Acompanhar por percentualConcluido.
3 Concluído Todos os vínculos alvo foram atualizados. Nenhuma.
4 Concluído com pendências A taxa foi aplicada, mas parte dos CNPJs informados não tinha vínculo vivo na operação. Conferir cnpjCedenteNaoEncontrados e tratar os documentos listados.
5 Falha O processamento foi interrompido por erro técnico. Ler mensagemErro e acionar o suporte. A operação pode ser reenviada com segurança.

Escopo da atualização de taxa

Devolvido em escopo na consulta de processamento de 8.5.

Valor Nome Significado
1 Operação inteira A chamada não informou cnpjCedente e alcançou todos os vínculos da operação.
2 Cedentes informados A chamada informou cnpjCedente e alcançou apenas os documentos daquela lista.

cnpjCedenteNaoEncontrados só aparece no escopo 2

No escopo Operação inteira não há lista de documentos a conciliar: o alvo é a carteira toda. O campo vem vazio.