Skip to main content
GET
Obtenha o saldo restante e utilizado da conta de usuário atual. Este endpoint retorna informações de saldo a nível de usuário, independente de tokens específicos, para visualização do saldo geral da conta.

Autorização

string
obrigatório
Todos os endpoints da API exigem autenticação por Bearer TokenObtenha sua chave de API:Acesse a página de gerenciamento de chaves de API para obter sua chave de APIAdicione-a ao cabeçalho da requisição:

Endpoints

Ambos os endpoints possuem a mesma funcionalidade, você pode usar qualquer um deles.

Resposta

boolean
Indica se a requisição foi bem-sucedida
string
Mensagem de erro (retornada apenas em caso de falha)
float
Saldo restante do usuário (retornado em caso de sucesso).
integer
Créditos restantes do usuário (retornado em caso de sucesso).
float
Saldo utilizado do usuário (retornado em caso de sucesso)
float
Créditos utilizados do usuário (retornado em caso de sucesso)

Saldo do token vs. saldo do usuário

Casos de uso

  • Visualizar o saldo geral da conta de usuário
  • Configurar lembretes de recarga e alertas de saldo
  • Exibir o saldo da conta no painel do usuário
Informações sobre a unidade do saldoA unidade do valor do saldo depende da configuração do sistema:
  • USD - Dólares americanos
  • CNY - Yuan chinês
  • Tokens - Quantidade de tokens

Erros comuns

Observação de segurançaSua chave de API é como uma senha. Mantenha-a em local seguro e não a compartilhe com outras pessoas. Em produção, sempre use HTTPS.