CinetPay Seamless Integration
CinetPay Seamless Integration permet d'intégrer facilement CinetPay de façon transparente à son service en ligne, c'est à dire que le client effectue le paiement sans quitter le site du marchand.
CinetPay Seamless Integration a été testé et fonctionne sur :
- Cordova
- phoneGap
- Ionic
- jQuery Mobile L'integration de ce SDK se fait en trois etapes :
Pour ceux qui possèdent des services qui ne neccessitent pas un traitement des notifications de paiement de CinetPay, vous pouvez passer directement à l'etape 2, par exemple les services de don.
A chaque paiement, CinetPay vous notifie via un lien de notification, nous vous conseillons de toujours le traiter côté serveur. Nous allons utiliser PHP dans ce cas de figure : Script index.php dans http://mondomaine.com/notify/ (le script doit se trouver dans le repertoire de votre url notify_url) ;
<?php
if (isset($_POST['cpm_trans_id'])) {
// SDK PHP de CinetPay
require_once __DIR__ . '/cinetPay.php';
require_once __DIR__ . '/commande.php';
//La classe commande correspond à votre colonne qui gère les transactions dans votre base de données
$commande = new Commande();
try {
// Initialisation de CinetPay et Identification du paiement
$id_transaction = $_POST['cpm_trans_id'];
$apiKey = _VOTRE_APIKEY_;
$site_id = _VOTRE_SITEID_;
$plateform = "TEST"; // Valorisé à PROD si vous êtes en production
$CinetPay = new CinetPay($site_id, $apiKey, $plateform);
// Reprise exacte des bonnes données chez CinetPay
$CinetPay->setTransId($id_transaction)->getPayStatus();
$cpm_site_id = $CinetPay->_cpm_site_id;
$signature = $CinetPay->_signature;
$cpm_amount = $CinetPay->_cpm_amount;
$cpm_trans_id = $CinetPay->_cpm_trans_id;
$cpm_custom = $CinetPay->_cpm_custom;
$cpm_currency = $CinetPay->_cpm_currency;
$cpm_payid = $CinetPay->_cpm_payid;
$cpm_payment_date = $CinetPay->_cpm_payment_date;
$cpm_payment_time = $CinetPay->_cpm_payment_time;
$cpm_error_message = $CinetPay->_cpm_error_message;
$payment_method = $CinetPay->_payment_method;
$cpm_phone_prefixe = $CinetPay->_cpm_phone_prefixe;
$cel_phone_num = $CinetPay->_cel_phone_num;
$cpm_ipn_ack = $CinetPay->_cpm_ipn_ack;
$created_at = $CinetPay->_created_at;
$updated_at = $CinetPay->_updated_at;
$cpm_result = $CinetPay->_cpm_result;
$cpm_trans_status = $CinetPay->_cpm_trans_status;
$cpm_designation = $CinetPay->_cpm_designation;
$buyer_name = $CinetPay->_buyer_name;
// Recuperation de la ligne de la transaction dans votre base de données
$commande->setTransId($id_transaction);
$commande->getCommandeByTransId();
// Verification de l'etat du traitement de la commande
if ($commande->getStatut() == '00') {
// La commande a été déjà traité
// Arret du script
die();
}
// Dans le cas contrait, on remplit notre ligne des nouvelles données acquise en cas de tentative de paiement sur CinetPay
$commande->setMethode($payment_method);
$commande->setPayId($cpm_payid);
$commande->setBuyerName($buyer_name);
$commande->setSignature($signature);
$commande->setPhone($cel_phone_num);
$commande->setDatePaiement($cpm_payment_date . ' ' . $cpm_payment_time);
// On verifie que le montant payé chez CinetPay correspond à notre montant en base de données pour cette transaction
if ($commande->getMontant() == $cpm_amount) {
// C'est OK : On continue le remplissage des nouvelles données
$commande->setErrorMessage($cpm_error_message);
$commande->setStatut($cpm_result);
$commande->setTransStatus($cpm_trans_status);
if($cpm_result == '00'){
//Le paiement est bon
// Traitez et delivrez le service au client
}else{
//Le paiement a échoué
}
} else {
//Fraude : montant payé ' . $cpm_amount . ' ne correspond pas au montant de la commande
$commande->setStatut('-1');
$commande->setTransStatus('REFUSED');
}
// On met à jour notre ligne
$commande->update();
} catch (Exception $e) {
echo "Erreur :" . $e->getMessage();
// Une erreur s'est produite
}
} else {
// Tentative d'accès direct au lien IPN
}
?>
Avant de commencer cette etape, il faut lier le seamless SDK à votre page :
https://www.cinetpay.com/cdn/seamless_sdk/latest/cinetpay.prod.min.js
: si vous êtes en production
Cela se fait dans la balise head de votre page web
Exemple (en PROD) :
<head>
...
<script charset="utf-8"
src="https://www.cinetpay.com/cdn/seamless_sdk/latest/cinetpay.prod.min.js"
type="text/javascript">
</script>
</head>
Le formulaire de paiement CinetPay est constitué de :
amount
: Montant du paiementcurrency
: Devise du paiement, toujours en CFA pour le momenttrans_id
: L'identifiant de la transaction, elle est uniquedesignation
: La designation de votre paiementnotify_url
: le lien de notification silencieuse (IPN) après paiement
Vous pouvez ajouter en option ces deux elements :
cel_phone_num
: Numéro de téléphone sur lequel l'utilisateur effectuera le paiementcpm_phone_prefixe
: Code Pays du numéro de téléphone (exemple 225)
Exemple :
<p id="payment_result"></p>
<form id="info_paiement">
<input type="hidden" id="amount" value="10">
<input type="hidden" id="currency" value="CFA">
<input type="hidden" id="trans_id" value="">
<input type="hidden" id="cpm_custom" value="">
<input type="hidden" id="designation" value="Achat de chaussure noir">
<button type="submit" id="process_payment">Proceder au Paiement</button>
</form>
NB : Avant l'affichage de ce formulaire, vous devez enregistrer les informations concernant cette transaction dans votre base de données afin de les verifier après paiement du client
Sur clic du bouton "Proceder au Paiement", Nous allons recuperer le montant de la transaction, l'identifiant de la transaction, la devise, la désignation et l'url de notification pour debuter le processus de paiement transparent sur CinetPay Exemple (fichier payment.js) :
<script >
CinetPay.setConfig({
apikey: '174323661757617531bf99c9.80613927',
site_id: 393509,
notify_url: 'http://mondomaine.com/notify/'
});
var process_payment = document.getElementById('process_payment');
process_payment.addEventListener('click', function () {
CinetPay.setSignatureData({
amount: parseInt(document.getElementById('amount').value),
trans_id: document.getElementById('trans_id').value,
currency: document.getElementById('currency').value,
designation: document.getElementById('designation').value,
custom: document.getElementById('cpm_custom').value
});
CinetPay.getSignature();
});
</script>
Lorsque le client se trouve sur le guichet de CinetPay, Vous pouvez suivre l'etat d'avancement du client sur CinetPay grace à ces evènements :
error
: Une erreur s'est produite, les requëtes ajax ou le paiement ont echoué,paymentPending
: Le paiement est en courspaymentSuccessfull
: Le paiement est terminé, Le paiement est valide ou est annulé
Exemple (suite du fichier payment.js):
<script >
var result_div = document.getElementById('payment_result');
CinetPay.on('error', function (e) {
result_div.innerHTML = '';
result_div.innerHTML += '<b>Error code:</b>' + e.code + '<br><b>Message:</b>:' + e.message;
});
CinetPay.on('paymentPending', function (e) {
result_div.innerHTML = '';
result_div.innerHTML = 'Paiement en cours <br>';
result_div.innerHTML += '<b>code:</b>' + e.code + '<br><b>Message:</b>:' + e.message;
});
CinetPay.on('signatureCreated', function () {})
CinetPay.on('paymentSuccessfull', function (paymentInfo) {
if(typeof paymentInfo.lastTime != 'undefined'){
result_div.innerHTML = '';
if(paymentInfo.cpm_result == '00'){
result_div.innerHTML = 'Votre paiement a été validé avec succès : <br> Montant payé :'+paymentInfo.cpm_amount+'<br>';
}else{
result_div.innerHTML = 'Une erreur est survenue :'+paymentInfo.cpm_error_message;
}
}
});
</script>
CinetPay Seamless Integration a été testé et fonctionne sur tous les navigateurs modernes y compris :
- Chrome
- Safari
- Firefox
- Opera
- Internet Explorer 8+.
Ces informations sont disponibles dans votre BackOffice CinetPay.
Vous trouverez un exemple d'intégration complet dans le dossier exemple/html/