Vérifier le Solde

Utilisé pour interroger le solde disponible de l'application à laquelle appartient l'API Key actuelle. L'application interrogée est déterminée par l'API Key, et il n'est pas nécessaire de transmettre l'ID de l'application dans la requête.

URL de Requête

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

Authentification

Veuillez vous référer à Authentification pour savoir comment effectuer l'authentification de l'API.

Exemple de Requête

En-tête de Requête

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

            

Paramètres de Requête

Aucun paramètre de requête.

Paramètres de Réponse

Réponse de Succès

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

            

Description du Champ

1. Les montants sont tous des décimales sous forme de chaîne, conservant 4 décimales. Cette conception vise à éviter les erreurs de précision lors de la transmission et de l'analyse des nombres à virgule flottante. Veuillez utiliser des types décimaux de haute précision (tels que BigDecimal / Decimal dans divers langages) pour l'analyse, et ne calculez pas directement en tant que nombres à virgule flottante.
2. Devise: Actuellement, toutes les applications sont réglées en Dollars américains (USD).
3. Le solde peut être négatif: Pour les applications ayant activé un quota de découvert, le balance / total_balance peut renvoyer une valeur négative (telle que "-12.3400") après un découvert, indiquant qu'il y a des arriérés. Veuillez recharger à temps.
4. total_balance est calculé de manière cohérente par le serveur au même moment et peut être utilisé directement pour l'affichage et le rapprochement.

Réponse d'Échec

Le code d'état HTTP est 4xx ou 5xx, et le corps de la réponse contient les champs suivants :

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

            

Codes d'Erreur