Obter saldo

Sandbox

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

POST

/api/v1/emprestimos/fgts/saldo/{cpfPessoa}

Utilize este endpoint para obter 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 Path

Parâmetros Header

Respostas

🟢200OK

application/json

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/saldo/' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Exemplo 1

{
    "score": 0,
    "doc": "46376232000",
    "id": "68096d9c-a71f-480d-9182-afdfb97b8a2e",
    "dataSet": "fgts",
    "status": "Ok",
    "result": {
        "cpfTrabalhador": "46376232000",
        "dataSaldo": "06/10/2022",
        "existeSaldoDesconsiderado": false,
        "qtdPedidos": 0,
        "periodos": [
            {
                "valor": 23197.33,
                "dataRepasse": "01/12/2023"
            }
        ]
    }
}

Página anterior

Simular saldo

Próxima página

Cadastrar pessoa física