Skip to main content
Les soldes de vos comptes peuvent être consultés à tout moment via l’API HUB2.
Consultez le point de terminaison dans la référence de l’API.

Requête

Exemple de requête :
Paramètres de requête (tous facultatifs) :
  • currency : la devise à récupérer, ici XOF.
  • date : la date et l’heure (UTC, ISO 8601) auxquelles calculer le solde, ici 2023-10-01T00:00:00.000Z. Par défaut, le solde actuel est renvoyé.
  • accountType : limite la réponse à certains comptes : collection, transfer ou transfer-irt. Répétez le paramètre ou passez une liste séparée par des virgules (par exemple accountType=collection,transfer). S’il est omis, tous vos comptes sont renvoyés.

Réponse

Exemple de réponse :
  • availableBalance : fonds immédiatement disponibles sur le compte.
  • reservedBalance (comptes de transfert) : fonds réservés pour les transferts en cours de traitement. Selon leur résultat, une partie de ces fonds peut être libérée et redevenir disponible.
  • amount (compte de collecte) : obsolète, utilisez availableBalance à la place.
La réponse peut aussi contenir un tableau transferIrtAccount (transferts internationaux), avec les mêmes champs que transferAccount. Un compte que vous ne détenez pas, ou exclu par accountType, est absent de la réponse. Pour les devises sans décimale comme le XOF et le XAF, les montants sont des unités entières (100 = 100 FCFA).