> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hub2.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Soldes

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

<Info>
  Veuillez consulter le point de terminaison dans la [référence API](/api-reference/balance/check-merchant-balance).
</Info>

# Requête

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

<CodeGroup>
  ```bash Curl theme={null}
  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' \
  ```

  ```typescript Typescript theme={null}
  import fetch from 'node-fetch';

  async function getBalance() {
      const response = await fetch('https://api.hub2.io/balance?currency=XOF&date=2023-10-01T00:00:00.000Z', {
          method: 'GET',
          headers: {
              'ApiKey': '[REDACTED]',
              'MerchantId': '[REDACTED]',
              'Environment': 'sandbox'
          }
      });

      if (response.ok) {
          const result = await response.json();
          console.log(result);
      } else {
          console.log(`HTTP Status: ${response.status}`);
      }
  }

  getBalance();
  ```

  ```python Python theme={null}
  import requests

  url = 'https://api.hub2.io/balance?currency=XOF&date=2023-10-01T00:00:00.000Z'

  headers = {
      'ApiKey': '[REDACTED]',
      'MerchantId': '[REDACTED]',
      'Environment': 'sandbox',
  }

  response = requests.get(url, headers=headers)

  if response.status_code == 200:
      print(response.json())
  else:
      print(f'HTTP Status: {response.status_code}')
  ```
</CodeGroup>

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 :

```json theme={null}
{
  "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
    }
  ]
}
```