Sumário
Para realizar a consulta do saldo do FGTS do cliente, primeiramente deve-se realizar a consulta do CPF no endpoint anterior. O protocolo gerado na cnosulta anterior será utilizado aqui.
Rota: /proposals/consulta-protocolo (Post) #
Descrição: #
Realiza o pedido de consulta de saldo FGTS à CAIXA através do protocolo da consulta do CPF.
Pedido de consulta #
- endpoint: /proposals/consulta-protocolo
- method: POST
- body:
{ "protocolo": 1978499 }
Atributos do request #
Campo | Tipo | Descrição | Exemplo |
---|---|---|---|
protocolo obrigatório | string | Protocolo gerado na consulta do CPF | “1978499” |
Response #
A resposta é apresentada segundo o JSON a seguir, com os valores de saldo fornecidos pela CAIXA.
- status: 201
- body:
{ "protocolo": 1978499, "dataHoraRequisicao": "12/12/2024 10:59:21", "status": "Resposta concluída", "saldo": { "cpfTrabalhador": "01706799349", "dataSaldo": "12/12/2024", "existeSaldoDesconsiderado": false, "qtdPedidos": 0, "periodos": [ { "dataRepasse": "01/07/2025", "valor": 3921.26 }, { "dataRepasse": "01/07/2026", "valor": 3550.39 }, { "dataRepasse": "01/07/2027", "valor": 3093.03 }, { "dataRepasse": "01/07/2028", "valor": 2622.1 }, { "dataRepasse": "01/07/2029", "valor": 2097.68 }, { "dataRepasse": "01/07/2030", "valor": 1678.14 }, { "dataRepasse": "01/07/2031", "valor": 1188.78 }, { "dataRepasse": "01/07/2032", "valor": 832.14 }, { "dataRepasse": "01/07/2033", "valor": 582.5 }, { "dataRepasse": "01/07/2034", "valor": 393.67 }, { "dataRepasse": "01/07/2035", "valor": 232.75 }, { "dataRepasse": "01/07/2036", "valor": 116.38 }, { "dataRepasse": "01/07/2037", "valor": 58.19 }, { "dataRepasse": "01/07/2038", "valor": 29.09 }, { "dataRepasse": "01/07/2039", "valor": 14.55 }, { "dataRepasse": "01/07/2040", "valor": 7.27 }, { "dataRepasse": "01/07/2041", "valor": 3.64 }, { "dataRepasse": "01/07/2042", "valor": 1.82 }, { "dataRepasse": "01/07/2043", "valor": 0.91 }, { "dataRepasse": "01/07/2044", "valor": 0.45 }, { "dataRepasse": "01/07/2045", "valor": 0.23 }, { "dataRepasse": "01/07/2046", "valor": 0.11 }, { "dataRepasse": "01/07/2047", "valor": 0.06 }, { "dataRepasse": "01/07/2048", "valor": 0.03 }, { "dataRepasse": "01/07/2049", "valor": 0.01 }, { "dataRepasse": "01/07/2050", "valor": 0.01 } ] } }