@gurulab/qosic-js-package v1.0.5

Custom npm package for qosic's API

Introduction

Ce projet stipule une librairie JavaScript basée sur une Interface de Programmation d'Application (API) Mobile Money , permettant de faire des paiements , des encaissements et remboursement. Cette librairie permettra aux développeurs de l'intégrer facilement sans réécrire tout un code donné. Il s'agit d'une classe composée de méthodes codées uniquement en JavaScript et il suffit d'aller récupérer celles qui effectueront ce qu'ils souhaitent afin d'avoir un code stable et mieux sécurisé.

Comment ca marche ?

Installation

Faire npm:

$ npm installer @gurulab/qosic-js-package

Instancier la classe payment qui implémente les méthodes:

• requestpayment()

• getstatus()

• refund()

• setUrl() : Retourne l'url adéquate pour l'exécution de la requête.

• canAskPayment() : Fait appel aux méthodes isNetworkDefined(), isTypeDefined(), isFirstNameDefined(), isLastNameDefined(), isAmountDefined(), isTransrefDefined(), isMsisdnDefined() qui vérifient si les données lors d'une demande de paiement sont bien définies. Retourne donc un message d'ereur si elles ne sont pas définies.

• canAskStatus() : Fait appel à la méthode isTransrefDefined() qui vérifient si les données lors d'une demande de paiement sont bien définies. Retourne donc un message d'ereur si elles ne sont pas définies.

• canAskRefund() : Fait appel à la méthode isTransrefDefined() qui vérifient si les données lors d'une demande de paiement sont bien définies. Retourne donc un message d'ereur si elles ne sont pas définies.

Comment on utilise la classe ?

on instancie la classe en faisant :

payment = new payment( numéro de téléphone, montant, prénom, nom, idTransaction )

• numéro de téléphone : numéro du client
• montant: Montant de la transaction
• prénom: Prénom du client
• nom: Nom du client
• idTransaction: est un nombre unique généré pour chaque transaction

requestpayment:

1- Request Payment Elle permet d'envoyer une requête de demande de paiement qui débite de l'argent sur le compte du client.

Les éléments importants à envoyer pour la demande RequestPayment:

• numéro de téléphone : numéro du client

• montant: Montant de la transaction

• prénom: Prénom du client

• nom: Nom du client

• transfref : référence unique de la transaction. à utiliser comme identifiant unique dans l'appel à la demande de paiement

• idTransaction: est un nombre unique généré pour chaque transaction

  2- Format de la réponse en cas de succès

  La réponse à une demande contient les informations suivantes:

  • responsecode:c'est le code de réponse pour la transaction
  • responsemsg: le message de la reponse

  • transref: c'est l'identifiant unique de la transaction.

  3- Format de la réponse en cas d'échec:

  status: 500, statusText: 'Internal Server Error', data: { responsecode: '-1', responsemsg: 'Error Processing Transaction', transref: null, serviceref: null, comment: null }

  4- Utilisation: Après avoir instancié la classe payment, faire payment.requestpayment()

getstatus:

1- Get Transaction Statuts C'est une requête qui permet d'obtenir les détails sur une transaction faite.

Les éléments importants à envoyer pour la requête getStatuts :

• clientid: Un unique id généré par qos .

• transref: référence unique de la transaction. à utiliser comme identifiant unique dans l'appel à la demande de paiement

  2- format de la réponse en cas de succès

  La réponse à une demande contient les informations suivantes:

  • responsecode:c'est le code de réponse pour la transaction
  • responsemsg: le message de la reponse
  • transref: c'est l'identifiant unique de la transaction.

  3-format de la réponse en cas d'échec

  status: 500, statusText: 'Internal Server Error', data: { responsecode: '-1', responsemsg: 'Error Processing Transaction', transref: null, serviceref: null, comment: null }

  4- Utilisation Après avoir instancié la classe payment , faire payment.requestpayment()

refund:

1- Refund Elle renvoie la requête permettant de reverser l'argent dans le compte Mobile Money du client.

Les éléments importants à envoyer pour la requête Refund :

• clientid: Un unique id généré par qos

• transref: référence unique de la transaction. à utiliser comme identifiant unique dans l'appel à la demande de paiement

  2- Format de la réponse en cas de succès

  La réponse à une demande contient les informations suivantes:

  • responsecode: c'est le code de réponse pour la transaction
  • responsemsg: le message de la reponse
  • transref: c'est l'identifiant unique de la transaction.

  3- Format de la réponse en cas d'échec

  status: 500, statusText: 'Internal Server Error', data: { responsecode: '-1', responsemsg: 'Error Processing Transaction', transref: null, serviceref: null, comment: null }

  4- Utilisation: Après avoir instancié la classe payment , faire payment.refund() .