Mapa de Status

Referência consolidada de todos os enumeradores que podem aparecer nas respostas síncronas e webhooks do produto consignado SIAPE.

Consulta de Margem (federal_payroll.balance)

Status	Significado
pending_search	Resposta síncrona — consulta enfileirada
succeeded	Webhook — margem retornada
failure	Webhook — falha

Failure reasons

Enumerador	Significado
unauthorized_institution	Servidor não pré-autorizou QI SCD no Portal
inexistent_relationship	Sem vínculo federal
invalid_document_number	CPF malformado
inactive_federal_employee	Servidor inativo
deceased_federal_employee	Servidor falecido

Averbação / Desaverbação (credit_operation.collateral)

Status	Significado
pending_consent	SIGEPE aceitou; aguardando servidor confirmar no Portal
success	Averbação confirmada (collateral_constituted: true)
failure	Falha (ver enumerator)

Enumeradores de failure

Enumerador	Ação
consent_refused	Servidor recusou no Portal — cancela operação
consent_expired	Janela de consentimento expirou — cancela
invalid_balance	Margem insuficiente — cancela
unauthorized_institution	Autorização QI SCD expirou no Portal — retenta por até 7 dias
origin_contract_not_found	Contrato origem (port/refin) não existe — cancela
waiting_for_origin_contract_closure	Aguardando quitação externa — permanece em retry
expired_portability	Janela de port no SIGEPE fechou
successfully_deleted	Margem desaverbada com sucesso

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)
canceled_permanently	Cancelada definitivamente
settled	Liquidada

Cancel reasons

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

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 vencimento
overdue	Em atraso
canceled	Cancelada

Recuperar último estado

GET /debt/{DEBT_KEY}/collateral

Retorna last_response + reservation_status + timestamp.