monetah/monetah-checkout

Library providing access to the Monetah checkout API

v0.8 2025-05-29 21:58 UTC

This package is auto-updated.

Last update: 2025-06-30 10:41:21 UTC


README

Monetah-Checkout

Une librairie PHP permettant d'utiliser les services Monetah dans un projet

Installation

Via Composer

Utilisez composer pour installer Monetah et ses dépendances, après avoir modifié son chemin global, exécutez la commande suivante sur votre terminal en vous positionnant dans le dossier de votre projet :

composer require monetah/monetah-checkout

Ensuite dans votre code, utilisez l'autoload de Composer :

require_once 'vendor/autoload.php';

Installation manuelle

Si vous ne souhaitez pas utiliser Composer, vous pouvez télécharger la dernière version, et ensuite incluez le fichier init.php dans votre code :

require_once '/path/to/monetah-checkout/init.php';

Prérequis

Pour utiliser Monetah il faut d'abord avoir un compte business sur le site de Monetah, ce compte vous servira pour tester votre intégration.

Après avoir entré les informations nécessaires, vous obtiendrez votre Client id et Client secret qui seront très utiles pour l'utilisation de monetah-checkout.

Utilisations

Dans un fichier dans le repertoire source (src/) de votre projet : Instantiez l'objet Monetah avec comme arguments : $clientId et $clientSecret qui sont à récupérer sur le site Monetah après avoir créé votre compte business, un troisième argument $debug spécifie l'environnement, par défaut il est à true, passez le à false en mode production.

use Monetah\checkout\Monetah;

$clientId = "<votre client id>";
$clientSecret = "<votre client secret>";

$monetah = new Monetah($clientId, $clientSecret);

Pour effectuer un paiement vous utilisez l'objet PaymentToken, qui vous donnera par la suite un moyen d'obtenir le lien qui dirigera l'utilisateur sur le middleware de paiement Monetah pour finaliser le processus :

<?php
//Effectuer un paiement

$orderId = 93; //Une identification unique pour le paiement
$amount = 120; //Le montant du paiement
$currency = "usd"; //Devise à facturer

$payToken = $monetah->checkout($amount, $currency, $orderId);

?>

<p>
	<a href='<?= $payToken->payment_url; ?>'>
		<img src='https://monetah.com/resources/assets/images/logo.png' width="120px" height="50px">
	</a>
</p>

Attention : Vous devez trouver un moyen de génerer une référence unique ($orderId), sinon laissez la géneration automatique. Les devises ne peuvent-etre que ('htg', 'usd', 'cad', 'eur')

Vous pouvez toujours récupérer la référence, qu'elle soit automatique ou non, à travers l'objet PaymentToken ainsi : $payToken->reference;. Vous pouvez par exemple le stocker dans une session pour une utilisation ultérieur, par exemple lors de la récupération des détails du paiement


Après finalisation du processus de paiement, vous pouvez récupérer les informations à partir de l'objet PaymentDetails en utilisant la référence

$monetah = new Monetah($id, $secret);

$payDetails = $monetah->retrieveOrder($orderId);

var_dump($payDetails);

Notes : Vous pouvez aussi récupérer les détails du paiement avec la méthode retrieveTransaction($transaction_id) sur l'objet Monetah en utilisant le paramètre transaction_id dans l'url de retour fournit par l'api monetah

Extras

Pour toutes suggestions ou problèmes rencontrés, contactez au admin@monetah.com