Bienvenue dans la documentation complète des API et services NICE PAY. Cette documentation vous guidera à travers l'intégration de nos différents services de paiement dans vos applications.
Note importante : Toutes nos API utilisent l'authentification par token. Assurez-vous de sécuriser vos clés d'API.
# URL de Production
https://api.nicepaygroup.com/v1
# URL de Test (Sandbox)
https://sandbox.nicepaygroup.com/v1
Transferts nationaux et internationaux vers plusieurs pays d'Afrique de l'Ouest via différents opérateurs.
Voir la documentation →Rechargez votre compte NICE PAY via plusieurs canaux : Mobile Money, cartes bancaires, crypto-monnaies.
Voir la documentation →Créez et partagez des liens de paiement pour recevoir des paiements de vos clients.
Voir la documentation →Intégrez des fonctionnalités Bitcoin dans vos applications avec notre API sécurisée.
Voir la documentation →Notre service de transfert d'argent permet d'envoyer des fonds vers plusieurs pays d'Afrique de l'Ouest via différents opérateurs de Mobile Money.
| Pays | Opérateurs |
|---|---|
| International | CARTE BANCAIRE |
| Sénégal | Orange Money, Free Money, Expresso, Wave, Wizall |
| Côte d'Ivoire | Orange Money, MTN, Moov, Wave |
| Bénin | Moov, MTN |
| Burkina Faso | Orange Money, Moov |
| Togo | T-money, Moov Togo |
| Mali | Orange Money, Moov |
Endpoint pour initier un transfert d'argent.
{
"recipient_name": "Koffi A.",
"recipient_phone": "2250700000000",
"country": "Côte d'Ivoire",
"operator": "Orange Money",
"amount": 10000,
"currency": "XOF",
"description": "Transfert familial"
}
{
"success": true,
"transaction_id": "TRX202310150001",
"status": "pending",
"message": "Transfert initié avec succès"
}
Rechargez votre compte NICE PAY via plusieurs canaux de paiement disponibles dans les pays supportés.
Dépôt via Orange Money, MTN Mobile Money, Moov Money, etc.
Visa, Mastercard et autres cartes internationales.
Bitcoin et autres crypto-monnaies principales.
Virements directs depuis votre compte bancaire.
Endpoint pour initier un dépôt sur un compte NICE PAY.
{
"account_id": "ACC123456",
"amount": 50000,
"currency": "XOF",
"method": "orange_money",
"phone": "2250700000000"
}
Créez et partagez des liens de paiement personnalisés pour recevoir des paiements de vos clients. Ces liens peuvent être intégrés dans vos sites web, emails, ou messages.
Endpoint pour créer un nouveau lien de paiement.
{
"product_name": "Produit ABC",
"description": "Description du produit",
"amount": 25000,
"currency": "XOF",
"fee_option": "buyer_pays",
"redirect_url": "https://votresite.com/merci",
"custom_data": {
"order_id": "ORD12345",
"customer_email": "client@example.com"
}
}
{
"success": true,
"payment_link": "https://nicepaygroup.com/pay?id=UNIQUE123",
"unique_id": "UNIQUE123",
"expires_at": "2023-12-31T23:59:59Z"
}
Une fois le lien de paiement créé, vous pouvez l'intégrer de plusieurs manières :
<a href="https://nicepaygroup.com/pay?id=UNIQUE123"
class="payment-button">
Payer 25,000 FCFA
</a>
<!-- Ou avec un bouton stylisé -->
<button onclick="window.location.href='https://nicepaygroup.com/pay?id=UNIQUE123'"
class="bg-yellow-500 text-black px-6 py-3 rounded-lg font-bold">
Payer maintenant
</button>
Notre API Bitcoin vous permet d'intégrer des fonctionnalités de paiement en Bitcoin dans vos applications. Convertissez facilement entre Bitcoin et monnaies locales.
Obtenir le taux de change Bitcoin/XOF actuel.
{
"btc_to_xof": 24500000,
"xof_to_btc": 0.0000000408,
"timestamp": "2023-10-15T10:30:00Z"
}
Créer une nouvelle adresse Bitcoin pour recevoir des paiements.
{
"user_id": "USER123",
"callback_url": "https://yourapp.com/webhook/bitcoin"
}
{
"address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"user_id": "USER123"
}
Convertir et retirer des Bitcoin en monnaie locale.
{
"user_id": "USER123",
"amount_btc": 0.01,
"destination": "orange_money",
"phone": "2250700000000"
}
Intégrez la solution Machankura, un portefeuille Bitcoin accessible via USSD, WhatsApp, Web et App, avec les APIs de NicePay pour permettre la conversion instantanée de Bitcoin en monnaie locale (XOF) et vice versa.
L'objectif de cette intégration est d'interfacer Machankura avec NicePay pour permettre :
NicePay met à disposition une API d'achat d'Airtime qui permet aux utilisateurs d'acheter des unités téléphoniques directement depuis leur portefeuille Machankura, pour eux-mêmes ou pour un tiers.
{
"phone_number": "2250700000000",
"amount": 1000,
"operator": "ORANGE"
}
{
"success": true,
"transaction_id": "ATX202310150001",
"status": "completed",
"message": "Recharge effectuée avec succès"
}
NicePay propose une API bancaire robuste permettant à Machankura d'offrir des virements vers et depuis des comptes bancaires.
Permet à l'utilisateur d'envoyer des fonds de son portefeuille Machankura vers un compte bancaire local (XOF).
{
"account_number": "002589****",
"bank_code": "CICI",
"amount": 10000,
"currency": "XOF"
}
Permet à un utilisateur d'alimenter son portefeuille Machankura à partir de son compte bancaire.
{
"reference": "REF202510XX",
"amount": 15000,
"account_id": "WALLET_123456",
"currency": "XOF",
"status": "SUCCESS"
}
Cette section présente la documentation détaillée de toutes nos API avec des exemples d'utilisation dans différents langages de programmation.
Toutes les requêtes API doivent inclure un token d'authentification dans l'en-tête HTTP.
Authorization: Bearer YOUR_API_TOKEN
Warning: file_get_contents(): php_network_getaddresses: getaddrinfo for api.nicepaygroup.com failed: Name or service not known in /htdocs/Documentation.php on line 827
Warning: file_get_contents(https://api.nicepaygroup.com/v1/api/payment-links): Failed to open stream: php_network_getaddresses: getaddrinfo for api.nicepaygroup.com failed: Name or service not known in /htdocs/Documentation.php on line 827
Warning: Trying to access array offset on null in /htdocs/Documentation.php on line 830
Warning: Trying to access array offset on null in /htdocs/Documentation.php on line 833
Erreur :
// Exemple d'intégration JavaScript pour créer un lien de paiement
const apiUrl = 'https://api.nicepaygroup.com/v1/api/payment-links';
const apiToken = 'YOUR_API_TOKEN';
const data = {
product_name: 'Produit ABC',
description: 'Description du produit',
amount: 25000,
currency: 'XOF',
fee_option: 'buyer_pays',
redirect_url: 'https://votresite.com/merci'
};
fetch(apiUrl, {
method: 'POST',
headers: {
'Authorization': `Bearer ${apiToken}`,
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => {
if (result.success) {
console.log('Lien de paiement :', result.payment_link);
} else {
console.error('Erreur :', result.message);
}
})
.catch(error => {
console.error('Erreur réseau :', error);
});
# Exemple d'intégration Python pour créer un lien de paiement
import requests
import json
api_url = 'https://api.nicepaygroup.com/v1/api/payment-links'
api_token = 'YOUR_API_TOKEN'
data = {
'product_name': 'Produit ABC',
'description': 'Description du produit',
'amount': 25000,
'currency': 'XOF',
'fee_option': 'buyer_pays',
'redirect_url': 'https://votresite.com/merci'
}
headers = {
'Authorization': f'Bearer {api_token}',
'Content-Type': 'application/json'
}
response = requests.post(api_url, headers=headers, data=json.dumps(data))
result = response.json()
if result.get('success'):
print(f"Lien de paiement : {result['payment_link']}")
else:
print(f"Erreur : {result.get('message', 'Erreur inconnue')}")
# Exemple d'intégration cURL pour créer un lien de paiement
curl -X POST \
https://api.nicepaygroup.com/v1/api/payment-links \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"product_name": "Produit ABC",
"description": "Description du produit",
"amount": 25000,
"currency": "XOF",
"fee_option": "buyer_pays",
"redirect_url": "https://votresite.com/merci"
}'
Ce guide vous aidera à intégrer rapidement les API NICE PAY dans votre application.
Toutes les API retournent des codes HTTP standard et des messages d'erreur détaillés.
| Code HTTP | Signification |
|---|---|
| 200 | Succès |
| 400 | Requête invalide |
| 401 | Non autorisé |
| 403 | Accès refusé |
| 404 | Ressource non trouvée |
| 500 | Erreur serveur |
Configurez des webhooks pour recevoir des notifications en temps réel sur le statut de vos transactions.
{
"event": "payment.completed",
"data": {
"transaction_id": "TRX202310150001",
"amount": 25000,
"currency": "XOF",
"status": "completed",
"timestamp": "2023-10-15T10:30:00Z"
}
}
Notre équipe de support est disponible pour vous aider dans l'intégration de nos API.