NODEJS


  IMPORTANT


Lire toutes les sections en bleues pour mieux comprendre la documentation et les sections en orange signifiant l'alerte afin d'éviter des erreurs à commettre durant les intégrations et les procédures détaillées pour les intégration.

GENERATION DE VOS CLE D'API

Les clés d'API sont vos références numériques auprès des systèmes de PayDunya. Nous les utilisons afin d'identifier votre compte et les applications que vous allez créer. Ces clés sont nécessaires pour toute intégration des APIs de paiements PayDunya. Voici chronologiquement la marche à suivre :

INSTALLATION


Installation PayDunya via la commande npm


npm install paydunya

Installation PayDunya via la commande yarn


yarn add paydunya

CONFIGURATION DE BASE


Obligatoire


Connectez-vous à votre compte et cliquez sur Intégration API au niveau du menu à gauche puis sur détails au niveau de l'application que vous avez créée, récupérez les clés d'API et donnez-les en arguments aux méthodes suivantes


var paydunya = require('paydunya');

var setup = new paydunya.Setup({
  masterKey: 'wQzk9ZwR-Qq9m-0hD0-zpud-je5coGC3FHKW',
  privateKey: 'test_private_rMIdJM3PLLhLjyArx9tF3VURAF5',
  publicKey: 'test_public_kb9Wo0Qpn8vNWMvMZOwwpvuTUja',
  token: 'IivOiOxGJuWhc5znlIiK',
  mode: 'test' // Optionnel. Utilisez cette option pour les paiements tests.
});

Info

Si vous êtes en test utilisez les clés de test sinon utilisez les clés de production et spécifiez le mode en remplaçant "test" par "live" dans le code ci-dessus.

Pour plus de détails sur le passage en production cliquez ici.

Bonne pratique

Il pourrait être généralement adapté de mettre la configuration de vos clés d'API au niveau des variables d'environnement. Dans ce cas, vous pouvez initialiser paydunya.Setup sans passer de paramètres de configuration. Le package se chargera de détecter automatiquement les variables d'environnement pour ensuite les utiliser. Les noms de variables d'environnement attendus sont: PAYDUNYA_MASTER_KEY, PAYDUNYA_PRIVATE_KEY, PAYDUNYA_PUBLIC_KEY et PAYDUNYA_TOKEN.


1 - Configuration des informations de votre service/activité/entreprise


Vous pouvez configurer les informations de votre service/activité/entreprise comme illustré ci-dessous. PayDunya utilise ces paramètres afin de configurer les informations qui s'afficheront sur la page de paiement, les factures PDF et les reçus imprimés.


// Configuration des informations de votre service/entreprise
var store = new paydunya.Store({
    name: 'Magasin Chez Sandra', // Seul le nom est requis
    tagline: "L'élégance n'a pas de prix",
    phoneNumber: '336530583',
    postalAddress: 'Dakar Plateau - Etablissement kheweul',
    websiteURL: 'http://www.chez-sandra.sn',
    logoURL: 'http://www.chez-sandra.sn/logo.png'
});

2 - Configuration de l'IPN (Instant Payment Notification)


L'IPN correspond à l'URL du fichier sur lequel vous souhaitez recevoir les informations de la transaction de paiement pour un éventuel traitement en backoffice. PayDunya utilise cette URL afin de vous envoyer instantanément, par requête POST, les informations relatives à la transaction de paiement.

Astuce

Il existe deux façons de configurer l'URL de notification instantanée de paiement: soit en vous rendant dans votre compte PayDunya au niveau des informations de configuration de votre application ou soit directement dans votre code.

L'utilisation de la seconde option vous offre les deux possibilités ci-dessous.


3 - Configuration globale de l'URL de notification instantanée de paiement


Cette instruction devra être incluse au niveau de la configuration de votre service/activité.


var store = new paydunya.Store({
    name: 'Magasin chez Sandra',
    callbackURL: 'http://www.ma-super-boutique.com/fichier_de_reception_des_données_de_facturation'
});

4 - Configuration de l'URL de notification instantanée de paiement sur une instance de facture


Alerte

Cette configuration écrasera les paramètres globaux de redirection si ceux-ci ont déjà été définis.


invoice.callbackURL = 'http://www.ma-super-boutique.com/fichier_de_reception_des_données_de_facturation'

Important

La validation réussie de la transaction de paiement retourne la structure ci-dessous contenant les informations sur le client,l'URL de sa facture PayDunya en version PDF et également un hash permettant de vérifier que les données reçues proviennent bien de nos serveurs.


Réponse attendue:


array (
  'data' => 
    array (
     'response_code' => '00',
     'response_text' => 'Transaction Found',
     'hash' => '8c6666a27fe5daeb76dae6abc7308a557dca5be1bda85dfe5d81fa330cdc0bc3c4b37765fe5d2cc36aa2ba0f9284226a80f5488d14740fa70769d6079a179406',
     'invoice' => 
        array (
         'token' => 'test_jkEdPY8SuG',
         'items' => 
            array (
             'item_0' => 
                array (
                  'name' => 'Chaussures Croco',
                  'quantity' => '3',
                  'unit_price' => '10000',
                  'total_price' => '30000',
                  'description' => 'Chaussures faites en peau de crocrodile authentique qui chasse la pauvreté',
               ),
             'item_1' => 
                array (
                 'name' => 'Chemise Glacée',
                 'quantity' => '1',
                 'unit_price' => '5000',
                 'total_price' => '5000',
                 'description' => '',
               ),
           ),
          'taxes' => 
            array (
              'tax_0' => 
                array (
                  'name' => 'TVA (18%)',
                  'amount' => '6300',
               ),
              'tax_1' => 
                array (
                'name' => 'Livraison',
                'amount' => '1000',
              ),
      ),
      'token': 'test_Jh2T8skw1j',
      'total_amount' => '42300',
      'description' => 'Paiement de 42300 FCFA pour article(s) achetés sur Magasin le Choco',
      ),
      'custom_data' => 
        array (
          'categorie' => 'Jeu concours',
          'periode' => 'Noël 2015',
          'numero_gagnant' => '5',
          'prix' => 'Bon de réduction de 50%',
        ),
      'actions' => 
        array (
          'cancel_url' => 'http://magasin-le-choco.com/cancel_url.aspx',
          'callback_url' => 'http://magasin-le-choco.com/callback_url.aspx',
          'return_url' => 'http://magasin-le-choco.com/return_url.aspx',
        ),
      'mode' => 'test',
      'status' => 'completed',
      'customer' => 
        array (
         'name' => 'Alioune Faye',
         'phone' => '774563209',
         'email' => 'aliounefaye@gmail.com',
        ),
      'receipt_url' => 'https://paydunya.com/sandbox-checkout/receipt/pdf/test_jkEdPY8SuG.pdf',
    ),
  )  

Important


Le hash renvoyé par PayDunya est le hash de votre MasterKey (clé principale). Ce hash vous permettra de vous assurer que les données que vous avez reçues proviennent de nos serveurs. L'algorithme utilisé pour obtenir le hash est du SHA-512. Dans la réponse attendue un message d'échec est renseigné dans le noeud fail_reason seulement pour les transactions par carte bancaires échouées ou annulées.

Astuce


PayDunya Fait une requête Post de type application/x-www-form-urlencoded sur votre endpoint de callback et poste un tableau de données contenant les informations du paiement. Vous devez utiliser de ce part, la clé "data" avant de récupérer un noeud. La strucutre renvoyée se trouve sous l'index "data". Il faut aussi observer que la structure de la réponse que vous recevez est un tableau.


Si vous utilisez Express



yarn add body-parser

var bodyParser = require('body-parser')
  app.use( bodyParser.json() );       // to support JSON-encoded bodies
  app.use(bodyParser.urlencoded({     // to support URL-encoded bodies
    extended: true
}));

1 - Récupération du statut du paiement



app.post('/ipn-url', function(req, res) {
    var status = req.body.data.status;
});

2 - Récupération du montant total du paiement



app.post('/ipn-url', function(req, res) {
    var amount = req.body.data.invoice.total_amount;
});

3 - Récupération du Hash



app.post('/ipn-url', function(req, res) {
    var hash = req.body.data.hash;
});

Info

Le hash renvoyé par PayDunya est le hash de votre MasterKey (clé principale). Ce hash vous permettra de vous assurer que les données que vous avez reçu proviennent de nos serveurs.


4 - Exemple de code de vérification IPN


Alerte

Hashez votre clé principale et comparez le résultat au hash reçu par IPN.


try{
  // Prenez votre MasterKey, hashez la et comparez le résultat au hash reçu par IPN
  if(hash == sha512("VOTRE_CLE_PRINCIPALE")) {
    if(status == "completed") {
      // Faites vos traitements backoffice ici...
    }
  }
  } else {
    console.log("Cette requête n'a pas été émise par PayDunya");
  }
} catch() {}

Bonne pratique

Ne jamais mettre en clair vos clés d'API dans un fichier de votre code source, utilisez à la place par exemple des variables d'environnement.

APIs

LES SERVICES PAR & PER

Initialisation

Initialisation d'un Paiement Avec Redirection (PAR) :


Le service de "Paiement Avec Redirection (PAR)" de PayDunya vous permet de créer une facture et de rediriger votre client vers notre plateforme afin qu'il puisse achever le processus de paiement. Nous vous recommandons d'utiliser l'API de "Paiement Avec Redirection (PAR)" car elle est la plus adaptée dans 99% des cas. L'avantage principal de cette option est que les clients peuvent choisir de payer à partir d'une variété d'options de paiement disponibles sur notre plateforme. De plus, si une nouvelle option est rajoutée dans le futur, celle-ci apparaitra directement sur la page de paiement sans que vous ayez à modifier quoi que ce soit au niveau de votre code source.


// Procédez ainsi si vous souhaitez rediriger vos clients vers notre site Web  afin qu'il puisse achever le processus de paiement
// Il est important de remarquer que le constructeur requiert respectivement comme paramètres
// une instance des classes paydunya.Setup et paydunya.Store
var invoice = new paydunya.CheckoutInvoice(setup, store);

AJOUT DES INFORMATIONS DE PAIMENT


1 - Ajout d'articles et de description de facture :


Il est important de savoir que les éléments de facture sont essentiellement utilisés à des fins de présentation sur la page de paiement. PayDunya n'utilisera en aucun cas l'un des montants déclarés pour facturer le client. Pour ce faire, vous devez explicitement utiliser l'attribut total_amount de l'objet invoice afin de préciser le montant exact à facturer au client.


// L'ajout d'éléments à votre facture est très basique.
// Les paramètres attendus sont nom du produit, la quantité, le prix unitaire,
// le prix total et une description optionelle.
invoice.addItem('Chaussures Croco', 1, 10000, 30000, 'Chaussures faites en peau de crocrodile authentique qui chasse la pauvreté');
invoice.addItem('Chemise Glacée', 1, 5000, 5000);

Astuce

Vous pouvez de manière optionelle définir une description générale de facture qui sera utilisée dans les cas où vous avez besoin d'inclure des informations supplémentaires à votre facture.


invoice.description = "Description Optionnelle"

2 - Configuration du montant total de la facture :


PayDunya s'attend à ce que vous préciser le montant total de la facture du client. Ce sera ce montant qui sera facturé à votre client. Nous considérons que vous auriez déjà fait tous les calculs au niveau de votre serveur avant de fixer ce montant.

Info

PayDunya n'effectuera pas de calculs au niveau de ses serveurs. Le montant total de la facture fixé à partir de votre serveur sera celui que PayDunya utilisera pour facturer votre client.


invoice.totalAmount = 42300

Cas du PAR : Redirection vers la page de paiement PayDunya


Après avoir rajouté des articles à votre facture et configurer le montant total de la facture, vous pouvez rediriger votre client vers la page de paiement en appelant la méthode create depuis votre objet facture invoice. Veuillez s'il vous plaît noter que la méthode invoice.create() retourne un booléen (true ou false) selon le fait que la facture ait été créée avec succès ou non. Cela vous permet de mettre une instruction if - else et gérer le résultat comme bon vous semble.


// Le code suivant décrit comment créer une facture de paiement au niveau de nos serveurs,
// rediriger ensuite le client vers la page de paiement
// et afficher ensuite son reçu de paiement en cas de succès.
invoice.create()
  .then(function (){
    console.log(invoice.status);
    console.log(invoice.token); // Token de facture
    console.log(invoice.responseText);
    console.log(invoice.url); // URL de redirection de paiement de facture PayDunya
  })
  .catch(function (e) {
    console.log(e);
  });

CAS DU PER : Paiement Et Redistribution (PER)


Cette option s'avère très intéressante si vous souhaitez créer votre propre solution de paiement par dessus celle de PayDunya ou si vous devez reverser un certain pourcentage à chaque vente (dans le cas d'une marketplace par exemple). L'argent est redistribué sur les différents comptes PayDunya des destinataires et le service n'est pas facturé.

Vous pouvez transférer des fonds vers d'autres comptes clients PayDunya à partir de votre compte via l'API de Paiement Et Redistribution (PER). Pour des raisons de sécurité, vous devez explicitement activer l'option de Paiement Et Redistribution (PER) dans la configuration de votre intégration/application en vous rendant dans votre compte PayDunya. Vous pouvez toujours activer ou désactiver le service de Paiement Et Redistribution (PER) en mettant à jour la configuration de votre intégration/application en vous rendant dans votre compte PayDunya.


var directPay = new paydunya.DirectPay(setup);
directPay.creditAccount('EMAIL_OU_NUMERO_MOBILE_DU_CLIENT_PAYDUNYA', MONTANT_A_TRANSFERER)
  .then(function (){
    console.log(directPay.description);
    console.log(directPay.responseText);
    console.log(directPay.transactionID);
  })
  .catch(function (e) {
    console.log(e);
  });

METHODES API SUPPLEMENTAIRES


1 - Ajout de taxes (facultatif)


Vous pouvez ajouter des informations relatives aux taxes appliquées au niveau de la page de paiement. Ces informations seront ensuite affichées sur la page de paiement, les factures PDF et les reçus imprimés, les reçus électroniques.


// Les paramètres sont l'intitulé de la taxe et le montant de la taxe.
invoice.addTax('TVA (18%)', 6300);
invoice.addTax("Livraison", 1000);

2 - Ajout de données supplémentaires (facultatif)


Si vous avez besoin d'ajouter des données supplémentaires à vos informations de requête de paiement à des fins d'utilisation ultérieure, nous vous offrons la possibilité de sauvegarder des données personnalisées sur nos serveurs et de les récupérer une fois le paiement réussi.

Info

Les données personnalisées ne sont affichées nulle part sur la page de paiement, les factures/reçus, les téléchargements et impressions. Elles sont uniquement récupérées à l'aide de notre action de callback Confirm au niveau de l'API.


// Les données personnalisées vous permettent d'ajouter des données supplémentaires à vos informations de facture
// que pourrez récupérer plus tard à l'aide de notre action de callback Confirm
invoice.addCustomData("categorie", "Jeu concours");
invoice.addCustomData("periode", "Noël 2015");
invoice.addCustomData("numero_gagnant", 5);
invoice.addCustomData("prix","Bon de réduction de 50%");

3 - Restriction des moyens de paiement à afficher (facultatif)


Par défaut, les moyens de paiement activés au niveau de la configuration de votre intégration seront tous affichés sur la page de paiement pour l'ensemble de vos factures.

Si toutefois vous souhaitez resteindre la liste des moyens de paiements à afficher sur la page de paiement d'une facture donnée, nous vous offrons la possibilité de le faire en utilisant les méthodes addChannel et addChannels.

Info

Actuellement, les moyens de paiement disponibles sont les suivants:
card, wari, jonijoni-senegal, orange-money-senegal, paydunya.


# Ajout des moyens de paiement de manière individuelle
invoice.addChannel('wari')
invoice.addChannel('card')

# Ajout de plusieurs moyens de paiement à la fois
invoice.addChannels(['card', 'jonijoni-senegal', 'orange-money-senegal'])

4 - Configuration d'une URL de redirection après annulation de paiement


Vous pouvez optionnellement définir une URL sur laquelle seront redirigés vos clients après une annulation de commande.

Info

Il existe deux façons de configurer l'URL d'annulation de commande: soit de manière globale au niveau des informations de configuration de votre application ou soit par commande.

Alerte

L'utilisation de la seconde option écrase les paramètres globaux si ceux-ci ont déjà été définis.


5 - Configuration d'une URL de redirection après annulation de paiement



var store = new paydunya.Store({
name: 'Magasin chez Sandra',
cancelURL: 'http://magasin-le-choco.com/cancel_url'
});

6 - Configuration de l'URL de redirection après annulation de paiement sur une instance de facture


Alerte

Cette configuration écrasera les paramètres globaux de redirection si ceux-ci ont déjà été définis.


invoice.cancelURL = 'http://magasin-le-choco.com/cancel_url';

7 - Configuration d'une URL de redirection après confirmation de paiement


PayDunya fait un excellent travail de gestion de téléchargements et d'impressions de reçus de paiements après que votre client ait effectué avec succès le paiement de sa commande. Cependant, il peut y avoir des cas où vous souhaiteriez rediriger vos clients vers une autre URL après qu'ils aient réussi le paiement de leur commande. La configuration ci-dessous vient répondre à ce besoin.

Info

PayDunya rajoutera ?token=INVOICE_TOKEN à votre URL. Nous expliquerons comment utiliser ce token dans le chAPItre suivant.


8 - Configuration globale de l'URL de redirection après confirmation de paiement.


Cette instruction devra être incluse au niveau de la configuration de votre service/activité


var store = new paydunya.Store({
  name: 'Magasin chez Sandra',
  returnURL: 'http://magasin-le-choco.com/return_url'
});

9 - Configuration de l'URL de redirection après confirmation de paiement sur une instance de facture

Alerte

Cette configuration écrasera les paramètres globaux de redirection si ceux-ci ont déjà été définis.


invoice.returnURL = 'http://magasin-le-choco.com/return_url';

VERIFICATION DE L'ETAT DE PAIEMENT

Notre API vous permet de vérifier le statut de toutes les transactions de paiement en utilisant le token de facture. Vous pouvez donc conserver votre token de facture et l'utiliser pour vérifier le statut de paiement de ladite facture. Le statut d'une facture peut être soit pending (en attente), cancelled (annulé) ou completed (complété) en fonction de si oui ou non le client a réglé la facture.

Info

Cette option s'avère toutefois adaptée pour les paiements PAR dans la mesure où cela vous permettrait par exemple de connaitre le statut de paiement de votre facture même si le client se trouve toujours sur notre page de paiement.


// PayDunya rajoutera automatiquement le token de la facture sous forme de QUERYSTRING "token"
// si vous avez configuré un "return_url" ou "cancel_url".
var token = 'test_VPGPZNnHOC';

var invoice = new paydunya.CheckoutInvoice(setup, store);
invoice.confirm(token)
.then(function (){
  // Récupérer le statut du paiement
  // Le statut du paiement peut être soit completed, pending, cancelled
  console.log(invoice.status);

  console.log(invoice.responseText);  // Réponse du serveur

  // Les champs qui suivent seront disponibles si et
  // seulement si le statut du paiement est égal à "completed".

  // Vous pouvez récupérer le nom, l'adresse email et le
  // numéro de téléphone du client en utilisant l'objet suivant
  console.log(invoice.customer); // {name: 'Alioune', phone: '773830274', email: 'aliounebadara@gmail.com'}

  // URL du reçu PDF électronique pour téléchargement
  console.log(invoice.receiptURL); // 'https://app.paydunya.com/sandbox-checkout/receipt/pdf/test_VPGPZNnHOC.pdf'
})
.catch(function (e) {
  console.log(e);
});