YPAY JavaScript Payment Gateway SDK
đą YPAY â Passerelle de Paiement
YPAY est une passerelle de paiement complÚte et sécurisée qui combine
traitement transactionnel programmatique et
interface utilisateur intuitive.
Notre solution permet aux entreprises dâintĂ©grer facilement des paiements sur leurs plateformes grĂące Ă une API unifiĂ©e, tout en offrant aux utilisateurs une expĂ©rience fluide via lâapplication mobile YPAY.
đ FonctionnalitĂ©s principales
- đ
SĂ©curitĂ© renforcĂ©e : gĂ©nĂ©ration dâOTP de paiement via lâapplication mobile YPAY.
- âĄ
API robuste : intégration simple pour déclencher et valider des transactions.
- đš
Interface utilisateur intĂ©grĂ©e : widgets prĂȘts Ă lâemploi pour un parcours de paiement transparent.
- đ
ĂcosystĂšme unifiĂ© : une seule plateforme pour gĂ©rer vos paiements et vos intĂ©grations.
đ± ExpĂ©rience Utilisateur
Les utilisateurs génÚrent leurs
OTP de paiement directement depuis lâapplication mobile YPAY.
Ces OTP sont ensuite consommés sur les plateformes partenaires qui ont intégré notre API, garantissant une authentification forte et une transaction sécurisée.
---
đŠ Installation
$3
``
html
`
That's it! No separate CSS file needed. All styles are included in the JavaScript bundle.
$3
`
html
`
$3
`
bash
npm install ypay_js
`
`
javascript
// ES6 Modules
import YPAY from 'ypay-sdk';
import PaymentUI from 'ypay-sdk/src/ypay_ui/js/paymentUI.js';
// CommonJS
const { YPAY, Transaction } = require('ypay_js');
`
$3
Download the latest release from GitHub Releases and include the file in your project:
`
html
`
---
đ Quick Start
$3
`
html
YPAY Payment Demo
`
$3
`
javascript
const paymentUI = new PaymentUI(
'YOUR_API_TOKEN',
'XOF',
'en',
{
onSuccess: (data) => {
console.log('Payment successful:', data);
window.location.href = '/success';
},
onFailure: (error) => {
console.error('Payment failed:', error);
}
},
{ onSuccess: true, onFailure: true },
true,
'My Shop',
'https://example.com/logo.png'
);
paymentUI.amount = 10000;
paymentUI.modal = true;
paymentUI.renderForm();
`
---
đ Documentation
The project documentation is divided into two main sections:
$3
Complete guide for integrating the payment user interface:
- UI Components
- Button Integration
- Modal & Tab Modes
- Styling & Customization
- Localization
- Configuration Options
$3
Core SDK for direct API integration:
- Transaction Management
- Validation
- Error Handling
- API Reference
---
âš Features
- â
Complete Payment UI - Ready-to-use modal and tab interfaces
- â
Multi-Currency Support - XOF, USD, NGN
- â
Multi-Language - English and French
- â
Responsive Design - Works on all devices
- â
Granular Dialog Control - Show/hide success and error dialogs independently
- â
Form Validation - Built-in input validation
- â
Singleton Pattern - Single instance management
- â
Event Callbacks - Success and failure handlers
- â
Verbose Logging - Debug mode for development
- â
CDN Ready - Available via jsDelivr
- â
Minified Bundles - Optimized for production
---
đš Styles de Boutons
YPAY fournit plusieurs styles de boutons prĂȘts Ă l'emploi :
`
html
`
---
đ§ Configuration
$3
`
javascript
new PaymentUI(token, currency, language, handlers, showDialogs, verbose, shopName, logo)
`
| ParamÚtre | Type | Défaut | Description |
|-----------|------|---------|-------------|
| token
| string | requis | Votre token d'authentification API |
| currency
| string | "XOF"
| Code de devise (XOF, USD, NGN) |
| language
| string | "en"
| Langue de l'interface ("en" ou "fr") |
| handlers
| object | {}
| Callbacks succÚs/échec |
| showDialogs
| boolean\|object | true
| ContrĂŽle des dialogues d'alerte UI |
| verbose
| boolean | true
| Activer le logging console |
| shopName
| string | "Unknown"
| Nom de votre boutique |
| logo
| string | ""
| URL de l'image du logo |
$3
Format booléen (hérité) :
`
javascript
showDialogs: true // Show all dialogs
showDialogs: false // Hide all dialogs
`
Format objet (recommandé) :
Object format (recommended):
`
javascript
showDialogs: {
onSuccess: true, // Show success dialog
onFailure: false // Hide error dialog
}
`
---
đ Usage Examples
$3
`
javascript
const payment = new PaymentUI(
'YOUR_TOKEN',
'XOF',
'fr',
{
onSuccess: (data) => {
// Redirect to order confirmation
window.location.href = '/order-complete?id=' + data.transaction_id;
},
onFailure: (error) => {
// Custom error handling
showCustomErrorMessage(error);
}
},
{ onSuccess: false, onFailure: true }, // Silent success, show errors
false, // No console logs in production
'Mon E-Shop',
'/assets/logo.png'
);
payment.amount = 15000;
payment.modal = true;
payment.renderForm();
`
$3
`
javascript
const payment = new PaymentUI(
'YOUR_TOKEN',
'XOF',
'en',
{
onSuccess: (data) => {
console.log('Subscription activated:', data);
updateSubscriptionStatus('active');
},
onFailure: (error) => {
console.error('Subscription failed:', error);
showRetryOption();
}
},
true, // Show all dialogs
true, // Enable verbose logging
'Premium Subscription'
);
payment.amount = 5000;
payment.modal = true;
payment.renderForm();
`
$3
`
javascript
import YPAY from 'ypay-sdk';
const ypay = new YPAY('YOUR_TOKEN', 'XOF', 'My Shop');
await ypay.createTransaction(
'ABCD-1234', // Card code
'123456', // OTP
10000, // Amount
'en', // Language
{
onSuccess: (data) => console.log('Success:', data),
onFailure: (error) => console.error('Error:', error)
}
);
`
---
đ Supported Currencies
- XOF - West African CFA franc (F CFA)
- USD - United States Dollar
- NGN - Nigerian Naira
---
đŁïž Supported Languages
- English (en
)
- French (fr
)
---
đ Bonnes Pratiques de SĂ©curitĂ©
1. Ne jamais exposer votre token API dans le code client pour la production
2. Utiliser des variables d'environnement pour les données sensibles
3. Implémenter la validation cÎté serveur pour les transactions critiques
4. Utiliser HTTPS pour toutes les pages de paiement
5. Nettoyer les entrées utilisateur avant le traitement
---
đïž Structure du Projet
`
ypay-sdk/
âââ src/ # Fichiers source
â âââ sdk/ # SDK principal
â â âââ enums.js
â â âââ patterns.js
â â âââ transaction.js
â â âââ ypay.js
â âââ ypay_ui/ # Composants UI
â âââ js/
â âââ styles/
â âââ templates/
â âââ assets/
âââ dist/ # Fichiers construits (CDN)
â âââ ypay-sdk.min.js
â âââ ypay-ui.min.js
â âââ ypay-ui.min.css
â âââ ypay-full.min.js
âââ documentation/ # Documentation
âââ payment_ui.md
âââ ypay.md
`
---
đ ïž DĂ©veloppement
$3
`
bash
Cloner le dépÎt
git clone https://github.com/YTECH-DEV/ypay_js.git
cd ypay_js
Installer les dépendances
npm install
Construire tous les bundles
npm run build:all
Mise Ă jour de version
npm version patch # ou minor/major
`
$3
`
bash
Construire le projet
npm run build:all
Ouvrir le fichier de test dans le navigateur
open test-local.html
``
---
đ Support des Navigateurs
- Chrome (derniĂšre version)
- Firefox (derniĂšre version)
- Safari (derniĂšre version)
- Edge (derniĂšre version)
- Navigateurs mobiles (iOS Safari, Chrome Mobile)
---
đ€ Support
-
đ Documentation :
Documentation ComplĂšte
-
đ§ API Docs : https://ypay.ytech-bf.com/api/docs
-
đ§ Email : infos@ytech-bf.com
-
đ Issues :
GitHub Issues
-
đ Site Web : https://ypay.ytech-bf.com
---
đ Licence
Copyright © 2024 YTECH. Tous droits réservés.
Voir le fichier
LICENSE pour plus de détails.
---
đŠ Historique des Versions
$3
- Version initiale
- Composants UI complets
- Support multi-devises
- Support multi-langues
- ContrĂŽle granulaire des dialogues
- Distribution CDN
---
đ Transformez les paiements mobiles pour les entreprises du monde entier

