4 endpoints
Wallet
Le solde de votre compte de paiement, son RIB au nom du marchand, l'attestation à télécharger, et son alimentation.
Les intitulés et descriptions d'endpoints viennent du contrat OpenAPI, en anglais — ils ne peuvent pas diverger de l'API.
En clair
Votre compte de paiement ChariPay : consulter le solde, obtenir votre RIB, l'alimenter.
Quand l'utiliser
Pour afficher un solde dans votre back-office, pour communiquer un RIB à un payeur, ou pour approvisionner le compte avant une opération sortante.
Comment l'intégrer
- 1Lisez le solde disponible avant toute opération qui sort de l'argent.
- 2Récupérez le RIB, ou son attestation PDF, quand un tiers doit vous virer des fonds.
- 3Alimentez le wallet quand la position ne couvre pas ce que vous voulez engager.
- POST
/v1/wallet/cash-insApprovisionner le compte de paiement du marchand - GET
/v1/wallet/account/rib-documentTélécharger le RIB du compte de paiement (PDF) - GET
/v1/wallet/accountRécupérer le compte de paiement (RIB) - GET
/v1/walletRécupérer le solde du compte de paiement
Approvisionner le compte de paiement du marchand
Crée un lien de paiement par carte hébergé localement. La soumission de la carte alimente l'eSIM partagée de la sandbox ou l'eSIM de production réelle du marchand via le parcours de checkout canonique. En mode registre seul, la sandbox crée et finalise un encaissement (cash-in) canonique via l'outbox durable.
Schéma · WalletCashinRequest
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
Idempotency-Key | string | header | Requis | Clé d'idempotence obligatoire, sécurisant les nouvelles tentatives. |
amount | number | body | Requis | Montant à approvisionner, en MAD. |
Télécharger le RIB du compte de paiement (PDF)
Renvoie les coordonnées bancaires du compte de paiement sous forme de document PDF téléchargeable.
Aucun paramètre.
Récupérer le compte de paiement (RIB)
Renvoie les coordonnées bancaires copiables (RIB/IBAN/BIC, titulaire, banque) et les soldes actuels.
Aucun paramètre.
Récupérer le solde du compte de paiement
Renvoie le solde en temps réel du compte de paiement en MAD pour l'environnement de la clé.
Aucun paramètre.
Une question sur l'intégration ?
Notre équipe technique répond aux intégrateurs, du premier appel en sandbox jusqu'à la mise en production.