La API de Consulta de Saldo se utiliza para consultar en tiempo real el saldo actual de su cuenta CheckNumber y la cuota de detección disponible.
Punto Final de la API
GET https://api.checknumber.ai/v1/balance
Método de Solicitud
Encabezados de Solicitud
| Parámetro | Requerido | Descripción |
|---|
X-API-Key | Sí | Su clave de API (también se acepta el encabezado alternativo X-Access-Key) |
Ejemplos de Respuesta
Respuesta Exitosa
Descripción de Campos
| Campo | Tipo | Descripción |
|---|
balance | number | Saldo actual de la cuenta (USD) |
Respuesta No Autorizada
"message": "Se requiere una clave de acceso (X-API-Key o X-Access-Key)"
Códigos de Estado
| Código | Descripción |
|---|
200 | Solicitud exitosa |
401 | No autorizado; falta la clave de API o no es válida |
502 | Error al consultar el saldo; error del servicio ascendente |