Développeurs

GET/v3/getbalance

Consulter le solde du compte

Consultez le solde, la devise et les conditions de paiement enregistrés pour votre compte API.

Sur cette page
  1. Requête
  2. Réponse
  3. Erreurs et utilisation

Consultez le solde, la devise et la valeur des conditions de paiement du compte correspondant à vos identifiants API. Il s’agit d’une consultation du solde ; elle n’ajoute pas de fonds et ne passe aucune commande.

Requête

Utilisez des identifiants API côté serveur via HTTPS. Les exemples lisent les identifiants depuis des variables d’environnement ; ils ne contiennent aucun identifiant utilisable. Vérifiez status.code dans le corps JSON ainsi que le statut HTTP. Ces anciens gestionnaires ne définissent pas systématiquement un statut d’erreur HTTP en cas d’erreur applicative.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/getbalance"

Aucun paramètre de chemin, de requête ou de corps n’est requis.

Réponse

Cette structure de réponse est fournie à titre d’exemple ; elle ne contient ni données de compte ni devis tarifaire actuel.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
Champs de la réponse de consultation du solde
ChampSignification
balanceLe solde enregistré du compte. Préservez la précision décimale lors du traitement des valeurs monétaires.
currencyLa valeur de devise enregistrée pour ce compte.
termsLa valeur des conditions de paiement enregistrée pour le compte. Le gestionnaire n’en énumère pas les valeurs possibles et ne la normalise pas ; ne supposez pas que l’exemple couvre toutes les valeurs possibles.

Erreurs et utilisation

En cas d’échec de l’authentification, la réponse d’authentification commune de l’API est utilisée. Ce gestionnaire ne définit ni erreur distincte pour un solde manquant ni pagination. Le solde renvoyé ne constitue pas une réservation de fonds et ne garantit pas la réussite d’une commande ultérieure.