Let’s be smart together

Date de modification : 17/08/2022

TUTORIAL D’INSTALLATION DE L’API DE PAIEMENT EN LIGNE SOLEASPAY

https://soleaspay.com

1 Sommaire

I.Introduction ..................................................................................................................................... 2

I.1 Présentation de l’entreprise ......................................................................................................... 2

I.2 Contexte du document ....................................................................................................….......... 2

II. Pré requis ....................................................................................................................................... 2

II.1 Compétences techniques ............................................................................................................. 2

II.2 L’API KEY ..................................................................................................................…..….…………..2

III.Installation ..................................................................................................................................….3

III.1 : intégration .................................................................................................................... …………..3

III.2 Description .......................................................................................................…………………........ 4

III 3 : réponse et résultat .........................................................................................……………….......... 6

III.4 : vérification de la transaction …………………………………………………......................…………............... 7

III.5 Outils.................................................................................................……………………………….......... 8

M032118560945G | Email mysoleas@gmail.com /contact@mysoleas.com | Bp 4798 DLA

intégrateur de solutions, informatique, prestation de service, import-export
RCCM : RC/DLA/2021/B/1509
 Let’s be smart together

I. Introduction
I.1 Présentation de l’entreprise

MYSOLEAS SARL est une entreprise de droit Camerounais innovante dans le domaine des Fin
Tech (Financial Technologies) qui a développé une solution de paiement en ligne dénommée
SoleasPay (SoPay), une plateforme de paiement qui permet d'acheter et de vendre sur internet en
utilisant tous les moyens de paiement locaux existants. MYSOLEAS SARL se veut innovante et
révolutionnaire pour les paiements en ligne en Afrique centrale et se positionne comme une
passerelle de paiement en ligne visant à faciliter les transactions des données financières des
comptes de clients mobile money vers des sites marchands dans le monde.

I.2 Contexte du document

Ce document est un manuel d’installation de l’api web du paiement en ligne de SOLEASPAY

(SOPAY), sur votre site de vente en ligne.

Ce module permettra à vos clients de payer vos articles ou vos services directement en ligne.

II. Pré requis

II.1 Compétences techniques

L’installation de ce module est certes simple, mais nécessite néanmoins des compétences
techniques de base en matière de développement de sites ou d’applications web notamment en
Javascript.

II.2 L’APIKEY

Avant de commencer l’installation, rassurez-vous d’avoir déjà créé un compte MARCHANT ou

PROFESSIONNEL sur SOLEASPAY. Et d’avoir déjà reçu par mail votre clé d’access (APIKEY). Ce code
sera utilisé plus bas dans ce tutorial.

Si vous n’avez pas encore d’APIKEY, rédigez un simple mail adressé à

support@mysoleas.com. Dans ce mail, vous demandez simplement que vous souhaitez avoir votre
apiKey lié à votre compte, et précisez le numéro de téléphone lié à votre compte. Vous le recevrez
par la suite dans les heures ou minutes qui suivent.

M032118560945G | Email mysoleas@gmail.com /contact@mysoleas.com | Bp 4798 DLA

intégrateur de solutions, informatique, prestation de service, import-export
RCCM : RC/DLA/2021/B/1509
 Let’s be smart together

Attention, pour recevoir votre APIKEY, vous devrez avoir bouclé les formalités administratives :

 Signature du contrat

 Dépôt du registre de commerce pour votre entreprise ou toute autre pièce justificative,
nécessaire aux opérateurs et administrations financières, en faveur de la lutte contre le
blanchiment d’argent et la web-criminalité.

III. Installation

III.1 Intégration

L’installation du SOPAY BUTTON V2 se résume en l’insertion des scripts suivants dans votre
page web comme suit :

a) <script id="SBScript" type='text/javascript' data-lang=${LANGUE} data-apikey=${votre

APIKEY} src="https://soleaspay.com/webPay/v2/sopayButton.min.js"></script>

* pour les tests, veuillez utiliser le script a l’adresse

https://soleaspay.com/sandbox/sandboxButton.min.js

b) <script type='text/javascript' >

const options = {

btnTitle : 'Test Pay Now',

amount : 1000,
currency : "XAF",
orderId : "MLS00000025F",
description : "Test sopay button payment v2",
businessName : 'Shop Name',
loadInvoice : true,
successUrl : 'https://yourdomain.com/receivePayment'
}

function initButton(){

return SopayButton.tiping(options)
.then((res)=>console.log(res))
.catch((err)=>console.log(err))
.finally(initButton)
}
initButton()

M032118560945G | Email mysoleas@gmail.com /contact@mysoleas.com | Bp 4798 DLA

intégrateur de solutions, informatique, prestation de service, import-export
RCCM : RC/DLA/2021/B/1509
 </script>

Let’s be smart together

III.2 Description :

i. Dans la page de paiement, reserver l’espace du Sopay Button

dans une boite ‘<div class= ‘sopayButton’> </div>’

ii. Pour le premier script, il s’agit de l’appel du Sopay Button. Il prend

en parametre :

- l’id qui définit le script à appeler. La valeur par defaut est SBScript

- le data-lang qui définit la lague du formulaire à integrer : il a pour valeur en ou fr

- le data-apikey qui est l’apikey du compte professionnel Sopay qui recevra le paiement. Il
est obtenu soit dans le dashbord du compte professionnel soit par demande via mail a
l’adresse support@mysoleas.com.

iii. Le second script est le code à renseigner pour nourrire l’api sopay. Il contient les
informations du paiement à éffectuer ainsi que le type de formulaire à intégrer.

a) Les paramètres sont les suivants :

- type : sans definitions explicite, il est defini dans la fontion initButton() et correspond
au type d’integration à mener :

 SopayButton.tiping(options)

Il s’agit du formulaire permetant a

l’utilisateur/client de votre systeme
de définir le montant de l’opperation
à éffectuer.

M032118560945G | Email mysoleas@gmail.com /contact@mysoleas.com | Bp 4798 DLA

intégrateur de solutions, informatique, prestation de service, import-export
RCCM : RC/DLA/2021/B/1509
 Let’s be smart together

 SopayButton.billing(options)

Ideal pour les systemes de e-commerce,

ici le montant à payer par vos
utilisateurs/Clients est définit par votre
systeme de panier mis en place. ceux-ci
renseignent juste le service à utilser puis
le compte via lequel ce montant va etre
debiter.

- btnTitle : Il s’agit du texte afficher dans le sopay Button lors de son chargement ;

- amount : c’est le montant à faire payer à l’utilisateur/client pour une opération de type
Billing ;

- currency : la devise dans laquelle le paiement doit etre éffectuer. Elle doit correspondre au
à celle par defaut du service selectionner par l’utilisateur/client

- description : il s’agit de la description ou l’objet du paiement initié ;

- orderId : la reference unique du paiement dans le systeme du partenaire;

- loadInvoice : si oui ou non le systeme doit générer une facture pour son client (true|false)

- then : ici vous y mettrez l’operation à mener si le paiement est éffectuer avec succes. Par
defaut vous recevrer les details dans la console : (res) => console.log(res) ;

- catch : la fonction appellée en cas d’echec de la transaction. Par defaut vous recevrez les
details dans la console : (res) => console.log(res) ;

- successUrl : L’url à laquelle vous souhaitez recevoir une notification une fois le paiement
éffectuer.

M032118560945G | Email mysoleas@gmail.com /contact@mysoleas.com | Bp 4798 DLA

intégrateur de solutions, informatique, prestation de service, import-export
RCCM : RC/DLA/2021/B/1509
 Let’s be smart together

Faire payer un de vos clients revient donc à faire soumettre par votre client ce formulaire dument
rempli par votre système

Si le client éffectue son paiement, cet argent ira automatiquement dans votre compte
SOPAY, et vous serez notifié instantanément par MAIL.

Le client peut à tout moment annuler le paiement et retourner sur votre site.

A ce niveau, vous pouvez déjà recevoir des paiements sur votre site vers votre compte
SOPAY.

Par ailleurs, par la suite, vous trouverez un exemple de requete afin d’illustrer comment
votre site recevra automatiquement une confirmation de paiement, et qu’il puisse valider
automatiquement la commande ou le panier du client.

Sachez que cette API peut également fonctionner sans interface graphique. Vous pouvez initier un

paiement mobile money, sans que l’utilisation ne voit s’afficher l’interface graphique de SOPAY. Le

manuel d’installation de cette API est fourni dans un autre document et disponible a l’adresse
https://doc.mysoleas.com/sopay.

III 3 : réponse et résultat

La reponse est un objet JSON représenté comme suit (par défaut il est visible dans la
console du navigateur) :

a) Opération réussie
{
success: true,
data: {
status: "SUCCESS",
ref: "2981691514",
payId: "MLS116B",
amount: 1000,
message: "Payment Receive Successfully"
}
b) Opération échouée
{
success: false,
message: "Invalid Currency Provide for Current Service"
}

M032118560945G | Email mysoleas@gmail.com /contact@mysoleas.com | Bp 4798 DLA

intégrateur de solutions, informatique, prestation de service, import-export
RCCM : RC/DLA/2021/B/1509
 Let’s be smart together

c) Description :

la réponse JSON contient dans les deux cas (02) les propriétées :

- success qui vaut true pour une opération réussie et false en cas d’erreur.

- message qui donnes les informations sur la réponse.

Elle contient uniquement dans le cas d’une opération réussi les détails de la
transaction sous la propriétée data.

- status : qui donne le statut de la requette ;

- ref : qui est la reference externe de l’opération ; à savoir celle génerer par le systeme de
paiement choisi

- payId : qui donne la refférence interne Sopay de la transaction. Elle est indispensable pour
avoir les détails de la réquette et ou vérifier son état.

III.4 : vérification de la transaction

Pour des besoins de sécurité avancée, il est recommandé de vérifier une transaction avant de
rendre le service dedié par votre systeme.

Cette verification consiste en un simple appel Get de l’api SOPAY comme suit

GET https://soleaspay.com/api/agent/verif-pay?amount=${amount}&ref=${ref}&payid=${payId}

elle prend en paramettre :

- amount : le montant de la transaction ;

- ref : la reference du systeme externe ;

- payId : l’id sopay de la transaction.

Il est indispensable d’envoyer l’apikey dans l’entete sous le paramettre

x-api-key : ${votre apikey}

La reponse est un objet JSON qui donne l’état de la transaction.

{
success: true/false,

message: information about transaction

}

M032118560945G | Email mysoleas@gmail.com /contact@mysoleas.com | Bp 4798 DLA

intégrateur de solutions, informatique, prestation de service, import-export
RCCM : RC/DLA/2021/B/1509
 Let’s be smart together

seules les opération avec un attribut success = true sont considérer comme éffectué
avec succes.

III.5 Outils

Soleaspay met à votre disposion une api gratuite de conversion en temps reel des devises
que nous prennons en charges. A savoir USD, EUR, RUB, GBP, AED,, CNY, BTC, ETH, DOGE, LTC, XAF,
SPC.

La conversion est un simple appel GET comme suit :

GET https://soleaspay.com/api/convert?amount=${amount}&from=${devise}&to=${out devise}

elle prend en paramettre :

- amount : le montant a convertir;

- from: la devise initiale du montant envoyé;

- to: la devise dans laquelle convertir le montant envoyé. S’il est absent, l’api convertira le montant
envoyé et vous retournera le resultat en SOPAY COIN (SPC). S’il vaut ALL, l’api convertira ce montant
en toutes les devises prise en charge par SOPAY.

Pour toute autres information, nous contacter via whatsapp ou appel au +237 698 618 200
ou vous rendre sur le site https://app.soleaspay.com

M032118560945G | Email mysoleas@gmail.com /contact@mysoleas.com | Bp 4798 DLA

intégrateur de solutions, informatique, prestation de service, import-export
RCCM : RC/DLA/2021/B/1509