Introduction

Objet du document

Ce document décrit la procédure d’intégration de la solution de paiement sécurisé en ligne Payline en mode API AJAX dans votre site commerçant.

Public visé

Ce document est destiné aux commerçants et intégrateurs qui souhaitent utiliser le mode d’intégration « API AJAX » la solution de paiement Payline.

Liste des documents de référence

Nos documents sont disponibles sur notre site internet www.payline.com ou sur simple demande auprès de notre service support : support@payline.com

Avertissement

Ce document est la propriété exclusive de Monext. Toute reproduction intégrale ou partielle, toute utilisation par des tiers, ou toute communication à des tiers, sans accord préalable écrit de Monext est illicite.
Monext®, marque communautaire et internationale propriété exclusive de Monext Ltd et/ou des sociétés du groupe.
Payline®, marque nationale et internationale propriété exclusive de Monext et/ou des sociétés du groupe.

Contacts

Vous avez besoin d’aide, de conseil ou vous souhaitez simplement nous poser une question ? Contactez l’Assistance Payline par : support@payline.com
Pour toute question liée à la mise en place de la solution Payline, vous pouvez joindre notre assistance technique par mail support@payline.com, du lundi au vendredi de 09h00 à 18h00.

Principe général

Présentation

L’interface AJAX présentée est une extension du mode direct. Le commerçant récupère les données carte sur  la page récapitulative de commande hébergée sur ses serveurs. Ce mode permet l’exécution de la demande d’autorisation en mode synchrone ou asynchrone (via stockage temporaire du CVV), l’usage des fonctionnalités de portefeuille et permet de se libérer des obligations PCI-DSS.

L’interface AJAX

Deux modes d’intégration seront proposés :

• Le mode AJAX :
• Réservé aux navigateurs les plus récents, capables d’effectuer des appels AJAX « cross-domain » : IE8+, Chrome, Firefox et Safari ;
• L’intégration du type JSON-P n’est pas compatible avec PCI-DSS (passage du numéro de carte dans l’URL étant interdit) ;
• Intégration asynchrone dans les sites et dans les app-mobile (encore plus transparent pour l’acheteur) ;
  
  
• Pour les navigateurs non compatibles, le mode POST avec redirection temporaire :
• Le commerçant redirige brièvement l’acheteur sur Payline pour la tokenisation. Après traitement, Payline redirige de nouveau l’acheteur sur le site du commerçant ;
• Payline n’affiche aucune page Web, la redirection est donc transparente pour l’acheteur ;
• Ce mode d’intégration est compatible avec tous les navigateurs actuels.

Prérequis et précautions

Périmètre applicable

Le mode d’intégration avec l’API AJAX sur la solution de paiement Payline n’est pas adapté pour traiter les moyens de paiements avec redirection (Paypal, PaysafeCard, …) ou non soumis aux règles de PCI-DSS (vouchers prépayés, comptes eWallet, …).

Actuellement les moyens de paiement pris en charge par l’API AJAX sont :

• Les cartes CB / Visa / Mastercard ;
• Les cartes American Express.

Pour tous les autres moyens de paiement, le marchand peut utiliser l’API directe.

Sécurité

La collecte des données de paiement par le site marchand implique un risque plus élevé pour le commerçant. Ce mode d’intégration nécessite donc une application rigoureuse des standards de sécurité.

En outre, deux éléments importants sont à mettre en œuvre par le marchand :

1. la page de collecte des données de paiement ne doit stocker (fichiers logs, …) à aucun moment les informations « numéro de carte » et « CVV » saisies par l’acheteur. Ces données ne doivent être transmises qu’à Payline au travers d’un des deux modes préconisés (AJAX cross-domaine ou http POST) ;
2. le numéro de commande fourni lors de l’appel à la fonction getToken doit être bien retrouvé à l’identique lors de l’analyse de la réponse. Ce contrôle garantit que les données n’ont pas été détournées dans le but de procéder à un autre paiement que celui prévu initialement.

Le point 1 est particulièrement important : le marchand doit vérifier régulièrement si le script d’appel à la fonction getToken a été modifié. Si tel est le cas, il doit s’assurer que les préconisations restent valides.

Prérequis techniques

Pour les serveurs PHP les exemples de code fonctionnent :

• Avec la bibliothèque gzdecode.php. qui est optionnelle jusqu’à la version 5.4.0 (disponible en standard pour les versions supérieures) ;
• Avec les modules mcrypt et php_soap, qui sont à activer.

Pour les serveurs J2E, afin de pouvoir accéder aux fonctions de chiffrement avec des clés supérieures à 128 bits, il faut installer le package Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy (http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html).

Description fonctionnelle

Cinématique d’un paiement simple

Voici les étapes principales d’un paiement avec cette nouvelle interface :

1. L’acheteur valide son panier, le navigateur envoie une requête http sur le serveur commerçant ;
2. Le serveur commerçant :
1. génère une référence unique de commande ;
2. chiffre avec sa clé d’accès la chaine composée de la référence commande et du numéro de contrat ;
3. construit et renvoie le formulaire au navigateur ;
3. L’acheteur saisit et valide ses données (paiement, adresse de facturation, etc…) ;
4. Le navigateur réalise un appel à la servlet Payline « getToken » ;
5. La servlet Payline traite la requête :
1. déchiffre les données à partir de la clé commerçant ;
2. affecte un CVV virtuel à la transaction (valable pour une seule commande) ;
3. tokenize le numéro de carte ;
4. chiffre, à partir de la clé du commerçant, le token, la date d’expiration et le CVV virtuel (+ autres infos sur la carte) ;
5. retourne les données au navigateur avec éventuellement une redirection http vers la « returnURL » (http 302 en mode synchrone) ;
6. Le navigateur réalise un appel au site du commerçant pour passer les données du formulaire (sans les données bancaires) avec le message chiffré par Payline ;
7. Le serveur commerçant :
1. déchiffre le message avec sa clé d’accès pour obtenir : le token, la date d’expiration et le CVV virtuel.
2. vérifie que la référence de commande déchiffrée est bien celle attendue ;
3. appelle le WS Payline « doAuthorization » avec les données déchiffrées ;
8. Le WS Payline « doAuthorization » :
1. appelle le tokenizer pour obtenir le numéro de carte à partir du token ;
2. récupère le CVV à partir du CVV virtuel ;
3. appelle la banque du commerçant pour réaliser une demande d’autorisation ;
4. réalise les contrôles anti-fraude ;
5. retourne le résultat au commerçant.

Figure 1 : Cinématique d’un paiement simple (sans 3DS)

Cinématique d’un paiement 3DSecure

Voici les étapes principales pour un paiement 3DSecure :

1. L’acheteur valide son panier, le navigateur envoie une requête http sur le serveur commerçant ;
2. Le serveur commerçant génère un formulaire comme dans la cinématique précédente ;
3. L’acheteur saisit et valide ses données (paiement, adresse de facturation, etc…) ;
4. Le navigateur :
1. appelle la servlet « getToken » ;
2. appelle le serveur du commerçant avec les données Payline et les autres données du formulaire.
5. Le serveur du commerçant :
1. déchiffre les données Payline pour récupérer le token, la date d’expiration et le CVV virtuel ;
2. stocke dans la session de l’acheteur ces données ;
3. appelle le WS Payline « verifyEnrollment » avec le token et la date d’expiration.
6. Le WS Payline « verifyEnrollment » :
1. déduit le numéro de carte réel à partir du token carte ;
2. demande au MPI l’adresse de l’ACS de l’acheteur.
7. L’acheteur :
1. est redirigé sur l’ACS de sa banque ;
2. s’identifie ;
3. est redirigé sur le site du commerçant (cf. TERM_URL).
8. Le serveur commerçant appelle le WS Payline « doAuthorization » avec le token, la date d’expiration, le CVV virtuel et le PARes ;
9. Le WS Payline « doAuthorization » :
1. déduit le numéro de carte réel à partir du token carte ;
2. récupère le CVV à partir du CVV virtuel ;
3. appelle le MPI pour vérifier le PARes ;
4. appelle la banque du commerçant pour réaliser une demande d’autorisation ;
5. réalise les contrôles anti-fraude ;
6. retourne le résultat au commerçant.
   
   

Figure 2 : Cinématique d’un paiement simple avec 3DSecure

Cinématique d’un paiement 3DSecure déclenché par le module anti-fraude

Voici les étapes principales pour un paiement 3DSecure déclenché par le module anti-fraude :

1. L’acheteur valide son panier, le navigateur envoie une requête http sur le serveur commerçant
2. Le serveur commerçant génère un formulaire comme dans la cinématique précédente
3. L’acheteur saisit et valide ses données (paiement, adresse de facturation, etc…)
4. Le navigateur :
1. appelle la servlet Payline « getToken » ;
2. appelle le serveur du commerçant avec les données Payline et les autres données du formulaire.
5. Le serveur du commerçant :
1. décrypte les données Payline pour récupérer le token, la date d’expiration et le CVV virtuel ;
2. stocke dans la session de l’acheteur ses données ;
3. appelle le WS Payline « doAuthorization » avec le token, la date d’expiration et le CVV virtuel ;
6. Le WS Payline « doAuthorization » :
1. appelle le tokenizer pour obtenir le numéro de carte ;
2. réalise les contrôles 3DSecure ;
3. renvoie un code d’erreur 02715 « Authentication3DSecure is mandatory ».
7. Le serveur du commerçant appelle le WS Payline « verifyEnrollment » avec le token et la date d’expiration.

Le traitement reprend à partir de l’étape 6 de la cinématique 3DS précédente :

1. Le WS Payline « verifyEnrollment » :
1. déduit le numéro de carte réel à partir du token carte ;
2. demande au MPI l’adresse de l’ACS de l’acheteur.
2. L’acheteur :
1. est redirigé sur l’ACS de sa banque ;
2. s’identifie ;
3. est redirigé sur le site du commerçant (cf. TERM_URL).
3. Le serveur commerçant appelle le WS Payline « doAuthorization » avec le token, la date d’expiration, le CVV virtuel et le PARes ;
4. Le WS Payline « doAuthorization » :
1. déduit le numéro de carte réel à partir du token carte ;
2. récupère le CVV à partir du CVV virtuel ;
3. appelle le MPI pour vérifier le PARes ;
4. appelle la banque du commerçant pour réaliser une demande d’autorisation ;
5. réalise les contrôles anti-fraude ;
6. retourne le résultat au commerçant.

 Figure 3 : Cinématique d’un paiement avec 3DSecure déclenché par le module LCLF

Cinématique d’enregistrement d’une carte dans un portefeuille

Dans ce scénario, aucun paiement n’est réalisé.

Lorsque l’acheteur valide :

1. Le navigateur de l’acheteur envoie les données de la carte à Payline (sur le module des pages Web de paiement) ;
2. Payline retourne un token chiffré si les données sont conformes (cf. la première cinématique) ;
3. Le navigateur retourne ces données au serveur commerçant ;
4. Le serveur commerçant :
1. déchiffre les données pour récupérer : le token, la date d’expiration et le CVV virtuel ;
2. appelle le WS Payline « createWallet ».
5. Le WS Payline « createWallet » :
1. appelle le tokenizer pour récupérer le numéro de carte réel et retransforme le CVV virtuel en CVV réel ;
2. envoie une demande d’autorisation pour scoring à la banque du commerçant (ex : autorisation à 1 euro ou demande d'information selon la banque).

Figure 4 : Cinématique d’un enregistrement de carte dans le portefeuille Payline

Cinématique d’un second paiement par token

Dans cette cinématique, le commerçant a conservé au préalable le token de la carte (et la date d’expiration) dans sa base de données lors du premier paiement. La page de paiement affiche les cartes associées à ce compte acheteur.
Le commerçant a la possibilité de collecter le CVV auprès de son acheteur et le fournir lors de l’appel « doAuthorization » ou d’effectuer une transaction sans CVV.

Lorsque l’acheteur valide la commande :

1. Le serveur commerçant
1. recherche le token carte associé au client ;
2. appelle WS Payline « doAuthorization » avec le token carte, avec ou sans CVV et un code action 120 ou 121.
2. Le WS Payline « doAuthorization »
1. appelle le tokenizer pour récupérer le numéro de carte réel ;
2. envoie une autorisation à la banque du commerçant.
   
   

Implémentation

Modification de la gestion des clés commerçant

Les commerçants qui vont utiliser les paiements en mode AJAX doivent générer une clé d’accès à Payline avec le nouveau module de gestion. Ce nouveau module permet d’attribuer une référence de clé à chaque clé générée. Il est accessible au travers du centre d’administration dans le menu « Configuration ».

Cette référence est à utiliser dans les appels à la fonction getToken décrite ci-après.

La clé elle-même garde les mêmes usages qu’auparavant.

Figure 6 : nouvel écran de génération de clé d’accès

Fonction de création de token

Description

Ce service est développé sous la forme d’une Servlet nommée « getToken ». Il est à appeler au niveau de la page du commerçant pour obtenir le token de la carte de l’acheteur (requête AJAX ou requête POST+redirection).

Données en entrée

Le champ data contient les informations suivantes (valeurs séparées par des points virgules) :

Remarque : Le nombre de requêtes getToken est limité à 3 tentatives pour chaque référence commande. Si vous obtenez 3 erreurs lors d’une commande, il faudra re-générer une chaine chiffrée qui se base sur une nouvelle référence de commande.

Données en sortie

Le service retourne soit une liste de valeur encodées, soit un code erreur si la fonction ne s’est pas déroulée correctement.

Le champ data contient les informations suivantes (valeurs séparées par des points virgules) :

Codes d’erreur

API webservice

Les webservices Payline ont évolué de façon à être compatible avec le paiement en mode Ajax.

Pour cela le champ « card.token » a été ajouté dans les paramètres d’entrée des webservices suivants :

• doAuthorization
• createWallet
• updateWallet
• verifyAuthentication
• verifyEnrollment
• doCredit
• doDebit

Afin de bénéficier de cette évolution, veillez à bien reprendre la dernière version du WSDL Payline.

Les URL des serveurs Payline à utiliser sont :

Homologation : https://homologation-webpayment.payline.com/webpayment/getToken

Production :      https://secure.payline.com/webpayment/getToken

Exemples d’implémentation

Trois étapes sont nécessaires :

1. Préparation de la page de collecte des données carte

2. Page de paiement

3. Traitement de la réponse

Préparation de la page de collecte des données carte

Avant de présenter la page à ses acheteurs, le commerçant doit préparer les éléments qui serviront à envoyer la demande de token à Payline :

1. Préparer un hash de sa clé d’accès Payline (méthode SHA-256) ;
2. Affecter une référence de commande unique au panier de l’acheteur ;
3. Récupérer les informations de son compte Payline : identifiant commerçant et numéro de contrat sur lequel va porter le paiement ;
4. Chiffrer ces données ;
5. Générer le formulaire de paiement présenté à l’acheteur en incluant les données chiffrées à l’étape précédente.

À noter que la chaîne de caractères chiffrée (obtenue à l’étape 5) doit être encodée en base64url (cf. https://fr.wikipedia.org/wiki/Base64#base64url).

Code serveur PHP

Préparer un hash de la clé d’accès :

$aes256Key = hash("SHA256", $accessKey, true);

La donnée accessKey représente la clé d’accès du commerçant 

Pour chiffrer les données, il faut d’abord concaténer les données avant de chiffrer la chaine de caractères obtenue :

messageUtf8 = utf8_encode($merchantId.";".$orderRef.";".$contractNumber);
$crypted crypted = getEncrypt($messageUtf8, $aes256Key);

function getEncrypt($message, $key){
     $block = mcrypt_get_block_size('rijndael_128', 'ecb');
     $pad = $block - (strlen($message) % $block);
     $message .= str_repeat(chr($pad), $pad);
     return base64_url_encode(mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $key, $message, MCRYPT_MODE_ECB));
}

Avec :
merchantId : identifiant Payline du commerçant
orderRef : référence unique de la commande en cours
contractNumber : numéro de contrat Payline sur lequel va porter le paiement.

Code serveur J2E

Préparer un hash de la clé d’accès :

MessageDigest sha = MessageDigest.getInstance("SHA-256");
aes256Key = sha.digest(accessKey.getBytes("UTF-8"));

La donnée accessKey représente la clé d’accès du commerçant.

Chiffrer les données. Il faut d’abord concaténer les données avant de chiffrer la chaîne de caractères obtenue :

byte[] msgUtf8 = (merchantId+orderRef+ContractNumber).getBytes("UTF-8");

SecretKeySpec secretKeySpec = new SecretKeySpec(accessKeyBytes, "AES");
Cipher cipher = Cipher.getInstance("AES");
cipher.init(Cipher.ENCRYPT_MODE, secretKeySpec);
byte[] ciphered = cipher.doFinal(msgUtf8);

String crypted = Base64.encodeBase64URLSafeString(ciphered);

Page de paiement

La page de paiement doit implémenter un fonctionnement qui garantit que le numéro de carte saisit par l’acheteur ne sera jamais stocké (ni par le navigateur de l’acheteur, ni par le serveur web du commerçant).

L’appel à la fonction getToken() peut se faire en mode AJAX cross-domain ou via une requête http post (fournir une URL de retour dans ce cas).

En retour un traitement côté serveur web commerçant doit être appelé afin de prendre en compte la réponse et retourner la page adéquate à l’acheteur (ticket/confirmation de paiement ou page d’erreur selon les cas).

Exemple de script d’appel AJAX :

<script src="http://code.jquery.com/jquery-1.10.1.min.js"></script>
<script>
  // Requête AJAX pour appeler la fonction getToken de Payline
  $(document).ready( function () {
    $("#paymentForm").submit( function() {  // à la soumission du formulaire
      jQuery.support.cors = true;  // activer les requêtes ajax cross-domain
      $.ajax( {
        type: "POST",
        url: "https://homologation-webpayment.payline.com/webpayment/getToken",
        data: "data="+$("#data").val() + "&accessKeyRef=" + 
$("#accessKeyRef").val() + "&cardNumber=" + $("#cardNumber").val() +
 "&cardExpirationDate=" + $("#cardExpirationDate").val() + 
"&cardCvx=" + $("#cardCvx").val(),
        success: function(msg){ // si l'appel a bien fonctionné
          $.ajax({  // fonction permettant de faire de l'ajax
            type: "POST", // methode de transmission au site marchand
            url: "paymentAjax.php",  // traitement serveur (appel local)
            data: "resultPayline="
            success: function(result){  // si l'appel a bien fonctionné
     // traitement du résultat OK (afficher les parametres dans cet exemple)
              var divMsg = $(result);
              divMsg.hide();
              $("#result").append(divMsg);
              divMsg.slideDown();
            }
          });
        },
        error:function (xhr, status, error){
          console.log("Erreur lors de l'appel de Payline : " + xhr.responseText + " (" + status + " - " + error + ")");
        }
      });
      return false; // pour rester sur la même page à la soumission du formulaire
    });
  });
</script>

<form id="paymentForm" action="#" method="post">
  <input type="hidden" name="data" id="data" size='255' value="<?php echo $crypted ?>" />
  <input type="hidden" name="accessKeyRef" id="accessKeyRef" value="<?php echo $accessKeyRef ?>" />
  <label for="">Numéro de carte</label>
  <input type="text" name="cardNumber" id="cardNumber"/>
  <label for="">Date d'expiration</label>
  <input type="text" name="cardExpirationDate" id="cardExpirationDate"/>
  <label for="">Cryptogramme</label>
  <input type="text" name="cardCvx" id="cardCvx"/>
  <br/>
  <input type="submit" class="btn btn-primary" value="Payer" />
</form>

Traitement de la réponse

La réponse contient des données qu’il faut déchiffrer et décompresser, le tout étant codé en base64url.

La chaine peut ensuite être découpée pour récupérer les valeurs séparées par les points-virgules.

Une fois cette étape effectuée, il est possible de procéder à toute opération sur la carte au travers de l’API Webservice Payline.

Généralement le marchand va effectuer une demande d’autorisation à Payline (avec token carte, date d’expiration et CVV virtuel) ou bien une vérification d’enrôlement 3DSecure.

Pour plus d’information sur l’API webservice, vous pouvez consulter la documentation associée.

Serveur PHP

Déchiffrer les données reçues :

$zippedData = getDecrypt($data, $aes256Key);

function getDecrypt($message, $key){
     $message = base64_url_decode($message);
     $message = mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $key, $message, MCRYPT_MODE_ECB);
     $block = mcrypt_get_block_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_ECB);
     $len = strlen($message);
     $pad = ord($message[$len-1]);
     return substr($message, 0, $len-$pad);
}

La donnée data représente la valeur du paramètre ($_POST['data']) reçu en retour (cas où l’appel ne retourne pas une erreur).

Décompresser les données :

$uncompressedData = gzdecode($zippedData);

Découper le résultat pour récupérer le résultat de l’appel :

$paylineDataResponse=explode(';', $uncompressedData);

$cardToken = $paylineDataResponse[0];
$cardExpirationDate = $paylineDataResponse[1];
$cardVirtualCVV = $paylineDataResponse[2];
$orderReference = $paylineDataResponse[3];
…

Serveur J2E

Déchiffrer les données reçues :

byte[] decryptedMessage = new byte[0];
zippedData = AESEncryption.decrypt(aes256Key, data);

public static final byte[] decrypt(final String key, final String message) {
  byte[] decrypt = new byte[0];
  MessageDigest sha = MessageDigest.getInstance("SHA-256");
  keyBytes = sha.digest(key.getBytes("UTF-8"));
  SecretKeySpec secretKeySpec = new SecretKeySpec(keyBytes, "AES");
  Cipher cipher = Cipher.getInstance("AES");
  cipher.init(Cipher.DECRYPT_MODE, secretKeySpec);
  decrypt = cipher.doFinal(Base64.decodeBase64(message.getBytes("UTF-8")));
  return finalDecrypt;
 }

La donnée data représente la valeur du paramètre (request.getParameter("data")) reçu en retour (cas où l’appel ne retourne pas une erreur).

Décompresser les données :

final StringBuffer outStr = new StringBuffer();
final ByteArrayInputStream gzipedStr = new ByteArrayInputStream(zippedData);
final GZIPInputStream gis = new GZIPInputStream(gzipedStr);
final BufferedReader bf = new BufferedReader(new InputStreamReader(gis));
String line;
while ((line = bf.readLine()) != null) {
  outStr.append(line);
}
gis.close();
String uncompressedData = outStr.toString();

Découper le résultat pour récupérer le résultat de l’appel :

String[] paylineDataResponse = uncompressedData.split(";");

String cardToken = paylineDataResponse[0];
String cardExpirationDate = paylineDataResponse[1];
String cardVirtualCVV = paylineDataResponse[2];
String orderReference = paylineDataResponse[3];
…