Wallets

Un wallet est le compte de valeur de votre application, pour un pays, une devise et un type donnés. Les payins créditent un wallet. Les payouts le débitent.

Types de wallet

Solde réservé et solde disponible

Chaque wallet distingue deux natures de solde.

• Disponible — fonds utilisables tout de suite (par exemple pour un payout ou un refund).
• Réservé — fonds immobilisés un moment :
  • côté payin, les fonds en attente de settlement (voir Settlement différé) ;
  • côté payout, les fonds réservés dès la création, avant l'envoi au bénéficiaire.

Une application et ses pays

Une application possède un portefeuille par (pays, devise, type). Si votre application encaisse et reverse en Côte d'Ivoire, elle a par exemple un portefeuille PAYIN CI et un portefeuille PAYOUT CI, tous deux en XOF. Le pays sert au choix des opérateurs et au routage ; ce n'est pas un compartiment d'argent distinct.

Les soldes sont comptabilisés par devise. Comme le XOF est partagé par plusieurs pays (zone UEMOA), deux portefeuilles de même devise et même type partagent le même solde.

Consulter vos soldes

GET /v1/wallets renvoie, pour l'application de votre clé d'API, le solde disponible et réservé de chaque portefeuille, dans l'environnement de la clé (fg_sandbox_ ou fg_live_). Les montants sont formatés selon la devise.

{
  "data": [
    {
      "walletId": "wlt_...",
      "countryIso2": "CI",
      "type": "PAYOUT",
      "currency": "XOF",
      "available": "612.00",
      "reserved": "0.00"
    },
    {
      "walletId": "wlt_...",
      "countryIso2": "CI",
      "type": "PAYIN",
      "currency": "XOF",
      "available": "176.00",
      "reserved": "0.00"
    }
  ],
  "meta": { "environment": "SANDBOX" }
}

Voir la référence List wallet balances.

Cohérence des soldes

Chaque mouvement de fonds est enregistré et traçable. Un montant qui quitte le solde réservé arrive quelque part : sur le solde disponible, chez un bénéficiaire ou en remboursement. Jamais nulle part. Vos soldes restent donc toujours exacts, quel que soit l'ordre dans lequel les opérations se terminent.