curl -X GET https://api.nixfypagamentos.com/api/public/balance \
-H "X-Api-Public-Key: sua_chave_publica_aqui" \
-H "X-Api-Private-Key: sua_chave_privada_aqui" \
-H "Content-Type: application/json"
{
"available": 3153900,
"blocked": 0,
"total": 2653900
}
Saldo
Obter Saldo Disponível
Como obter o saldo disponível na sua conta via API pública
GET
/
api
/
public
/
balance
curl -X GET https://api.nixfypagamentos.com/api/public/balance \
-H "X-Api-Public-Key: sua_chave_publica_aqui" \
-H "X-Api-Private-Key: sua_chave_privada_aqui" \
-H "Content-Type: application/json"
{
"available": 3153900,
"blocked": 0,
"total": 2653900
}
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:string
required
Sua chave pública da API
string
required
Sua chave privada da API
Exemplo de Requisição
curl -X GET https://api.nixfypagamentos.com/api/public/balance \
-H "X-Api-Public-Key: sua_chave_publica_aqui" \
-H "X-Api-Private-Key: sua_chave_privada_aqui" \
-H "Content-Type: application/json"
Resposta de Sucesso
integer
required
Saldo disponível em centavos (valor que pode ser usado para transferências)
integer
required
Saldo bloqueado em centavos (valor reservado para operações pendentes, MEDs, etc.)
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:
3153900centavos = R$ 31.539,000centavos = R$ 0,002653900centavos = 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