Simular saldo

Utilize este endpoint para simular o saldo FGTS.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/emprestimos/fgts/simula-com-saldo' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "cpfPessoa": "99999999999", "numeroParcelas": 2 }'

{ "id": "68096d9c-a71f-480d-9182-afdfb97b8a2e", "calculateByValueType": "Gross", "requestedAmount": 10000, "initialValue": 10000, "liquidValue": 10000, "amountPaid": 10000, "monthlyInterest": 0.02, "yearlyInterest": 0.02, "startDate": "2022-05-04T12:00:00-03:00", "dueDate": "2022-05-04T12:00:00-03:00", "comm": 10000, "finTax": 10000, "effectiveMonthlyCost": 0.02193, "effectiveYearlyCost": 0.2974, "paymentScheduleItems": [ { "id": "25727aeb-d5db-42f1-832a-e6b05966986d", "dueDate": "2022-09-27T09:00:00-03:00", "principalAmountInCents": 1946824, "amortization": 0, "interest": 0, "financeTax": 0, "payment": 0, "tokenName": "string", "tokenAmount": 0 } ] }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Parâmetros Bodyapplication/json

Parâmetros para fazer uma simulação com saldo.

cpfPessoa

string

requerido

CPF do portador.

Exemplo:

99999999999

numeroParcelas

integer <int32>

requerido

Número de parcelas adiantadas.

Exemplo:

Examples

Respostas

🟢200OK

application/json

default response

Body

string

opcional

Identificador da simulação.

Exemplo:

68096d9c-a71f-480d-9182-afdfb97b8a2e

calculateByValueType

string

opcional

Tipo de tabela de amortização.

Exemplo:

Gross

requestedAmount

integer <int64>

opcional

Valor solicitado em centavos.

Exemplo:

10000

initialValue

integer <int64>

opcional

Valor inicial da dívida contraída em centavos.

Exemplo:

10000

liquidValue

integer <int64>

opcional

Valor líquido da operação em centavos.

Exemplo:

10000

amountPaid

integer <int64>

opcional

Valor total a ser descontado do FGTS em centavos.

Exemplo:

10000

monthlyInterest

number <double>

opcional

Taxa de juros nominal mensal da operação.

Exemplo:

0.02

yearlyInterest

number <double>

opcional

Taxa de juros nominal anual da operação.

Exemplo:

0.02

startDate

string

opcional

Data de início.

Exemplo:

2022-05-04T12:00:00-03:00

dueDate

string

opcional

Data de vencimento da última parcela.

Exemplo:

2022-05-04T12:00:00-03:00

comm

integer <int32>

opcional

Custo de emissão da operação em centavos.

Exemplo:

10000

finTax

integer <int32>

opcional

Valor de IOF da operação.

Exemplo:

10000

effectiveMonthlyCost

number <double>

opcional

Custo Efetivo Total (CET) mensal da operação.

Exemplo:

0.02193

effectiveYearlyCost

number <double>

opcional

Custo Efetivo Total (CET) anual da operação.

Exemplo:

0.2974

paymentScheduleItems

array[object (PaymentScheduleItems) {9}]

opcional

Plano de pagamento da operação.

string

opcional

Identificador.

Exemplo:

25727aeb-d5db-42f1-832a-e6b05966986d

dueDate

string

opcional

Data de vencimento.

Exemplo:

2022-09-27T09:00:00-03:00

principalAmountInCents

integer <int32>

opcional

Valor em centavos.

Exemplo:

1946824

amortization

integer <int32>

opcional

Amortização.

Exemplo:

interest

integer <int32>

opcional

Taxa de juros.

Exemplo:

financeTax

integer <int32>

opcional

Valor do imposto.

Exemplo:

payment

integer <int32>

opcional

Pagamento.

Exemplo:

tokenName

string

opcional

Nome do token.

tokenAmount

number <double>

opcional

Valor do token.

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor