Simular operação

post

https://apis.stg.grafeno.be/laas/v2/simulation/{credit_type}

Simulação de operação de crédito (CCB e Nota comercial).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

credit_type

string

enum

required

Tipo de operação de crédito que será simulada.

Allowed:

Query Params

save_as_draft

boolean

Determina se a simulação deve ser salva para utilização posterior.

Body Params

amortization_rule

string

enum

required

Regra de dias considerados para amortização.

Allowed:

amortization_table

string

enum

required

Sistema de amortização da operação.

Allowed:

contract_date

date

required

Data de ínicio do contrato de crédito. Deve ser sempre igual ou maior a data de simulação.

first_installment_date

date

required

Data de vencimento para a primeira parcela.

installments_quantity

int32

required

Número total de parcelas da operação.

installment_amount

double

Valor da parcela da operação de crédito. Se informado, o parâmetro tax_percentage não pode ser incluído na simulação.

indication

string

enum

required

Natureza da taxa de juros da operação.

Allowed:

partner_id

string

required

Uuid do parceiro bancarizador ou escriturador, a depender do tipo de operação de crédito.

payments_frequency

string

enum

required

Frequência no pagamento de parcelas da operação de crédito.

Allowed:

value

double

required

Valor total da operação de crédito.

tax_percentage

double

Taxa de juros aplicada a operação de crédito. Se informado, o parâmetro installmente_amount não pode ser incluído na simulação.

waiting_period

int32

Tempo de carência para iniciar o pagamento de uma operação. Deve ser sempre menor que o número máximo de parcelas da operação e durante o período de carência, serão cobrados apenas os juros da operação.

person_type

string

enum

required

Tipo de tomador de crédito (PF ou PJ).

Allowed:

indexer

string

enum

Indexador de juros da operação. Obrigatório caso a operação utilize juros pós-fixados: indication = pos-fixed.

Allowed:

percentual_comission

double

Valor percentual da comissão que o credor receberá. A comissão deverá ser acordada com o time comercial da Grafeno para que fique disponível para uso.

type_of_calculation

string

enum

required

Base de cálculo da operação.

Allowed:

include_daily_data

boolean

Indica se a simulação irá retornar ou não dados diários de custos e juros.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400