NODEJS

GENERATE YOUR API KEYS

API keys are your digital references towards PayDunya systems. We use them to identify your account and the applications you will create. These keys are necessary for any integration of the APIs of PayDunya's payments APIs. Here are the steps to follow:

  • First you need have a PayDunya Business account activated. Create one if it is not yet the case.

  • Login to your account and click on API WebPay & MobPay at the menu level on the left.

  • Click on the button Set up a new application and fill out the form.

  • Choose Test mode, I want to make payment tests and Enable production mode.

INSTALLATION

PayDunya installation via the command npm


yarn add paydunya

BASIC CONFIGURATION

Login to your account and click on Intégration API at the menu level left then on details at the level of the application you have created, retrieve the API keys and give them as arguments to the following methods


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' // Optional. Use this option for test payments.
});

Info

If you are in test use the test keys otherwise use the production keys and specify the mode by replacing "test" with "live" in the code above.

For more details on the transition to production cliquez ici.

Good practice


It might be generally appropriate to set the configuration of your API keys at the environment variable level. In this case, you can initialize paydunya.Setup without passing configuration parameters. The package will automatically detect the environment variables and use them. The expected environment variable names are: PAYDUNYA_MASTER_KEY, PAYDUNYA_PRIVATE_KEY, PAYDUNYA_PUBLIC_KEY et PAYDUNYA_TOKEN.

1 - Configuring your service/activity/company information


You can configure your service/activity/company information as shown below. PayDunya uses these settings to configure the information that will appear on the payment page, PDF invoices, and printed receipts.


// Configuring your service / company information
var store = new paydunya.Store({
    name: 'Chez Sandra Store', // Only the name is required
    tagline: "Elegance is priceless,"
    phoneNumber: '336530583',
    postalAddress: 'Dakar Plateau - Establishment kheweul',
    websiteURL: 'http://www.chez-sandra.sn',
    logoURL: 'http://www.chez-sandra.sn/logo.png'
});

2 - Configuring IPN (Instant Payment Notification)


The IPN is the URL of the file on which you want to receive payment transaction information for possible backoffice processing. PayDunya uses this URL to send you instantly, by request POST, the information relating to the payment transaction.

Trick


There are two ways to set up the Instant Payment Notification URL: either by going to your PayDunya account at the level of your app's configuration information or directly in your code.

Using the second option offers you the two possibilities below.


2-1 - Global configuration of instant payment notification URL


This instruction should be included in the configuration of your service/activity.


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

2-2 - Configuring the Instant Payment Notification URL on an Invoice Instance


  Alert


This configuration will overwrite the global redirection settings if they have already been defined.


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

Mandatory


The successful validation of the payment transaction returns the structure below containing the customer information, the URL of its PayDunya invoice in PDF format and also a hash to verify that the received data come from our servers.


Expected answer


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',
    ),
  )  

  Mandatory


The hash returned by PayDunya is the hash of your MasterKey. This hash will allow you to make sure that the data you have received comes from our servers. The algorithm used to obtain the hash is SHA-512. In the expected response, a failure message is entered in the fail_reason node only for failed or canceled bank card transactions.

 Mandatory


PayDunya Make a Post request of type application/x-www-form-urlencoded on your callback endpoint and post a data table containing the payment information. You must use the "data" key before recovering a node. The returned structure is located under the index "data" .


If you use 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
}));

3 - Recovery of payment status



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

4 - Recovery of the total payment amount



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

5 - Hash recovery



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

Info


The hash returned by PayDunya is the hash of your MasterKey. This hash will allow you to make sure that the data you have received comes from our servers.

6 - Sample IPN verification code

  Alert


Hash your main key and compare the result to the hash received by IPN.


try{
  // Take your MasterKey, hash it and compare the result to the received hash by IPN
  if(hash == sha512("VOTRE_CLE_PRINCIPALE")) {
    if(status == "completed") {
      // Do your backoffice treatments here ...
    }
  }
  } else {
    console.log("This request was not issued by PayDunya");
  }
} catch() {}

Good practice


Never put your API keys in a file of your source code, instead use for example environment variables.

APIs

SERVICES PAR AND PER

initialization

Initialization of a Payment With Redistribution (PAR):

PayDunya's "Payment With Redistribution (PAR)" service allows you to create an invoice and redirect your customer to our platform so that it can complete the payment process. We recommend using the "Payment With Redistribution (PAR)" API because it is the most suitable in 99% of cases. The main advantage of this option is that customers can choose to pay from a variety of payment options available on our platform. In addition, if a new option is added in the future, it will appear directly on the payment page without you having to change anything in your source code.


// Do this if you want to redirect your customers to our website so that they can complete the payment process
// It is important to note that the constructor requires respectively as parameters
// an instance of the paydunya.Setup and paydunya.Store classes
var invoice = new paydunya.CheckoutInvoice(setup, store);

1 - ADDING PAYMENT INFORMATION


1-1 - Adding articles and invoice description:


It is important to know that billing items are primarily used for presentation purposes on the payment page. PayDunya will not use any of the amounts declared to bill the customer. To do this, you must explicitly use the SetTotalAmount method of the API to specify the exact amount to bill the customer.


// Adding items to your bill is very basic.
// The expected parameters are product name, quantity, unit price,
// the total price and an optional description.
invoice.addItem('Croco shoes', 1, 10000, 30000, 'Shoes made of genuine crocodile skin that hunts poverty');
invoice.addItem('Ice Shirt', 1, 5000, 5000);

Trick


You can optionally define a general invoice description that will be used in cases where you need to include additional information in your invoice.


invoice.description = "Optional Description"

1-1 - Configuration of the total amount of the invoice:


PayDunya expects you to specify the total amount of the customer's bill. This will be the amount that will be billed to your client. We consider that you have already done all calculations at your server before setting this amount.

Info


PayDunya will not perform calculations on its servers. The total amount of the invoice set from your server will be the one that PayDunya will use to bill your customer.


invoice.totalAmount = 42300

PAR case: Redirection to the PayDunya payment page


After adding items to your invoice and configuring the total invoice amount, you can redirect your customer to the payment page by calling the create method from your invoice object invoice. Please note that the invoice.create() method returns a boolean (true or false) depending on whether the invoice was successfully created or not. This allows you to put an if - else statement and handle the result as you see fit.


// The following code describes how to create a payment invoice at our servers,
// then redirect the customer to the payment page
// and then post his payment receipt if successful.
invoice.create()
  .then(function (){
    console.log(invoice.status);
    console.log(invoice.token); // Bill Token
    console.log(invoice.responseText);
    console.log(invoice.url); // PayDunya invoice payment redirection URL
  })
  .catch(function (e) {
    console.log(e);
  });

PER CASE : Payment And Redistribution


This option is very interesting if you want to create your own payment solution over PayDunya or if you have to pay a certain percentage for each sale (in the case of a marketplace for example). The money is redistributed on the various PayDunya accounts of the recipients and the service is not invoiced.

You can transfer funds to other PayDunya customer accounts from your account via the Payment and Redistribution (PER) API. For security reasons, you must explicitly enable the Payment and Redistribution (PER) option in your integration/application configuration by going to your PayDunya account. You can always enable or disable the Payment and Redistribution (PER) service by updating the configuration of your integration/application by going to your PayDunya account.


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);
  });

ADDITIONAL API METHODS

1 - Adding of taxes (optional)


You can add tax information on the payment page. This information will then be displayed on the payment page, PDF invoices and printed receipts, electronic receipts.


// The parameters are the name of the tax and the amount of the tax.
invoice.addTax('TVA (18%)', 6300);
invoice.addTax("Livraison", 1000);

2 - Adding additional data (optional)

If you need to add additional data to your payment request information for future use, we offer you the option of backing up custom data on our servers and recovering it once the payment is successful.

Info


LCustom data is not displayed anywhere on the payment page, invoices/receipts, downloads, and impressions. They are only retrieved using our confirm callback action at the API level.


// Custom data allows you to add additional data to your billing information
// that can be retrieved later using our callback Confirm action
invoice.addCustomData("category", "contest");
invoice.addCustomData("period", "Christmas 2015");
invoice.addCustomData("numero_gagnant", 5);
invoice.addCustomData("price", "50% discount coupon");

3 - Restriction of the means of payment to display (optional)


By default, the payment methods activated in your integration configuration will all be displayed on the payment page for all your invoices.

However, if you want to keep the list of payment methods to display on the payment page of a given invoice, we offer you the possibility to do so using the methods addChannel and addChannels.

  Info


Currently, the available means of payment are:

card, wari, jonijoni-senegal, orange-money-senegal, paydunya.


// Addition of means of payment individually
invoice.addChannel('wari')
invoice.addChannel('card')

// Addition of several payment methods at a time
invoice.addChannels(['card', 'jonijoni-senegal', 'orange-money-senegal'])

4 - Configuring a redirect URL after canceling payment


4-1 - Configuring a redirect URL after canceling payment


You can optionally define a URL to which your customers will be redirected after an order cancellation.

Info


There are two ways to configure the order cancellation URL: either globally at the configuration information level of your application or by order.

 Alert


Using the second option overwrites the global settings if they have already been defined.


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

4-2 - Configuring the redirection URL after canceling payment on an invoice instance


 Alert


This configuration will overwrite the global redirection settings if they have already been defined.


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

4-3 - Configuring a redirect URL after payment confirmation


PayDunya does a great job of managing downloads and receipt printing of payments after your customer has successfully paid for their order. However, there may be cases where you would want to redirect your customers to another URL after they have successfully paid for their order. The configuration below meets this need.

Info


PayDunya will add ?token=invoice_token to your URL. We will explain how to use this token in the next chapter.


4-4 - Global configuration of the redirect URL after payment confirmation.


This instruction should be included in the configuration of your service/activity


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

4-5 - Configuring the redirect URL after confirming payment on an invoice instance


  Alert


This configuration will overwrite the global redirection settings if they have already been defined.


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

CHECKING THE PAYMENT STATUS

Our API allows you to check the status of all payment transactions using the invoice token. You can therefore keep your invoice token and use it to check the payment status of the invoice. The status of an invoice can be either pending (pending) , canceled (canceled) , or completed (completed) depending on if yes or not the customer has paid the bill.

Info


However, this option is suitable for PAR payments as it would allow you for example to know the payment status of your bill even if the customer is still on our payment page.


// PayDunya will automatically add the invoice token as a QUERYSTRING "token"
// if you have configured a "return_url" or "cancel_url".
var token = 'test_VPGPZNnHOC';

var invoice = new paydunya.CheckoutInvoice(setup, store);
invoice.confirm(token)
.then(function (){
  // Retrieve payment status
  // The payment status can be either completed, pending, cancelled
  console.log(invoice.status);

  console.log(invoice.responseText);  // Server response

  // The following fields will be available if and
  // only if the payment status is equal to "completed".

  // You can retrieve the name, the email address and the
  // customer's phone number using the following object
  console.log(invoice.customer); // {name: 'Alioune', phone: '773830274', email: 'aliounebadara@gmail.com'}

  // URL of the electronic PDF receipt for download
  console.log(invoice.receiptURL); // 'https://app.paydunya.com/sandbox-checkout/receipt/pdf/test_VPGPZNnHOC.pdf'
})
.catch(function (e) {
  console.log(e);
});