singpay-sdk
v1.0.0
Published
SDK non-officiel pour l'intégration facile des paiements SingPay (Airtel Money, Moov Money, Carte Bancaire) au Gabon.
Maintainers
Readme
SingPay SDK for Node.js
SDK officiel (non-officiel wrapper) pour faciliter l'intégration des paiements SingPay (Airtel Money, Moov Money, Carte Bancaire) dans vos applications Node.js.
Installation
npm install singpay-sdk(Si le paquet n'est pas encore sur npm, installez-le via git ou chemin local)
Configuration
- Renommez le fichier
.env.exampleen.env(si fourni) ou créez-en un nouveau. - Ajoutez vos clés API dans ce fichier
.env:
SINGPAY_CLIENT_ID=votre_client_id
SINGPAY_CLIENT_SECRET=votre_client_secret
SINGPAY_WALLET=votre_wallet_id- Importez et initialisez le client :
require('dotenv').config(); // Charge les variables du .env
const SingPay = require('singpay-sdk');
const singPay = new SingPay({
clientId: process.env.SINGPAY_CLIENT_ID,
clientSecret: process.env.SINGPAY_CLIENT_SECRET,
walletId: process.env.SINGPAY_WALLET,
isProduction: false // true pour la production
});Fonctionnalités
1. Paiement Mobile Money (Push USSD)
Déclenche une demande de paiement directement sur le téléphone du client.
// Paiement Airtel Money
try {
const result = await singPay.payAirtel(500, '074000000', 'REF-12345');
console.log(result);
} catch (error) {
console.error(error);
}
// Paiement Moov Money
const result = await singPay.payMoov(500, '062000000', 'REF-12345');2. Paiement par Carte Bancaire / Web
Génère un lien de paiement sécurisé où l'utilisateur pourra payer par Carte ou Mobile Money via l'interface SingPay.
const linkInfo = await singPay.generatePaymentLink(
1000, // Montant
'REF-WEB-001', // Référence
'https://monsite.com/success', // Redirection succès
'https://monsite.com/echec' // Redirection échec
);
console.log(linkInfo.link); // Redirigez l'utilisateur vers cette URL3. Vérification de Transaction
const status = await singPay.checkTransactionStatus('ID_TRANSACTION_SINGPAY');
console.log(status);API Reference
payAirtel(amount, phone, reference, [disbursement])
amount: Number - Montant en XAF.phone: String - Numéro du client.reference: String - Votre référence unique.
payMoov(amount, phone, reference, [disbursement])
- Mêmes paramètres que
payAirtel.
generatePaymentLink(amount, reference, successUrl, errorUrl, [disbursement], [logoUrl])
- Crée un lien de paiement hébergé.
Note: Ce SDK n'est pas affilié officiellement à SingPay mais respecte leur documentation API Swagger.
