Aller au contenu

Soldes

Lire le solde de chaque moyen de paiement et comprendre en attente, disponible et réservé.

Les soldes indiquent l’argent du marchand chez 221 Pay. Ils sont en lecture seule : seuls les paiements, remboursements et retraits les font bouger.

Lire les soldes

Terminal
curl "$API_URL/v1/balances" -H "Authorization: Bearer $API_KEY"
200 · application/json
{
  "gateway_mode": "real",
  "rails": {
    "sn_wave":   { "available": "245000", "pending": "0", "reserved": "100000" },
    "sn_orange": { "available": "38500",  "pending": "0", "reserved": "0" },
    "ci_wave":   { "available": "12000",  "pending": "0", "reserved": "0" }
  }
}

rails contient un solde par moyen de paiement, sous son identifiant (sn_wave, ci_wave…) : chaque moyen de paiement activé sur un projet du marchand, et chaque moyen de paiement qui garde un solde. Voir Moyens de paiement et pays.

Trois compartiments

CompartimentContenu
pendingMontants nets reçus, en attente de mise à disposition.
availableArgent retirable et utilisable pour rembourser.
reservedArgent mis de côté pour un retrait ou un remboursement en cours, ou à l’issue inconnue.

Le cycle d’un montant :

  1. Paiement confirmed : le montant net (net) est crédité ; dès la confirmation, il est disponible.
  2. Retrait ou remboursement accepté : le montant prélevé passe de available à reserved.
  3. Versement réussi : il quitte reserved. Versement refusé : il revient dans available. Issue inconnue : il reste dans reserved jusqu’à la preuve.

Un solde par moyen de paiement

Chaque encaissement crédite le solde de son moyen de paiement : un paiement ci_wave crédite rails.ci_wave. Les soldes ne se mélangent pas :

  • un retrait puise dans le solde du moyen de paiement du numéro de retrait ;
  • un remboursement puise dans le solde du moyen de paiement du paiement remboursé.

Mode du compte : gateway_mode

ValeurSignification
simulatedMode test : soldes simulés, aucun argent réel.
realMode réel.

Voir Tests.

Les mêmes chiffres dans le tableau de bord

Rubrique Solde et retraits : soldes, numéros de retrait et historique des retraits. L’accueil du tableau de bord résume aussi, par moyen de paiement, le solde disponible et le taux de réussite des 30 derniers jours.