---
title: "Consultar saldo"
method: GET
path: "/v1/balance"
tags: ["Saldo"]
---

# Consultar saldo

`GET /v1/balance`

Retorna o saldo atual e volumes de transacoes da sua organizacao.

## Response `200`

Dados do saldo

- GetBalanceResponse
  - `data` BalanceData, nullable
    - `currency` string — Moeda
    - `balance` BalanceInfo
      - `available` integer — Saldo disponivel para saque (centavos)
      - `pending` integer — Saldo pendente de liquidacao (centavos)
      - `reserved` integer — Saldo reservado (centavos)
      - `total` integer — Saldo total (centavos)
    - `totals` TotalsInfo
      - `lifetimeVolume` integer — Volume total recebido (centavos)
      - `lifetimePayouts` integer — Total de saques realizados (centavos)
      - `lifetimeRefunds` integer — Total de estornos (centavos)
    - `period` PeriodInfo
      - `volumeToday` integer — Volume do dia atual (centavos)
      - `volumeThisWeek` integer — Volume dos ultimos 7 dias (centavos)
      - `volumeThisMonth` integer — Volume dos ultimos 30 dias (centavos)
    - `updatedAt` string, date-time — Ultima atualizacao
  - `message` string, nullable
  - `error` ApiErrorResponse, nullable
    - `message` string — Mensagem de erro
    - `code` string — Codigo do erro

## Other responses

- `401` — Nao autorizado

---

[API](https://skmtc.net/safefy-pay/apis/safefy-pix-gateway.md) · [All operations](https://skmtc.net/safefy-pay/apis/safefy-pix-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safefy-pay/safefy-pix-gateway/revisions/57157be53ccc/schema)
