Pular para o conteúdo principal

Consulta de Saldo

info

Descrição​

Esse endpoint permite que um usuário autenticado consulte o saldo associado ao seu CPF.

Endpoint​

POST /nossa/v1/balance

Headers​

{
  "Authorization": "Bearer {TOKEN_DO_LOGIN}",
  "Content-Type": "application/json"
}

Payload (Body)​

{
  "cpf": "12345678909"
  "service_type": "string"
}

Observações:​

É necessário definir dentro de "service_type": "qi" ou "bmp".

Exemplo :​

	{
	...
	   "service_type": "bmp"
	...
	}

Exemplo de Requisição cURL​

curl --location --request POST 'https://nossa-fintech-api.spixiiservices.com.br/nossa/v1/balance' \
--header 'Authorization: Bearer SEU_TOKEN_AQUI' \
--header 'Content-Type: application/json' \
--data '{
  "cpf": "12345678909"
}'

Respostas de Requisições:​
  {
  "key": "27dc2ef5-0687-4c60-a4b4-975097f1812a",
  "status": "success",
  "data": {
  "periods": 
    [
      {
        "amount": 3278.49,
        "due_date": "2025-08-01"
      },
      {
        "amount": 3170.23,
        "due_date": "2026-08-01"
      }
    ]
  },
    "eligible": true
  }

info

Comentários​

  • O token JWT deve ser enviado em todas as requisições autenticadas no header como: 
    Authorization: Bearer SEU_TOKEN_AQUI
  • Caso o token esteja expirado ou inválido, a API retornará um erro 401 Unauthorized.
  • Para evitar bloqueios, garanta que o CPF informado seja válido.
  • Certifique-se de que o token de autenticação esteja válido.
  • O cliente deve autorizar a QI SCD e a Singulare para que o CPF retorne saldo.
  • O service_type tem como objetivo aprimorar o direcionamento das operações conforme a instituição responsável.

Histórico de consultas de saldo​

Retorna o histórico das consultas de saldo do FGTS do usuário autenticado. Apenas consultas cujo CPF retornou saldo serão salvas.


info

Descrição​

Retorna o histórico das consultas de saldo.


Endpoint​

GET https://nossa-fintech-api.spixiiservices.com.br/nossa/v1/balan
ce/history

Headers​

{
  "Authorization": "Bearer {TOKEN_DO_LOGIN}"
}

"message": "Histórico de consultas retornado com sucesso.",
"history": [
  {
    "cpf": "yyyyyyyyyyy",
    "balance": 24123.8,
    "created_at": "2025-01-27T14:50:30",
    "created_by": "vendedor@gmail.com"
  }
]

info

Comentários​

  • Certifique-se de que o token de autenticação esteja válido.
  • Dependendo do cargo do usuário, também retornará a consulta do time.