Skip to main content

​
Obter Saldo Disponível

Obtém o saldo disponível, bloqueado e total da sua conta usando chaves de API.

​
Autenticação

Este endpoint requer autenticação via API Keys:
​
X-Api-Public-Key
string
required
Sua chave pública da API
​
X-Api-Private-Key
string
required
Sua chave privada da API

​
Exemplo de Requisição

curl -X GET https://api.nextpagamentos.io/api/public/balance \
  -H "X-Api-Public-Key: nxpay_f33e03c5c526bd65e0f1c8eddbc9d576" \
  -H "X-Api-Private-Key: nxpay_dc3295ab805921e4b6ece2462f65267e9e9e087bfd66c94e9762008dd45df006" \
  -H "Content-Type: application/json"

​
Resposta de Sucesso

​
available
integer
required
Saldo disponível em centavos (valor que pode ser usado para transferências)
​
blocked
integer
required
Saldo bloqueado em centavos (valor reservado para operações pendentes, MEDs, etc.)
​
total
integer
required
Saldo total em centavos (soma de available + blocked)

​
Exemplo de Resposta

{
  "available": 3153900,
  "blocked": 0,
  "total": 2653900
}
Todos os valores são retornados em centavos (inteiros). Para converter para reais, divida por 100:
  • 3153900 centavos = R$ 31.539,00
  • 0 centavos = R$ 0,00
  • 2653900 centavos = R$ 26.539,00

​
Códigos de Erro

​
401 Unauthorized

Não autorizado - API Key ou API Secret inválidos ou ausentes. 
{
  "error": "Não autorizado",
  "message": "Autenticação necessária. Verifique suas chaves de API."
}

​
500 Internal Server Error

Erro interno do servidor. 
{
  "error": "Erro interno do servidor",
  "message": "Falha ao obter saldo. Tente novamente mais tarde."
}

​
Observações Importantes

  • Valores em centavos: Todos os valores retornados estão em centavos (inteiros)
  • Saldo disponível: Valor que pode ser usado para transferências (cashout)
  • Saldo bloqueado: Valor reservado para operações pendentes, MEDs abertos, etc.
  • Saldo total: Soma de available + blocked
  • Se o usuário não tiver saldo cadastrado, será criado automaticamente com valores zerados