Pular para o conteúdo principal

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)

StatusSignificado
pending_searchResposta síncrona — consulta enfileirada
succeededWebhook — margem retornada
failureWebhook — falha

Failure reasons

EnumeradorSignificado
unauthorized_institutionServidor não pré-autorizou QI SCD no Portal
inexistent_relationshipSem vínculo federal
invalid_document_numberCPF malformado
inactive_federal_employeeServidor inativo
deceased_federal_employeeServidor falecido

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

StatusSignificado
pending_consentSIGEPE aceitou; aguardando servidor confirmar no Portal
successAverbação confirmada (collateral_constituted: true)
failureFalha (ver enumerator)

Enumeradores de failure

EnumeradorAção
consent_refusedServidor recusou no Portal — cancela operação
consent_expiredJanela de consentimento expirou — cancela
invalid_balanceMargem insuficiente — cancela
unauthorized_institutionAutorização QI SCD expirou no Portal — retenta por até 7 dias
origin_contract_not_foundContrato origem (port/refin) não existe — cancela
waiting_for_origin_contract_closureAguardando quitação externa — permanece em retry
expired_portabilityJanela de port no SIGEPE fechou
successfully_deletedMargem desaverbada com sucesso

Operação (debt)

StatusSignificado
waiting_signatureAguardando assinatura
signature_finishedAssinatura concluída
waiting_disbursementAguardando desembolso
disbursedDesembolsado
canceledCancelada (não-permanente)
canceled_permanentlyCancelada definitivamente
settledLiquidada

Cancel reasons

EnumeradorSignificado
manualCancelado via API ou portal
waiting_signatureNão assinou no prazo
not_collateral_constitutedAverbação falhou
is_portabilityPortabilidade falhou
pix_max_retryMuitas falhas no desembolso PIX
lack_of_resourceSem recurso pra desembolsar
kyc_not_acceptedKYC reprovado
agencia_conta_invalidaErro em dados bancários
invalid_accountConta inválida
rejected_paymentPagamento recusado pelo banco destino

Reversal (cancelamento pós-desembolso)

StatusSignificado
pending_fundReversal iniciado, aguardando devolução pro fundo
completedReversal completo
failedReversal falhou (raro — investigação manual)

Parcelas (installment.status_change)

StatusSignificado
openedAberta, ainda não venceu
waiting_paymentAberta, na data de vencimento
paidPaga em dia
paid_earlyPaga antes do vencimento
paid_partialPaga parcialmente
paid_overduePaga após o vencimento
paid_partial_overduePaga parcialmente após vencimento
overdueEm atraso
canceledCancelada

Recuperar último estado

GET /debt/{DEBT_KEY}/collateral

Retorna last_response + reservation_status + timestamp.