Skip to main content
GET
/
payments
/
balance
Consulter le solde
curl --request GET \
  --url https://sandbox-api.caurisflux.com/api/v1/payments/balance \
  --header 'X-API-Key: <api-key>'

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.

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

​
Authentification

X-API-Key: pk_test_xxx:sk_test_xxx

​
Requête

curl https://sandbox-api.caurisflux.com/api/v1/payments/balance \
  -H "X-API-Key: pk_test_xxx:sk_test_xxx"

​
Réponse

{
  "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égorieDescription
collectSolde des encaissements (paiements reçus)
payoutSolde dédié aux décaissements
creditLigne de crédit (si activée)

​
Champs de réponse

ChampTypeDescription
categoriesobjectSoldes par catégorie
categories.*.availablenumberMontant disponible immédiatement
categories.*.pendingnumberMontant en attente de validation
totals.availablenumberTotal disponible (toutes catégories)
totals.pendingnumberTotal en attente (toutes catégories)
currencystringDevise des montants
updatedAtstringDate 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)
Les fonds passent de pending à available après confirmation par le provider de paiement (généralement quelques heures à 24h).