Kit d'intégration JAVA

S’abonner

Tout au long de cet article, xx désigne le numéro de release Payline.

Le kit JAVA est mis à disposition sous la forme d'un package webPayline_4.xx.war prêt à être déployé sur un serveur Apache Tomcat.

L'application web contenue dans ce package présente l’ensemble des fonctionnalités Payline disponible via le kit d’intégration. Chaque fonctionnalité se décline sous la forme de deux fichiers :  

  • un fichier sous le répertoire demos nommé <catégorie>-<nom_fonction>.jsp (ou .html) contenant le formulaire de présentation.
  • un fichier <nom_fonction>.jsp comportant le code qui récupère l’ensemble des valeurs transmises par le formulaire et utilise la librairie pour effectuer l’appel au web service.


Par exemple, la fonctionnalité « doWebPayment » qui permet la réalisation d’un paiement Web, se traduit par la présence des deux fichiers suivant :

  • demos/web-doWebPayment.jsp : Ce fichier simule la page récapitulatif de la commande de votre client. Elle constitue l’étape 0 dans le processus de paiement web. Vous pouvez modifier les valeurs des champs du formulaire : Amount, Currency et OrderRef pour réaliser des paiements tests.
  • web/doWebPayment.jsp :Ce fichier contient le code JSP qui récupère les informations transmises par le formulaire et utilise la librairie pour initialiser une demande de paiement web.


Le package webPayline_4.xx.war contient la librairie payline-4.xx.jar.
Cette librairie regroupe les classes qui décrivent les objets de l’API SOAP Payline et les fonctions permettant de réaliser les appels aux web services Payline.
Une fois le package webPayline_4.xx.war déployé, elle se trouve sous webPayline_4.xx\WEB-INF\lib

Le package webPayline_4.xx.war contient la librairie commons-codec-1.10.jar.
Cette librairie doit être ajoutée à votre environnement pour l'utilisation de l'API AJAX. Elle contient la classe Base64 utilisée par les fonctions d'échange avec la servlet getToken de Payline.
Une fois le package webPayline_4.xx.war déployé, elle se trouve sous webPayline_4.xx\WEB-INF\lib

Le package webPayline_4.xx.war contient également un fichier payline.properties.
Ce fichier regroupe l’ensemble de la configuration du kit : les paramètres propres à votre compte commerçant tel que l’identifiant commerçant, la clé d’accès aux services Payline, etc.
Les paramètres définis dans ce fichier sont décrits dans le chapitre Configuration du kit.
Une fois webPayline_4.xx.war  déployé, payline.properties se trouve sous webPayline_4.xx\WEB-INF\classes.

Fonctions
L’ensemble des web services Payline est couvert par le kit JAVA. Les fonctions d’appel des web services sont réparties dans 4 classes : DirectPayment, ExtendedAPI, WalletPayment et WebPayment.

Appel
Le passage de paramètre entre votre boutique et ces fonctions se fait via les objets définis dans la librairie Examinez les scripts d’exemple contenus dans le kit pour comprendre ce mécanisme.

Retour
La réponse d’un web service Payline est également composée d’objets définis dans la librairie. Examinez les scripts d’exemple contenus dans le kit pour comprendre la lecture d’une réponse.

Cas particulier :
Si lors de l’appel à une fonction du kit une exception se produit (par exemple en raison d’une absence de communication avec Payline du fait du mauvais paramétrage de l’authentification ou de proxy), une réponse contenant le code XXXXX ainsi que le libellé de l’exception est renvoyée.
Cette réponse n’est pas retournée par Payline, mais par la librairie.

Configuration du kit
Une fois le kit décompressé sur votre serveur, vous devez configurer les paramètres suivants dans le fichier « payline.properties » :

MERCHANT_ID : l’identifiant de votre compte commerçant,
ACCESS_KEY : la clé d’accès associé à votre compte commerçant,
CONTRACT_NUMBER : le numéro de contrat qui identifie votre point de vente et votre moyen de paiement par défaut,
RETURN_URL : l’URL de retour utilisée lorsque le paiement a été accepté,
CANCEL_URL : l’URL d’annulation utilisée lorsque le paiement a été refusé ou que votre client a annulé le paiement,
PRODUCTION : indicateur qui permet de basculer facilement de l’environnement d’homologation à la production.

Paramètres optionnels :

PAYMENT_ACTION : le code de la méthode de paiement à utiliser par défaut,
PAYMENT_MODE : le mode de paiement à utiliser par défaut,
PAYMENT_CURRENCY : le code ISO de la devise à utiliser par défaut,
ORDER_CURRENCY : le code ISO de la devise à utiliser par défaut,
SECURITY_MODE : le code du mode de sécurité à utiliser par défaut,
LANGUAGE_CODE : le code ISO de la langue à faire afficher par défaut,
NOTIFICATION_URL : l’URL de notification utilisée lorsque Payline vous notifie d’un paiement effectué,
SELECTED_CONTRACT_LIST : la liste des numéros de contrat à faire afficher, séparés par des « ; » (si vous en possédez plusieurs, sinon votre numéro de contrat unique). Laissez ce champ vide si vous souhaitez que tous vos contrats soient proposés.
SECOND_CONTRACT_LIST : la liste des numéros de contrats proposés à l’acheteur en cas d’échec du premier essai de paiement.
CUSTOM_PAGE_CODE : le code de personnalisation des pages de paiement Payline à utiliser par défaut.
CUSTOM_TEMPLATE_URL : URL de votre template de personnalisation des pages de paiement
PROXY_HOST : l’URL de votre proxy Internet,
PROXY_PORT : le port de communication de votre proxy Internet,
PROXY_LOGIN : l’identifiant utilisateur requis par votre proxy Internet,
PROXY_PASSWORD : le mot de passe utilisateur requis par de votre proxy Internet

Exemples
Les classes DirectPayment, ExtendedAPI, WalletPayment et WebPayment contenant les fonctions d’appel aux web services Payline possèdent deux constructeurs :

  • Sans paramètre : la configuration utilisée est celle définie dans le fichier payline.properties
  • Avec paramètre de type ConnectParams : ce constructeur ne tient pas compte du fichier payline.properties et permet d’utiliser des paramètres récupérés à la volée depuis votre système

doAuthorization
Un exemple d’appel à doAuthorization avec utilisation du constructeur sans paramètre de DirectPayment est fourni dans le script direct/doAuthorization.jsp de l’application webPayline.

Voici un exemple simple de l’utilisation du constructeur avec paramètre :

ConnectParams params = new ConnectParams(null, false, false, "19406042904914", "A8****************oj", "proxy-host", "8080", null, null);
DirectPayment directPayment = new DirectPayment(params);
Payment payment = new Payment();
payment.setAmount("990");
payment.setCurrency("978");
payment.setAction("101");
payment.setMode("CPT");
payment.setContractNumber("CB");
Order order = new Order();
Date dNow = new Date();
order.setRef("KIT_"+dNow.getTime());
order.setAmount(payment.getAmount());
order.setCurrency(payment.getCurrency());
java.text.SimpleDateFormat s = new java.text.SimpleDateFormat("dd/MM/yyyy HH:mm");
order.setDate(s.format(dNow));
Card card = new Card();
card.setType("VISA");
card.setNumber("1111222233334444");
card.setExpirationDate("0114");
card.setCvx("123");
DoAuthorizationResponse res = directPayment.doAuthorization(payment, order, null, card, null, null, null, null);


Compatibilité du kit
Le kit JAVA est testé dans les environnements suivants :

  • Windows XP Pro / Windows 7 Pro
  • Tomcat 5.5 et 6.0.35
  • Java 1.5 & 1.6     

 

Vous avez d’autres questions ? Envoyer une demande

Commentaires

Réalisé par Zendesk