Node.js Admin SDK

L'installation du Node.js Admin SDK se fait par le biais de la commande npm qui suit :

$ npm i -s kkiapay/nodejs-sdk

Importation

const kkiapay = require("kkiapay-nodejs-sdk"); // javascript
ou
import { kkiapay } from "kkiapay-nodejs-sdk"; // typescript

Initialisation

L'utilisation du SDK Admin serveur requiert de procéder à l'instanciation d'un objet kkiapay. Il vous faudra afin de procéder à cette opération non seulement récupérer vos clés d'API mais également user des lignes de code ci-après que vous soyez en mode Sandbox ou en production.

  • En Sandbox

const k = kkiapay({privatekey:"xxxxxxx",
                   publickey:"xxxxxxx",
                   secretkey:"xxxxxxx",
                   sandbox:true})

La valeur true de l'attribut $sandbox vous permet de passer en mode test.

  • En Production

const k = kkiapay({privatekey:"xxxxxxx",
                   publickey:"xxxxxxx",
                   secretkey:"xxxxxxx"})

Statut d'une transaction

Le SDK Admin vous permet de procéder à la récupération des diverses informations liées à une transaction. Cette opération de récupération nécessite de vous les informations ci-après:

  • Vos clés publique, privée et secrète d'API

  • La référence de l’opération (voir l’image ci-dessous)

Exemple d'utilisation

Vous pouvez afin de tester cette fonctionnalité user du code ci-après :

k.verify("transactionId").
then((response) => {
    //Gérer la réponse 
}).
catch((error) => {
    //Gérer l'erreur
})

Remboursement d'une transaction

Toute transaction effectuée par mobile money et portant la mention "Succès" peut faire l'objet d'une opération de remboursement. En effet, il vous est offert la possibilité de procéder à un remboursement si votre client n’a pas obtenu satisfaction pour le bien ou service pour lequel il a payé ou si vous le jugez nécessaire. Il vous faudra afin de procéder à une telle opération fournir les informations ci-après :

  • Vos clés publique, privée et secrète d'API

  • La référence de l’opération (voir l’image ci-dessous)

Le remboursement d'une transaction n'inclut point celui des frais de transaction qui lui sont liés.

Exemple d'utilisation

Vous pouvez afin de tester cette fonctionnalité user du code ci-après :

k.refund("transactionId").
then((response) => {
    //Gérer la réponse
}).
catch((error) => {
    //Gérer l'erreur
})

Last updated