Les soldes des comptes peuvent être consultés à tout moment via l’API HUB2.

Veuillez consulter le point de terminaison dans la référence API.

Requête

Voici un exemple de requête vers ce point de terminaison :

curl --location --request GET 'https://api.hub2.io/balance?currency=XOF&date=2023-10-01T00:00:00.000Z' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Environment: sandbox' \

Notez bien les paramètres suivants :

  • Paramètre currency : détermine la monnaie à récupérer, ici la valeur est XOF
  • Paramètre date : détermine la date pour laquelle le solde doit être récupéré, ici la valeur est 2023-10-01T00:00:00.000Z, par défaut si le champ est manquant, le solde actuel est renvoyé

Réponse

Voici un exemple de réponse au format JSON :

{
  "collectionAccount": [
    {
      "amount": 100,
      "availableBalance": 100,
      "currency": "XOF",
      "date": "2023-10-01T00:00:00.000Z"
    }
  ],
  "transferAccount": [
    {
      "availableBalance": 100,
      "reservedBalance": 100,
      "currency": "XOF",
      "date": "2023-10-01T00:00:00.000Z",
      "amount": 100
    }
  ]
}