---
title: "Realizar a consulta do saldo total da conta."
method: GET
path: "/api/v1/balance/total"
tags: ["Extrato"]
---

# Realizar a consulta do saldo total da conta.

`GET /api/v1/balance/total`

**Extrato- Realizar a consulta do saldo total da conta**<br/>Permite que usuários autorizados acessem e recuperem o saldo total disponível em uma conta específica no sistema de pagamentos. Essa funcionalidade oferece aos usuários uma visão rápida e precisa de suas finanças, facilitando o gerenciamento de seus recursos e a tomada de decisões financeiras conscientes.<br/><br/>**Funcionalidades Essenciais:**<br/>-   **Consulta de Saldo Total:** Os usuários podem consultar o saldo total disponível em uma conta específica, fornecendo o identificador da conta (ID único, número de referência).<br/>-   **Atualização em Tempo Real:** O saldo total retornado pela API reflete o valor atualizado no momento da consulta, garantindo precisão e confiabilidade.<br/>-   **Histórico de Saldos (Opcional):** A API pode fornecer um histórico de saldos anteriores da conta, permitindo que os usuários acompanhem as mudanças em seus recursos ao longo do tempo.<br/>-   **Integração com Sistemas Contábeis:** O saldo total recuperado pela API pode ser integrado a sistemas contábeis para automatizar o registro de transações e a reconciliação de contas.<br/><br/>**Requisição**<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>client-id</td><td>Texto</td><td>Client ID enviado no Header</td><td>Sim</td></tr><tr><td>contaOrigem</td><td>Texto</td><td>Conta do lançamento com digito verificador.</td><td>Sim</td></tr><tr><td>cpfOperador</td><td>Texto</td><td>CPF do operador</td><td>Sim</td></tr></tbody></table><br/><br/>**Resposta**<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem para comprovação da transação</td></tr><tr><td>Data - current_balance</td><td>Texto</td><td>Saldo total atual da conta consultada</td></tr></tbody></table>

## Query parameters

- `contaOrigem` string, required
- `cpfOperador` string, required

## Headers

- `client-id` string, uuid, required

## Response `200`

Consulta realizada com sucesso.

- object
  - `message` string
  - `data` object[]
    - `current_balance` string
  - `errors` string
  - `statusCode` integer
  - `status` boolean

## Other responses

- `401` — Invalid client data.
- `403` — Invalid token.
- `422` — Invalid input fields.

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)