BarakniSend - Developer - Api Documentation

Introduction

Cette section décrit l’API de BarakniSend la passerelle de paiement.

BarakniSend L’API est simple à intégrer dans votre logiciel métier. Notre API utilise des URL bien formatées, accepte les requêtes cURL et renvoie des réponses JSON.

Vous pouvez utiliser l’API en mode test, ce qui n’affectera pas vos données réelles. La clé API sert à authentifier la requête et à déterminer si le paiement est valide ou non. En mode test, utilisez l’URL sandbox ; en mode réel, utilisez l’URL live fournie dans la section correspondante. Initier un Paiement .

Obtenir la Clé API

Cette section explique comment obtenir votre clé API.

Connectez-vous à votre BarakniSend compte marchand. If you don't have any ? Cliquez ici

L’étape suivante consiste à trouver le Clé API menu dans la barre latérale de votre tableau de bord. Cliquez dessus.

Vous y trouverez vos clés API : clé publique et clé secrète. Utilisez ces clés pour initier une demande API. Vous pouvez générer de nouvelles clés API à tout moment en cliquant sur Générer une Clé API bouton. Veuillez ne jamais partager ces clés avec qui que ce soit.

Initier un Paiement

Cette section décrit le processus d’initiation d’un paiement.

Pour initier un paiement, suivez l'exemple de code et respectez scrupuleusement les paramètres. Vous devrez envoyer vos requêtes vers les points d’API suivants.

Point d’accès Live : https://baraknisend.com/payment/initiate

Point d’accès Test : https://baraknisend.com/sandbox/payment/initiate

E-mail pour Mode Test : [email protected]

Code de Vérification Mode Test : 222666

Méthode de Requête : POST

Envoyez une requête au point d’accès avec les paramètres ci-dessous.

Nom du Paramètre	Type du Paramètre	Description
public_key	string (50)	Obligatoire Votre Clé API Publique
identifier	string (20)	Obligatoire L’identifiant sert à reconnaître la transaction de votre côté.
currency	string (4)	Obligatoire Code de la devise, doit être en majuscules. Ex : USD, EUR
amount	decimal	Obligatoire Montant du paiement.
details	string (100)	Obligatoire Détails de votre paiement ou transaction.
ipn_url	string	Obligatoire L’URL pour recevoir les notifications IPN.
success_url	string	Obligatoire URL de redirection en cas de paiement réussi.
cancel_url	string	Obligatoire URL de redirection en cas d’annulation.
site_logo	string/url	Obligatoire Logo de votre entreprise.
checkout_theme	string	Optionnel Thème du formulaire de paiement (clair/foncé). Par défaut : clair.
customer_name	string (30)	Obligatoire Nom du client.
customer_email	string (30)	Obligatoire E-mail valide du client.

Exemple de code PHP

<?php
    $parameters = [
        'identifier' => 'DFU80XZIKS',
        'currency' => 'USD',
        'amount' => 100.00,
        'details' => 'Purchase T-shirt',
        'ipn_url' => 'http://example.com/ipn_url.php',
        'cancel_url' => 'http://example.com/cancel_url.php',
        'success_url' => 'http://example.com/success_url.php',
        'public_key' => 'your_public_key',
        'site_logo' => 'https://baraknisend.com/assets/images/logoIcon/logo.png',
        'checkout_theme' => 'dark',
        'customer_name' => 'John Doe',
        'customer_email' => '[email protected]',

    ];

    //live end point
    $url = "https://baraknisend.com/payment/initiate";

    //test end point
    $url = "https://baraknisend.com/sandbox/payment/initiate";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_POSTFIELDS,  $parameters);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);

    //$result contains the response back.
?>

Exemples de Réponses

//Error Response.
{
    "error": "true",
    "message": "Invalid api key"
}

//Success Response.
{
    "success": "ok",
    "message": "Payment Initiated. Redirect to url.",
    "url":"http://example.com/initiate/payment/checkout?payment_id=eJSAASDxdrt4DASDASVNASJA7893232432cvmdsamnvASF"
}

Valider le Paiement et IPN

Cette section explique comment recevoir votre notification instantanée IPN.

Pour initier un paiement, suivez l'exemple de code et respectez scrupuleusement les paramètres. Vous devrez envoyer vos requêtes vers les points d’API suivants.

Point d’accès : L’URL IPN de votre application métier.

Méthode de Requête : POST

Vous recevrez les paramètres suivants :

Nom du Paramètre	Description
status	Statut du paiement.
identifier	L’identifiant servant à reconnaître la transaction de votre côté.
signature	Une signature hash pour vérifier l’authenticité du paiement.
data	Les données contiennent des informations telles que les frais, le montant, la devise, l’ID de la transaction, etc.

Exemple de code PHP

<?php
    //Receive the response parameter
    $status = $_POST['status'];
    $signature = $_POST['signature'];
    $identifier = $_POST['identifier'];
    $data = $_POST['data'];

    // Generate your signature
    $customKey = $data['amount'].$identifier;
    $secret = 'YOUR_SECRET_KEY';
    $mySignature = strtoupper(hash_hmac('sha256', $customKey , $secret));

    $myIdentifier = 'YOUR_GIVEN_IDENTIFIER';

    if($status == "success" && $signature == $mySignature &&  $identifier ==  $myIdentifier){
        //your operation logic
    }
?>