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

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

Configuration des reversements

Il vous est possible en utilisant le SDK Admin de configurer votre mode de reversement (reversement périodique ou par palier). Cette opération de configuration nécessitera de vous vos clés publique privée et secrète d'API.

Exemple d'utilisation

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

// Configurer un reversement par palier
k.setup_payout({algorithm : "roof",
send_notification : true,
destination_type : "MOBILE_MONEY",
roof_amount : "1000",
destination : "22997000000" }).then((response) =>
{
// Il est renvoyé un objet récapitulantles diverses données liées au mode de reversement configuré.
}).catch((error) => {
//Gérer l'erreur
})
// Configurer un reversement périodique
k.setup_payout({algorithm : "rate",
send_notification : true,
destination_type : "MOBILE_MONEY",
rate_frequency : "1m",
destination : "22997000000" }).then((response) =>
{
//Gérer la réponse
}).catch((error) => {
//Gérer l'erreur
})

Référence

Attribut

Type

Description

algorithm

String

“roof” pour un reversement par palier et “rate" pour un reversement périodique

send_notification

Boolean

Configurer la réception d'une notification à chaque reversement

destination

String

Le numéro de compte ou le numéro mobile money qui reçoit le reversement

destination_type

String

"MOBILE_MONEY" lorsque le compte de destination est un compte mobile money et "BANK_ACCOUNT" lorsqu'il s'agit plutôt d'un compte bancaire

rate_frequency

String

La période de reversement : "1m” pour un reversement mensuel, “3j” pour un reversement tout les trois jours, “1w” pour un reversement hebdomadaire

roof_amount

String

Le montant palier à remboursé lorsque l’algorithme “rate” est utilisé