Mapa de Status
Referência consolidada de todos os enumeradores que podem aparecer nas respostas síncronas e webhooks do produto consignado militar.
Consulta de Margem (military_payroll.balance.status_change)
| Status | Significado |
|---|---|
pending_search | Resposta síncrona — consulta enfileirada no Zetra |
succeeded | Webhook — margem retornada com sucesso |
failed | Webhook — falha (ver failure_reason) |
Failure reasons
| Enumerador | Zetra code | Significado |
|---|---|---|
invalid_registration_code | 210 | Matrícula inválida |
military_not_found | 293 | CPF/matrícula sem registro |
military_blocked | 352 | Militar com bloqueio em folha |
communication_error | 241 | Zetra indisponível |
invalid_document_number | — | CPF malformado |
Averbação / Desaverbação (credit_operation.collateral)
| Enumerador | reservation_status | Significado |
|---|---|---|
successfully_accepted | pending_confirmation | Zetra aceitou a requisição, aguardando confirmação |
successfully_reserved | reserved | Margem reservada com sucesso |
successfully_deleted | deleted | Margem desaverbada com sucesso |
waiting_confirmation | — | Aguardando Zetra |
communication_error | — | Erro de comunicação (cod 241) |
consignable_margin_exceeded | — | Margem insuficiente (cod 359) |
consent_refused | — | Militar recusou o consentimento |
consent_expired | — | Janela de consentimento expirou |
expired_portability | — | Janela de port expirou |
origin_contract_not_found | — | Contrato origem (port/refin) não existe |
waiting_for_origin_contract_closure | — | Aguardando quitação externa |
Operação (debt)
| Status | Significado |
|---|---|
waiting_signature | Aguardando assinatura |
signature_finished | Assinatura concluída |
waiting_disbursement | Aguardando desembolso |
disbursed | Desembolsado |
canceled | Cancelada (não-permanente, ainda recuperável) |
canceled_permanently | Cancelada definitivamente |
settled | Liquidada (todas as parcelas pagas) |
Cancel reasons (cancel_reason_enumerator)
| Enumerador | Significado |
|---|---|
manual | Cancelado via API ou portal |
waiting_signature | Não assinou no prazo |
not_collateral_constituted | Averbação falhou |
is_portability | Portabilidade falhou |
pix_max_retry | Muitas falhas no desembolso PIX |
lack_of_resource | Sem recurso pra desembolsar |
kyc_not_accepted | KYC reprovado |
agencia_conta_invalida | Erro em dados bancários |
invalid_account | Conta inválida |
rejected_payment | Pagamento recusado pelo banco destino |
disbursing_error | Erro genérico no desembolso |
entry_not_paid | Entrada não paga (refin com troco negativo) |
bank_slip_paid | Boleto já foi pago |
unsupported_transaction | Tipo de conta não suporta a transação |
Reversal (cancelamento pós-desembolso)
| Status | Significado |
|---|---|
pending_fund | Reversal iniciado, aguardando devolução pro fundo |
completed | Reversal completo |
failed | Reversal falhou (raro — investigação manual) |
Parcelas (installment.status_change)
| Status | Significado |
|---|---|
opened | Aberta, ainda não venceu |
waiting_payment | Aberta, na data de vencimento |
paid | Paga em dia |
paid_early | Paga antes do vencimento |
paid_partial | Paga parcialmente |
paid_overdue | Paga após o vencimento |
paid_partial_overdue | Paga parcialmente após o vencimento |
overdue | Em atraso |
canceled | Cancelada |
Recuperar último estado
Pra consultar o estado atual de uma operação a qualquer momento:
GET /debt/{DEBT_KEY}/collateral
Retorna last_response (último enumerador) + reservation_status + timestamp da última atualização.