Domínios — Empréstimos

Usados em Simulações e Empréstimos. Ao enviar, informe a key.

Ciclo de vida

LoanStatus

Devolvido em status (com cor).

Code	Key	Nome	Cor	Quando ocorre nesta jornada
0	draft	Rascunho	Cinza	Logo após POST /v5/loans.
30	awaiting_formalization	Aguardando Formalização	Amarelo	Quando a formalização solicitada por POST /{loanId}/signature-requests gera a CCB e o link de assinatura.
31	signed	Assinado	Amarelo	Quando o tomador conclui a assinatura eletrônica, ou após PUT /{id}/signatures.
61	endorsement_processing	Processando Averbação	Azul claro	Após PUT /{id}/endorsements no consignado privado, enquanto a averbação na Dataprev é processada em segundo plano. Se a Dataprev recusar, o contrato volta ao status anterior.
62	endorsement	Averbado	Verde	Após PUT /{id}/endorsements (no consignado privado, quando a Dataprev confirma a averbação).
64	endorsement_awaiting_confirmation	Aguardando Confirmação do Beneficiário	Âmbar	Averbação que depende da confirmação do beneficiário (consignado INSS). Não ocorre no consignado privado.
63	integrated	Integrado	Verde	Após PUT /{id}/disbursements. Bloqueia novas transições.
70	canceled	Cancelado	Vermelho	Cancelamento pelo portal ou pela desaverbação automática do consignado privado.
153	pending	Pendente	Laranja	Aguardando ação externa.
189	error	Erro	Vermelho	Falha em processamento.
200	awaiting_approval	Aguardando Aprovação	Amarelo	Fluxos de análise.
201	awaiting_disbursement	Aguardando Desembolso	Âmbar	Fluxos de análise.
202	disbursement_processing	Processando Desembolso	Azul claro	Desembolso enviado ao provedor, aguardando conclusão.
203	partially_settled	Parcialmente Liquidado	Verde claro	Fluxos de pagamento.
204	settled	Liquidado	Verde	Fluxos de pagamento.
205	delinquent	Inadimplente	Vermelho	Fluxos de pagamento.
206	renegotiated	Renegociado	Âmbar	Renegociação.

LoanStage

Code	Key	Nome	Observação
1	proposal	Proposta	Da emissão até o desembolso.
2	contract	Contrato	Atribuído no desembolso quando a data efetiva difere da prevista e as parcelas são recalculadas. Bloqueia novo desembolso (1010014).

LoanStep

Code	Key	Nome	Observação
1	formalization	Formalização	Padrão.
1830	awaiting_sync	Aguardando Sincronização	Atribuído no desembolso quando o envio ao banco liquidante falha.

Formalização

LoanDocumentRequestType

Campo type do pedido de documento.

Code	Key	Nome	Quando ocorre
1	ccb	Geração da CCB	Geração só da CCB, pelo portal.
2	signature_request	Geração da CCB e Link de Assinatura	POST /v5/loans/{loanId}/signature-requests.

LoanDocumentRequestStatus

Campo status do pedido de documento.

Code	Key	Nome	Cor	Significado
1	pending	Pendente	Amarelo	Pedido registrado, aguardando processamento.
2	processing	Processando	Azul	Em processamento.
3	succeeded	Concluído	Verde	CCB gerada (e, em signature_request, assinatura e jornada criadas).
4	retrying	Reagendado	Laranja	Falha inesperada; nova tentativa agendada em nextAttemptAt.
5	failed	Falha	Vermelho	Encerrado sem sucesso. Motivo em status.note e lastError; evento loan.document_failed.

Simulação

LoanSimulationMode

Code	Key	Nome	Campos fixados
1	term_rate_installment	Prazo, Taxa e Valor da Parcela	numberOfInstallments, monthlyRate, installmentAmount — simulação e emissão por Valor de Parcela na collection
2	term_rate_disbursement	Prazo, Taxa e Valor do Desembolso	numberOfInstallments, monthlyRate, disbursementAmount — simulação e emissão por Valor do Desembolso na collection
3	term_rate_principal	Prazo, Taxa e Valor do Principal	numberOfInstallments, monthlyRate, principalAmount — emissão por Valor do Principal na collection
4	term_installment_disbursement	Prazo, Valor da Parcela e Valor do Desembolso	taxa inferida
5	term_installment_principal	Prazo, Valor da Parcela e Valor do Principal	taxa inferida
6	principal	Valor do Principal	apenas principal

LoanType

Code	Key	Nome
1	loan	Empréstimo — padrão do produto private_payroll
2	salary_advance	Antecipação Salarial
3	credit_card	Cartão de Crédito

LoanProductType

Code	Key	Nome
100	personal_loan	Crédito Pessoal
200	public_payroll_loan	Crédito Consignado Público
300	private_payroll_loan	Crédito Consignado Privado — produto private_payroll
350	payroll_credit_card	Cartão de Crédito Consignado
351	payroll_credit_card_withdrawal	Cartão de Crédito Consignado + Saque
352	payroll_benefit_card	Cartão Benefício Consignado
353	payroll_benefit_card_withdrawal	Cartão Benefício Consignado + Saque
600	public_payroll_advance	Antecipação da Folha de Pagamento Pública
700	private_payroll_advance	Antecipação da Folha de Pagamento Privada

LoanOperationType

Code	Key	Nome
10	new	Novo — padrão
20	refinance	Refinanciamento
30	portability	Portabilidade
40	portability_refinance	Portabilidade + Refinanciamento
50	refinance_from_portability	Refinanciamento da Portabilidade
60	additional_withdrawal	Saque Complementar

LoanPayrollEntity

Chaves sugeridas; o domínio real é um cadastro de entidades consignatárias por empresa.

Code	Key	Nome
100	personal	Crédito Pessoal
200	social_security	Previdência (INSS)
210	federal_government	Governo Federal (SIAPE)
300	private_company	Empresa Privada — produto private_payroll
600+	state_government_*, city_government_*	Governos estaduais e prefeituras conveniadas

LoanPartyType

Code	Key	Nome
1	borrower	Tomador — atribuído ao borrower
2	legal_representative	Representante Legal
3	guarantor	Avalista

Cálculo

LoanGraceType

Code	Key	Nome
1	principal	Principal — padrão
2	total	Total
3	no_interest	Sem Juros

LoanInterestType

Code	Key	Nome
1	pre_fixed_days	Prefixados Dia — padrão do produto
2	pre_fixed_month	Prefixados Mês
3	floating	Pós-fixados
4	hybrid	Misto

LoanInterestBase

Code	Key	Nome
1	calendar_days_360	Dias corridos base 360
2	calendar_days_365	Dias corridos base 365 — padrão do produto
3	business_days	Dias úteis

LoanAmortizationSystem

Code	Key	Nome
10	price	Price — padrão do produto
11	pre_price_days	Price Diário Prefixado
20	sac	SAC

LoanFloatingIndexType

Code	Key	Nome
0	none	Não Definido — padrão
1	cdi	CDI
2	selic	SELIC
3	ipca	IPCA
4	igpm	IGPM

LoanPaymentFrequencyType

Code	Key	Nome
1	monthly	Mensal — padrão
2	weekly	Semanal
3	daily	Diário

LoanBusinessDayAdjustmentRule

Code	Key	Nome
1	next_business_day	Próximo dia útil

LatePenaltyRule

Code	Key	Nome
1	fixed_amount	Valor Fixo
2	percentage_of_original_amount	Percentual sobre o valor original
3	percentage_of_outstanding_balance	Percentual sobre o saldo devedor — produto private_payroll (2%)

LateInterestRule

Code	Key	Nome
1	daily_percentage_of_outstanding_balance	Percentual diário sobre o saldo devedor
2	monthly_percentage_of_outstanding_balance	Percentual mensal sobre o saldo devedor — produto private_payroll (1% a.m.)

Pagamento e desembolso

LoanPaymentMethod

Code	Key	Nome
1	bank_slip	Boleto Bancário
2	direct_loan	Empréstimo em Conta — padrão do produto
3	pix	PIX

LoanDisbursementMethod

Code	Key	Nome
1	ted	TED — padrão do produto
3	pix	PIX
4	card	Cartão
5	tef	TEF

BankAccountType

Campo disbursementBankAccount.type.

Code	Key	Nome
1	checking_account	Conta Corrente
2	savings_account	Conta Poupança

LoanDisbursementStatus

Campo status dos comandos de desembolso listados em GET /v5/loans/{loanId}/disbursements.

Code	Key	Nome	Significado
1	pending	Pendente	Comando criado.
2	sent	Enviado	Enviado ao pagador.
3	validated	Validado	O pagador validou a chave e as condições do contrato.
4	failed	Falhou	O pagador informou que o pagamento não foi feito, ou o envio falhou.
5	rejected	Recusado	A validação foi recusada (condições alteradas, valor ou documento divergentes).
6	canceled	Cancelado	Substituído por um novo envio ou cancelado junto com o contrato.
7	expired	Expirado	Chave vencida.
8	completed	Concluído	O pagador confirmou o pagamento; o contrato é desembolsado.

Consignado privado no contrato

Campos do registro de consignado privado do contrato (bloco privatePayroll).

LoanPrivatePayrollFgtsWithdrawalType

Campo fgtsWithdrawalType do bloco privatePayroll: modalidade de saque do FGTS do trabalhador, usada para definir quais garantias de FGTS podem ser dadas.

Code	Key	Nome	Significado
10	severance_withdrawal	Saque-rescisão	Saldo do FGTS e multa rescisória podem compor a garantia.
20	birthday_withdrawal	Saque-aniversário	Só a multa rescisória compõe a garantia; o saldo do FGTS fica de fora.

LoanPrivatePayrollEndorsementStatus

Campo endorsementStatus.

Code	Key	Nome	Significado
10	pending	Pendente	Ainda não averbado.
20	requested	Solicitada	Averbação enviada à Dataprev, aguardando retorno.
30	endorsed	Averbada	Averbação confirmada pela Dataprev.
40	rejected	Recusada	A Dataprev recusou a averbação.
50	canceled	Cancelada	Averbação cancelada.
60	excluded	Excluída	Averbação excluída na Dataprev (desaverbação).

LoanPrivatePayrollDeliveryStatus

Campos contractInformationStatus (envio do contrato) e exclusionStatus (desaverbação).

Code	Key	Nome
10	pending	Pendente
20	requested	Solicitado
30	sent	Enviado
40	error	Erro

LoanPrivatePayrollExclusionReason

Campo exclusionReason e configuração endorsement_exclusion_reason da desaverbação automática. O código é o informado à Dataprev.

Code	Key	Nome
1	withdrawal	Desistência do Empréstimo — padrão
2	death	Falecimento
3	early_settlement	Liquidação Antecipada
7	court_order	Ação Judicial
8	fraud	Exclusão por Fraude
9	other	Outros