Présentation ............................................................................................................................................. 1
1. Authentification ........................................................................................................................... 1
2. Autorisation ................................................................................................................................. 1
Description des Services ......................................................................................................................... 2
1. Service info-client ....................................................................................................................... 2
2. Service solde................................................................................................................................ 2
3. Service historique ........................................................................................................................ 3
4. Service account-account .............................................................................................................. 3
5. Service paiement-internet ............................................................................................................ 6
6. Service paiement marchand ......................................................................................................... 7
Présentation
Ce document décrit les spécifications de l’API REST permettant à tout développeur
d’intégrer les services de Coris Money. Elles seront accessibles sur l’url :
https://hostname/api/external/apiName.
Dans la suite nous présenterons les différents services que Coris Money offre mais avant
tout voyons quelques règles à respecter pour bénéficier de ces services.
1. Authentification
Avant de pouvoir accéder à une ressource, une authentification est nécessaire.
Exemple de requête d’authentification
curl -X POST 'https://hostname/oauth/token' /
-H "Content-Type: application/x-www-form-urlencoded" /
-d "username=<user>" /
-d 'password=<password>' /
-d 'grant_type=password' /
-d 'client_id=<client_id>' /
-d 'client_secret=<secret>'
Exemple de réponse
{
"access_token" : "6b9c1108-165e-4c69-a7c5-b327bc12face",
"token_type" : "bearer",
"refresh_token" : "b610b8c3-5c1b-43d6-bfe2-be081268645e",
"expires_in" : 373,
"scope" : "read write"
}
Dans chaque appel à la ressource ajouter l’entête suite
headers: { 'Authorization': 'Bearer ' + access_token }.
2. Autorisation
L’authentification ne suffit pas pour bénéficier des services externes de CorisMoney. Pour
des raisons de sécurité, des règles d’appel des API ont étés mises en place afin de filtrer et
rejeter toutes les requêtes qui ne les respectent pas.
Une fois la requête envoyé, le système vérifie que les règles préétablies sont bien
respectées avant de poursuivre les traitements. Dans le cas contraire un message d’erreur
est renvoyé.
Exemple de requête :
2. Service solde
La plateforme CorisMoney expose un API permettant la consultation de solde d’un client.
Les requêtes doivent être de type GET.
Exemple de requête :
Request URL: http://localhost:9002/api/external/solde?codePays=226&telephone=76477115
Request Method: GET
3. Service historique
Il s’agit d’un API exposé par CORISMONEY permettant à un bénéficiaire de consulter
l’historique des transactions d’un client sur une période donnée. Pour se faire le bénéficiaire
envoi une requête de type GET.
Exemple de requête :
RequestURL:
http://localhost:9002/api/external/historique?codePays=226&telephone=76477115&debutPer
iode=01-01-2020&finPeriode=14-10-2020
Request Method: GET
4. Service account-account
Ce service permet à un bénéficiaire de débiter un compte pour créditer un autre après
l’approbation du client détenteur du compte. Cette opération s’effectue en deux étapes : La
demande d’envoi d’un code OTP au détenteur du compte source et l’envoi de la requête de
validation.
Send-code-otp
account-account
Réponse
Exemple de réponse
{
code: " 0",
message: " Opération effectuée avec succès.",
transactionId: " 1900021",
}
Exemple de requête :
Request URL: http://localhost:9002/api/external/operations/paiement-
internet?codePays=226&telephone=76477115&codePv=PV025&codeRetrait=02154
Request Method: GET
Communication du code de
retrait par le client au
bénéficiaire
paiement-internet
Réponse
codeOTP Code envoyé au client après l’appel de l’API send- String Oui
code-otp
Send-code-otp
Réponse
Exemple de réponse
{
code: " -1",
message: " Code OTP introuvable.",
transactionId: " 1900021",
}