Simulação do valor máximo

Request

ENDPOINT

/baas/fgts_simulation

MÉTODO

POST

Esse serviço mostra qual é o valor máximo que pode ser antecipado pelo tomador, de acordo com as parcelas informadas.

Como originador, é possível informar qual valor o tomador poderá desembolsar de cada parcela, sendo isso individual ou parcelas múltiplas.

Request Body

{
    "borrower": {
      "person_type": "natural"
    },
    "financial": {
        "interest_type": "pre_price_days",
        "credit_operation_type": "ccb",
        "annual_interest_rate": 0.05,
        "disbursement_date": "2022-07-25",
        "disbursement_start_date": "2022-07-27",
        "disbursement_end_date": "2022-07-27",
        "issue_date": "2019-07-25",
        "interest_grace_period": 0,
        "principal_grace_period": 0,
        "number_of_installments": 2,
        "fine_configuration": {
            "contract_fine_rate": 0,
            "interest_base": "workdays",
            "monthly_rate": 0
        }
    }
}

BODY PARAMS

Campo	Descrição
borrower (obrigatório)	Tomador da dívida, neste caso precisamos apenas do tipo de pessoa ("person_type")
financial	Objeto Financial (adaptado para o saque-aniversário FGTS)

BORROWER OBJECT

Campo	Descrição
person_type (obrigatório)	Tomador da dívida, neste caso precisamos apenas do tipo de pessoa ("person_type")

FINANCIAL OBJECT

Campo	Descrição
desired_installments	Valor de desembolso para o cliente
interest_type (obrigatório)	Tipo de juros aplicado na dívida.
credit_operation_type (obrigatório)	Tipo de operação de crédito: "ccb", "cce", "cci", "nce"
annual_interest_rate (obrigatório)	Valor porcentual da parcela prefixada de juros (atenção: 1 = 100%)
disbursement_date	Data de desembolso (formato "AAAA-MM-DD") (excludente de disbursement_date)
disbursement_start_date (obrigatório)	Data inicial do período de desembolso (formato "AAAA-MM-DD") (excludente de disbursement_date)
disbursement_end_date (obrigatório)	Data final do período de desembolso (formato "AAAA-MM-DD") (excludente de disbursement_date)
issue_date (obrigatório)	Data de emissão da CCB (formato "AAAA-MM-DD")
interest_grace_period (obrigatório)	Carência de juros (em meses)
principal_grace_period (obrigatório)	Carência do principal (em meses)
number_of_installments (obrigatório)	Número de parcelas (anuais)
fine_configuration (obrigatório)	configuração das multas
rebates (obrigatório)	Lista de objetos de rebates.

DESIRED INSTALLMENTS OBJECT

Campo	Descrição
total_amount (obrigatório)	Valor amortizado em determinada data
due_date	Data Hora do Pedido (formato "AAAA-MM-DD")

FINE CONFIGURATION OBJECT

Campo	Descrição
contract_fine_rate (obrigatório)	Valor porcentual fixo da multa
interest_base	Contagem do tempo para multa ("calendar_days" para dias corridos, "workdays" para dias úteis)
monthly_rate	Valor porcentual mensal da multa

REBATES OBJECT

Campo	Descrição
amount	Valor do rebate.
fee_type	Tipo de fee
amount_type	Tipo do valor inserido (valor absoluto, valor em porcentagem)
rebate_bank_account	Objeto conta bancária de rebate.

REBATES BANK ACCOUNT OBJECT

Campo	Descrição
name	Nome da instituição financeira
bank_code	Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) com 3 dígitos.
ispb_number	Identificador da instituição no Sistema de Pagamentos Brasileiro.
account_digit	Dígito da conta.
branch_number	Número da agência
account_number	Número da conta.
document_number	CPF ou CNPJ do dono da conta para o rebate.