Documentation API

🔑 1. Obtenir vos clés API

Pour utiliser notre API, vous avez besoin de deux identifiants :

api_key – Clé publique (visible)
api_secret – Clé privée (à garder secrète)

Connectez-vous à votre espace VPay Pro.
Dans le menu, cliquez sur "API & Développeurs".
Vos clés sont générées automatiquement. Vous pouvez les copier ou les régénérer.

Sécurité : Ne partagez jamais votre api_secret. Utilisez toujours un serveur sécurisé.

📱 2. Télécharger l'application VPay

Gérez vos transactions, factures et paiements en mobilité. L'application VPay Pro est disponible sur :

Google Play App Store APK Android

Scan de reçus, génération de factures, suivi des paiements, webhooks intégrés.

💳 3. Paiement (Payin)

POST https://vpay.digital/VPayPro/Payment/Api-vpay.php

Envoyez les paramètres ci-dessous. L'API redirigera vers la page de paiement sécurisée.

Paramètres obligatoires

Paramètre	Type	Description
`api_key`	string	Votre clé publique
`api_secret`	string	Votre clé privée
`companyName`	string	Nom exact de l'entreprise
`amount`	float	Montant en FCFA (min 100)
`email`	email	Email du client

Optionnels

Paramètre	Type	Description
`phone`	string	Téléphone (225xxxxxxxxx)
`country`	string	Code pays (CI, SN, BJ, etc.) défaut CI
`reference`	string	Référence personnalisée
`webhook_url`	string	URL de notification spécifique

💰 4. Retrait d'argent (Payout)

POST https://vpay.digital/VPayPro/Payout/Api-payout.php

Permet à vos utilisateurs de retirer des fonds vers leur compte Mobile Money (Orange, MTN, Moov, Wave, etc.) dans plus de 20 pays.

Paramètres obligatoires

Paramètre	Type	Description
`api_key`	string	Votre clé publique
`system`	string	Nom de votre entreprise
`user_name`	string	Nom complet du bénéficiaire
`country_code`	string	ci, sn, bj, cm, cd, ga, gh, ke, etc.
`operator`	string	om, mtn, moov, wave, airtel, etc.
`phone`	string	Numéro local (sans indicatif)
`amount`	float	Montant ≥ 100 FCFA
`callback_url`	string	URL pour recevoir la confirmation finale

📌 Fonctionnement : Le montant est débité immédiatement de votre solde. En cas d'échec final, le solde est automatiquement recrédité via notre webhook.

📡 5. Webhooks (notifications)

Nous envoyons des requêtes POST sur l’URL que vous avez configurée (globale ou transactionnelle).

Webhook Paiement (Payin)

{
  "event": "payment.success",
  "timestamp": 1714329671,
  "data": {
    "reference": "TXN_123456",
    "amount": 5000,
    "currency": "XOF",
    "payment_method": "mobile_money",
    "status": "completed"
  }
}
            

Webhook Retrait (Payout)

{
  "event": "payout.session.completed",
  "tokenPay": "D0h6fjyjkCfi",
  "montant": 200,
  "numeroRetrait": "07xxxxxxxxx",
  "moyen": "orange-money-ci",
  "createdAt": "2025-07-17T17:35:23.468Z"
}
            

Événements : payout.session.completed, payout.session.cancelled. Votre serveur doit répondre avec un HTTP 200 OK.

⚠️ 6. Codes d'erreur fréquents

API_KEY_INVALID – Clé API inexistante ou révoquée.
SECRET_INVALID – Secret API incorrect.
COMPANY_NOT_FOUND – Entreprise non trouvée.
AMOUNT_INVALID – Montant non valide (min 100 FCFA).
INSUFFICIENT_BALANCE – Solde insuffisant pour le retrait.
WITHDRAW_MODE_MISSING – Opérateur non supporté pour ce pays.

📞 Support technique

Notre équipe est à votre disposition pour faciliter votre intégration.

support@vpay.digital
https://vpay.digital