cauris
v0.2.1
Published
SDK TypeScript/JavaScript pour l'API de paiement Cauris — Mobile Money en Afrique
Maintainers
Readme
Cauris — SDK TypeScript / JavaScript
API de paiement Mobile Money pour l'Afrique. Orange Money, MTN, 9 pays.
Installation
npm install caurisRecevoir un paiement (3 lignes)
import Cauris from 'cauris';
const cauris = new Cauris('ck_test_...');
const charge = await cauris.charges.create({
amount: 5000,
phone: '237691234567',
});
console.log(charge.id); // "d6ac3af6-..."
console.log(charge.status); // "pending"Le client recoit une notification USSD. Il confirme. Tu recois un webhook.
Verifier un paiement
const charge = await cauris.charges.retrieve('d6ac3af6-...');
console.log(charge.status); // "success" | "pending" | "failed"Envoyer de l'argent (Payout)
const payout = await cauris.payouts.send({
amount: 5000,
phone: '237691234567',
reason: 'Remboursement commande #123',
});
console.log(payout.id); // "a1b2c3d4-..."
console.log(payout.status); // "success"Parametres de charges.create
| Param | Type | Requis | Description |
|---|---|---|---|
| amount | number | oui | Montant en unite minimale (5000 = 5000 XAF) |
| phone | string | oui | Numero international (237691234567) |
| currency | string | non | Defaut: XAF. Valeurs: XAF, XOF, CDF, UGX, GNF |
| notifyUrl | string | non | URL webhook appelee a la confirmation |
| metadata | object | non | Donnees libres (ex: { orderId: "123" }) |
Pays supportes
Cameroun, Senegal, Congo-Brazzaville, Congo-Kinshasa, Uganda, Benin, Guinee-Conakry, Gabon.
Liens
- Site : https://app-cauris.vercel.app
- PyPI : https://pypi.org/project/cauris/
