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": "j17", "bmp" ou "qi".

Exemplo :​

	{
	...
	   "service_type": "j17"
	...
	}

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",
  "service_type": "j17"
}'

Respostas de Requisições:​
  {
    "key": "ab8782dc-e812-4352-ac78-9204a9e67c90",
    "status": "completed",
    "eligible": true,
    "data": {
      "periods": [
        {
          "due_date": "2032-06-22",
          "amount": 699.45,
          "anticipation_amount": 699.45
        },
        {
          "due_date": "2028-06-23",
          "amount": 961.38,
          "anticipation_amount": 961.38
        },
        {
          "due_date": "2029-06-23",
          "amount": 801.81,
          "anticipation_amount": 801.81
        },
        {
          "due_date": "2030-06-23",
          "amount": 738.05,
          "anticipation_amount": 738.05
        },
        {
          "due_date": "2031-06-23",
          "amount": 301.2,
          "anticipation_amount": 301.2
        },
        {
          "due_date": "2027-06-24",
          "amount": 793.47,
          "anticipation_amount": 793.47
        }
      ],
      "components": [
        {
          "code": "CUSTOCCB",
          "type": "PERCENTUAL",
          "initial_value": 0.0001,
          "final_value": 0.0001
        },
        {
          "code": "TAXAJUROS",
          "type": "PERCENTUAL",
          "initial_value": 1.79,
          "final_value": 1.79
        },
        {
          "code": "IOFAMORTIZACAO",
          "type": "PERCENTUAL",
          "initial_value": 0.0082,
          "final_value": 0.0082
        },
        {
          "code": "IOFADICIONAL",
          "type": "PERCENTUAL",
          "initial_value": 0.38,
          "final_value": 0.38
        },
        {
          "code": "TED_PIX",
          "type": "VALOR_PRESENTE",
          "initial_value": 1,
          "final_value": 1
        }
      ],
      "max_loan_value": 4295.36,
      "balance_date": "2026-06-24"
    }
  }

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 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.