
🐘PHP SDK
Le SDK Moneroo PHP est une bibliothèque complète qui permet aux développeurs PHP d'interagir avec le service d'orchestration des paiements Moneroo.
Besoins
PHP 7.4 et versions ultérieures.
Installation
Vous pouvez installer le paquet via composer
:
composer require moneroo/moneroo-php
Paiement
La classe Moneroo\Payment
fournit des méthodes pour initialiser, vérifier, récupérer et marquer les paiements comme traités. Vous pouvez l'utiliser comme suit :
Initier le paiement
Pour créer un paiement, vous devez transmettre un tableau de données de paiement à la méthode de création. Le tableau doit contenir les clés suivantes :
Voici les champs obligatoires sous forme de tableau :
amount
integer
Oui
Le montant du paiement.
currency
string
Oui
La devise du paiement.
description
string
Non
Description du paiement.
return_url
string
Oui
URL de retour où votre client sera redirigé après le paiement.
customer.email
string
Oui
Adresse e-mail du client.
customer.first_name
string
Oui
Prénom du client.
customer.last_name
string
Oui
Nom du client.
customer.address
string
Non¹
Adresse du client.
customer.city
string
Non¹
Ville du client.
customer.state
string
Non¹
État du client.
customer.country
string
Non¹
Pays du client. Il s'agir du code du pays au format ISO 3166-1 alpha-2 valide.
customer.zip
string
Non¹
Code postal du client.
metadata
array
Non²
Données supplémentaires pour le paiement.
methods
array
Non³
Méthodes de paiement autorisées.
Si ces informations ne sont pas fournies, le client peut être invité à les saisir au cours de la procédure de paiement, en fonction de la méthode de paiement sélectionnée.
Il s'agit d'un tableau de paires clé-valeur. Seules les chaînes de caractères sont autorisées.
S'il n'est pas fourni, tous les modes de paiement disponibles seront autorisés. Le tableau ne doit contenir que les méthodes de paiement prises en charge.
Exemple d'utilisation
$paymentData = [
'amount' => 100,
'currency' => 'USD',
'customer' => [
'email' => '[email protected]',
'first_name' => 'John',
'last_name' => 'Doe',
'phone' => '123456789',
'address' => '123 Main St',
'city' => 'Los Angeles',
'state' => 'CA',
'country' => 'USA',
'zip' => '90001',
],
'description' => 'Payment for order #123',
'return_url' => 'https://yourwebsite.com/thanks',
'metadata' => [
'order_id' => '123',
'customer_id' => '456',
],
'methods' => ['card', 'orange_ci'],
];
$monerooPayment = new \Moneroo\Payment($publicKey, $secretKey);
$payment = $monerooPayment->init($paymentData);
// Redirect the customer to the Checkout URL
header('Location: ' . $payment->checkout_url);
La méthode create
renvoie un objet contenant les détails du paiement, y compris l'identifiant de la transaction et l'URL de paiement vers laquelle vous devez rediriger le client pour qu'il effectue le paiement. Vous pouvez utiliser cet identifiant de transaction pour vérifier le paiement ultérieurement.
Vérifier le paiement
Vous pouvez vérifier un paiement à l'aide de son id
. Cette fonction est utile lorsque vous souhaitez vérifier l'état d'un paiement avant de traiter une commande de votre côté.
$transactionId = 'your-payment-transaction-id';
$monerooPayment = new \Moneroo\Payment();
$payment = $monerooPayment->verify($transactionId);
Récupération du paiement
Pour obtenir les détails d'un paiement, utilisez la méthode get
avec l'id de la transaction.
$transactionId = 'your-payment-transaction-id';
$monerooPayment = new \Moneroo\Payment($publicKey, $secretKey);
$payment = $monerooPayment->get($transactionId);
Marquer le paiement comme traité
Il s'agit actuellement d'une fonctionnalité expérimentale. Veuillez l'utiliser avec prudence et signaler tout problème que vous rencontrez.
Cette méthode est utile lorsque vous souhaitez marquer un paiement comme étant traité après avoir reçu un rappel de l'API Moneroo et avoir traité la commande de votre côté. Cela vous permet également d'éviter les commandes en double ou de stocker les identifiants des transactions dans votre base de données pour référence ultérieure.
Pour marquer un paiement comme traité, utilisez la méthode makeAsProcessed
avec l'id de la transaction.
Exemple d'usage :
$transactionId = 'your-payment-transaction-id';
$monerooPayment = new \Moneroo\Payment($publicKey, $secretKey);
$payment = $monerooPayment->makeAsProcessed($transactionId);
Transfert
La classe Moneroo\Payout
fournit des méthodes d'initialisation, de vérification et de récupération des paiements.
Initier le paiement
Pour initialiser un tranfert, vous devez transmettre un tableau de données répondant aux règles de validation spécifiées. Le tableau doit contenir les clés suivantes :
Voici les champs obligatoires sous forme de tableau :
amount
integer
Oui
Le montant du transfert.
currency
string
Oui
La devise du transfert. La devise doit être une devise prise en charge dans un format ISO 4217 valide.
description
string
Oui
Description du transfert.
customer.email
string
Oui
Adresse e-mail du client.
customer.first_name
string
Oui
Prénom du client.
customer.last_name
string
Oui
Nom du client.
return_url
string
Oui
URL de retour où votre client sera redirigé après le transfert.
customer.address
string
Non
Adresse du client.
customer.city
string
Non
Ville du client.
customer.state
string
Non
État du client.
customer.country
string
Non
Pays du client. Il s'agir du code du pays au format ISO 3166-1 alpha-2 valide.
customer.zip
string
Non
Code postal du client.
metadata
array
Non
Données supplémentaires pour le transfert.
method
string
Oui¹
Méthodes de transfert autorisées
request_confirmation
²
bool
Non
Si vous souhaitez demander une confirmation au client.
En plus des informations ci-dessus, vous devez ajouter des champs obligatoires pour les méthodes de tranfert dans les détails du compte. Par exemple, si le mode de paiement est mtn_bj
, vous devez fournir les champs msisdn.
Il s'agit d'une information différente de celle de l'utilisateur, qui indique où l'argent sera versé. Pour plus d'informations, veuillez consulter les champs obligatoires pour chaque méthode de transfert.
$payoutData = [
'amount' => 100,
'currency' => 'USD',
'customer' => [
'email' => '[email protected]',
'first_name' => 'John',
'last_name' => 'Doe',
// other customer details...
],
'description' => 'Salary payment',
'method' => 'mtn_bj',
'msisdn' => '22912345678', // required field for mtn_bj payout method
// other data...
];
$monerooPayout = new Moneroo\Payout($publicKey, $secretKey);
$payout = $monerooPayout->init($payoutData);
La méthode create
renvoie un objet contenant les détails du paiement, y compris l'id de la transaction et le statut du paiement. Vous pouvez utiliser cet identifiant de transaction pour vérifier le paiement ultérieurement.
Vérifier le transfert
Vous pouvez vérifier un tranfert grâce à l'id de la transaction.
$transactionId = 'your-payout-transaction-id';
$monerooPayout = new Moneroo\Payout($publicKey, $secretKey);
$payout = $monerooPayout->verify($transactionId);
Récupérer le tranfert
Pour obtenir les détails d'un tranfert, utilisez la méthode get
avec l'id de la transaction.
$transactionId = 'your-payout-transaction-id';
$payout = new \Moneroo\Payout($publicKey, $secretKey);
$payout = $payout->get($transactionId);
Traitement des exceptions
Le SDK est livré avec un certain nombre d'exceptions personnalisées pour vous aider à gérer les erreurs potentielles qui peuvent survenir lors de l'utilisation de l'API Moneroo. Ces exceptions sont les suivantes :
InvalidPayloadException : Cette exception est déclenchée lorsque la charge utile envoyée à l'API ne répond pas aux critères attendus.
ForbiddenException : Cette exception est déclenchée lorsque l'utilisateur authentifié tente d'effectuer une action pour laquelle il ne dispose pas des autorisations nécessaires.
InvalidResourceException : Cette exception est déclenchée lorsqu'une requête est adressée à une ressource inexistante ou invalide.
ServerErrorException : Cette exception est déclenchée en cas d'erreur du côté du serveur.
NotAcceptableException : Cette exception est déclenchée lorsque les caractéristiques du contenu de la demande du client ne sont pas acceptables selon les en-têtes Accept envoyés dans la demande.
ServiceUnavailableException : Cette exception est déclenchée lorsque le service est actuellement indisponible, peut-être en raison de problèmes de maintenance ou de charge sur le serveur.
UnauthorizedException : Cette exception est levée lorsque la demande ne comporte pas d'informations d'authentification valides pour la ressource cible.
Pour chaque exception, vous pouvez accéder au message d'erreur en appelant$exception->getMessage()
, et au code d'erreur (s'il est disponible) en appelant$exception->getCode()
.
Support
Si vous avez des questions ou besoin d'aide, n'hésitez pas à nous contacter. Nous sommes toujours heureux de répondre à vos questions.
Vulnérabilités sécuritaires
Si vous découvrez une faille de sécurité dans le SDK PHP de Moneroo, veuillez envoyer un e-mail à Moneroo Security via [email protected]. Toutes les failles de sécurité seront traitées rapidement.
Licence
Le SDK Moneroo PHP est un logiciel libre sous licence MIT.
Last updated
Was this helpful?