Skip to main content
GET
/
balance
Consultar Saldo
curl --request GET \
  --url https://api.example.com/balance
{
  "200": {},
  "401": {},
  "500": {},
  "available_balance": 123,
  "pending_balance": 123,
  "total_balance": 123,
  "currency": "<string>",
  "formatted": {}
}

​
Visão Geral

Este endpoint retorna informações sobre o saldo da sua conta KlivoPay, incluindo o saldo disponível para saque e valores que ainda estão em processo.

​
Endpoint

GET https://api.klivopay.com.br/api/public/v1/balance

​
Parâmetros

​
api_token
string
required
Seu token de autenticação da API KlivoPay

​
Exemplo de Requisição

curl -X GET 'https://api.klivopay.com.br/api/public/v1/balance?api_token=seu_token_aqui'

​
Resposta de Sucesso

200 OK
{
  "success": true,
  "data": {
    "available_balance": 125000,
    "pending_balance": 35000,
    "total_balance": 160000,
    "currency": "BRL",
    "formatted": {
      "available_balance": "R$ 1.250,00",
      "pending_balance": "R$ 350,00",
      "total_balance": "R$ 1.600,00"
    }
  }
}

​
Campos da Resposta

​
available_balance
integer
Saldo disponível para saque em centavos
​
pending_balance
integer
Saldo bloqueado/em processamento em centavos
​
total_balance
integer
Saldo total (disponível + pendente) em centavos
​
currency
string
Moeda do saldo (BRL = Real Brasileiro)
​
formatted
object
Valores formatados em formato monetário brasileiro

​
Códigos de Resposta

​
200
OK
Saldo consultado com sucesso
​
401
Unauthorized
Token de API inválido ou ausente
​
500
Internal Server Error
Erro interno do servidor
O saldo disponível (available_balance) é o valor que pode ser solicitado para saque imediatamente.
Valores são sempre retornados em centavos. R$ 1.250,00 = 125000 centavos.