Simulator Affiliates

POST https://api.caas.staging.bancocdc.com.br/operation/simulation/{:code}

📘

Through this route you can simulate the credit operation using the RATE model. Customer registration is not required for the process.

🚧

Attention point:

• To consume the route, it is necessary to pass the product code as a parameter.
• It is only possible to register the TAC once the relationship with the client is finalized. If the client has outstanding installments, it is not possible!

Available Hiring types

❗️

This hiring type must match the affiliate's allowed_employment_type_code

Value	Description
1	Permanent employee
2	Temporary employee
3	Commissioned employee
4	CLT (Brazilian labor law contract)
5	Retired / Pensioner
7	Others
8	Open-ended contract
9	Trial/Probationary Contract
10	Flexible Permanent
11	Flexible Retired/Pensioner
12	Health Agent: E/S/C
13	Guardianship Council
14	Table of 3 to 5 Installments for Active and Inactive
15	Table of 3 to 5 Installments for Non-Permanent
16	Senior Age Table 76 to 79 Years
17	Senior Age Table 80 to 85 Years
18	Exception Table
19	Permanent CLT Employee
20	Service Provider +10 (years of service)
21	Service Provider -10 (years of service)
22	Permanent - Intermediate
23	Permanent - 3 Years
24	Permanent +3 Years
25	Retired/Pensioner - Intermediate

---

Response

Http Code	Return Code	Message
200	200-01	Success.
400	400-01	Something unexpected happened.
400	400-02	Invalid hash.
400	400-10	Please provide the correct document.
400	400-23	Values outside the parametrization: 'X'
400	400-24	The operation could not be simulated.
400	400-43	Error when registering the result of the installments.
400	400-46	Error when registering the result of the operation.
400	400-47	For the iof_finance field, you must enter Y to finance fees and N when not necessary.
400	400-61	Error simulating: 'X'
400	400-77	The purchaser is disabled.
401	401-05	Unauthorized or token invalid
406	406-03	field 'X' is mandatory and was not informed.
406	406-04	The purchaser was not found.
429	429-01	Too many requests
400	400-83	The customer has installments to pay, so it is not possible to send tariff_amount.
400	400-81	Client has ongoing operations.
400	400-84	It is not possible to charge free_tariff_amount for the simulation product.

Response Parameters

Parameter	Type	Description
request_code	string	Code of the request made
return	boolean	Indicates whether the request was successful
return_code	string	Return code of the request
message	string	Message indicating the reason for the response
data	object	Object containing additional information
data.code	string	Code of the simulated operation
data.document_customer	string	Customer's document
data.name_customer	string	Customer's name
data.requested_amount	number	Amount requested by the customer
data.tariff_amount	number	Tariff amount
data.disbursement_amount	number	Amount disbursed
data.iof_amount	number	IOF (Tax on Financial Operations) amount
data.iof_financed	string	Indicates whether the IOF is financed (S/N)
data.rate_iof_people_amount	number	IOF rate for individuals
data.rate_iof_base_amount	number	Base IOF rate
data.financed_amount	number	Total amount financed
data.total_interest_amount_installments	number	Total interest amount over installments
data.rate_amount	number	Interest rate amount
data.total_installments	number	Total number of installments
data.entry_date	string	Entry date of the operation
data.first_due_date	string	Due date of the first installment
data.last_due_date	string	Due date of the last installment
data.monthly_CET_amount	number	Monthly CET (Total Effective Cost) amount
data.annual_CET_amount	number	Annual CET (Total Effective Cost) amount
data.installments	array	Array containing installment information
data.installments.code	string	Code of the installment
data.installments.amortized_amount	number	Amortized amount for the installment
data.installments.interest_amount	number	Interest amount for the installment
data.installments.debt_amount	number	Remaining debt amount for the installment
data.installments.installment_amount	number	Total amount of the installment
data.installments.installment	number	Installment number
data.installments.due_date	string	Due date of the installment
data.installments.days_until_expiration	number	Number of days until the installment expires

---

Request Parameters