Consultar saldo da conta
GET/v1/conta/saldo
Retorna o saldo de créditos pré-pagos disponível no Dashboard API da conta vinculada à chave enviada. A operação é gratuita, não cria lançamento de consumo e permanece acessível quando o saldo estiver zerado, permitindo que a integração decida quando alertar ou iniciar uma recarga.
Valor para a operação: permite controlar consumo, alertas de saldo baixo e decisões de recarga diretamente na integração.
Autenticação e resposta: envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.
SLA e HTTP 202: a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.
Requisição
Responses
- 200
- 202
- 400
- 401
- 403
- 404
- 422
- 429
- 500
Resposta da operação.
A operação ultrapassou a janela síncrona e continua no servidor. Faça polling da URL informada.
Response Headers
URL absoluta de acompanhamento.
Espera mínima recomendada antes do próximo polling, em segundos.
JSON inválido ou parâmetros ausentes/inválidos.
API key ausente ou inválida.
Conta inativa, saldo insuficiente ou operação não permitida.
Recurso não encontrado.
Parâmetros válidos sintaticamente, mas rejeitados por regra de negócio.
Limite de requisições excedido. A API aplica limites por classe de rota.
Erro interno não especificado.