A API de Consulta de Saldo é usada para consultar em tempo real o saldo atual da sua conta CheckNumber e a cota disponível de detecção.
Endpoint da API
GET https://api.checknumber.ai/v1/balance
Método de Requisição
| Parâmetro | Obrigatório | Descrição |
|---|
X-API-Key | Sim | Sua chave de API (o header alternativo X-Access-Key também é aceito) |
Exemplos de Resposta
Resposta com Sucesso
Descrição dos Campos
| Campo | Tipo | Descrição |
|---|
balance | number | Saldo atual da conta (USD) |
Resposta Não Autorizada
"message": "Uma chave de acesso é obrigatória (X-API-Key ou X-Access-Key)"
Códigos de Status
| Código | Descrição |
|---|
200 | Requisição bem-sucedida |
401 | Não autorizado; a chave de API está ausente ou é inválida |
502 | Falha na consulta de saldo; erro do serviço upstream |