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

# Consulter le solde

> Récupérer le solde disponible par catégorie

Récupère votre solde disponible et en attente par catégorie.

### Authentification

```bash theme={null}
X-API-Key: pk_test_xxx:sk_test_xxx
```

### Requête

```bash theme={null}
curl https://sandbox-api.caurisflux.com/api/v1/payments/balance \
  -H "X-API-Key: pk_test_xxx:sk_test_xxx"
```

### Réponse

```json theme={null}
{
  "success": true,
  "data": {
    "categories": {
      "collect": {
        "available": 1500000,
        "pending": 250000
      },
      "payout": {
        "available": 500000,
        "pending": 0
      },
      "credit": {
        "available": 0,
        "pending": 0
      }
    },
    "totals": {
      "available": 2000000,
      "pending": 250000
    },
    "currency": "XOF",
    "updatedAt": "2024-01-15T12:30:00.000Z"
  }
}
```

### Catégories de balance

| Catégorie | Description                               |
| --------- | ----------------------------------------- |
| `collect` | Solde des encaissements (paiements reçus) |
| `payout`  | Solde dédié aux décaissements             |
| `credit`  | Ligne de crédit (si activée)              |

### Champs de réponse

| Champ                    | Type   | Description                          |
| ------------------------ | ------ | ------------------------------------ |
| `categories`             | object | Soldes par catégorie                 |
| `categories.*.available` | number | Montant disponible immédiatement     |
| `categories.*.pending`   | number | Montant en attente de validation     |
| `totals.available`       | number | Total disponible (toutes catégories) |
| `totals.pending`         | number | Total en attente (toutes catégories) |
| `currency`               | string | Devise des montants                  |
| `updatedAt`              | string | Date de dernière mise à jour         |

### Utilisation

Utilisez cet endpoint pour :

* Vérifier le solde disponible avant un payout
* Afficher le solde dans votre dashboard
* Déclencher des alertes de solde bas

### Solde disponible vs pending

* **available** : Montant utilisable immédiatement pour les payouts
* **pending** : Montant en attente (paiements non encore confirmés par le provider)

<Info>
  Les fonds passent de `pending` à `available` après confirmation par le provider de paiement (généralement quelques heures à 24h).
</Info>