PHP Admin SDK
L'installation de la version PHP du SDK Admin requiert l'utilisation de la commande composer qui suit :
composer require kkiapay/kkiapay-php
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
$kkiapay = new \Kkiapay\Kkiapay($public_key,
$private_key,
$secret,
$sandbox = true);
La valeur true de l'attribut
$sandbox vous permet de passer en mode test.- En Production
$kkiapay = new \Kkiapay\Kkiapay($public_key,
$private_key,
$secret);
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)
Vous pouvez afin de tester cette fonctionnalité user du code ci-après :
$kkiapay->verifyTransaction($transaction_id);
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.
Vous pouvez afin de tester cette fonctionnalité user du code ci-après :
$kkiapay->refundTransaction($transaction_id);
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.
Vous pouvez afin de tester cette fonctionnalité user du code ci-après :
// Configurer un reversement par palier
$kkiapay->setupPayout(array( "algorithm" => "roof",
"send_notification" => true,
"destination_type" => "MOBILE_MONEY",
"roof_amount" => "1000",
"destination" => "22997000000" ));
// Configurer un reversement périodique
$kkiapay->setupPayout(array( "algorithm" => "rate",
"send_notification" => true,
"destination_type" => "MOBILE_MONEY",
"rate_frequency" => "1m",
"destination" => "22997000000" ));
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 3yr ago