FR 1.0.0
Accueil
Plugin et SDK
KKIAPAY SERVICES
Tableau de bord
Sécurité et Gestion des fraudes
PHP Admin SDK
L'installation de la version PHP du SDK Admin requiert l'utilisation de la commande composer qui suit :
1
composer require kkiapay/kkiapay-php
Copied!
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
1
$kkiapay = new \Kkiapay\Kkiapay($public_key,
2
$private_key,
3
$secret,
4
$sandbox = true);
Copied!
La valeur true de l'attribut
$sandbox vous permet de passer en mode test.- En Production
1
$kkiapay = new \Kkiapay\Kkiapay($public_key,
2
$private_key,
3
$secret);
Copied!
Statut d'une transaction
Il vous est offert, avec le SDK Admin Serveur, la possibilité de récupérer l’ensemble des informations liées à une transaction, en utilisant la référence de l’opération ayant été effectuée. Il vous faudra pour cela fournir les informations suivantes :
- 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 :
1
$kkiapay->verifyTransaction($transaction_id);
Copied!
Remboursement d'une transaction
Toute transaction effectuée par mobile money et portant la mention "Succès" peur 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 :
1
$kkiapay->refundTransaction($transaction_id);
Copied!
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 :
1
// Configurer un reversement par palier
2
$kkiapay->setupPayout(array( "algorithm" => "roof",
3
"send_notification" => true,
4
"destination_type" => "MOBILE_MONEY",
5
"roof_amount" => "1000",
6
"destination" => "22997000000" ));
7
8
// Configurer un reversement périodique
9
$kkiapay->setupPayout(array( "algorithm" => "rate",
10
"send_notification" => true,
11
"destination_type" => "MOBILE_MONEY",
12
"rate_frequency" => "1m",
13
"destination" => "22997000000" ));
Copied!
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é
Last modified 2yr ago