API du Payement Sécurisé Online

les fonctions payement() et payement_mensuel()

string payement          (  long idd,           string password,       string intitule_lien,  string nom_client,  string url_retour,
                            string nom_site,    long numero_commande,  double montant,        long monnaie,       string langue)
string payement_mensuel  (  long idd,           string password,       string intitule_lien,  string nom_client,  string url_retour,
                            string nom_site,    long numero_commande,  double montant,        long monnaie,       string langue,      long nombre_mois)

Description

Ces fonctions vous permettent de contacter notre serveur de payement pour qu'il gère les transactions de vos clients. Chaque transaction doit être préalablement “initialisée” par un appel à la fonction payement()

(ou payement_mensuel() dans le cas d'un payement qui sera répété tous les mois à la même date). Les fonctions payement() et payement_mensuel() acceptent les mêmes paramètres, avec le paramètre nombre_mois en plus pour le payement mensuel.

Pour le payement mensuel, vous devez vous assurer que la date d'expiration de la carte est suffisante pour pouvoir assurer tous les payements.

Lorsque vous appelez une de ces deux fonctions, un lien s'affiche sur votre page HTML et un numéro de session vous est retourné. Le lien permet à votre client, d'un simple clic, d'effectuer son payement sur le serveur sécurisé.

Vous devez également stocker le numéro de session qui vous est retourné : il vous servira à vérifier l'état (accepté, refusé, annulé…) du payement de votre client.

Exemple d'utilisation

$idd = IDENTIFIANT;
$password = "MOT_DE_PASSE";
$url_retour = "http://DOMAINE/retour.php?session=";
$num_commande = NUMERO_COMMANDE;
$nom_client = "M. Jacques Client";
$montant = 12.25;
$session = payement($idd, $password, "Cliquez ici pour payer", $nom_client, $url_retour, "le site WWW", $num_commande, $montant, 978, "fr");
if ($session) {
  // Le numéro de session se trouve dans la variable $session :
  // le payement pourra se poursuivre.
}
else {
  // Erreur : pas de numéro de session, le payement ne pourra
  // pas se poursuivre.
}

Détail des paramètres

idd : l'identifiant de commerçant Online indiqué sur la page “informations” de votre console sécurisée d'administration.

password : le mot de passe qui vous a été fourni lors de votre inscription au payement sécurisé Online.

intitule_lien : texte qui apparaît dans le lien généré sur votre page par l'appel de payement(). Le lien pour payer sera de la forme : <A HREF=…>intitule_lien</A>

nom_client : Nom/identifiant de votre client. Vous pouvez utiliser ce paramètre pour vous aider à identifier un payement.

url_retour : URL que le serveur de payement appellera suite à l'opération de payement et sur laquelle le client reviendra après son payement. L'URL appelée par le serveur sera légèrement modifiée :

le numéro de session (le même que celui retourné par payement() ou payement_mensuel()) y sera concaténé, ainsi que ”&auto=1” dans le cas du retour automatique.

Attention ! La validité de ce paramètre conditionne la possibilité de gérer correctement le retour de payement de votre client. Voir l'introduction à l'interface de payement d'Online pour un exemple.

nom_site : nom de votre site tel qu'il apparaîtra dans l'interface de payement. Le lien pour revenir sur votre site sera de la forme :

  • “Retourner sur nom_site” en Français.
  • “Back to nom_site” en Anglais.

numero_commande : référence de la commande. Ce numéro doit vous permettre d'identifier de façon unique chacune de vos opérations de payement. Sa taille est limitée à 10 caractères (numéro compris entre 0 et 2147483647).

montant : montant du payement (minimum 1.00 euro).

monnaie : 978 uniquement (euro).

langue : langue dans laquelle l'interface de payement Online se présentera aux clients. Les valeurs possibles sont “fr” (Français) et “en” (Anglais).

nombre_mois : nombre de mois durant lesquels le payement doit s'effectuer. Le payement se fera chaque mois à la même date, sauf si la date est supérieure au 28 du mois, auquel cas le payement se fera le 28. Le nombre de mois inclus le premier payement (ex: si vous donnez 5 en paramètre, 5 prélevements seront éffectués, le premier immédiatement puis 4 payements étalés sur 4 mois).

Valeur de retour : payement() et payement_mensuel() renvoient une chaîne contenant le numéro de session retourné par le serveur sécurisé de payement.

check_payement()

string check_payement(long idd, string password, string session_id)

Description

Cette fonction vous permet, au retour du payement, de demander l'état d'une transaction au serveur sécurisé. Exemple d'utilisation

$state = check_payement($idd, $password, $session);
if ($state) {
  // L'état a bien été récupéré
}
else {
  // Problème lors de la récupération de l'état
}

Détail des paramètres

idd : l'identifiant de commerçant Online indiqué sur la page “informations” de votre console sécurisée d'administration.

password : le mot de passe qui vous a été fourni lors de votre inscription au payement sécurisé Online.

session : le numéro de session obtenu lors de l'appel à payement() ou payement_mensuel()

Valeurs de retour

P : En attente : Ceci signifie qu'il n'y a pas eu de tentative de payement pour cette transaction.

S : Succès : Le payement a été validé par la banque et crédité sur votre compte.

F : Échec : Le payement a été refusé par la banque.

T : Échec : Le client a saisi de mauvaises informations trois fois de suite.

C : Annulation : Le client a cliqué sur le bouton “Annuler” (ou “Cancel”) de la page de payement.

X : Erreur : Une erreur s'est produite lors du payement. Contacter service facturation

 
hebergement-web/payement_api.txt · Dernière modification: 2008/04/09 16:54 par admin
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki