Consulta de Saldo FGTS
Para utilizar esta rota, os desenvolvedores devem enviar uma solicitação HTTP POST para o endpoint, incluindo os parâmetros necessários para identificar o usuário e autenticar a solicitação.
POST /fgts/balance
Para efetuar a consulta necessário envio das sequintes informações:
Request body
{
"documentNumber": "string",
"provider": "bms"
}
Atenção“provider” pode ser enviado como “BMS“ | “QI“ | “CARTOS“
Request URL
https://greengold-bff-prod.proudocean-73e4f49e.eastus.azurecontainerapps.io
ATENÇÂO
Para Obter o retorno de saldo utilizar o seguinte endpoint
GET /fgts/balance
Enviar os seguintes parametros para acompanhar o retorno do saldo do cliente
|
search |
CPF que está aguardando retorno do saldo |
|
status |
pending, error, success |
|
page |
pagina com os cpfs |
|
limit |
Numero de CPFs a serem exibidos por página |