Consultar Saldo

Se utiliza para consultar el saldo disponible de la aplicación a la que pertenece la API Key actual. La aplicación consultada está determinada por la API Key, y no es necesario pasar el ID de la aplicación en la solicitud.

URL de Solicitud

GET https://otp.api.engagelab.cc/v1/balance

Autenticación

Consulte Autenticación para saber cómo realizar la autenticación de la API.

Ejemplo de Solicitud

Encabezado de Solicitud

              
              GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Parámetros de Solicitud

Sin parámetros de solicitud.

Parámetros de Respuesta

Respuesta Exitosa

              
              {
    "currency": "USD",
    "balance": "123.4500",
    "gift_balance": "1.0000",
    "total_balance": "124.4500"
}

            

Descripción del Campo

1. Los importes son todos decimales de cadena, conservando 4 decimales. Este diseño es para evitar errores de precisión durante la transmisión y el análisis de números de punto flotante. Utilice tipos decimales de alta precisión (como BigDecimal / Decimal en varios lenguajes) para el análisis, y no calcule directamente como números de punto flotante.
2. Moneda: Actualmente, todas las aplicaciones se liquidan en dólares estadounidenses (USD).
3. El saldo puede ser negativo: Para las aplicaciones que han activado una cuota de sobregiro, el balance / total_balance puede devolver un valor negativo (como "-12.3400") después del sobregiro, lo que indica que está en mora. Por favor, recargue a tiempo.
4. total_balance es calculado consistentemente por el servidor en el mismo momento y puede usarse directamente para visualización y conciliación.

Respuesta Fallida

El código de estado HTTP es 4xx o 5xx, y el cuerpo de la respuesta contiene los siguientes campos:

              
              {
    "code": 2001,
    "message": "invalid token"
}

            

Códigos de Error