Simular saldo

Sandbox

https://horizon-api-sb.app.rpe.tech

POST

/api/v1/emprestimos/fgts/simula-com-saldo

Utilize este endpoint para simular o saldo FGTS.

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

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

default response

Body

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "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
        }
    ]
}