Calculer les frais d'un service
curl --request GET \
--url https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees \
--header 'Authorization: Bearer <token>'import requests
url = "https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": 123,
"timestamp": "2023-11-07T05:31:56Z",
"body": {
"montantFrais": 123,
"modeApplication": "SOUSTRACTION"
}
}{
"message": "<string>",
"status": 123,
"timestamp": "2023-11-07T05:31:56Z",
"body": null
}{
"message": "<string>",
"status": 123,
"timestamp": "2023-11-07T05:31:56Z",
"body": null
}{
"message": "<string>",
"status": 123,
"timestamp": "2023-11-07T05:31:56Z",
"body": null
}Frais
Calculer les frais d'un service
Simuler les frais applicables à une opération sur un service donné, avant de l’exécuter.
GET
/
api
/
v1
/
services
/
{referenceService}
/
fees
Calculer les frais d'un service
curl --request GET \
--url https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees \
--header 'Authorization: Bearer <token>'import requests
url = "https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://egimgarsud.gimpayapp.com/api/v1/services/{referenceService}/fees")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": 123,
"timestamp": "2023-11-07T05:31:56Z",
"body": {
"montantFrais": 123,
"modeApplication": "SOUSTRACTION"
}
}{
"message": "<string>",
"status": 123,
"timestamp": "2023-11-07T05:31:56Z",
"body": null
}{
"message": "<string>",
"status": 123,
"timestamp": "2023-11-07T05:31:56Z",
"body": null
}{
"message": "<string>",
"status": 123,
"timestamp": "2023-11-07T05:31:56Z",
"body": null
}Cet appel simule les frais d’une opération sans rien engager. Il est indispensable avant d’exécuter une opération : il ne vous donne pas seulement un montant, mais aussi le mode d’application qui détermine le montant à envoyer ensuite.
Exploiter
La réponse contient
Exploiter modeApplication
La réponse contient montantFrais, referenceService et surtout modeApplication, qui change la façon dont vous devez calculer le montant de l’opération :
modeApplication | Signification | Montant à envoyer à POST /operations |
|---|---|---|
ADDITION | Les frais s’ajoutent au montant initial | Le montant net souhaité — le débit total sera supérieur |
SOUSTRACTION | Les frais sont déduits du montant envoyé | Le montant total — le bénéficiaire recevra moins |
Contrôlez le solde de l’instrument initiateur après ce calcul, pas avant : en mode
ADDITION, un solde qui couvre le montant saisi peut ne pas couvrir le débit réel.Réponses
Le corps utile arrive dansbody, à l’intérieur de l’enveloppe commune { message, status, body, timestamp }. montantFrais est exprimé en FCFA.
Un 400 signale un referenceService manquant ou un montant incorrect. Un 404 indique un service introuvable : récupérez les références valides via GET /mmps/{referenceMmp}/services.
Et ensuite ?
Exécuter l'opération
Appliquez le mode de frais au montant transmis.
Glossaire
Les valeurs de
modeApplication.Authorizations
Jeton émis par POST /api/v1/auth/token.
Path Parameters
Référence unique du service.
Query Parameters
Montant de l'opération pour lequel calculer les frais.
Example:
10000