Developer - Api Documentation

initiation

Cette section décrit le Tnstar Business API de passerelle de paiement.


Tnstar Business L'API est facile à mettre en œuvre dans votre logiciel d'entreprise. Notre API est des URL bien formatées, accepte les requêtes cURL et renvoie les réponses JSON.

You can use the API in test mode, which does not affect your live data. The API key is use to authenticate the request and determines the request is valid payment or not. For test mode just use the sandbox URL and In case of live mode use the live URL from section Initier le paiement .

Devises prises en charge

Cette section décrit les devises prises en charge par Tnstar Business


Tnstar Business allows to make transaction with below currencies. Any new currency may update in future.

Nom de la devise Symbole de la monnaie Code de devise
United States Dollar $ USD
Français Cfa CFA XOF
Euro Européen EUR

Obtenez la clé API

Cette section décrit comment obtenir votre clé API.


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

La prochaine étape consiste à trouver le Clé API menu dans la barre latérale de votre tableau de bord. Cliquez sur le menu.

Les clés API peuvent être trouvées ici, ce qui est Clé publique et clé secrète. Utilisez ces clés pour lancer la requête API. Chaque fois que vous pouvez générer une nouvelle clé API en cliquant sur Génère Une Clé d'API bouton. N'oubliez pas de ne partager ces clés avec personne.

Initier le paiement

Cette section décrit le processus d'initiation du paiement.


Pour lancer le paiement, suivez l'exemple de code et soyez prudent avec les paramètres. Vous devrez faire une demande avec ces points de terminaison d'API suivants.

Point final en direct : https://tnstar.money/payment/initiate

Point final du test : https://tnstar.money/sandbox/payment/initiate

Courrier en mode test : test_mode@mail.com

Code de vérification du mode test : 222666

Méthode de demande : POST

Demande au point final avec les paramètres suivants ci-dessous.

Nom du paramètre Type de paramètre Description
public_key string (50) Required Your Public API key
identifier string (20) Required Identifier is basically for identify payment at your end
currency string (4) Required Currency Code, Must be in Upper Case. e.g. USD,EUR
amount decimal Required Payment amount.
details string (100) Required Details of your payment or transaction.
ipn_url string Required The url of instant payment notification.
success_url string Required Payment success redirect url.
cancel_url string Required Payment cancel redirect url.
site_logo string/url Required Your business site logo.
checkout_theme string Optional Checkout form theme dark/light. Default theme is light
customer_name string (30) Required Customer name.
customer_email string (30) Required Customer valid email.
Example PHP code
<?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://tnstar.money/assets/images/logoIcon/logo.png',
        'checkout_theme' => 'dark',
        'customer_name' => 'John Doe',
        'customer_email' => 'john@mail.com',

    ];

    //live end point
    $url = "https://tnstar.money/payment/initiate";

    //test end point
    $url = "https://tnstar.money/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.
?>
Example Responses
//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 l'IPN

Cette section décrit le processus pour obtenir votre notification de paiement instantanée.


Pour lancer le paiement, suivez l'exemple de code et soyez prudent avec les paramètres. Vous devrez faire une demande avec ces points de terminaison d'API suivants.

Point final : URL IPN de votre application professionnelle.

Méthode de demande : POST

Vous obtiendrez les paramètres suivants ci-dessous.

Nom du paramètre Description
status Statut de réussite du paiement.
identifier L’identifiant sert essentiellement à identifier le paiement de votre côté.
signature Une signature hachée pour vérifier votre paiement de votre côté.
data Les données contiennent des informations de base avec les frais, le montant, la devise, l'identifiant de la transaction de paiement, etc.
Example PHP code
<?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
    }
?>

API Plugin


You can use our ready made API Plugin for your desire CMS to collect payment using Tnstar Business.

WooCommerce Plugin

We use tracking cookies when you visit our website, for your security including or to create an account to prevent others from logging into your website or mobile application account in another location or other device and for you insured learn more

Allow