Présentation
Cette page présente la mise en œuvre de la Page Web de Paiement Version 2 (Mode redirection).
Cette page web à redirection permet d'obtenir une page de paiement hébergé chez Payline avec le mode d'intégration widget. Le commerçant bénéficie d'un meilleur visuel et de toutes les dernières fonctionnalités mises à jour.
Le commerçant utilise les mêmes services des pages à redirection en indiquant le nouveau Template Id défini dans le centre administration.
Payline se charge d'appeler la page de paiement et d'y intégrer le widget.
Les services disponibles sont :
Centre d'administration
Vous pouvez créer un nouveau template dans le menu Personnalisation des pages avec sélectionnant l'option PageWebPaiement V2 :
| Info |
|---|
Veuillez consulter la disponibilité de la fonction Personnalisation intégrale de votre abonnement : Nos offres. |
Les templates hébergés peuvent être composés de fichiers de type :
- Template file (page web contenant les informations de la DIV pour appeler le widget) ;
- HTML (un, et un seul) ;
- CSS ;
- JS ;
- des images au format jpg, gif, png et bmp.
Création de la page web (template file)
Le fichier HTML doit contenir, à minima, dans la head les liens vers les ressources statiques du widget correspondant à l'environnement souhaité (homologation, production) :
| Prérequis | Homologation | Production |
| Javascript Widget | https://homologation-payment.cdn.payline.com/cdn/scripts/widget-min.js | https://payment.cdn.payline.com/cdn/scripts/widget-min.js |
| CSS Widget | https://homologation-payment.cdn.payline.com/cdn/styles/widget-min.css | https://payment.cdn.payline.com/cdn/styles/widget-min.css |
Et éventuellement un lien vers votre propre css, de manière relative.
| Volet |
|---|
| Développer |
|---|
| title | Exemple de code en environnement de test... |
|---|
|
| Bloc de code |
|---|
| language | xml |
|---|
| theme | Confluence |
|---|
| title | Head du fichier |
|---|
|
<html>
<head>
<title>Mon template</title>
<link rel="stylesheet" type="text/css" href="tuto.css" />
<script src="https://homologation-payment.cdn.payline.com/cdn/scripts/widget-min.js" charset="utf-8"></script>
<link rel="stylesheet" href="https://homologation-payment.cdn.payline.com/cdn/styles/widget-min.css" charset="utf-8">
</head>
</html>
| Inclusion d'extrait |
|---|
| PW - lib : JS et CSS |
|---|
| PW - lib : JS et CSS |
|---|
| nopanel | true |
|---|
|
DIV
A cela il est nécessaire d'ajouter, dans le body, une div nommée PaylineWidget avec des paramètres tels que le template choisi (parmi column, tab et lightbox, cf. la documentation du widget Mode in-Shop), des callback (cf. PW - Personnalisation du widget : Fonction CallBack).
callBack
L'exemple ci-dessous représente la création d'une div avec le template column et ajouter une callBack pour customiser le widget lorsqu'il s'agit d'un contexte de type PAYMENT_METHOD_LIST (la liste des moyens de paiement, où le consommateur aura le choix des moyens de paiement et renseignera ses données de paiement) :
| Volet |
|---|
| Développer |
|---|
| title | Exemple de code en environnement de Test.. |
|---|
|
| Bloc de code |
|---|
| language | xml |
|---|
| theme | Confluence |
|---|
| title | Création de la div widget |
|---|
| <html>
<head>
<title>Mon template</title>
<link rel="stylesheet" type="text/css" href="tuto.css" />
<script src="https://homologation-payment.cdn.payline.com/cdn/scripts/widget-min.js" charset="utf-8"></script>
<link rel="stylesheet" href="https://homologation-payment.cdn.payline.com/cdn/styles/widget-min.css" charset="utf-8">
</head>
<body>
<div id="PaylineWidget" data-template="column" data-event-didshowstate="customPaymentMethodList">
</div>
</body>
</html> |
|
|
Le code data-event-didshowstate="customPaymentMethodList", permet d'appeler la fonction JS customPaymentMethodList, lorsqu'un contexte de type PAYMENT_METHOD_LIST s'est affiché afin de personnaliser l'affichage avec, par exemple, jQuery.
Vous pouvez trouver la liste des états possibles retournés dans la callback : Fonctionnalités du Widget
Personnaliser sa page
Vous devez ajouter le Javascript au fichier HTML, soit créer un fichier Javascript que vous ajouterez dans notre head via un lien relatif :
| Volet |
|---|
| Développer |
|---|
| title | Exemple de code en environnement de Test.. |
|---|
|
| Bloc de code |
|---|
| language | xml |
|---|
| title | Ajout du fichier Javascript dans la head |
|---|
| <html>
<head>
<title>Mon template</title>
<link rel="stylesheet" type="text/css" href="tuto.css" />
<script src="https://homologation-payment.cdn.payline.com/cdn/scripts/widget-min.js" charset="utf-8"></script>
<link rel="stylesheet"href="https://homologation-payment.cdn.payline.com/cdn/styles/widget-min.css" charset="utf-8">
<script src="tuto.js" charset="utf-8"></script>
</head>
<body>
<div id="PaylineWidget" data-template="column" data-event-didshowstate="customPaymentMethodList">
</div>
</body>
</html> |
|
|
Pour que le widget s'initialise, il faut lui fournir un token obtenu via un doWebPayment (effectuer une demande de paiement) ou un manageWebWallet (effectuer une gestion de portefeuille). Lors du doWebPayment , l'url générée par les WebServices de l'API Payline générera une URL de la forme suivante : https://webpayment.payline.com/v2/[clé chiffrée du template]/#[TOKEN]
Il faut donc ajouter à votre javascript la fonction capable de récupérer le token dans l'url, et de la fournir au widget :
| Volet |
|---|
| Développer |
|---|
|
| Bloc de code |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| title | Récupération du token dans l'url |
|---|
| // On récupère le token sans le #
var urlToken = location.hash.substr(1);
if (urlToken) {
var element = document.getElementById('PaylineWidget');
element.setAttribute('data-token', urlToken);
} |
|
|
Cela permet au Widget de s'initialiser avec le token de l'url lors du chargement de la page.
Lorsque vous développez votre template, vous pouvez ajouter #[TOKEN] en récupérant un Token sur notre API WebServices d'homologation, les liens vers les css, js et images étant relatifs, cela vous permet d'utiliser votre template en copier tous vos fichiers dans le même dossier.
Ensuite nous allons personnaliser notre contexte PAYMENT_METHOD_LIST à l'aide de la fonction customPaymentMethodList que l'on a déclaré plus haut.
| Volet |
|---|
| Développer |
|---|
|
| Bloc de code |
|---|
| language | js |
|---|
| title | Récupération du token dans l'url |
|---|
| // On récupère le token sans le #
var urlToken = location.hash.substr(1);
if (urlToken) {
var element = document.getElementById('PaylineWidget');
element.setAttribute('data-token', urlToken);
}
// Fonction permettant de customiser le PAYMENT_METHOD_LIST
function customPaymentMethodList(state) {
<!-- S'il c'est un contexte PAYMENT_METHODS_LIST (liste des moyens de paiement) ou PAYMENT_NEEDS_MORE_INFOS (confirmation d'une donnée de paiement) alors je procède aux modifications suivantes -->
if (state.state === "PAYMENT_METHODS_LIST" || state.state === "PAYMENT_NEEDS_MORE_INFOS") {
<!-- On remplace le label de la case à cocher -->
$('.pl-remember-text').text('Enregistrer mes informations pour mes prochains paiements');
<!-- S'il y a des wallets je procède à certaines modifications -->
if ($('#pl-wLayout-view') !== undefined) {
<!-- Je retire les titres -->
$('.pl-wallets-title').remove();
$('.pl-container-title').remove();
<!-- Je remplace le titre des wallets -->
$('.pl-wallets').before('<span style="font-size:12pt !important">Je valide mon paiement en sélectionnant ma carte ou mon compte Paypal</span>');
<!-- Je retire le message du CVV du wallet -->
$('.pl-cvv-message').remove();
}
}
} |
|
|
Payline permet l'ajout de balises dans la page permettant de la personnaliser la page. Ces balises seront valorisées lors du chargement de la page.
Par exemple vous pourriez ajouter le nom et le prénom de l'utilisateur, ainsi que le montant de la transaction, pour cela vous devez ajouter des span et des mots clés entourés de # :
| Volet |
|---|
| Développer |
|---|
| title | Exemple de code en environnement de Test.. |
|---|
|
| Bloc de code |
|---|
| language | xml |
|---|
| title | Ajout du fichier Javascript dans la head |
|---|
| <html>
<head>
<title>Mon template</title>
<link rel="stylesheet" type="text/css" href="tuto.css" />
<script src="https://homologation-payment.cdn.payline.com/cdn/scripts/widget-min.js" charset="utf-8"></script>
<link rel="stylesheet" href="https://homologation-payment.cdn.payline.com/cdn/styles/widget-min.css" charset="utf-8">
<script src="tuto.js" charset="utf-8"></script>
</head>
<body>
<div id="PaylineWidget" data-template="column" data-event-didshowstate="customPaymentMethodList">
</div>
<div id="orderData">
<ul>
<li>
<span class="label">N° de commande</span>
<span class="value">#PaylineOrderRef#</span>
</li>
<li>
<span class="label">Montant: </span>
<span class="value">#PaylineFormattedAmount#</span>
</li>
<li>
<span class="label">Acheteur</span>
<span class="value">#PaylineBuyerFirstName# #PaylineBuyerLastName#</span>
</li>
</ul>
</div>
</body>
</html> |
|
|
Et une fonction javascript pour réaliser le remplacement dans la page il est nécessaire d'appeler dans la callBack customPaymentMethodList. L'argument doit être l'id du bloc où faire les remplacements, ici c'est orderData :
| Volet |
|---|
| Développer |
|---|
|
| Bloc de code |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| title | Remplacement de mots clés |
|---|
| // Fonction parsant toutes les chaînes contenues entre des caractères #
function parse(str) {
return str.match(/#([^#]*)#/g);
}
// Fonction remplaçant toutes les chaines
function replace(blockId) {
// Récupération du tableau de toutes les chaines à remplacer de la div "main"
var block = $('#' + blockId);
var stringArrayToReplace = parse(block.text());
// Pour chaque élément du tableau on remplace avec les données fournies par le Widget
var result = block.html();
for (i = 0; i < stringArrayToReplace.length; i++) {
var hashedKey = stringArrayToReplace[i];
var key = hashedKey.substring(1, hashedKey.length-1);
result = result.replace(hashedKey,Payline.Api.getContextInfo(key));
}
block.html(result);
block.show();
} |
|
|