Gestion Plus JSON

De Documentation Mercanet
Aller à : navigation, rechercher

Sommaire

Introduction

Objet du document

Ce document a pour but d’expliquer comment mettre en œuvre les échanges entre les sites Web des commerçants et la solution Mercanet Gestion Plus. Ce document s’adresse à tous les commerçants qui souhaitent souscrire à l’offre Mercanet et avoir recours à un connecteur à base d’échanges JSON via le protocole REST entre les sites des commerçants et les serveurs Mercanet, le tout en utilisant Mercanet Gestion Plus comme passerelle. L'interface checkout permet de :

  • créer une transaction à l'aide d'une carte, d'un portefeuille électronique.
  • initialiser et finaliser une transaction avec un portefeuille externe (Masterpass, Paylib).
  • gérer la vérification 3D-Secure pour les transactions par carte et par portefeuille électronique.

L’interface cash management permet d’effectuer les opérations suivantes sur une transaction :

  • annulation
  • duplication
  • remboursement
  • forçage
  • validation
  • recyclage
  • acceptation ou refus

L'interface diagnostic permet de :

  • trouver les informations relatives à une transaction.

L'interface wallet permet de :

  • créer ou supprimer un portefeuille commerçant.
  • ajouter, mettre à jour ou supprimer des moyens de paiement d’un portefeuille commerçant.

L’interface du service Web payment mean info permet de :

  • consulter les informations cartes associées au numéro d’une carte où à son Numéro d’Identification Émetteur (IIN).

L'interface du service Web fraud permet de :

  • vérifier si les transactions existantes sont frauduleuses.

Prestataires de services intermédiaires effectuant des opérations Mercanet pour le compte de commerçants

Si vous êtes un prestataire de services intermédiaire qui effectue des opérations Mercanet pour le compte d’un commerçant, vous devez indiquer votre identifiant unique de prestataire de services intermédiaire dans le champ intermediateServiceProviderId. De plus, le sceau devra être calculé avec votre propre clé secrète plutôt qu’avec celle du commerçant que vous représentez. Veuillez vous référer au guide de configuration des fonctionnalités pour de plus amples informations sur les prestataires de services. En outre, des informations détaillées sur le calcul du sceau sont fournies au chapitre intitulé « Comment signer un message » de ce document.

Kit de démarrage

Veuillez trouver ci-après des exemples de programmes plus complet écrit en PHP vous permettant de mettre en oeuvre l'appel des Web Service de Mercanet :

Kit pour le connecteur Gestion Plus JSON

Vous pourrez tester les différents moyens de paiement:

  • Paiement differé
  • paiement N fois
  • Paiement One click
  • Paiement simple
  • ...

Description du protocole

Protocole REST et champs JSON

JSON est une syntaxe utilisée pour le stockage et l’échange d’informations textuelles. Très similaire au XML, JSON est plus compact et s’avère plus facile et plus rapide à analyser. La manière la plus simple d’accéder à n’importe quel service est d’utiliser cURL. Exemple de requête cURL en PHP :

<?php

…

// Open cURL session and data are sent to server 
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,            $url_of_service );
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt($ch, CURLOPT_POST,           true );
curl_setopt($ch, CURLOPT_POSTFIELDS,     $data_to_send);
curl_setopt($ch, CURLOPT_HTTPHEADER,     array('Content-Type: application/json', 'Accept: application/json'));
curl_setopt($ch, CURLOPT_PROXY,          $name_and_proxy_port);
$result = curl_exec($ch);
$info = curl_getinfo($ch);

// Manage errors
if ($result == false || $info['http_code'] != 200) {
  echo $result;
  if (curl_error($ch))
    $result .= "\n". curl_error($ch);
}

// Close cURL session
curl_close($ch);
…

?>

Dans les exemples suivants, les données passées au serveur via la requête JSON dépendent entièrement du service auquel vous essayer d’accéder et des champs que nécessite ce dernier. Pour obtenir des exemples spécifiques, référez-vous à la documentation fournie par chaque service. ? Remarque

Les noms des champs sont sensibles à la casse.


Syntaxe de la requête

Le champ data a le format suivant :

{“<nom du champ>” : ”<nom de la valeur>”, “<nom du champ>” : ”<nom de la valeur>”, “nom du champ” : “nom de la valeur” etc., “sceau” : “valeur du sceau” }

Tous les champs nécessaires à la transaction (consultez le dictionnaire des données pour en connaître les détails) doivent être présents dans cette chaîne de caractères. L’ordre des champs n’a pas d’importance. Exemple de requête cardOrder :

{"amount" : "1000", "captureDay" : "0","captureMode" : "AUTHOR_CAPTURE","cardCSCValue" : "100","cardExpiryDate" : "201406","cardNumber" : "4975497549754975", "currencyCode" : "978", "interfaceVersion" : "IR_WS_2.3","merchantId" : "011223744550001", "orderChannel" : "INTERNET", "transactionReference" : "tref20131209",”keyVersion” : “1”, "seal" : "112a4b079ece08a0a55511cd5469fc47051d6ddb1404623170ba3873668e5c58" }

Syntaxe d'une liste

La syntaxe utilisée pour créer une liste en JSON suit la norme. Voici un résumé de cette structure pour les deux principaux types de listes : les listes de champs simples (par ex. chaînes de caractères) et les listes d’objets.

  • Liste de champs simples :

…,"nom du champ" : ["valeur1","valeur2"],…

Exemple avec fraudData :

{"amount" : "1000","captureDay" : "0","captureMode" : "AUTHOR_CAPTURE","cardCSCValue" : "100","cardExpiryDate" : "201406","cardNumber" : "4975497549754975","currencyCode" : "978","fraudData" : {"bypassCtrlList" : ["All","ForeignBinCard"]},"interfaceVersion" : "IR_WS_2.3","keyVersion" : "1","merchantId" : "011223744550001","orderChannel" : "INTERNET","transactionReference" : "tref20131209","seal" : "f18d95fcfbcc02e577467a9ddaa86b74d65908e9c36df12c74465f1324bf2100"}
  • Liste d’objets :

…,“Nom du champ” : [{“nom du sous-champ1”:”valeur1”,“nom du sous-champ2”:”valeur2”},{“nom du sous-champ1”:”valeur3”, “nom du sous-champ2”:”valeur4”}],… Exemple avec riskManagementCustomDataList :

{"amount" : "1000","captureDay" : "0","captureMode" : "AUTHOR_CAPTURE","cardCSCValue" : "100","cardExpiryDate" : "201604","cardNumber" : "4975497549754975","currencyCode" : "978","interfaceVersion" : "IR_WS_2.3","keyVersion" : "1","merchantId" : "011223744550001","orderChannel" : "INTERNET","riskManagementCustomDataList" : [{"riskManagementCustomSequence" : "abc","riskManagementCustomValue" : "123"},{"riskManagementCustomSequence" : "efg","riskManagementCustomValue" : "456"}],"transactionReference" : "tref20131209","seal" : "1e0f6cf0f2ca8365b84c9118f39ab3ed2837e114b9b42c1a49da1db368ce76d4"}

Syntaxe du champ « seal »

La valeur du champ seal est calculée ainsi :

  • concaténation des valeurs des champs de données dans l’ordre alphabétique des noms de champs, sauf pour les champs keyVersion et sealAlgorithm ;
  • obtention de l’encodage UTF-8 des données du résultat précédent ;
  • HMAC avec chiffrement SHA256 des octets obtenus avec la clé secrète.

Cette procédure peut être résumée ainsi :
HMAC ( SHA256 ( UTF-8(sortedDataValues), secretKey ) )

Syntaxe de concaténation pour les champs composites

Si des champs composites comportant une sous-structure sont utilisés, un calcul de champ spécifique doit être effectué :

  • - concaténation du champ composite et du nom de champ de la sous-structure avec sensibilité à la casse ;
  • - tri de la totalité des champs de la sous-structure, puis tri de ces champs et des autres champs.

Exemple : Le nom de champ à utiliser pour une byPassCrtList de fraudData doit être fraudDatabyPassCtrlList et sa valeur sera triée avec les autres champs.
Si elle contient All,ForeignBinCard, sa valeur devient AllForeignBinCard pour le calcul du sceau.

Exemple de calcul du champ « seal »

<?php

…

// Seal computation thanks to hash sorted data hash with merchant key
$data_to_send=$amount.$captureDay.$captureMode.$cardCSCValue.$cardExpiryDate.$cardNumber.$cardSeqNumber.$currency_code.$pb.$customerId.$customerIpAddress.$ivers.$mid.$merchantTransactionDateTime.$orderChannel.$orderId.$returnContext.$opeorig.$tref;

$data_to_send= utf8_encode($data_to_send)

$seal=hash_hmac('sha256', $data_to_send, $secretKey);

…

?>

Comment SIGNER un MESSAGE

Motifs de signature d'un message

Une vérification concluante de signature nécessite deux éléments :

  • l’intégrité des messages de la requête et de la réponse : aucune altération ne doit avoir eu lieu pendant l’échange.
  • l’authentification de l’émetteur et du destinataire, car ils partagent la même clé secrète.

? Remarque

En cas de compromission réelle ou supposée de la clé utilisée pour la signature, il appartient au commerçant d’obtenir son renouvellement par le biais de l’extranet Mercanet Téléchargement.



Méthode de signature d’un message

L’opération de signature est effectuée en calculant une valeur cryptée basée sur les paramètres de la transaction (valeurs des champs) à laquelle est ajoutée la clé secrète (inconnue de l’internaute). Toutes les chaînes de caractères sont converties en UTF8 avant chiffrement. L’algorithme de chiffrement (SHA256) produit un résultat irréversible. Généralement, lorsqu’un message de cette nature est reçu, son destinataire doit recalculer la valeur cryptée afin de la comparer à la valeur reçue. Toute différence indique que les données échangées ont été falsifiées. Le résultat au format hexadécimal doit être envoyé dans le champ nommé seal.

Exemples de code

Php 5

<?php

…

echo hash_mac('sha256', $data, $secretKey);

…

?>

data et secretKey doivent utiliser un jeu de caractères UTF-8. Référez-vous à la fonction utf8_encode pour la conversion de caractères ISO-8859-1 en UTF-8.

Java

import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException ;

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;

public class ExampleHMACSHA256 {

	/**
	 * table to convert a nibble to a hex char.
	 */
	static final char[] hexChar = {
	   '0' , '1' , '2' , '3' ,
	   '4' , '5' , '6' , '7' ,
	   '8' , '9' , 'a' , 'b' ,
	   'c' , 'd' , 'e' , 'f'};

	/**
	 * Fast convert a byte array to a hex string
	 * with possible leading zero.
	 * @param b array of bytes to convert to string
	 * @return hex representation, two chars per byte.
	 */
	public static String encodeHexString ( byte[] b )
	   {
	   StringBuffer sb = new StringBuffer( b.length * 2 );
	   for ( int i=0; i<b.length; i++ )
	      {
	      // look up high nibble char
	      sb.append( hexChar [( b[i] & 0xf0 ) >>> 4] );

	      // look up low nibble char
	      sb.append( hexChar [b[i] & 0x0f] );
	      }
	   return sb.toString();
	   }

	/**
	 * Computes the seal
	 * @param Data the parameters to cipher
	 * @param secretKey the secret key to append to the parameters 
	 * @return hex representation of the seal, two chars per byte.
	 */
	public static String computeSeal(String data, String secretKey) throws Exception
	{
  Mac hmacSHA256 = Mac.getInstance("HmacSHA256");
  SecretKeySpec keySpec = new SecretKeySpec(secretKey.getBytes(), "HmacSHA256");
  hmacSHA256.init(keySpec);

  return encodeHexString(hmacSHA256.doFinal(data.getBytes()));
	}
	
	/**
	 * @param args
	 */
	public static void main(String[] args) {
		try {
			System.out.println (computeSeal("parameters", "key"));
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

}

.net

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using System.Security.Cryptography;

namespace ExampleDotNET
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void cmdGO_Click(object sender, EventArgs e)
        {
            String sChaine = txtSips.Text;
            UTF8Encoding utf8 = new UTF8Encoding();
            Byte[] encodedBytes = utf8.GetBytes(sChaine);
        
            byte[] shaResult;
            
            HMAC hmac = new HMAC.Create("HMACSHA256");
            var key = "YourSecretKey";
            hmac.Key = utf8.GetBytes(key); 
            hmac.Initialize();

            shaResult = hmac.ComputeHash(encodedBytes);

            lblHEX.Text = ByteArrayToHEX(shaResult);
        }

        private string ByteArrayToHEX(byte[] ba)
        {
            StringBuilder hex = new StringBuilder(ba.Length * 2);
            foreach (byte b in ba)
                hex.AppendFormat("{0:x2}", b);
            return hex.ToString();
        }

    }
}

TESTS

Les étapes de test et d'intégration peuvent être réalisées à l’aide de l'environnement de recette. Afin de pouvoir l’utiliser, vous devez contacter l'assistance technique en indiquant les services dont vous avez besoin. L'assistance technique vous enverra un identifiant commerçant (merchantId) et une clé secrète. Les détails techniques nécessaires pour utiliser l’environnement de recette sont fournis ci-dessous :

Nom du service URL du service
URL de recettehttps://office-server-mercanet.test.sips-atos.com/
Nom du service de paiement/rs-services/v2/checkout
Nom du service de gestion de caisse/rs-services/v2/cashManagement
Nom du service de diagnostic/rs-services/v2/diagnostic
Nom du service portefeuille/rs-services/v2/wallet
Nom du service d'information sur les moyens de paiement/rs-services/v2/paymentMeanInfo
Nom du service fraude/rs-services/v2/fraud

Dans l’environnement de recette, le processus d’autorisation est simulé. Cela signifie qu’il n’est pas nécessaire d’utiliser des moyens de paiement réels pour effectuer des tests.

Tester les transactions par carte

Voir le chapitre concernant les [Cartes de test]

Mise en production

L'étape suivante consiste à se connecter à l'environnement de production pour la mise en production effective. Pour réaliser cette opération, le commerçant doit modifier l'URL du serveur Office et utiliser les identifiants commerçant reçus durant la phase d’inscription.

Identifiants commerçant

L'URL du serveur de paiement de production est suivante : https://office-server.mercanet.bnpparibas.net/ Pour accéder à l’environnement de production, trois éléments sont nécessaires :

  • l’identifiant commerçant (merchantID) qui identifie le site de commerce électronique sur le serveur Mercanet ;
  • la version (keyVersion) de la clé secrète ;
  • la clé secrète (secretKey) utilisée pour signer les requêtes et vérifier les réponses.

L’identifiant commerçant (merchantID) est fourni par l’assistance technique à l’issue de l’inscription du commerçant. La version de la clé (keyVersion) et la clé secrète (secretKey) peuvent être téléchargées depuis l’extranet Mercanet Téléchargement à l’aide du nom d’utilisateur et du mot de passe fournis par l’assistance technique à l’issue de l’inscription du commerçant.

Validation en production

À partir du moment où le commerçant utilise ses propres identifiants sur le serveur de production, toutes les transactions et opérations de gestion de caisse sont réelles (par exemple, les transactions de paiement sont réelles de bout en bout, c’est-à-dire jusqu'à ce que les fonds soient crédités sur le compte du commerçant et débités de celui de l'acheteur). Avant l'ouverture réelle de la boutique au public, le commerçant peut soumettre une requête pour valider le paiement de bout en bout, c’est à dire jusqu'à ce que les fonds soient crédités sur son compte et débités de celui de l'acheteur.

Description des services

La version de l’interface (interfaceVersion) pour la version actuelle est 2.18

Description du service checkout

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout Ce service permet de réaliser un ordre de paiement à l'aide d'une carte ou d'un portefeuille électronique. La valeur du champ interfaceVersion est fixée à IR_WS_2.18

Service cardOrder

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/cardOrder Une requête d'ordre de paiement par carte inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée authenticationData
  • Paramètres d’entrée billingAddress
  • Paramètres d’entrée billingContact
  • Paramètres d’entrée customerAddress
  • Paramètres d’entrée customerContact
  • Paramètres d’entrée customerData
  • Paramètres d’entrée deliveryAddress
  • Paramètres d’entrée deliveryContact
  • Paramètres d’entrée fraudData
  • Paramètres d’entrée holderAddress
  • Paramètres d’entrée holderContact
  • Paramètres d’entrée holderData
  • Paramètres d’entrée subMerchantAddress
  • Paramètres d’entrée paymentMeanData
  • Paramètres d’entrée riskManagementCustomData
  • Paramètres d’entrée s10TransactionReference
  • Paramètres d’entrée shoppingCartDetail
cardOrder - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.3

captureDay

Facultatif

WS_2.3

captureMode

Facultatif

WS_2.3

cardCSCValue

Facultatif

WS_2.3

cardEffectiveDate

Facultatif

WS_2.3

cardExpiryDate

Obligatoire

WS_2.3

cardNumber

Obligatoire

WS_2.3

cardSeqNumber

Facultatif

WS_2.3

currencyCode

Obligatoire

WS_2.3

customerId

Facultatif

WS_2.3

customerIpAddress

Facultatif

WS_2.3

customerLanguage

Facultatif

WS_2.15

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

invoiceReference

Facultatif

WS_2.3

keyVersion

Obligatoire

WS_2.3

subMerchantCategoryCode

Facultatif

WS_2.14

merchantId

Obligatoire

WS_2.3

subMerchantLegalId

Facultatif

WS_2.14

subMerchantShortName

Facultatif

WS_2.14

merchantTransactionDateTime

Facultatif

WS_2.3

orderChannel

Facultatif

WS_2.3

- Facultatif pour AccordKdo - Obligatoire pour tous les autres moyens de paiement

orderId

Facultatif

WS_2.3

panType

Facultatif

WS_2.4

paymentMeanBrand

Facultatif

WS_2.2

paymentMeanBrandSelectionStatus

Facultatif

WS_2.13

Si ce champ est spécifié en entrée, paymentMeanBrand est obligatoire.

paymentPattern

Facultatif

WS_2.3

Ce champ est obligatoire pour certains moyens de paiement. Pour de plus amples informations, référez-vous au guide de mise en œuvre du moyen de paiement concerné.

returnContext

Facultatif

WS_2.3

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

statementReference

Facultatif

WS_2.3

subMerchantId

Facultatif

WS_2.14

transactionReference

Facultatif

WS_2.6

transactionOrigin

Facultatif

WS_2.3

billingAddress

Facultatif

WS_2.3

Voir plus bas

billingContact

Facultatif

WS_2.3

Voir plus bas

customerAddress

Facultatif

WS_2.3

Voir plus bas

customerContact

Facultatif

WS_2.3

Voir plus bas

deliveryAddress

Facultatif

WS_2.3

Voir plus bas

deliveryContact

Facultatif

WS_2.3

Voir plus bas

authenticationData

Facultatif

WS_2.3

Voir plus bas

customerData

Facultatif

WS_2.3

Voir plus bas

fraudData

Facultatif

WS_2.3

Voir plus bas

holderAddress

Facultatif

WS_2.3

Voir plus bas

holderContact

Facultatif

WS_2.3

Voir plus bas

holderData

Facultatif

WS_2.5

Voir plus bas

subMerchantAddress

Facultatif

WS_2.14

Voir plus bas

paymentMeanData

Facultatif

WS_2.5

Voir plus bas

s10TransactionReference

Facultatif

WS_2.6

Voir plus bas

riskManagementCustomDataList

Facultatif

WS_2.8

Liste d’objets riskManagementCustomeData Voir plus bas

shoppingCartDetail

Facultatif

WS_2.8

Voir plus bas

Tableau n° 1 : Champs d’une requête cardOrder

Paramètres d’entrée de s10TransactionReference

Champ

Présence

A partir de la version

Commentaires

s10TransactionId

Facultatif

WS_2.6

s10TransactionIdDate

Facultatif

WS_2.6

Tableau 2 : Champs de l'élément s10TransactionReference

Paramètres d’entrée de billingAddress

Champ

Présence

A partir de la version

Commentaires

addressAdditional1

Facultatif

WS_2.3

addressAdditional2

Facultatif

WS_2.3

addressAdditional3

Facultatif

WS_2.3

city

Facultatif

WS_2.3

company

Facultatif

WS_2.3

country

Facultatif

WS_2.3

postBox

Facultatif

WS_2.3

state

Facultatif

WS_2.3

street

Facultatif

WS_2.3

streetNumber

Facultatif

WS_2.3

zipCode

Facultatif

WS_2.3

Tableau 3 : Champs de l'élément billingAddress

Paramètres d’entrée de billingContact

Champ

Présence

A partir de la version

Commentaires

email

Facultatif

WS_2.3

firstname

Facultatif

WS_2.3

gender

Facultatif

WS_2.3

lastname

Facultatif

WS_2.3

mobile

Facultatif

WS_2.3

phone

Facultatif

WS_2.3

title

Facultatif

WS_2.3

Tableau 4 : Champs de l'élément billingContact

Paramètres d’entrée de customerAddress

Champ

Présence

A partir de la version

Commentaires

addressAdditional1

Facultatif

WS_2.3

addressAdditional2

Facultatif

WS_2.3

addressAdditional3

Facultatif

WS_2.3

city

Facultatif

WS_2.3

company

Facultatif

WS_2.3

country

Facultatif

WS_2.3

postBox

Facultatif

WS_2.3

state

Facultatif

WS_2.3

street

Facultatif

WS_2.3

streetNumber

Facultatif

WS_2.3

zipCode

Facultatif

WS_2.3

Tableau 5 : Champs de l'élément customerAddress

Paramètres d’entrée de customerContact

Champ

Présence

A partir de la version

Commentaires

email

Facultatif

WS_2.3

firstname

Facultatif

WS_2.3

gender

Facultatif

WS_2.3

lastname

Facultatif

WS_2.3

mobile

Facultatif

WS_2.3

phone

Facultatif

WS_2.3

title

Facultatif

WS_2.3

Tableau 6 : Champs de l'élément customerContact

Paramètres d’entrée de deliveryAddress

Champ

Présence

A partir de la version

Commentaires

addressAdditional1

Facultatif

WS_2.3

addressAdditional2

Facultatif

WS_2.3

addressAdditional3

Facultatif

WS_2.3

City

Facultatif

WS_2.3

company

Facultatif

WS_2.3

country

Facultatif

WS_2.3

postBox

Facultatif

WS_2.3

state

Facultatif

WS_2.3

street

Facultatif

WS_2.3

streetNumber

Facultatif

WS_2.3

zipCode

Facultatif

WS_2.3

Tableau 7 : Champs de l'élément deliveryAddress

Paramètres d’entrée de deliveryContact

Champ

Présence

A partir de la version

Commentaires

email

Facultatif

WS_2.3

firstname

Facultatif

WS_2.3

gender

Facultatif

WS_2.3

lastname

Facultatif

WS_2.3

mobile

Facultatif

WS_2.3

phone

Facultatif

WS_2.3

title

Facultatif

WS_2.3

Tableau 8 : Champs de l'élément deliveryContact

Paramètres d’entrée de fraudData

Champ

Présence

A partir de la version

Commentaires

allowedCardArea

Facultatif

WS_2.3

Pour usage futur

allowedCardCountryList

Facultatif

WS_2.3

allowedIpArea

Facultatif

WS_2.3

Pour usage futur

allowedIpCountryList

Facultatif

WS_2.3

bypass3DS

Facultatif

WS_2.3

Pour usage futur

bypassCtrlList

Facultatif

WS_2.3

bypassInfoList

Facultatif

WS_2.3

deniedCardArea

Facultatif

WS_2.3

Pour usage futur

deniedCardCountryList

Facultatif

WS_2.3

deniedIpArea

Facultatif

WS_2.3

Pour usage futur

deniedIpCountryList

Facultatif

WS_2.3

riskManagementDynamicSettingList

Facultatif

WS_2.10

Liste d’objets riskManagementDynamicSetting

Tableau 9 : Champs de l'élément fraudData

Paramètres d’entrée de riskManagementDynamicSetting

Champ

Présence

A partir de la version

Commentaires

riskManagementDynamicParam

Obligatoire

WS_2.10

riskManagementDynamicValue

Obligatoire

WS_2.10

Tableau 10 : Champs de l'élément riskManagementDynamicSetting


Paramètres d’entrée de holderAddress

Champ

Présence

A partir de la version

Commentaires

addressAdditional1

Facultatif

WS_2.3

addressAdditional2

Facultatif

WS_2.3

addressAdditional3

Facultatif

WS_2.3

city

Facultatif

WS_2.3

company

Facultatif

WS_2.3

country

Facultatif

WS_2.3

postBox

Facultatif

WS_2.3

state

Facultatif

WS_2.3

street

Facultatif

WS_2.3

streetNumber

Facultatif

WS_2.3

zipCode

Facultatif

WS_2.3

Tableau 11 : Champs de l'élément holderAddress

Paramètres d’entrée de holderContact

Champ

Présence

A partir de la version

Commentaires

email

Facultatif

WS_2.3

firstname

Facultatif

WS_2.3

gender

Facultatif

WS_2.3

lastname

Facultatif

WS_2.3

mobile

Facultatif

WS_2.3

phone

Facultatif

WS_2.3

title

Facultatif

WS_2.3

Tableau 12 : Champs de l'élément holderContact

Paramètres d’entrée de holderData

Champ

Présence

A partir de la version

Commentaires

birthCity

Facultatif

WS_2.5

Pour usage futur

birthCountry

Facultatif

WS_2.5

Pour usage futur

birthDate

Facultatif

WS_2.5

birthZipCode

Facultatif

WS_2.5

Pour usage futur

nationalityCountry

Facultatif

WS_2.5

Pour usage futur

newPwd

Facultatif

WS_2.5

Pour usage futur

pwd

Facultatif

WS_2.5

Pour usage futur

Tableau 13 : Champs de l'élément holderContact

Paramètres d’entrée de customerData

Champ

Présence

A partir de la version

Commentaires

birthCity

Facultatif

WS_2.3

Pour usage futur

birthCountry

Facultatif

WS_2.3

Pour usage futur

birthDate

Facultatif

WS_2.3

birthZipCode

Facultatif

WS_2.3

Pour usage futur

nationalityCountry

Facultatif

WS_2.3

Pour usage futur

newPwd

Facultatif

WS_2.3

Pour usage futur

pwd

Facultatif

WS_2.3

Pour usage futur

Tableau 14 : Champs de l'élément customerData

Paramètres d’entrée de authenticationData

Les paramètres d’entrée d’authenticationData incluent les éléments suivants :

  • Paramètres d’entrée cardAuthPolicy
  • Paramètres d’entrée threeD

Champ

Présence

A partir de la version

Commentaires

ignoreCSCCheckResult

Facultatif

WS_2.3

ignorePostcodeCheckResult

Facultatif

WS_2.3

ignoreAddressCheckResult

Facultatif

WS_2.3

automaticReverse

Facultatif

WS_2.3

checkAVS

Facultatif

WS_2.7

Tableau 15 : Champs de l'élément authenticationData/cardAuthPolicy

Champ

Présence

A partir de la version

Commentaires

cavv

Facultatif

WS_2.3

cavvAlgorithm

Facultatif

WS_2.3

eci

Facultatif

WS_2.3

securityIndicator

Facultatif

WS_2.3

txStatus

Facultatif

WS_2.3

xid

Facultatif

WS_2.3

Tableau 16 : Champs de l'élément authenticationData/threeD Seul le champ securityIndicator est obligatoire dans le cas d’un paiement 3D.


Paramètres d’entrée de paymentMeanData

Champ

Présence

A partir de la version

Commentaires

accord

Facultatif

WS_2.5

Voir plus bas

accordkdo

Facultatif

WS_2.5

Voir plus bas

bcacup

Facultatif

WS_2.12

Voir plus bas

cofinoga

Facultatif

WS_2.14

Voir plus bas

Tableau 17 : Champs de l'élément paymentMeanData

Paramètre d’entrée de accord

Champ

Présence

A partir de la version

Commentaires

settlementMode

Facultatif

WS_2.5

additionalAuthorisationNumber

Facultatif

WS_2.5

Tableau 18 : Champs de l'élément accord

Paramètres d’entrée de accordkdo

Champ

Présence

A partir de la version

Commentaires

settlementMode

Facultatif

WS_2.5

Tableau 19 : Champs de l'élément accordkdo

Paramètres d’entrée de bcacup

Champ

Présence

A partir de la version

Commentaires

settlementMode

Facultatif

WS_2.12

Tableau 20 : Champs de l'élément bcacup

Paramètres d’entrée de cofinoga

Champ

Présence

A partir de la version

Commentaires

settlementMode

Facultatif

WS_2.14

Tableau 21 : Champs de l'élément cofinoga

Paramètres d’entrée de shoppingCartDetail

Les paramètres d’entrée de shoppingCartDetail incluent les éléments suivants :

  • Paramètres d’entrée shoppingCartItem

Champ

Présence

A partir de la version

Commentaires

shoppingCartTotalAmount

Facultatif

WS_2.8

shoppingCartTotalQuantity

Facultatif

WS_2.8

shoppingCartTotalTaxAmount

Facultatif

WS_2.8

mainProduct

Facultatif

WS_2.8

shoppingCartItemList

Facultatif

WS_2.8

Liste d’objets shoppingCartItem

Tableau 22 : Champs de l'élément shoppingCartDetail

Paramètres d’entrée de shoppingCartItem

Champ

Présence

A partir de la version

Commentaires

productName

Facultatif

WS_2.8

productDescription

Facultatif

WS_2.8

productCode

Facultatif

WS_2.8

productSKU

Facultatif

WS_2.8

productUnitAmount

Facultatif

WS_2.8

productQuantity

Facultatif

WS_2.8

productTaxRate

Facultatif

WS_2.8

productUnitTaxAmount

Facultatif

WS_2.8

productCategory

Facultatif

WS_2.8

Tableau 23 : Champs de l'élément shoppingCartItem

Paramètres d’entrée de riskManagementCustomData

Champ

Présence

A partir de la version

Commentaires

riskManagementCustomSequence

Facultatif

WS_2.8

riskManagementCustomValue

Facultatif

WS_2.8

Tableau 24 : Champs de l'élément riskManagementCustomData


Paramètres d’entrée de subMerchantAddress

Champ

Présence

A partir de la version

Commentaires

addressAdditional1

Facultatif

WS_2.14

addressAdditional2

Facultatif

WS_2.14

addressAdditional3

Facultatif

WS_2.14

city

Facultatif

WS_2.14

company

Facultatif

WS_2.14

country

Facultatif

WS_2.14

postBox

Facultatif

WS_2.14

state

Facultatif

WS_2.14

street

Facultatif

WS_2.14

streetNumber

Facultatif

WS_2.14

zipCode

Facultatif

WS_2.14

Tableau 25 : Champs de l'élément subMerchantAddress

cardOrder - Données de sortie

La réponse à un ordre de paiement par carte inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie cardData
  • Données de sortie paymentMeanData
  • Données de sortie preAuthorisationRuleResult
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerResponseIdentifier

WS_2.5

acquirerResponseMessage

WS_2.5

acquirerResponseCode

WS_2.3

Uniquement en cas de refus lors du contrôle de pré-autorisation

authorisationId

WS_2.3

Uniquement en cas d’approbation

avsAddressResponseCode*

WS_2.3

avsPostcodeResponseCode*

WS_2.3

captureDay

WS_2.15

captureMode

WS_2.15

cardCSCResultCode

WS_2.3

cardData

WS_2.9

Voir plus bas

cardScheme

WS_2.3

complementaryCode

WS_2.3

complementaryInfo

WS_2.3

guaranteeIndicator

WS_2.3

holderAuthentRelegationCode*

WS_2.3

holderAuthentStatus*

WS_2.3

maskedPan

WS_2.3

paymentMeanBrandSelectionStatus

WS_2.13

preAuthorisationProfile

WS_2.13

preAuthorisationProfileValue

WS_2.13

preAuthorisationRuleResultList

WS_2.13

Liste d’objets preAuthorisationRuleResult ; voir plus bas

recurringResponseCode*

WS_2.3

responseCode

WS_2.3

returnContext

WS_2.3

Valeur transférée à la requête de paiement.

s10TransactionReference

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

WS_2.0

scoreColor*

WS_2.3

scoreInfo*

WS_2.3

scoreProfile*

WS_2.3

scoreThreshold*

WS_2.3

scoreValue*

WS_2.3

transactionDateTime

WS_2.3

transactionPlatform

WS_2.17

Usage futur (systématiquement valorisé à ‘PROD’ pour le moment)

transactionReference

WS_2.6

tokenPan

WS_2.3

paymentMeanData

WS_2.5

Voir 6.1.1.16

paymentMeanTradingName

WS_2.5

Tableau 26 : Champs de la réponse à une requête cardOrder

  •  : ces champs sont fournis lorsqu’ils sont disponibles, ce qui est fonction de l’état de la transaction et du moyen de paiement choisi.
Données de sortie de cardData

Champ

Présence

A partir de la version

Commentaires

cardProductCode

Facultatif

WS_2.9

cardProductName

Facultatif

WS_2.9

cardProductProfile

Facultatif

WS_2.9

cardScheme

Facultatif

WS_2.9

issuerCode

Facultatif

WS_2.9

issuerCountryCode

Facultatif

WS_2.9

Tableau 27 : Champs de l'élément cardData

Données de sortie de preAuthorisationRuleResult

Champ

Présence

A partir de la version

Commentaires

ruleCode

Facultatif

WS_2.13

ruleType

Facultatif

WS_2.13

ruleWeight

Facultatif

WS_2.13

ruleSetting

Facultatif

WS_2.13

ruleResultIndicator

Facultatif

WS_2.13

ruleDetailedInfo

Facultatif

WS_2.13

Tableau 28 : Champs de l'élément preAuthorisationRuleResult

cardOrder - Exemples

Exemple de requête cardOrder
{"amount" : "2500","captureDay" : "0","captureMode" : "AUTHOR_CAPTURE","cardCSCValue" : "0000","cardExpiryDate" : "201612","cardNumber" : "1234123412341234","currencyCode" : "978","interfaceVersion" : " IR_WS_2.3","keyVersion" : "1","merchantId" : "011223344550000","orderChannel" : "INTERNET","orderId" : " ORD101","returnContext" : " ReturnContext","transactionOrigin" : " SO_WEBAPPLI","transactionReference" : "TREFEXA2012","seal" : "2205f0636dc500c4f3ef536075895b8baba3a60c7087e06cd9d330c50a50c53e"}
Exemple de réponse à une requête cardOrder
{"acquirerResponseCode":"00","authorisationId":"123456789102","cardScheme":"MASTERCARD","complementaryCode":"","complementaryInfo":"","maskedPan":"5219##########00","responseCode":"00","returnContext":"ReturnContext","transactionDateTime":"2012-10-16T23:50:44-12:00","seal":"7ca065ebba90762e3286ee16d6a2d2da0eea8bae6b46592058933881d96d0c3d","transactionPlatform":"PROD"}

Service walletOrder

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/walletOrder Une requête d'ordre de paiement par portefeuille électronique inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée billingAddress
  • Paramètres d’entrée billingContact
  • Paramètres d’entrée customerAddress
  • Paramètres d’entrée customerContact
  • Paramètres d’entrée customerData
  • Paramètres d’entrée deliveryAddress
  • Paramètres d’entrée deliveryContact
  • Paramètres d’entrée fraudData
  • Paramètres d’entrée holderAddress
  • Paramètres d’entrée holderContact
  • Paramètres d’entrée customerData
  • Paramètres d’entrée authenticationData
  • Paramètres d’entrée s10TransactionReference
  • Paramètres d’entrée holderData
  • Paramètres d’entrée paymentMeanData
walletOrder - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.3

captureDay

Facultatif

WS_2.3

captureMode

Facultatif

WS_2.3

currencyCode

Obligatoire

WS_2.3

customerId

Facultatif

WS_2.3

customerIpAddress

Facultatif

WS_2.3

customerLanguage

Facultatif

WS_2.15

cardCSCValue

Facultatif

WS_2.3

invoiceReference

Facultatif

WS_2.3

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

merchantTransactionDateTime

Facultatif

WS_2.3

merchantWalletId

Obligatoire

WS_2.3

orderChannel

Obligatoire

WS_2.3

orderId

Facultatif

WS_2.3

paymentMeanId

Obligatoire

WS_2.3

returnContext

Facultatif

WS_2.3

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

statementReference

Facultatif

WS_2.3

transactionReference

Facultatif

WS_2.6

transactionOrigin

Facultatif

WS_2.3

paymentPattern

Facultatif

WS_2.3

Ce champ est obligatoire pour certains moyens de paiement. Pour de plus amples informations, référez-vous au guide de mise en œuvre du moyen de paiement concerné.

billingAddress

Facultatif

WS_2.3

Identique à cardOrder

billingContact

Facultatif

WS_2.3

Identique à cardOrder

customerAddress

Facultatif

WS_2.3

Identique à cardOrder

customerContact

Facultatif

WS_2.3

Identique à cardOrder

deliveryAddress

Facultatif

WS_2.3

Identique à cardOrder

deliveryContact

Facultatif

WS_2.3

Identique à cardOrder

fraudData

Facultatif

WS_2.3

Identique à cardOrder

holderAddress

Facultatif

WS_2.3

Identique à cardOrder

holderContact

Facultatif

WS_2.3

Identique à cardOrder

customerData

Facultatif

WS_2.3

Identique à cardOrder

authenticationData

Facultatif

WS_2.3

Identique à cardOrder

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

holderData

Facultatif

WS_2.17

Identique à cardOrder

paymentMeanData

Facultatif

WS_2.17

Identique à cardOrder

Tableau 29 : Champs d’une requête walletOrder

walletOrder - Données de sortie

La réponse à une requête d’ordre de paiement par portefeuille électronique inclut les éléments suivants:

  • Données de sortie par défaut
  • Données de sortie cardData
  • Données de sortie preAuthorisationRuleResult
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerResponseCode

WS_2.3

authorisationId

WS_2.3

avsAddressResponseCode*

WS_2.17

avsPostcodeResponseCode*

WS_2.17

cardCSCResultCode

WS_2.17

captureDay

WS_2.15

captureMode

WS_2.15

cardData

WS_2.9

Voir 6.1.1.26

cardScheme

WS_2.3

complementaryCode

WS_2.3

complementaryInfo

WS_2.3

maskedPan

WS_2.3

preAuthorisationProfile

WS_2.13

preAuthorisationProfileValue

WS_2.13

preAuthorisationRuleResultList

WS_2.13

Liste d’objets preAuthorisationRuleResult ; voir données de sortie de cardOrder

responseCode

WS_2.3

returnContext

WS_2.3

Valeur transférée à la requête de paiement

s10TransactionReference

WS_2.6

Voir paramètres d’entrée de cardOrder

scoreColor*

WS_2.1

scoreInfo*

WS_2.1

scoreProfile*

WS_2.1

scoreThreshold*

WS_2.1

scoreValue*

WS_2.1

seal

WS_2.0

transactionDateTime

WS_2.3

transactionPlatform

WS_2.17

Usage futur (systématiquemeent valorisé à ‘PROD’ pour le moment)

transactionReference

WS_2.6

tokenPan

WS_2.1

Tableau 30 : Champs de la réponse à une requête walletOrder

walletOrder - Exemples

Exemple de requête walletOrder
{"amount" : "2500","captureDay" : "0","captureMode" : "AUTHOR_CAPTURE","currencyCode" : "978","customerIpAddress" : "127.0.0.1","interfaceVersion" : "IR_WS_2.3","invoiceReference" : "FAC007NB","keyVersion" : "1","merchantId" : "011223344550000","merchantTransactionDateTime" : "2014-01-10T17:13:30.743+01:00","orderChannel" : "INTERNET","merchantWalletId" : "WALLET01", "paymentMeanId","10","transactionOrigin" : "SO_WEBAPPLI","transactionReference" : "TREFEXA2012", "seal" : "5bb0e9fcbb3eaa28557ac41ed6ab57ab84d9edbe9fe8eb0cedd3e8548433b7cd"}
Exemple de réponse à une requête walletOrder
{"acquirerResponseCode":"00","authorisationId":"123456789102","cardScheme":"MASTERCARD","maskedPan":"5219##########00","responseCode":"00","returnContext":"ReturnContext","transactionDateTime":"2012-10-16T23:50:44-12:00","seal":"7ca065ebba90762e3286ee16d6a2d2da0eea8bae6b46592058933881d96d0c3d","transactionPlatform":"PROD"}

Service paymentProviderInitialize

L'URL en est : https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/paymentProviderInitialize Requêtes d'initialisation de paiement pour les portefeuilles externes (Masterpass, Paylib) : Une telle requête initie une session pour le passage d’ordre de paiement par portefeuille externe. S'il s'agit d'une transaction sur un poste fixe et que l'étape d'initialisation a réussi, le commerçant reçoit en réponse une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour poursuivre la procédure de paiement. Cette redirection doit être réalisée par le biais d'un formulaire POST. Le commerçant doit également spécifier dans la requête l'URL (merchantReturnUrl) vers laquelle le client sera redirigé à la fin du paiement par portefeuille externe. Le commerçant doit ensuite appeler le service paymentProviderFinalize afin de finaliser la transaction. Une requête paymentProviderInitialize inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée authenticationData
  • Paramètres d’entrée billingAddress
  • Paramètres d’entrée billingContact
  • Paramètres d’entrée customerAddress
  • Paramètres d’entrée customerContact
  • Paramètres d’entrée customerData
  • Paramètres d’entrée deliveryAddress
  • Paramètres d’entrée deliveryContact
  • Paramètres d’entrée fraudData
  • Paramètres d’entrée holderAddress
  • Paramètres d’entrée paymentMeanData
  • Paramètres d’entrée s10TransactionReference
  • Paramètres d’entrée deliveryData
  • Paramètres d’entrée shoppingCartDetail
paymentProviderInitialize - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.3

captureDay

Facultatif

WS_2.3

captureMode

Facultatif

WS_2.3

currencyCode

Obligatoire

WS_2.3

customerId

Facultatif

WS_2.3

customerIpAddress

Facultatif

WS_2.3

customerLanguage

Facultatif

WS_2.3

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

invoiceReference

Facultatif

WS_2.3

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

merchantReturnUrl

Obligatoire

WS_2.3

merchantTransactionDateTime

Facultatif

WS_2.3

orderChannel

Obligatoire

WS_2.3

orderId

Facultatif

WS_2.3

paymentMeanBrand

Obligatoire

WS_2.3

paymentPattern

Facultatif

WS_2.3

Ce champ est obligatoire pour certains moyens de paiement. Pour de plus amples informations, référez-vous au guide de mise en œuvre du moyen de paiement concerné.

returnContext

Facultatif

WS_2.3

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

statementReference

Facultatif

WS_2.3

transactionReference

Facultatif

WS_2.6

transactionOrigin

Facultatif

WS_2.3

billingAddress

Facultatif

WS_2.3

Voir cardOrder

billingContact

Facultatif

WS_2.3

Voir cardOrder

customerAddress

Facultatif

WS_2.3

Voir cardOrder

customerContact

Facultatif

WS_2.3

Voir cardOrder

deliveryAddress

Facultatif

WS_2.3

Voir cardOrder

deliveryContact

Facultatif

WS_2.3

Voir cardOrder

authenticationData

Facultatif

WS_2.3

Voir cardOrder

customerData

Facultatif

WS_2.3

Voir cardOrder

paymentMeanData

Facultatif

WS_2.10

Voir plus bas

fraudData

Facultatif

WS_2.3

Voir cardOrder

holderAddress

Facultatif

WS_2.17

Voir paramètres d’entrée de cardOrder

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

deliveryData

Facultatif

WS_2.6

Voir duplicate

shoppingCartDetail

Facultatif

WS_2.6

Voir cardOrder

responseKeyVersion

Facultatif

WS_2.7

Tableau 34 : Champs d’une requête paymentProviderInitialize

Paramètres d’entrée de paymentMeanData

Champ

Présence

A partir de la version

Commentaires

paypal

Facultatif

WS_2.10

Voir plus bas

Tableau 35 : Champs de l'élément paymentMeanData

Paramètres d’entrée de paypal

Champ

Présence

A partir de la version

Commentaires

landingPage

Facultatif

WS_2.10

addrOverride

Facultatif

WS_2.10

invoiceId

Facultatif

WS_2.10

dupFlag

Facultatif

WS_2.10

dupDesc

Facultatif

WS_2.10

dupCustom

Facultatif

WS_2.10

dupType

Facultatif

WS_2.10

token

Facultatif

WS_2.12

deliveryAddressStatus

Facultatif

WS_2.12

payerBusiness

Facultatif

WS_2.12

payerId

Facultatif

WS_2.12

payerStatus

Facultatif

WS_2.12

payerSuffix

Facultatif

WS_2.12

payementStatus

Facultatif

WS_2.12

orderDescription

Facultatif

WS_2.14

Tableau 36 : Champs de l'élément paypal

paymentProviderInitialize - Données de sortie

La réponse à une requête paymentProviderInitialize inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

acquirerNativeResponseCode

WS_2.10

acquirerResponseIdentifier

WS_2.10

acquirerResponseMessage

WS_2.10

messageVersion

WS_2.3

outerRedirectionUrl

WS_2.9

paymentProviderSessionId

WS_2.3

redirectionData

WS_2.3

redirectionUrl

WS_2.3

responseCode

WS_2.3

seal

WS_2.0

Tableau 37 : Champs de la réponse à la requête paymentProviderInitialize

  •  : ces champs sont fournis lorsqu’ils sont disponibles, ce qui est fonction de l’état de la transaction et du moyen de paiement choisi.

paymentProviderInitialize - Exemples

Exemple de requête paymentProviderInitialize
{"amount" : "1000","captureMode" : "AUTHOR_CAPTURE","currencyCode" : "978","customerIpAddress" : "127.0.0.1","interfaceVersion" : "IR_WS_2.3","keyVersion" : "1","merchantId" : "023101122334455","merchantReturnUrl" : "http://www.yoursiteweb.com","merchantTransactionDateTime" : "2014-07-11T10:59:57.723+02:00","orderChannel" : "INTERNET","paymentMeanBrand" : "PAYLIB"," transactionReference" : "TREFEXA2012","seal" : " 95e479c276d71a07c655f3c2db1bb8b483c0921e544d4af4cff3e220b04eb551"}
Exemple de réponse à une requête paymentProviderInitialize
{"responseCode":"00","redirectionUrl":"https://payment.sips.atos.fr/paymentprovider/init","redirectionData":"RSs7cZyL1DqsVso","messageVersion":"0.1","seal":"79cf30535e08b8c6c9cfdd55c343845947f8fea892ec0ea1db96378055f71de6"}

Formulaire POST depuis le portefeuille externe


Une fois l'initialisation traitée, le site Web du commerçant doit ordonner au navigateur du porteur de carte d'envoyer le formulaire comportant messageVersion et redirectionData à l'URL reçue dans le champ redirectionUrl du service paymentProviderInitialize. Cette action doit être initiée via le navigateur du porteur de carte.

Redirection HTTP POST

Le site Web du commerçant doit construire un formulaire de redirection pour rediriger l'utilisateur final vers le site Web externe. Ce formulaire devra contenir les valeurs suivantes :

  • message_version : messageVersion retourné par le service paymentProviderInitialize.
  • redirection_data : redirectionData retourné par le service paymentProviderInitialize.
  • Le formulaire doit comporter des en-têtes Content-Type et Content-Length.

Il est conseillé d'utiliser le langage JavaScript pour cette action, mais ces implémentations doivent également fournir une solution alternative pour les environnements qui ne le gèrent pas, comme illustré dans l'exemple HTML ci-dessous.

Exemple de code de redirection HTTP POST
<html>
<head>
  <title>Title for Page</title>
</head>
<body OnLoad="OnLoadEvent();">
  <form name="downloadForm" action="REDIRECTION URL HERE (redirectionUrl)" method="POST">
    <noscript>
      <br>
        <br>
          <center>
            <h1>Processing your Transaction</h1>
            <h2>
              JavaScript is currently disabled or is not supported by your
              browser.
              <br>
            </h2>
            <h3>Please click Submit to continue the processing of your transaction.</h3>
            <input type="submit" value="Submit">
          </center>
    </noscript>
    <input type="hidden" name="message_version" value="MESSAGE VERSION HERE (messageVersion)">
    <input type="hidden" name="redirection_data" value="REDIRECTION DATA HERE (redirection_data)">
  </form>
  <SCRIPT LANGUAGE="Javascript">
    function OnLoadEvent()
    {
      document.downloadForm.submit();
    }
  </SCRIPT>
</body>
</html>
Données de sortie du formulaire POST

Une fois l'ordre de paiement traité, le client est redirigé par un formulaire POST vers l’URL spécifiée dans le champ merchantReturnUrl de la requête paymentProviderInitialize. Le commerçant doit récupérer les champs et les envoyer à la requête paymentProviderFinalized.

Champ

A partir de la version

Commentaires

merchantId

WS_2.3

messageVersion

WS_2.3

redirectionData

WS_2.3

transactionReference

WS_2_2

Tableau 38 : Champs de la réponse du formulaire POST

Service paymentProviderGetContext

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/paymentProviderGetContext Requêtes de récupération des informations du payeur (PayPal) : Cette requête est facultative et permet au commerçant de connaître l'identité et l'adresse de livraison du payeur pour les afficher avant la confirmation de la transaction. Une requête paymentProviderGetContext inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
paymentProviderGetContext : paramètres d'entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.12

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.12

merchantId

Obligatoire

WS_2.12

messageVersion

Obligatoire

WS_2.12

s10TransactionReference

Facultatif

WS_2.12

Voir cardOrder

seal

Obligatoire

WS_2.12

sealAlgorithm

Facultatif

WS_2.12

transactionReference

Facultatif

WS_2.2

redirectionData

Obligatoire

WS_2.12

Tableau 39 : Champs d’une requête paymentProviderGetContext

paymentProviderGetContext - Données de sortie

La réponse à une requête paymentProviderGetContext inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie customerAddress
  • Données de sortie customerContact
  • Données de sortie deliveryAddress
  • Données de sortie deliveryContact
  • Données de sortie holderAddress
  • Données de sortie PaymentMeanData.Paypal
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerNativeResponseCode

WS_2.12

acquirerResponseIdentifier

WS_2.12

acquirerResponseMessage

WS_2.12

customerAddress

WS_2.12

Voir 6.1.1.5

customerContact

WS_2.12

Voir 6.1.1.6

deliveryAddress

WS_2.12

Voir 6.1.1.7

deliveryContact

WS_2.12

Voir 6.1.1.8

holderAddress

WS_2.12

Voir 6.1.1.11

paymentMeanData

WS_2.12

Voir 6.1.7.2

responseCode

WS_2.12

seal

WS_2.12

Tableau 40 : Champs de la réponse à une requête paymentProviderGetContext

paymentProviderGetContext - Exemples

Exemple de requête paymentProviderGetContext
{"interfaceVersion" : "IR_WS_2.0","keyVersion" : "1","merchantId" : "011223344550000","messageVersion" : "0.1","redirectionData" : "RSs7cZy...L1DqsVso","transactionReference" : "TREFEXA2012","seal" : "30218c85ca303d33d5e7b60bb48222b9826fbc30b6c2ec98fff285702e445ae1"}
Exemple de réponse à une requête paymentProviderGetContext
{"responseCode":"00","deliveryAddress":{"addressAdditional1":"devliveryAdd11","city":"Blois","country":"FR","street":"Street","zipCode":"41000"},"deliveryContact":{"email":"team@email.com","firstname":"Team","lastname":"John","phone":"0254440000"},"customerAddress":{"addressAdditional1":"devliveryAdd11","city":"Blois","country":"FR","street":"Street","zipCode":"41000"},"customerContact":{"firstname":"Team","lastname":"BO","phone":"0254440000"},"paymentMeanData":{"paypal":{"token":"EC-4S931937D5977923H","deliveryAddressStatus":"Confirmed","payerId":"H3G7GWRLLSBDY","payerStatus":"verified","paymentStatus":"PaymentActionNotInitiated"}},"acquirerResponseMessage":"Process succeeded","acquirerResponseIdentifier":"419d14fb8a5c","seal":"18509963c41e3102967ee0ebc149165032b1b53cffec29f46d29ab37d8bc1df4"}

Service paymentProviderFinalize

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/paymentProviderFinalize Requêtes de finalisation de paiement pour les portefeuilles externes (Masterpass, Paylib) : Une telle requête est obligatoire pour connaître le résultat d'un ordre de paiement effectué par le biais d'un portefeuille externe. Elle doit être appelée une fois que le commerçant a reçu le formulaire POST du portefeuille externe via la merchantReturnUrl (voir requête paymentProviderInitialize). Une requête paymentProviderFinalize inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
paymentProviderFinalize - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

messageVersion

Obligatoire

WS_2.3

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Facultatif

WS_2.6

redirectionData

Obligatoire

WS_2.3

Tableau 41 : Champs d’une requête paymentProviderFinalize

paymentProviderFinalize - Données de sortie

La réponse à une requête paymentProviderFinalize inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie cardData
  • Données de sortie preAuthorisationRuleResult
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerNativeResponseCode

WS_2.10

acquirerResponseCode

WS_2.3

acquirerResponseIdentifier

WS_2.10

acquirerResponseMessage

WS_2.6

avsAddressResponseCode

WS_2.3

avsPostcodeResponseCode

WS_2.3

authorisationId

WS_2.3

captureLimitDate

WS_2.3

cardData

WS_2.9

Voir 6.1.1.26

complementaryCode

WS_2.3

complementaryInfo

WS_2.3

currencyCode

WS_2.3

captureDay

WS_2.3

captureMode

WS_2.3

cardExpiryDate

WS_2.3

cardCSCResultCode

WS_2.3

customerId

WS_2.3

customerIpAddress

WS_2.3

guaranteeIndicator*

WS_2.3

holderAuthentMethod*

WS_2.3

holderAuthentStatus*

WS_2.3

holderAuthentProgram*

WS_2.3

invoiceReference

WS_2.3

issuerWalletInformation

WS_2.6

maskedPan

WS_2.3

merchantId

WS_2.3

merchantTransactionDateTime

WS_2.3

orderChannel

WS_2.3

orderId

WS_2.6

panEntryMode

WS_2.3

paymentMeanBrand

WS_2.3

paymentPattern

WS_2.3

preAuthorisationProfile

WS_2.13

preAuthorisationProfileValue

WS_2.13

preAuthorisationRuleResultList

WS_2.13

Liste d’objets preAuthorisationRuleResult ; voir paramètres d’entrée de cardOrder

responseCode

WS_2.3

returnContext

WS_2.3

s10TransactionReference

WS_2.6

Voir paramètres d’entrée de cardOrder

scoreColor*

WS_2.3

scoreInfo*

WS_2.3

scoreProfile*

WS_2.3

scoreThreshold*

WS_2.3

scoreValue*

WS_2.3

seal

WS_2.0

statementReference

WS_2.3

transactionAmount

WS_2.3

transactionDateTime

WS_2.3

transactionPlatform

WS_2.17

Usage futur (systématiquement valorisé à ‘PROD’ pour le moment)

transactionReference

WS_2.3

transactionStatus

WS_2.3

walletType

WS_2.3

Tableau 42 : Champs de la réponse à une requête paymentProviderFinalize

  •  : ces champs sont fournis lorsqu’ils sont disponibles, ce qui est fonction de l’état de la transaction et du moyen de paiement choisi.

paymentProviderFinalize - Exemples

Exemple de requête paymentProviderFinalize
{"interfaceVersion" : "IR_WS_2.0","keyVersion" : "1","merchantId" : "011223344550000","messageVersion" : "0.1","redirectionData" : " RSs7cZyL1DqsVso ","transactionReference" : "TREFEXA2012","seal" : "30218c85ca303d33d5e7b60bb48222b9826fbc30b6c2ec98fff285702e445ae1"}
Exemple de réponse à une requête paymentProviderFinalize
{"responseCode":"00","captureDay":"0","currencyCode":"978","merchantId":"011223344550000","paymentPattern":"ONE_SHOT","transactionAmount":"200","transactionDateTime":"2014-01-14T08:38:11.494+01:00","transactionReference":"TREFEXA2012","seal":"79cf30535e08b8c6c9cfdd55c343845947f8fea892ec0ea1db96378055f71de6","transactionPlatform":"PROD"}

Service creditTransferInquire

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/creditTransferInquire Requêtes de récupération de la liste des banques émettrices disponibles : Actuellement, ce service n’est disponible que pour le moyen de paiement iDEAL. Cette requête permet d'obtenir une liste des banques émettrices. Si la requête a réussi, le commerçant reçoit en retour une liste de banques avec leur nom et leur code. Ces informations doivent être utilisées pour l'étape d'initialisation (creditTransferInitialize). Une requête creditTransferInquire inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
creditTransferInquire - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

currencyCode

Obligatoire

WS_2.9

customerLanguage

Facultatif

WS_2.9

interfaceVersion

Obligatoire

WS_2.9

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.9

merchantId

Obligatoire

WS_2.9

paymentMeanBrand

Obligatoire

WS_2.9

s10TransactionReference

Facultatif

WS_2.9

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Facultatif

WS_2.9

Tableau 43 : Champs d’une requête creditTransferInquire

creditTransferInquire - Données de sortie

La réponse à une requête creditTransferInquire inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie customerBank

Champ

A partir de la version

Commentaires

customerBankList

WS_2.9

errorFieldName

WS_2.9

responseCode

WS_2.9

seal

WS_2.0

Tableau 44 : Champs de la réponse à une requête creditTransferInquire

Données de sortie de customerBank

Champ

Présence

A partir de la version

Commentaires

customerBankCode

Facultatif

WS_2.9

customerBankName

Facultatif

WS_2.9

seal

Obligatoire

WS_2.0

Tableau 45 : Champs de l'élément customerBank

creditTransferInquire - Exemples

Exemple de requête creditTransferInquire
{"currencyCode" : "978","customerLanguage" : "fr","interfaceVersion" : "IR_WS_2.9","keyVersion" : "1","merchantId" : "011223344550000","paymentMeanBrand" : "IDEAL","transactionReference" : " TREFEXA2015","seal" : "ec7be3e2a0086a86f66f74bb6e10f244e51e4e648c7dbbf7c89ce9aa78a569cf"}
Exemple de réponse à une requête creditTransferInquire
{"customerBankList":[{"customerBankCode":"RABONL2U","customerBankName":"BANK - RABO"},{"customerBankCode":"INGBNL2A","customerBankName":"BANK - ING"}],"responseCode":"00","seal":"c46465d780517ce593b4bd5afe789fe58d2bc972937aaa35707ec8668265e6dc"}

Service creditTransferInitialize

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/creditTransferInitialize Requêtes d'initialisation de virement bancaire : Ce service est actuellement disponible pour les moyens de paiement iDEAL et Sofort✔berweisung. Cette requête initialise une session pour un virement bancaire. Si l'étape d'initialisation a réussi, le commerçant reçoit en retour une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour poursuivre le virement. Cette redirection doit être réalisée par le biais d'un formulaire POST. Dans la requête, le commerçant doit également indiquer l'URL (merchantReturnUrl) vers laquelle le client sera redirigé à la fin du virement bancaire externe. Le commerçant doit ensuite appeler le service creditTransferFinalizeAndOrder afin de finaliser la transaction. Une requête creditTransferInitialize inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée billingAddress
  • Paramètres d’entrée billingContact
  • Paramètres d’entrée customerAddress
  • Paramètres d’entrée customerContact
  • Paramètres d’entrée customerData
  • Paramètres d’entrée deliveryAddress
  • Paramètres d’entrée deliveryContact
  • Paramètres d’entrée fraudData
  • Paramètres d’entrée holderAddress
  • Paramètres d’entrée holderContact
  • Paramètres d’entrée s10TransactionReference
  • Paramètres d’entrée deliveryData
creditTransferInitialize - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.9

customerBankCode

Obligatoire

WS_2.9

customerBankName

Obligatoire

WS_2.9

currencyCode

Obligatoire

WS_2.9

customerId

Facultatif

WS_2.9

customerIpAddress

Facultatif

WS_2.9

customerLanguage

Facultatif

WS_2.9

interfaceVersion

Obligatoire

WS_2.9

intermediateServiceProviderId

Facultatif

WS_2.12

invoiceReference

Facultatif

WS_2.9

keyVersion

Obligatoire

WS_2.9

merchantId

Obligatoire

WS_2.9

merchantReturnUrl

Obligatoire

WS_2.9

merchantTransactionDateTime

Facultatif

WS_2.9

orderChannel

Obligatoire

WS_2.9

orderId

Facultatif

WS_2.9

paymentMeanBrand

Obligatoire

WS_2.9

paymentPattern

Facultatif

WS_2.9

returnContext

Facultatif

WS_2.9

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

statementReference

Facultatif

WS_2.9

transactionOrigin

Facultatif

WS_2.9

transactionReference

Facultatif

WS_2.9

billingAddress

Facultatif

WS_2.9

Voir cardOrder

billingContact

Facultatif

WS_2.9

Voir cardOrder

customerAddress

Facultatif

WS_2.9

Voir cardOrder

customerContact

Facultatif

WS_2.9

Voir cardOrder

deliveryAddress

Facultatif

WS_2.9

Voir cardOrder

deliveryContact

Facultatif

WS_2.9

Voir cardOrder

fraudData

Facultatif

WS_2.10

Voir cardOrder

holderAddress

Facultatif

WS_2.9

Voir cardOrder

holderContact

Facultatif

WS_2.9

Voir cardOrder

customerData

Facultatif

WS_2.9

Voir cardOrder

s10TransactionReference

Facultatif

WS_2.9

Voir paramètres d’entrée de cardOrder

Tableau 46 : Champs d’une requête creditTransferInitialize

creditTransferInitialize - Données de sortie

Champ

A partir de la version

Commentaires

errorFieldName

WS_2.9

messageVersion

WS_2.9

redirectionData

WS_2.9

redirectionUrl

WS_2.9

responseCode

WS_2.9

seal

WS_2.0

Tableau 47 : Champs de la réponse à une requête creditTransferInitialize

creditTransferInitialize - Exemples

Exemple de requête creditTransferInitialize
{"amount" : "1000","currencyCode" : "978","customerBankCode" : "RABONL2U","customerBankName" : "BANK - RABO","customerLanguage" : "fr","interfaceVersion" : "IR_WS_2.9","keyVersion" : "1","merchantId" : "011223344550000","merchantReturnUrl" : "http://www.yoursiteweb.com","merchantTransactionDateTime" : "2015-05-28T11:07:11.005+02:00","orderChannel" : "INTERNET","orderId" : "123","paymentMeanBrand" : "IDEAL","transactionReference" : " TREFEXA2015","seal" : "50e15601a2e83bcc5ffe596a51bab5b8dab2e3c62d3de2fe0d15502600f4aded"}
Exemple de réponse à une requête creditTransferInitialize
{"responseCode":"00","redirectionUrl":"https://payment-web.sips-atos.com/paymentprovider/init","redirectionData":"RSs7cZyL1D...a+hZ+1ticHD/4/s=","messageVersion":"0.1","seal":"d0814427cbd5515e78cb54476c8594eb2c1d3732a9b392afd325ebae33945069"}

Formulaire POST provenant du service externe de virement bancaire

Une fois l'initialisation traitée, le site Web commerçant doit ordonner au navigateur du porteur de carte d'envoyer le formulaire comportant messageVersion et redirectionData à l'URL reçue dans le champ redirectionUrl du service creditTransferInitialize. via le navigateur du porteur de carte.

Redirection HTTP POST

Le site Web du commerçant doit construire un formulaire de redirection pour rediriger l'utilisateur final vers le site Web externe. Ce formulaire devra contenir les valeurs suivantes :

  • message_version: messageVersion retourné par le service creditTransferInitialize.
  • redirection_data : redirectionData retourné par le service creditTransferInitialize.
  • Le formulaire doit comporter des en-têtes Content-Type et Content-Length.

Il est conseillé d'utiliser le langage JavaScript pour cette action, mais ces implémentations doivent également fournir une solution alternative pour les environnements qui ne le gèrent pas, comme illustré dans l'exemple HTML ci-dessous.

Exemple de code de redirection HTTP POST

<html> <head>

 <title>Title for Page</title>

</head> <body OnLoad="OnLoadEvent();">

 <form name="downloadForm" action="REDIRECTION URL HERE (redirectionUrl)" method="POST">
   <noscript>
     <br>
       <br>
         <center>
           <h1>Processing your Transaction</h1>
           <h2>
             JavaScript is currently disabled or is not supported by your
             browser.
             <br>
           </h2>
           <h3>Please click Submit to continue the processing of your transaction.</h3>
           <input type="submit" value="Submit">
         </center>
   </noscript>
   <input type="hidden" name="message_version" value="MESSAGE VERSION HERE (messageVersion)">
   <input type="hidden" name="redirection_data" value="REDIRECTION DATA HERE (redirection_data)">
 </form>
 <SCRIPT LANGUAGE="Javascript">
   function OnLoadEvent()
   {
     document.downloadForm.submit();
   }
 </SCRIPT>

</body> </html>

Données de sortie du formulaire POST

Une fois le virement bancaire traité, le client est redirigé vers le site Web du commerçant. Cette redirection envoie un formulaire POST vers l'URL indiquée dans le champ merchantReturnUrl de la requête creditTransferInitialize. Le commerçant doit récupérer les champs et les envoyer à la requête creditTransferFinalizeAndOrder.

Champ

A partir de la version

Commentaires

amount

WS_2.9

merchantId

WS_2.9

messageVersion

WS_2.9

redirectionData

WS_2.9

responseCode

WS_2.9

transactionDate

WS_2.9

transactionId

WS_2.9

transactionReference

WS_2_9

Tableau 48 : Champs de la réponse du formulaire POST

Service creditTransferFinalizeAndOrder

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/creditTransferFinalizeAndOrder Requêtes de finalisation de virement bancaire (iDEAL) : Ce service est actuellement disponible pour les moyens de paiement iDEAL et Sofort✔berweisung. Cette requête est obligatoire pour connaître le résultat d'un virement bancaire. Elle doit être appelée une fois que le commerçant a reçu le formulaire POST du service de virement bancaire via merchantReturnUrl (voir requête creditTransferInitialize). Une requête creditTransferFinalizeAndOrder inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
creditTransferFinalizeAndOrder - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.9

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.9

merchantId

Obligatoire

WS_2.9

messageVersion

Obligatoire

WS_2.9

redirectionData

Obligatoire

WS_2.9

seal

Obligatoire

WS_2.0

s10TransactionReference

Facultatif

WS_2.9

Voir paramètres d’entrée de cardOrder

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Facultatif

WS_2.9

Tableau 49 : Champs d’une requête creditTransferFinalizeAndOrder

creditTransferFinalizeAndOrder - Données de sortie

La réponse à une requête creditTransferFinalizeAndOrder inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie preAuthorisationRuleResult
  • Données de de s10TransactionReference

Champ

A partir de la version

Commentaires

amount

WS_2.9

authorisationId

WS_2.9

captureDay

WS_2.9

captureMode

WS_2.9

complementaryCode

WS_2.9

complementaryInfo

WS_2.9

currencyCode

WS_2.9

customerBankCode

WS_2.9

customerBankName

WS_2.9

customerId

WS_2.9

customerIpAddress

WS_2.9

errorFieldName

WS_2.9

holderAuthentMethod*

WS_2.9

holderAuthentProgram*

WS_2.9

holderAuthentStatus*

WS_2.9

invoiceReference

WS_2.9

merchantId

WS_2.9

merchantTransactionDateTime

WS_2.9

orderChannel

WS_2.9

orderId

WS_2.9

paymentMeanBrand

WS_2.9

paymentPattern

WS_2.9

preAuthorisationProfile

WS_2.13

preAuthorisationProfileValue

WS_2.13

preAuthorisationRuleResultList

WS_2.13

Liste d’objets preAuthorisationRuleResult ; voir données de sortie de cardOrder

responseCode

WS_2.9

returnContext

WS_2.9

s10TransactionReference

WS_2.9

Voir paramètres d’entrée de cardOrder

scoreColor*

WS_2.9

scoreInfo*

WS_2.9

scoreProfile*

WS_2.9

scoreThreshold*

WS_2.9

scoreValue*

WS_2.9

seal

WS_2.0

statementReference

WS_2.9

transactionDateTime

WS_2.9

transactionPlatform

WS_2.17

Usage futur (systématiquement valorisé à ‘PROD’ pour le moment)

transactionReference

WS_2.9

Tableau 50 : Champs de la réponse une requête creditTransferFinalizeAndOrder

  •  : ces champs sont fournis lorsqu’ils sont disponibles, ce qui est fonction de l’état de la transaction et du moyen de paiement choisi.

creditTransferFinalizeAndOrder - Exemples

Exemple de requête creditTransferFinalizeAndOrder
{"interfaceVersion" : "IR_WS_2.6","keyVersion" : "1","merchantId" : "011223344550000","messageVersion" : "0.1","redirectionData" : "RSs7cZyL1Dq....MzMbzqw","transactionReference" : "TREFEXA2015","seal" : "f8769766243dcb603e417556a0e1d54b29b64cb9398317af3a16eb0a19db7057"}
Exemple de réponse à une requête creditTransferFinalizeAndOrder
{"amount":1000,"customerBankCode":"RABONL2U","customerBankName":"BANK - RABO","captureDay":0,"captureMode":"AUTHOR_CAPTURE","currencyCode":"978","merchantTransactionDateTime":"2014-12-05T00:00:00+01:00","merchantId":"011223344550000","orderChannel":"INTERNET","orderId":"123","paymentMeanBrand":"IDEAL","paymentPattern":"ONE_SHOT","responseCode":"00","s10TransactionReference":{"s10TransactionId":"129192","s10TransactionIdDate":"20150528"},"transactionDateTime":"2015-05-28T11:18:26+02:00","transactionReference":"TREFEXA2015","seal":"85cd304554ebc24a60255dbb695b34c46665c6ad2f838966941ceb6dacd9e6ec","transactionPlatform":"PROD"}

Service cardCheckEnrollment

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/cardCheckEnrollment Requêtes d'initialisation de paiement par carte avec processus 3D-Secure : Sauf mention contraire, toute référence à 3-D Secure dans le présent document inclut Visa (Verified by Visa), MasterCard (SecureCode) et American Express (SafeKey). Cette requête initialise une transaction sur la plateforme Mercanet et contrôle l'inscription de la carte. Si l'étape d'inscription a réussi, le commerçant reçoit comme réponse une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour poursuivre son authentification. Cette redirection doit être réalisée par le biais d'un formulaire POST. Une requête cardCheckEnrollment inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée authenticationData
  • Paramètres d’entrée billingAddress
  • Paramètres d’entrée billingContact
  • Paramètres d’entrée customerAddress
  • Paramètres d’entrée customerContact
  • Paramètres d’entrée customerData
  • Paramètres d’entrée deliveryAddress
  • Paramètres d’entrée deliveryContact
  • Paramètres d’entrée fraudData
  • Paramètres d’entrée s10TransactionReference
  • Paramètres d’entrée deliveryData
  • Paramètres d’entrée paymentMeanData
cardCheckEnrollment - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.9

captureDay

Facultatif

WS_2.9

captureMode

Facultatif

WS_2.9

cardCSCValue

Facultatif

WS_2.9

cardExpiryDate

Facultatif

WS_2.9

cardNumber

Obligatoire

WS_2.9

currencyCode

Obligatoire

WS_2.9

customerId

Facultatif

WS_2.9

customerIpAddress

Facultatif

WS_2.9

customerLanguage

Facultatif

WS_2.9

interfaceVersion

Obligatoire

WS_2.9

intermediateServiceProviderId

Facultatif

WS_2.12

invoiceReference

Facultatif

WS_2.9

keyVersion

Obligatoire

WS_2.9

merchantId

Obligatoire

WS_2.9

merchantName

Facultatif

WS_2.9

merchantReturnUrl

Facultatif

WS_2.9

merchantTransactionDateTime

Facultatif

WS_2.9

merchantUrl

Facultatif

WS_2.9

orderChannel

Obligatoire

WS_2.9

orderId

Facultatif

WS_2.9

panType

Facultatif

WS_2.11

paymentMeanBrand

Facultatif

WS_2.13

paymentMeanBrandSelectionStatus

Facultatif

WS_2.13

Si ce champ est spécifié en entrée, paymentMeanBrand est obligatoire.

paymentPattern

Facultatif

WS_2.9

returnContext

Facultatif

WS_2.9

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

statementReference

Facultatif

WS_2.9

transactionOrigin

Facultatif

WS_2.9

transactionReference

Facultatif

WS_2.9

authenticationData

Facultatif

WS_2.9

Voir cardOrder

billingAddress

Facultatif

WS_2.9

Voir cardOrder

billingContact

Facultatif

WS_2.9

Voir cardOrder

customerAddress

Facultatif

WS_2.9

Voir cardOrder

customerContact

Facultatif

WS_2.9

Voir cardOrder

customerData

Facultatif

WS_2.9

Voir cardOrder

deliveryAddress

Facultatif

WS_2.9

Voir cardOrder

deliveryContact

Facultatif

WS_2.9

Voir cardOrder

fraudData

Facultatif

WS_2.9

Voir cardOrder

holderAddress

Facultatif

WS_2.9

Voir cardOrder

holderContact

Facultatif

WS_2.9

Voir cardOrder

s10TransactionReference

Facultatif

WS_2.9

Voir paramètres d’entrée de cardOrder

paymentMeanData

Facultatif

WS_2.18

Voir cardOrder

Tableau 51 : Champs d’une requête cardCheckEnrollment

cardCheckEnrollment - Données de sortie

La réponse à une requête cardCheckEnrollment inclut les éléments suivants :

  • Données de sortie par défaut :

Champ

A partir de la version

Commentaires

errorFieldName

WS_2.9

messageVersion

WS_2.9

paReqMessage

WS_2.9

paymentMeanBrandSelectionStatus

WS_2.13

redirectionData

WS_2.9

redirectionStatusCode

WS_2.9

redirectionUrl

WS_2.9

seal

WS_2.0

Tableau 52 : Champs de la réponse à une requête cardCheckEnrollment

cardCheckEnrollment - Exemples

Exemple de requête cardCheckEnrollment
{"amount" : "1000","captureDay" : "0","captureMode" : "AUTHOR_CAPTURE","cardCSCValue" : "123","cardExpiryDate" : "201602","cardNumber" : "1234123412341234","currencyCode" : "978","interfaceVersion" : "IR_WS_2.9","keyVersion" : "1","merchantId" : "011223344550000","merchantTransactionDateTime" : "2015-05-28T11:23:14.211+02:00","orderChannel" : "INTERNET","orderId" : "1234","transactionReference" : "TREFEXA2015","seal" : "607083393a51b4b23261270df83c28a61e06f74928bc1e868c0abb9325dde2f2"}
Exemple de réponse à une requête cardCheckEnrollment
{"redirectionUrl":"http://www.acssiteweb.com","paReqMessage":"eJxVUU1zgj...Rv8P/AJQjttc=","redirectionData":"uqjeV+Keg...MAwXk2jDJAe2TI=","redirectionStatusCode":"00","messageVersion":"0.1","seal":"3c40cf8c12a8eebdfc114c83db8f944b77932b03814d8bf43ea792c20d05e7a6"}

Service walletCheckEnrollment

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/walletCheckEnrollment Requêtes d'initialisation de paiement par portefeuille électronique avec le processus 3D-Secure : Sauf mention contraire, toute référence à 3-D Secure dans le présent document inclut Visa (Verified by Visa), MasterCard (SecureCode) et American Express (SafeKey). Cette requête initialise une transaction sur la plateforme Sips et vérifie si la carte récupérée à partir du portefeuille électronique est inscrite au programme. Si l'étape d'inscription a réussi, le commerçant reçoit comme réponse une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour poursuivre son authentification. Cette redirection doit être réalisée par le biais d'un formulaire POST. Une requête walletCheckEnrollment inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée authenticationData
  • Paramètres d’entrée billingAddress
  • Paramètres d’entrée billingContact
  • Paramètres d’entrée customerAddress
  • Paramètres d’entrée customerContact
  • Paramètres d’entrée customerData
  • Paramètres d’entrée deliveryAddress
  • Paramètres d’entrée deliveryContact
  • Paramètres d’entrée fraudData
  • Paramètres d’entrée s10TransactionReference
  • Paramètres d’entrée deliveryData
walletCheckEnrollment - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.9

captureDay

Facultatif

WS_2.9

captureMode

Facultatif

WS_2.9

cardCSCValue

Facultatif

WS_2.9

currencyCode

Obligatoire

WS_2.9

customerId

Facultatif

WS_2.9

customerIpAddress

Facultatif

WS_2.9

customerLanguage

Facultatif

WS_2.9

interfaceVersion

Obligatoire

WS_2.9

intermediateServiceProviderId

Facultatif

WS_2.12

invoiceReference

Facultatif

WS_2.9

keyVersion

Obligatoire

WS_2.9

merchantId

Obligatoire

WS_2.9

merchantName

Facultatif

WS_2.9

merchantReturnUrl

Facultatif

WS_2.9

merchantTransactionDateTime

Facultatif

WS_2.9

merchantUrl

Facultatif

WS_2.9

merchantWalletId

Obligatoire

WS_2.9

orderChannel

Obligatoire

WS_2.9

orderId

Facultatif

WS_2.9

paymentMeanId

Obligatoire

WS_2.9

paymentPattern

Facultatif

WS_2.9

returnContext

Facultatif

WS_2.9

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

statementReference

Facultatif

WS_2.9

transactionOrigin

Facultatif

WS_2.9

transactionReference

Facultatif

WS_2.9

authenticationData

Facultatif

WS_2.9

Voir cardOrder

billingAddress

Facultatif

WS_2.9

Voir cardOrder

billingContact

Facultatif

WS_2.9

Voir cardOrder

customerAddress

Facultatif

WS_2.9

Voir cardOrder

customerContact

Facultatif

WS_2.9

Voir cardOrder

customerData

Facultatif

WS_2.9

Voir cardOrder

deliveryAddress

Facultatif

WS_2.9

Voir cardOrder

deliveryContact

Facultatif

WS_2.9

Voir cardOrder

fraudData

Facultatif

WS_2.9

Voir cardOrder

holderAddress

Facultatif

WS_2.9

Voir cardOrder

holderContact

Facultatif

WS_2.9

Voir cardOrder

s10TransactionReference

Facultatif

WS_2.9

Voir paramètres d’entrée de cardOrder

Tableau 53 : Champs d’une requête walletCheckEnrollment

walletCheckEnrollment - Données de sortie

La réponse à une requête walletCheckEnrollment inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

errorFieldName

WS_2.9

messageVersion

WS_2.9

paReqMessage

WS_2.9

redirectionData

WS_2.9

redirectionStatusCode

WS_2.9

redirectionUrl

WS_2.9

seal

WS_2.0

Tableau 54 : Champs de la réponse à une requête walletCheckEnrollment

walletCheckEnrollment - Exemples

Exemple de requête walletCheckEnrollment
{"amount" : "1000","captureDay" : "0","captureMode" : "AUTHOR_CAPTURE","cardCSCValue" : "123","currencyCode" : "978","interfaceVersion" : "IR_WS_2.9","keyVersion" : "1","merchantId" : "011223344550000","merchantTransactionDateTime" : "2015-05-28T11:30:14.232+02:00","merchantWalletId" : "WALLET01","orderChannel" : "INTERNET","orderId" : "1234","paymentMeanId" : "10","transactionReference" : "TREFEXA2015","seal" : "3bfc4e958ba4ea43090db3c0c0bdba7162c92727ca1338b2111b28ddd91056a1"}
Exemple de réponse à une requête walletCheckEnrollment
{"redirectionUrl":"http://www.acssiteweb.com","paReqMessage":"eJxVUU1zgj...Rv8P/AJQjttc=","redirectionData":"uqjeV+Keg...MAwXk2jDJAe2TI=","redirectionStatusCode":"00","messageVersion":"0.1","seal":"3c40cf8c12a8eebdfc114c83db8f944b77932b03814d8bf43ea792c20d05e7a6"}

Envoi du formulaire POST à l’ACS

Le site Web du commerçant doit ordonner au navigateur du porteur de carte d'envoyer le formulaire comportant le message PAReq à l'URL ACS reçue dans le champ redirectionUrl du service cardCheckEnrollment ou walletCheckEnrollment. Cette action doit être initiée via le navigateur du porteur de carte. Conformément aux directives de mise en œuvre de 3DSecure édictées par VISA et Mastercard, cette action doit être réalisée en réduisant au minimum les interventions du porteur de carte.

Construction du formulaire de redirection

Le site Web du commerçant doit construire un formulaire PAReq pour rediriger l'utilisateur final vers l'ACS. Ce formulaire devra contenir les valeurs suivantes :

  • le message PAReq: paReqMessage renvoyé par le service cardCheckEnrollment ou walletCheckEnrollment.
  • TermUrl : l’URL du commerçant vers laquelle la réponse finale doit être envoyée après authentification de l’utilisateur final. Il doit s’agir d’une URL du site Web du commerçant.
  • le champ MD(« Merchant Data ») comporte des données sur le statut du commerçant qui doivent être retournées à ce dernier. Ce champ doit être utilisé pour récupérer la session sur le site Web du commerçant.
  • Le formulaire doit comporter des en-têtes Content-Type et Content-Length.


Il est conseillé d'utiliser le langage JavaScript pour cette action mais ces implémentations doivent également fournir une solution alternative pour les environnements qui ne le gèrent pas, comme illustré dans l'exemple HTML ci-dessous.

Exemple de code de redirection HTTP POST - PAReq
<html>
<head>
  <title>Title for Page</title>
</head>
<body OnLoad="OnLoadEvent();" >
  <form name="downloadForm" action="ACS URL HERE(redirectionUrl)" method="POST">
  <noscript>
  <br>
  <br>
  <center>
    <h1>Processing your 3-D Secure Transaction</h1>
    <h2>JavaScript is currently disabled or is not supported by your browser.<br></h2>
    <h3>Please click Submit to continue the processing of your 3-D Secure transaction.</h3>
    <input type="submit" value="Submit">
  </center>
  </noscript>
  <input type="hidden" name="PaReq" value="BASE-64 ENCODED PAREQ HERE(paReqMessage)">
  <input type="hidden" name="TermUrl" value="TERM URL HERE">
  <input type="hidden" name="MD" value="MERCHANT DATA HERE">
  </form>
<SCRIPT LANGUAGE="Javascript" >
<!--
function OnLoadEvent()
{
document.downloadForm.submit();
}
//-->
</SCRIPT>
</body>
</html>
Authentification de l’utilisateur final

L'authentification de l'utilisateur final est gérée directement sur le serveur ACS. Par conséquent, le commerçant ne peut avoir aucune influence sur cette authentification, ni sur l’aspect ou l’ergonomie de ces pages.

Redirection de l'utilisateur final vers le site du commerçant

À la fin du processus d'authentification, l'utilisateur final est redirigé vers le site du commerçant via une redirection HTTP. L'ACS enverra cette URL, via POST, les résultats de l'authentification sous forme de variables. Les variables POST seront les suivantes :

Champ

Commentaires

PARes

Doit être spécifié dans le service cardValidateAuthentication

MD

Merchant Data comporte des données sur le statut du commerçant qui doivent être retournées à ce dernier. Ce champ doit être utilisé pour récupérer la session sur le site Web du commerçant.

Tableau 55 : Champs de la réponse du formulaire POST

Service cardValidateAuthenticationAndOrder

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/cardValidateAuthenticationAndOrder Requêtes de finalisation et d'ordre de paiement avec un processus 3D-Secure : Sauf mention contraire, toute référence à 3-D Secure dans le présent document inclut Visa (Verified by Visa), MasterCard (SecureCode) et American Express (SafeKey). Cette requête est obligatoire pour l’exécution d'un ordre de paiement dans un contexte 3D-Secure (message PARes). Elle doit être effectuée une fois que le commerçant a reçu le formulaire POST de l'ACS (Access Control Server) (voir 6.1.25 Envoi du formulaire POST à l’ACS). Une requête cardValidateAuthenticationAndOrder inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
cardValidateAuthenticationAndOrder - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.9

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.9

merchantId

Obligatoire

WS_2.9

messageVersion

Obligatoire

WS_2.9

paResMessage

Obligatoire

WS_2.9

L'algorithme standard « Url Encode » doit être appliqué au champ paResMessage reçu de l’ACS.

s10TransactionReference

Facultatif

WS_2.9

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Facultatif

WS_2.9

redirectionData

Obligatoire

WS_2.9

Tableau 56 : Champs d’une requête cardValidateAuthenticationAndOrder

cardValidateAuthenticationAndOrder - Données de sortie

La réponse à une requête cardValidateAuthenticationAndOrder inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie preAuthorisationRuleResult
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerNativeResponseCode

WS_2.14

acquirerResponseCode

WS_2.9

acquirerResponseMessage

WS_2.9

amount

WS_2.9

authorisationId

WS_2.9

avsAddressResponseCode

WS_2.9

avsPostcodeResponseCode

WS_2.9

captureDay

WS_2.9

captureMode

WS_2.9

cardCSCResultCode

WS_2.9

cardExpiryDate

WS_2.9

complementaryCode

WS_2.9

complementaryInfo

WS_2.9

currencyCode

WS_2.9

customerId

WS_2.9

customerIpAddress

WS_2.9

errorFieldName

WS_2.9

guaranteeIndicator *

WS_2.9

holderAuthentMethod*

WS_2.9

holderAuthentProgram*

WS_2.9

holderAuthentRelegation*

WS_2.9

Non renvoyé si interfaceVersion est supérieur ou égal à 2.17, merci d’utiliser le champ holderAuthentRelegationCode

holderAuthentRelegationCode*

WS_2.17

holderAuthentProgram*

WS_2.9

holderAuthentResponseCode*

WS_2.9

holderAuthentStatus*

WS_2.9

invoiceReference

WS_2.9

maskedPan

WS_2.9

merchantId

WS_2.9

merchantTransactionDateTime

WS_2.9

orderChannel

WS_2.9

orderId

WS_2.9

panEntryMode

WS_2.9

paymentMeanBrand

WS_2.9

paymentMeanBrandSelectionStatus

WS_2.13

paymentPattern

WS_2.9

preAuthorisationProfile

WS_2.13

preAuthorisationProfileValue

WS_2.13

preAuthorisationRuleResultList

WS_2.13

Liste d’objets preAuthorisationRuleResult ; voir données de sortie de cardOrder

responseCode

WS_2.9

returnContext

WS_2.9

s10TransactionReference

WS_2.9

Voir paramètres d’entrée de cardOrder

scoreColor*

WS_2.9

scoreInfo*

WS_2.9

scoreProfile*

WS_2.9

scoreThreshold*

WS_2.9

scoreValue*

WS_2.9

seal

WS_2.0

statementReference

WS_2.9

tokenPan

WS_2.9

transactionDateTime

WS_2.9

transactionPlatform

WS_2.17

Usage futur (systématiquement valorisé à ‘PROD’ pour le moment)

transactionReference

WS_2.9

Tableau 57 : Champs de la réponse à une requête cardValidateAuthenticationAndOrder

  •  : ces champs sont fournis lorsqu’ils sont disponibles, ce qui est fonction de l’état de la transaction et du moyen de paiement choisi.

cardValidateAuthenticationAndOrder - Exemples

Exemple de requête cardValidateAuthenticationAndOrder
{"interfaceVersion" : "IR_WS_2.9","keyVersion" : "1","merchantId" : "011223344550000","messageVersion" : "0.1","paResMessage" : "eJydVV...0t+v+W/v/D/BbSqpU8=","redirectionData" : "uqjeV+KegCSM0POI...CjVUfxqyFq7zSYus7E=","transactionReference" : "TREFEXA2015","seal" : "9565b71cb583f025278de91940c69900dee72d91e8184ddb6547f00927597fd1"}
Exemple de réponse à une requête cardValidateAuthenticationAndOrder
{"amount":1000,"authorisationId":"010628","avsAddressResponseCode":"1","avsPostcodeResponseCode":"1","captureDay":0,"captureMode":"AUTHOR_CAPTURE","cardExpiryDate":"201602","currencyCode":"978","holderAuthentStatus":"3D_SUCCESS","guaranteeIndicator":"Y","maskedPan":"4907##########00","merchantId":"011223344550000","orderChannel":"INTERNET","orderId":"1234","paymentMeanBrand":"VISA","responseCode":"00","transactionDateTime":"2015-05-28T12:38:25+03:00","transactionReference":"TREFEXA2015","s10TransactionReference":{"s10TransactionId":"129306","s10TransactionIdDate":"20150528"},"seal":"ef3f3cc68a39a5d1144663162a35fa6070bfe39d5abbe672b15417ff87afc431","transactionPlatform":"PROD"}

Service cardValidateAuthentication

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/checkout/cardValidateAuthentication Requêtes de validation d'authentification 3D-Secure : Sauf mention contraire, toute référence à 3-D Secure dans le présent document inclut Visa (Verified by Visa), MasterCard (SecureCode) et American Express (SafeKey). Cette requête est obligatoire pour vérifier l'ensemble de l'authentification 3D-Secure (avec un message PARes). Elle doit être effectuée une fois que le commerçant a reçu le formulaire POST de l'ACS (Access Control Server) (voir 6.1.25 « Envoi du formulaire POST à l’ACS »). Une requête cardValidateAuthentication inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
cardValidateAuthentication - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.9

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.9

merchantId

Obligatoire

WS_2.9

messageVersion

Obligatoire

WS_2.9

paResMessage

Obligatoire

WS_2.9

L'algorithme standard « Url Encode » doit être appliqué au champ paResMessage reçu de l’ACS.

s10TransactionReference

Facultatif

WS_2.9

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Facultatif

WS_2.9

redirectionData

Obligatoire

WS_2.9

Tableau 58 : Champs d’une requête cardValidateAuthentication

cardValidateAuthentication - Données de sortie

La réponse à une requête cardValidateAuthentication inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

holderAuthentResponseCode

WS_2.9

responseCode

WS_2.9

seal

WS_2.0

Tableau 59 : Champs de la réponse à une requête cardValidateAuthentication

cardValidateAuthentication - Exemples

Exemple de requête cardValidateAuthentication
{"interfaceVersion" : "IR_WS_2.9","keyVersion" : "1","merchantId" : "011223344550000","messageVersion" : "0.1","paResMessage" : "eJydVV...0t+v+W/v/D/BbSqpU8=","redirectionData" : "uqjeV+KegCSM0POI...CjVUfxqyFq7zSYus7E=","transactionReference" : "TREFEXA2015","seal" : "9565b71cb583f025278de91940c69900dee72d91e8184ddb6547f00927597fd1"}
Exemple de réponse à une requête cardValidateAuthentication
{"responseCode":"00","holderAuthentResponseCode":"00,"seal":"ef3f3cc68a39a5d1144663162a35fa6070bfe39d5abbe672b15417ff87afc431"}

Description du service Web cashManagement

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement Ce service vous permet d’effectuer des opérations sur les transactions existantes. Par exemple, les opérations d’annulation et de remboursement ne sont pas indépendantes : elles doivent s'appliquer à une transaction. La valeur du champ interfaceVersion est fixée à CR_WS_2.18

Service acceptChallenge

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/acceptChallenge Cette fonction permet au commerçant d'accepter la contestation d’une transaction. Une fois la contestation validée, la transaction reprend son cours normal.

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
acceptChallenge - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

comment

Facultatif

WS_2.6

interfaceVersion

Obligatoire

WS_2.6

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.6

merchantId

Obligatoire

WS_2.6

operationOrigin

Facultatif

WS_2.6

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Facultatif

WS_2.6

validationIndicator

Facultatif

WS_2.6

Valeurs acceptées : « Y » et « N »

Tableau 60 : Champs de l'opération acceptChallenge

acceptChallenge - Données de sortie

La réponse à une requête acceptChallenge inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

acquirerResponseCode

WS_2.6

authorisationId

WS_2.6

captureLimitDate

WS_2.6

newStatus

WS_2.6

operationDateTime

WS_2.6

responseCode

WS_2.6

seal

WS_2.0

Tableau 61: Champs de la réponse à l’opération acceptChallenge

acceptChallenge - Exemples

Exemple de requête acceptChallenge
{"comment" : "good id","interfaceVersion" : "CR_WS_2.6","keyVersion" : "1","merchantId" : "011223344550000","operationOrigin" : "SIPS-SIM","transactionReference" : "SIM20140121510382","validationIndicator" : "Y","seal" : "e746314133f7aaabd8ac33db0daf941eda744e8ff70b700490792ffe3480087d"}
Exemple de réponse à une requête acceptChallenge
{"acquirerResponseCode":”00”, "authorisationId":”123”, "captureLimitDate":”1”, "operationDateTime":"2014-10-16T23:51:42-12:00","responseCode":"00","newStatus" : "VALIDATED","seal":"919b544bfb60539c8979992bc469e0b4229030ee2462a51f62c9cbd3510b3647"}

Service cancel

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/cancel Cette fonction permet de modifier le montant d'une transaction ou d'annuler une transaction à envoyer en banque. Une requête cancel inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference

? Remarque

Toute opération d'annulation envoyée entre 22h et 23h (heure locale française) entraînera automatiquement l'envoi en retour du code de réponse 24 ; l'opération ne sera pas traitée.




cancel - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

operationAmount

Obligatoire

WS_2.3

currencyCode

Obligatoire

WS_2.3

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

operationOrigin

Facultatif

WS_2.3

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Facultatif

WS_2.6

Tableau 62 : Champs de l'opération cancel

cancel - Données de sortie

La réponse à une requête cancel inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

newAmount

WS_2.3

newStatus

WS_2.3

operationDateTime

WS_2.3

responseCode

WS_2.3

seal

WS_2.0

Tableau 63 : Champs de la réponse à une opération cancel

cancel - Exemples

Exemple de requête cancel
{"currencyCode" : "978","interfaceVersion" : "CR_WS_2.3","merchantId" : "011223344550000","operationAmount" : "120","operationOrigin" : "SO_BATCH","transactionReference" : "TREFEXA2012","keyVersion" : "1","seal" : "bed2f99d4137d402fde0c86a182f7d4f01c68e57d8a073fe5e920c57d06da1b5"}
Exemple de réponse à une requête cancel
{"newAmount":0,"operationDateTime":"2012-10-16T23:51:42-12:00","responseCode":"00","newStatus" : "CANCELLED","seal":"919b544bfb60539c8979992bc469e0b4229030ee2462a51f62c9cbd3510b3647"}

Service creditHolder

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/creditHolder

Cette fonction permet aux commerçants qui disposent des coordonnées bancaires de leurs clients de créditer leur compte sans transaction préalable.

Une requête creditHolder inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée subMerchantAddress
  • Paramètres d’entrée s10TransactionReference
creditHolder - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.0

cardEffectiveDate

Facultatif

WS_2.0

cardExpiryDate

Obligatoire

WS_2.0

cardNumber

Obligatoire

WS_2.0

cardScheme

Facultatif

WS_2.0

cardSeqNumber

Facultatif

WS_2.0

currencyCode

Obligatoire

WS_2.0

customerEmail

Facultatif

WS_2.0

customerId

Facultatif

WS_2.0

customerIpAddress

Facultatif

WS_2.0

interfaceVersion

Obligatoire

WS_2.0

subMerchantAddress

Facultatif

WS_2.14

Voir 6.1.1.23

subMerchantCategoryCode

Facultatif

WS_2.14

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.0

merchantId

Obligatoire

WS_2.0

subMerchantLegalId

Facultatif

WS_2.14

subMerchantShortName

Facultatif

WS_2.14

orderChannel

Obligatoire

WS_2.0

orderId

Facultatif

WS_2.0

returnContext

Facultatif

WS_2.0

panType

Facultatif

WS_2.1

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

subMerchantId

Facultatif

WS_2.14

transactionOrigin

Facultatif

WS_2.0

transactionReference

Facultatif

WS_2.6

Tableau 64 : Champs de l'opération creditHolder

creditHolder - Données de sortie

La réponse à une requête creditHolder inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerResponseCode

WS_2.0

authorisationId

WS_2.0

maskedPan

WS_2.0

newStatus

WS_2.0

operationDateTime

WS_2.0

responseCode

WS_2.0

s10TransactionReference

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

WS_2.0

transactionPlatform

WS_2.17

Usage futur (systématiquement valorisé à ‘PROD’ pour le moment)

transactionReference

WS_2.6

Tableau 65 : Champs de la réponse à une requête creditHolder

creditHolder - Exemples

Exemple de requête creditHolder
{"amount" : "1000","cardExpiryDate" : "201508","cardNumber" : "4907000000000600","currencyCode" : "978","customerEmail" : "moi@mail.com","customerId" : "customerId1","customerIpAddress" : "127.0.0.1","interfaceVersion" : "CR_WS_2.6","keyVersion" : "1","merchantId" : "011223344550000","orderChannel" : "INTERNET","orderId" : "123","panType" : "PAN","returnContext" : "my return context","transactionOrigin" : "SIPS-SIM","transactionReference" : "SIM2014012248339","seal" : "5227610a0f14cc30872dffb60c2dae6a85c9e3f1e487ff29c307c2c05b93567d"}
Exemple de réponse à une requête creditHolder
{"maskedPan":"4907##########00","newStatus":"TO_CREDIT","operationDateTime":"2014-12-24T09:34:09+02:00","responseCode":"00","s10TransactionReference":{"s10TransactionId":"5","s10TransactionIdDate":"20141224"},"transactionReference":"SIM2014012248339","seal":"cca287c6f011ea942bb850fddc7eba495519a35cf0a73b7aab2b99800b5969bd","transactionPlatform":"PROD"}

Service duplicate

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/duplicate Cette fonction permet de créer une nouvelle transaction en utilisant les données bancaires d’une transaction existante. Une requête duplicate inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée authenticationData
  • Paramètres d’entrée deliveryAddress
  • Paramètres d’entrée deliveryContact
  • Paramètres d’entrée deliveryData
  • Paramètres d’entrée fraudData
  • Paramètres d’entrée holderAddress
  • Paramètres d’entrée subMerchantAddress
  • Paramètres d’entrée s10TransactionReference
  • Paramètres d’entrée s10FromTransactionReference
  • Paramètres d’entrée shoppingCartDetail
  • Paramètres d’entrée paymentMeanData
duplicate - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.3

authenticationData

Facultatif

WS_2.17

Se référer à 6.2.7.8

captureDay

Obligatoire

WS_2.3

captureMode

Obligatoire

WS_2.3

currencyCode

Obligatoire

WS_2.3

customerEmail

Facultatif

WS_2.3

customerId

Facultatif

WS_2.3

customerIpAddress

Facultatif

WS_2.3

deliveryAddress

Facultatif

WS_2.1

Voir 6.1.1.7

deliveryContact

Facultatif

WS_2.1

Voir 6.1.1.8

deliveryData

Facultatif

WS_2.5

Voir plus bas

fromMerchantId

Obligatoire

WS_2.3

fromTransactionReference

Obligatoire

WS_2.3

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.3

subMerchantAddress

Facultatif

WS_2.14

Voir paramètres d’entrée de cardOrder

subMerchantCategoryCode

Facultatif

WS_2.14

merchantId

Obligatoire

WS_2.3

subMerchantLegalId

Facultatif

WS_2.14

subMerchantShortName

Facultatif

WS_2.14

merchantTransactionDateTime

Facultatif

WS_2.3

orderChannel

Facultatif

WS_2.3

orderId

Facultatif

WS_2.3

returnContext

Obligatoire

WS_2.3

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

s10FromTransactionReference

Facultatif

WS_2.6

Voir plus bas

holderAddress

Facultatif

WS_2.17

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

shoppingCartDetail

Facultatif

WS_2.5

Voir plus bas

statementReference

Facultatif

WS_2.2

subMerchantId

Facultatif

WS_2.14

transactionOrigin

Facultatif

WS_2.3

transactionReference

Facultatif

WS_2.3

fraudData

Facultatif

WS_2.3

Voir 6.1.1.9

paymentMeanData

Facultatif

WS_2.12

Voir 6.2.7.6

Tableau 66 : Champs de l'opération duplicate

Paramètres d’entrée de deliveryData

Champ

Présence

A partir de la version

Commentaires

deliveryChargeAmount

Facultatif

WS_2.5

deliveryMethod

Facultatif

WS_2.5

deliveryMode

Facultatif

WS_2.5

deliveryOperator

Facultatif

WS_2.5

estimatedDeliveryDate

Facultatif

WS_2.5

estimatedDeliveryDelay

Facultatif

WS_2.6

Tableau 67 : Champs de l'élément deliveryData

Paramètres d’entrée de s10FromTransactionReference

Champ

Présence

A partir de la version

Commentaires

s10FromTransactionId

Facultatif

WS_2.6

S10FromTransactionIdDate

Facultatif

WS_2.6

Tableau 68 : Champs de l'élément s10FromTransactionReference

Paramètres d’entrée de shoppingCartDetail

Champ

Présence

A partir de la version

Commentaires

shoppingCartTotalAmount

Facultatif

WS_2.5

shoppingCartTotalQuantity

Facultatif

WS_2.5

shoppingCartTotalTaxAmount

Facultatif

WS_2.6

mainProduct

Facultatif

WS_2.5

shoppingCartItemList

Facultatif

WS_2.5

Voir plus bas

Tableau 69 : Champs de l'élément shoppingCartDetail

Paramètres d’entrée de shoppingCartItem

Champ

Présence

A partir de la version

Commentaires

productName

Facultatif

WS_2.5

productDescription

Facultatif

WS_2.5

productCode

Facultatif

WS_2.5

productSKU

Facultatif

WS_2.5

productUnitAmount

Facultatif

WS_2.5

productQuantity

Facultatif

WS_2.5

productTaxRate

Facultatif

WS_2.5

productUnitTaxAmount

Facultatif

WS_2.5

productCategory

Facultatif

WS_2.5

Tableau 70 : Champs de l'élément shoppingCartItem

Paramètres d’entrée de paymentMeanData

Champ

Présence

A partir de la version

Commentaires

bcacup

Facultatif

WS_2.12

Voir plus bas

Tableau 71: Champs de l'élément paymentMeanData

Paramètres d’entrée de bcacup

Champ

Présence

A partir de la version

Commentaires

settlementMode

Facultatif

WS_2.12

Tableau 72 : Champs de l'élément bcacup

Paramètres d’entrée de authenticationData

L’entrée authenticationData inclut les éléments suivants :

  • Entrées cardAuthPolicy

Champ

Présence

A partir de la version

Commentaires

ignorePostcodeCheckResult

Facultatif

WS_2.3

ignoreAddressCheckResult

Facultatif

WS_2.3

automaticReverse

Facultatif

WS_2.3

checkAVS

Facultatif

WS_2.7

Tableau 73 : Champs de l'élément authenticationData/cardAuthPolicy

duplicate - Données de sortie

La réponse à une requête duplicate inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie cardData
  • Données de sortie preAuthorisationRuleResult
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerResponseCode

WS_2.3

authorisationId

WS_2.3

scoreColor*

WS_2.3

cardData

WS_2.9

Voir 6.1.1.26

complementaryCode

WS_2.3

complementaryInfo

WS_2.3

maskedPan

WS_2.1

panExpiryDate

WS_2.1

paymentMeanBrand

WS_2.1

paymentMeanBrandSelectionStatus

WS_2.13

preAuthorisationProfile

WS_2.13

preAuthorisationProfileValue

WS_2.13

preAuthorisationRuleResultList

WS_2.13

Liste d’objets preAuthorisationRuleResult, voir données de sortie de cardOrder

s10TransactionReference

WS_2.6

Voir paramètres d’entrée de cardOrder

scoreInfo*

WS_2.3

scoreProfile*

WS_2.3

scoreThreshold*

WS_2.3

scoreValue

WS_2.3

seal

WS_2.0

responseCode

WS_2.3

transactionDateTime

WS_2.3

transactionPlatform

WS_2.17

Usage futur (systématiquement valorisé à ‘PROD’ pour le moment)

transactionReference

WS_2.6

Tableau 74 : Champs de la réponse à une requête duplicate

  • ces champs sont fournis lorsqu’ils sont disponibles, ce qui est fonction de l’état de la transaction et du moyen de paiement choisi.

duplicate - Exemples

Exemple de requête duplicate
{"amount" : "1000","currencyCode" : "978","captureDay" : "0","captureMode" : "AUTHOR_CAPTURE","customerEmail" : "customer@email.com","customerId" : "654321","customerIpAddress" : "127.0.0.1","interfaceVersion" : " CR_WS_2.3","merchantId" : "011223344550000","orderChannel" : "INTERNET","orderId" : "123456","returnContext" : "ReturnContext","transactionOrigin" : "SO_BATCH","fromTransactionReference" : "TREFEXA20122"","transactionReference" : "TREFEXA20121","keyVersion" : "1","seal" : "db2bbdd9550b5b7dc316d4b2859a0c45189aeaaf46b899cd90d5bde272e6ae24"}
Exemple de réponse à une requête duplicate
{"acquirerResponseCode":"00","authorisationId":"069308","responseCode":"00","transactionDateTime":"2012-10-16T23:48:14-12:00","seal":"0fdd9a35319712a9feff14eee0f68bbd35bd8fb6000819b2d5cd17b2704d6b6f"","transactionPlatform":"PROD"}

Service referral

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/referral Ce service permet de forcer une transaction. Une requête referral inclut les éléments suivants :

  • Paramètres d’entrée par défaut
referral - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

authorisationId

Obligatoire

WS_2.3

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

operationOrigin

Facultatif

WS_2.3

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Obligatoire

WS_2.3

Tableau 75 : Champs de l'opération referral

referral - Données de sortie

La réponse à une requête referral inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

newAmount

WS_2.3

newStatus

WS_2.3

operationDateTime

WS_2.3

responseCode

WS_2.3

seal

WS_2.0

Tableau 76 : Champs de la réponse à une requête referral

referral - Exemples

Exemple de requête referral
{"authorisationId" : "112598470074","interfaceVersion" : "CR_WS_2.3","merchantId" : "011223344550000","operationOrigin" : "SO_BATCH","transactionReference" : "TREFEXA2012","keyVersion" : "1","seal" : "2f0bff22f589a32b0f94037b1040da9d2006e70b8c969f8952c3203619a229ff"}
Exemple de réponse à une requête referral
{"newAmount":0,"operationDateTime":"2012-10-16T23:45:34-12:00","responseCode":"00","newStatus" : "TO_CAPTURE","seal":"919b544bfb60539c8979992bc469e0b4229030ee2462a51f62c9cbd3510b3647"}

Service refund

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/refund Cette fonction permet de recréditer le compte de l'acheteur.Une requête refund inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée paymentMeanData
  • Paramètres d’entrée s10TransactionReference
  • Paramètres d’entrée shoppingCartDetail

? Remarque

Toute opération de remboursement envoyée entre 22 h et 23 h (heure locale française) entraînera automatiquement l'envoi en retour du code de réponse 24 ; l'opération ne sera pas traitée.




refund - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

operationAmount

Obligatoire

WS_2.3

currencyCode

Obligatoire

WS_2.3

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

operationOrigin

Facultatif

WS_2.3

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

transactionReference

Facultatif

WS_2.6

paymentMeanData

Facultatif

WS_2.5

Voir plus bas

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

shoppingCartDetail

Facultatif

WS_2.11

Voir cardOrder

Tableau 77 : Champs de l'opération refund

Paramètres d’entrée de paymentMeanData

Champ

Présence

A partir de la version

Commentaires

facilypay

Facultatif

WS_2.5

Voir 6.2.11.3

Tableau 78 : Champs de l'élément paymentMeanData

Paramètres d’entrée de facilypay

Champ

Présence

A partir de la version

Commentaires

depositRefundIndicator

Facultatif

WS_2.5

Tableau 79 : Champs de l'élément facilypay

refund - Données de sortie

La réponse à une requête refund inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

acquirerResponseCode

WS_2.3

authorisationId

WS_2.3

newAmount

WS_2.3

newStatus

WS_2.3

operationDateTime

WS_2.3

responseCode

WS_2.3

seal

WS_2.0

Tableau 80 : Champs de la réponse à une requête refund

refund - Exemples

Exemple de requête refund
{"currencyCode" : "978","interfaceVersion" : "CR_WS_2.3","merchantId" : "011223344550000","operationAmount" : "1000","operationOrigin" : "SO_BATCH","transactionReference" : "TREFEXA2012","keyVersion" : "1","seal" : "bed2f99d4137d402fde0c86a182f7d4f01c68e57d8a073fe5e920c57d06da1b5"}
Exemple de réponse à une requête refund
{"acquirerResponseCode":"00","authorisationId":"123456789102","newAmount":0,"operationDateTime":"2012-10-16T23:45:34-12:00","responseCode":"00","newStatus" : "TO_CREDIT","seal":"919b544bfb60539c8979992bc469e0b4229030ee2462a51f62c9cbd3510b3647"}

Service refuseChallenge

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/refuseChallenge

Cette fonction permet au commerçant de refuser la contestation d’une transaction. Une fois la contestation refusée, la transaction est refusée.
  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
refuseChallenge - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

comment

Facultatif

WS_2.6

interfaceVersion

Obligatoire

WS_2.6

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.6

merchantId

Obligatoire

WS_2.6

operationOrigin

Facultatif

WS_2.6

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Facultatif

WS_2.6

Tableau 81 : Champs de l'opération refuseChallenge

refuseChallenge - Données de sortie

La réponse à une requête refuseChallenge inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

newStatus

WS_2.6

operationDateTime

WS_2.6

responseCode

WS_2.6

seal

WS_2.0

Tableau 82 : Champs de la réponse à une requête refuseChallenge

refuseChallenge - Exemples

Exemple de requête refuseChallenge
{"comment" : "bad id","interfaceVersion" : "CR_WS_2.6","keyVersion" : "1","merchantId" : "011223344550000","operationOrigin" : "SIPS-SIM","transactionReference" : "SIM20140121510382","seal" : "c36bcfaf3c05ef257795149686c53022f212e05c6fac98d0169c5e9313941444"}
Exemple de réponse à une requête refuseChallenge
 {"operationDateTime":"2014-10-16T23:51:42-12:00","responseCode":"00","newStatus" : "REFUSED","seal":"919b544bfb60539c8979992bc469e0b4229030ee2462a51f62c9cbd3510b3647"}

Service validate

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/validate Cette fonction permet d’initier l’envoi d’une transaction en banque. Une requête validate inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée subMerchantAddress
  • Paramètres d’entrée s10TransactionReference
validate - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

operationAmount

Obligatoire

WS_2.3

currencyCode

Obligatoire

WS_2.3

keyVersion

Obligatoire

WS_2.3

subMerchantAddress

Facultatif

WS_2.14

Voir paramètres d’entrée de cardOrder

subMerchantCategoryCode

Facultatif

WS_2.14

merchantId

Obligatoire

WS_2.3

subMerchantLegalId

Facultatif

WS_2.14

subMerchantShortName

Facultatif

WS_2.14

operationOrigin

Facultatif

WS_2.3

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

subMerchantId

Facultatif

WS_2.14

transactionReference

Facultatif

WS_2.6

lastRecoveryIndicator

Facultatif

WS_2.16

Tableau 83 : Champs de l'opération validate

validate - Données de sortie

La réponse à une requête validate inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

acquirerResponseCode

WS_2.3

authorisationId

WS_2.3

newAmount

WS_2.3

newStatus

WS_2.3

operationDateTime

WS_2.3

responseCode

WS_2.3

seal

WS_2.0

captureLimitDate

WS_2.0

Tableau 84 : Champs de la réponse à une requête validate

validate - Exemples

Exemple de requête validate
{"currencyCode" : "978","interfaceVersion" : "CR_WS_2.3","merchantId" : "011223344550000","operationAmount" : "1200","operationOrigin" : "SO_BATCH","transactionReference" : "TREFEXA2012","keyVersion" : "1","seal" : "bed2f99d4137d402fde0c86a182f7d4f01c68e57d8a073fe5e920c57d06da1b5"}
Exemple de réponse à une requête validate
{"acquirerResponseCode":"00","authorisationId":"123456789102","newAmount":1000,"operationDateTime":"2012-10-16T23:53:19-12:00","responseCode":"00","newStatus" : "TO_CAPTURE","seal":"919b544bfb60539c8979992bc469e0b4229030ee2462a51f62c9cbd3510b3647"}


Service recycle

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/recycle Cette fonction permet de créer une nouvelle transaction en utilisant les données bancaires d’une transaction existante. Cette opération est similaire à l'opération duplicate mais comporte certaines restrictions. Une requête recycle inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
recycle - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.3

captureDay

Facultatif

WS_2.3

captureMode

Facultatif

WS_2.3

currencyCode

Obligatoire

WS_2.3

fromTransactionReference

Obligatoire

WS_2.3

Voir duplicate

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.0

merchantId

Obligatoire

WS_2.3

merchantTransactionDateTime

Facultatif

WS_2.0

s10FromTransactionReference

Facultatif

WS_2.6

Voir duplicate

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

statementReference

Facultatif

WS_2.0

transactionOrigin

Facultatif

WS_2.0

transactionReference

Facultatif

WS_2.6

lastRecoveryIndicator

Facultatif

WS_2.17

Tableau 85 : Champs de l'opération recycle

recycle - Données de sortie

La réponse à une requête recycle inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie cardData
  • Données de sortie preAuthenticationRuleResult
  • Données de sortie preAuthorisationRuleResult
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerResponseCode

WS_2.3

authorisationId

WS_2.3

cardData

WS_2.9

Voir 6.1.1.26

complementaryCode

WS_2.3

complementaryInfo

WS_2.3

maskedPan

WS_2.3

panExpiryDate

WS_2.3

paymentMeanBrand

WS_2.3

paymentMeanBrandSelectionStatus

WS_2.13

preAuthenticationColor

WS_2.13

preAuthenticationInfo

WS_2.13

preAuthenticationProfile

WS_2.13

preAuthenticationProfileValue

WS_2.13

preAuthenticationRuleResultList

WS_2.13

Voir 6.2.17.3

preAuthenticationThreshold

WS_2.13

preAuthenticationValue

WS_2.13

preAuthorisationProfile

WS_2.13

preAuthorisationProfileValue

WS_2.13

preAuthorisationRuleResultList

WS_2.13

Liste d’objets preAuthorisationRuleResult ; voir données de sortie de cardOrder,

responseCode

WS_2.3

s10TransactionReference

WS_2.6

Voir paramètres d’entrée de cardOrder

scoreColor

WS_2.3

scoreInfo

WS_2.3

scoreProfile

WS_2.3

scoreThreshold

WS_2.3

scoreValue

WS_2.3

seal

|WS_2.0

transactionDateTime

WS_2.3

transactionPlatform

WS_2.17

Usage futur (systématiquement valorisé à ‘PROD’ pour le moment)

transactionReference

WS_2.6

Tableau 86 : Champs de la réponse à la requête recycle

Données de sortie de preAuthenticationRuleResult

Champ

A partir de la version

Commentaires

ruleCode

WS_2.13

ruleType

WS_2.13

ruleWeight

WS_2.13

ruleSetting

WS_2.13

ruleResultIndicator

WS_2.13

ruleDetailedInfo

WS_2.13

Tableau 87 : Champs de l’élément preAuthenticationRuleResult

recycle - Exemples

Exemple de requête recycle
{"amount" : "1000","captureMode" : "AUTHOR_CAPTURE","currencyCode" : "978","fromTransactionReference" : "SIM2014082813176","interfaceVersion" : "CR_WS_2.0","merchantId" : "011223344550000","merchantTransactionDateTime" : "2014-08-28T13:17:16.480+02:00","transactionOrigin" : "SIPS-SIM","transactionReference" : "SIM20140828131716","seal" : "bab5067f4fa23924cd80f35d5585519a563ff261f38dfa9b74fbb76888b00b64","keyVersion" : "1"}
Exemple de réponse à une requête recycle
{"acquirerResponseCode":"00","authorisationId":"736256","maskedPan":"4541##########00","panExpiryDate":"201504","paymentMeanBrand":"VISA","scoreValue":"-2.3","scoreColor":"RED","scoreInfo":"A3;N;NOT_APPLICABLE#WN;P;U#BN;N;U#GN;N;U#SC;N;TRANS=3:2;CUMUL=3000:250000","scoreProfile":"myprofSco","scoreThreshold":"-3.0","responseCode":"00","transactionDateTime":"2014-08-28T13:20:45+02:00","seal":"df0c23e0a60a745f1f546168fafedb7ae547912473d76c93ee52d31b9d714765","transactionPlatform":"PROD"}}

Service walletCreditHolder

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/cashManagement/walletCreditHolder Cette fonction permet aux commerçants qui disposent des données de portefeuille de leurs clients de créditer leur compte sans transaction préalable. Une requête walletCreditHolder inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
Paramètres d’entrée par défaut de walletCreditHolder

Champ

Présence

A partir de la version

Commentaires

amount

Obligatoire

WS_2.9

currencyCode

Obligatoire

WS_2.9

customerEmail

Facultatif

WS_2.9

customerId

Facultatif

WS_2.9

customerIpAddress

Facultatif

WS_2.9

interfaceVersion

Obligatoire

WS_2.9

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.0

merchantId

Obligatoire

WS_2.9

merchantWalletId

Obligatoire

WS_2.9

orderChannel

Obligatoire

WS_2.9

orderId

Facultatif

WS_2.9

paymentMeanId

Obligatoire

WS_2.9

returnContext

Facultatif

WS_2.9

s10TransactionReference

Facultatif

WS_2.9

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionOrigin

Facultatif

WS_2.9

transactionReference

Facultatif

WS_2.9

Tableau 88 : Champs de l'opération walletCreditHolder

Données de sortie de walletCreditHolder

La réponse à une requête wallerCreditHolder inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerResponseCode

WS_2.9

authorisationId

WS_2.9

maskedPan

WS_2.9

newStatus

WS_2.9

operationDateTime

WS_2.9

paymentMeanBrand

WS_2.9

responseCode

WS_2.9

s10TransactionReference

WS_2.9

Voir paramètres d’entrée de cardOrder

seal

WS_2.0

transactionPlatform

WS_2.17

Usage futur (systématiquement valorisé à ‘PROD’ pour le moment)

transactionReference

WS_2.9

Tableau 89: Champs de la réponse à une requête walletCreditHolder

walletCreditHolder - Exemples

Exemple de requête walletCreditHolder
{"amount" : "1000","currencyCode" : "978","customerEmail" : "toto@mail.fr","customerId" : "customerId1","customerIpAddress" : "127.0.0.1","interfaceVersion" : "CR_WS_2.6","keyVersion" : "1","merchantId" : "011223344550000","merchantWalletId" : "SIM01","orderChannel" : "INTERNET","orderId" : "123","paymentMeanId" : "2","returnContext" : "my return context","transactionOrigin" : "SIPS-SIM","transactionReference" : "SIM2014012248339","seal" : "d3f5f2c4c6f608e3a4940c6700ca6827c066715512be835660a8091c6ec1e098"}
Exemple de réponse à une requête walletCreditHolder
{"maskedPan":"4907##########00","newStatus":"TO_CREDIT","operationDateTime":"2015-05-06T12:12:07+03:00","responseCode":"00","s10TransactionReference":{"s10TransactionId":"34800","s10TransactionIdDate":"20150506"},"transactionReference":"SIM2014012248339","paymentMeanBrand":"VISA","seal":"250c2a5831ae3b1a015d4d8be0e1970936e2c53b50607c8f6182556c0291ab8d"","transactionPlatform":"PROD"}

Description du service Web diagnostic

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/diagnostic

Ce service permet de demander des informations sur les transactions existantes.

La valeur du champ interfaceVersion est fixée à DR_WS_2.18

Service getTransactionData

L’URL en est
https://office-server.mercanet.bnpparibas.net/rs-services/v2/diagnostic/getTransactionData Cette fonction permet de récupérer des informations relatives à une transaction spécifique configurée préalablement à l'aide de Mercanet et stockée dans la base de données Mercanet. Une requête getTransactionData inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
Paramètres d’entrée par défaut de getTransactionData

Champ

Présence

A partir de la version

Commentaires

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

s10TransactionReference

Facultatif

WS_2.6

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

transactionReference

Facultatif

WS_2.6

Tableau 90 : Champs d’une requête getTransactionData

getTransactionData - Données de sortie

La réponse à une requête getTransactiondata inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie cardData
  • Données de sortie s10FromTransactionReference
  • Données de sortie s10TransactionReference

Champ

A partir de la version

Commentaires

acquirerResponseCode

WS_2.18

acquirerResponseMessage

WS_2.9

authorisationId

WS_2.3

automaticResponseStatus

WS_2.3

avsAddressResponseCode*

WS_2.17

avsPostcodeResponseCode*

WS_2.17

cardCSCResultCode

WS_2.17

captureLimitDate

WS_2.3

cardData

WS_2.9

Voir 6.1.1.26

complementaryCode

WS_2.13

currencyCode

WS_2.3

currentAmount

WS_2.3

customerId

WS_2.3

customerIpAddress

WS_2.3

dccStatus

WS_2.3

fromTransactionReference

WS_2.3

getTransDataResponseCode

WS_2.18

holderAuthentMethod

WS_2.3

holderAuthentProgram

WS_2.3

holderAuthentStatus

WS_2.3

lastOperationDateTime

WS_2.3

lastOperationName

WS_2.3

maskedPan

WS_2.3

merchantId

WS_2.3

orderChannel

WS_2.3

orderId

WS_2.3

originAmount

WS_2.3

panEntryMode

WS_2.3

panExpiryDate

WS_2.3

paymentMeanBrand

WS_2.3

paymentMeanType

WS_2.3

paymentPattern

WS_2.3

preAuthenticationColor

WS_2.13

preAuthenticationProfile

WS_2.13

preAuthenticationProfileValue

WS_2.13

preAuthenticationThreshold

WS_2.13

preAuthenticationValue

WS_2.13

preAuthorisationProfile

WS_2.13

preAuthorisationProfileValue

WS_2.13

remainingAmount

WS_2.3

responseCode

WS_2.3

s10FromTransactionReference

WS_2.6

Voir duplicate

s10TransactionReference

WS_2.6

Voir paramètres d’entrée de cardOrder

scoreColor

WS_2.13

scoreProfile

WS_2.13

scoreThreshold

WS_2.13

scoreValue

WS_2.13

seal

WS_2.0

tokenPan

WS_2.3

transactionDateTime

WS_2.3

transactionReference

WS_2.6

transactionStatus

WS_2.3

walletType

WS_2.3

Tableau 91 : Champs de la réponse à une requête getTransactionData

getTransactionData - Exemples

Exemple de requête getTransactionData
{"interfaceVersion" : "DR_WS_2.3","merchantId" : "011223344550000", "transactionReference" : "TREFEXA2012","seal" : "112a4b079ece08a0a55511cd5469fc47051d6ddb1404623170ba3873668e5c58" }
Exemple de réponse à une requête getTransactionData
{"automaticResponseStatus":"UNDEFINED","authorisationId":"298392","captureLimitDate":"20140108","paymentMeanType":"CARD","paymentMeanBrand":"MASTERCARD","currencyCode":"826","currentAmount":1000,"customerId":"customerId1","customerIpAddress":"127.0.0.1","lastOperationDateTime":"2014-01-07T12:50:10+01:00","lastOperationName":"TRANSACTION","orderId":"123","originAmount":1000,"transactionDateTime":"2014-01-07T12:50:01+01:00","responseCode":"00","transactionStatus":"TO_CAPTURE","orderChannel":"INTERNET","paymentPattern":"ONE_SHOT","merchantId":"011223344550000","seal":"d971d516610f68050a71068c49ae778c37eb1c9b16f2ec90a3feadeb1bb60876"}

Service getFraudData

L’URL en est
https://office-server.mercanet.bnpparibas.net/rs-services/v2/diagnostic/getFraudData Cette fonction permet de récupérer des informations relatives au contrôle anti-fraude d'une transaction spécifique configurée préalablement à l'aide de Mercanet et stockée dans la base de données Mercanet. Une requête getFraudData inclut les éléments suivants :

  • Paramètres d’entrée par défaut
  • Paramètres d’entrée s10TransactionReference
getFraudData - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.13

intermediateServiceProviderId

Facultatif

WS_2.13

keyVersion

Obligatoire

WS_2.13

merchantId

Obligatoire

WS_2.13

s10TransactionReference

Facultatif

WS_2.13

Voir paramètres d’entrée de cardOrder

seal

Obligatoire

WS_2.13

sealAlgorithm

Facultatif

WS_2.13

transactionReference

Facultatif

WS_2.13

Tableau 92: Champs d’une requête getFraudData

getFraudData - Données de sortie

La réponse à une requête getFraudData inclut les éléments suivants :

  • Données de sortie par défaut
  • Données de sortie de preAuthenticationRuleResult
  • Données de sortie de preAuthorisationRuleResult

Champ

A partir de la version

Commentaires

complementaryCode

WS_2.13

fraudResponseCode

WS_2.13

Code de réponse de l'opération getFraudData Code 00 = Transaction trouvée Code 25 = Transaction non trouvée Code 99 = Problème technique

preAuthenticationColor

WS_2.13

preAuthenticationProfile

WS_2.13

preAuthenticationProfileValue

WS_2.13

preAuthenticationRuleResultList

WS_2.13

Voir 6.2.17.3

preAuthenticationThreshold

WS_2.13

preAuthenticationValue

WS_2.13

preAuthorisationProfile

WS_2.13

preAuthorisationProfileValue

WS_2.13

preAuthorisationRuleResultList

WS_2.13

Liste d’objets preAuthorisationRuleResult ; voir données de sortie de cardOrder,

scoreColor

WS_2.13

scoreProfile

WS_2.13

scoreThreshold

WS_2.13

scoreValue

WS_2.13

seal

WS_2.13

Tableau 93 : Champs de la réponse à une requête getFraudData

getFraudData - Exemples

Exemple de requête getFraudData
{"interfaceVersion" : "DR_WS_2.13","keyVersion" : "1","merchantId" : "029107704346091","sealAlgorithm" : "SHA-256","transactionReference" : "12345678945613","seal" : "1b30f5b8bfb1739adf716e5c86c67e5034c91c29cd2651a5e0b8d6e5e12a6be5"}
Exemple de réponse à une requête getFraudData
{"fraudResponseCode":"00","preAuthorisationProfile":"MP0050","preAuthorisationRuleResultList":[{"ruleCode":"CA","ruleType":"N","ruleWeight":"4","ruleSetting":"S","ruleResultIndicator":"-4","ruleDetailedInfo":"MIN=1000:2000;MAX=1000:100000"},{"ruleCode":"PE","ruleType":"N","ruleWeight":"4","ruleSetting":"S","ruleResultIndicator":"0","ruleDetailedInfo":"EXPIRY=1216:0616"},{"ruleCode":"EC","ruleType":"N","ruleWeight":"2","ruleSetting":"N","ruleResultIndicator":"U"}],"scoreColor":"BLACK","scoreProfile":"MP0050","scoreThreshold":"-17;-8","scoreValue":"-4.0","seal":"0c67850db20d23c8efd5f186c8f03104b697f1b4f49ef18af18cddf74b01bcbb"}

Description du service Web wallet

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/wallet Ce service permet de gérer les portefeuilles des clients. Un portefeuille vous permet de gérer les moyens de paiement par client et permet à celui-ci de payer. Ce service Web est uniquement utilisé à des fins de gestion et non pour le paiement. Référez-vous au service Web checkout pour le paiement par portefeuille.

La valeur du champ interfaceVersion est fixée à WR_WS_2.18.

Service addCard

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/wallet/addCard Cette fonction permet de créer un compte « portefeuille » avec une carte. Si la carte est déjà enregistrée dans le portefeuille, un code de réponse 94 est retourné. Si la création a réussi, un code de réponse 00 est retourné, ainsi que de nombreuses informations sur le compte et la carte associée :

  • identifiant du « portefeuille »
  • date de création
  • identifiant externe du moyen de paiement créé pour le « portefeuille »
  • numéro de carte, partiellement masqué (seuls les 4 premiers chiffres et les 2 derniers chiffres sont affichés en clair.)

Une requête addCard inclut les éléments suivants :

  • Paramètres d’entrée par défaut
addCard - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

cardNumber

Obligatoire

WS_2.3

cardExpiryDate

Obligatoire

WS_2.3

merchantWalletId

Obligatoire

WS_2.3

paymentMeanAlias

Facultatif

WS_2.3

Exemple : « ma carte VISA »

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

Tableau 94 : Champs d’une requête addCard

Données de sortie de addCard

La réponse à une requête addCard inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

errorFieldName

WS_2.0

Disponible si la valeur de walletResponseCode est 12 ou 30

maskedPan

WS_2.0

Disponible si le code de réponse est 00

paymentMeanId

WS_2.0

Disponible si le code de réponse est 00

seal

WS_2.0

walletActionDateTime

WS_2.0

Disponible si le code de réponse est 00

walletResponseCode

WS_2.0

Tableau 95 : Champs de la réponse à une requête addCard

addCard - Exemples

Exemple de requête addCard
{"cardExpiryDate" : "201405","cardNumber" : "5219000000000000","interfaceVersion" : " WR_WS_2.3","keyVersion" : "1","merchantId" : "011223344550000","merchantWalletId" : "iDWal1","paymentMeanAlias" : "myvisacard","seal" : "4b7beed20ff443b3c05cc904bcd793ba6cace54b9ff669cf26d8576e267dc03c"}
Exemple de réponse à une requête addCard
{"walletActionDateTime":"2014-03-19T23:15:03-12:00","paymentMeanId":"13","maskedPan":"4977##########55","walletResponseCode":"00","seal":"a6671feade95c57085939fe973e8455a5c7a81d465f78f1b94c22f8b29a2b751"}


Service signOff

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/wallet/signOff Cette fonction permet de supprimer un « portefeuille » et les moyens de paiements associés. Si le compte n'existe pas, un code de réponse 01 est retourné. Si la suppression a fonctionné, le code de réponse 00 est retourné avec la date de suppression.

Une requête signOff inclut les éléments suivants :

  • Paramètres d'entrée
signOff - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

merchantWalletId

Obligatoire

WS_2.3

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

Tableau 98 : Champs d’une requête signOff

signOff - Données de sortie

La réponse à une requête signOff inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

walletActionDateTime

WS_2.0

Disponible si le code de réponse est 00

walletResponseCode

WS_2.0

errorFieldName

WS_2.0

Disponible si la valeur de walletResponseCode est 12 ou 30

seal

WS_2.0

Tableau 99 : Champs de la réponse à une requête signOff

signOff - Exemples

Exemple de requête signOff
{"interfaceVersion" : "WR_WS_2.3","keyVersion" : "1","merchantId" : "011223344550000","merchantWalletId" : "SIM01","seal" : "8217a6163368bee3b5baebc47a822d40327344ce578411055f95d6e5752d00f4"}
Exemple de réponse à une requête signOff
{"walletActionDateTime":"2014-05-19T23:20:25-12:00","walletResponseCode":"00","seal":"8ff8b4302b5eeda23bad2d556dd539c2b3991f8dcd4deb66e338df3a1f59ebe6"}


Service updatePaymentMean

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/wallet/updatePaymentMean Cette fonction permet à un commerçant de mettre à jour l'un des moyens de paiement de son « portefeuille ». Si le compte ou la carte n'existe pas, un code de réponse 01 est retourné. Si la mise à jour a fonctionné, le code de réponse 00 est retourné avec la date de la mise à jour. Une requête updatePaymentDataMean inclut les éléments suivants :

  • Paramètres d'entrée
updatePaymentMean - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.3

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.3

merchantId

Obligatoire

WS_2.3

merchantWalletId

Obligatoire

WS_2.3

paymentMeanAlias

Facultatif

WS_2.3

paymentMeanId

Obligatoire

WS_2.3

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

Tableau 100 : Champs d’une requête updatePaymentMean

Données de sortie de updatePaymentMean

La réponse à une requête updatePaymentMean inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

walletActionDateTime

WS_2.0

Disponible si le code de réponse est 00

walletResponseCode

WS_2.0

errorFieldName

WS_2.0

Disponible si la valeur de walletResponseCode est 12 ou 30

seal

WS_2.0

Tableau 101 : Champs de la réponse à une requête updatePaymentMean

updatePaymentMean - Exemples

Exemple de requête updatePaymentMean
{"interfaceVersion" : " WR_WS_2.3","keyVersion" : "1","merchantId" : "011223344550000","merchantWalletId" : "walId011","paymentMeanAlias" : "myAlias","paymentMeanId" : "2","seal" : "1e26289499d5f6104e6300291f272d7b994a111eecf8feedccf934560de26e5d"}
Exemple de réponse à une requête updatePaymentMean
{"walletActionDateTime":"2014-05-19T23:19:54-12:00","walletResponseCode":"00","seal":"4d40a4af0fe8ceaf1370ab5e434c6ba939973bcacf33f202c72c47a8ab622c19"}

Service deletePaymentMean

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/wallet/deletePaymentMean

Cette fonction permet à un commerçant de supprimer définitivement l'un des moyens de paiement de son « portefeuille ».

Si le compte ou la carte n'existe pas, un code de réponse 01 est retourné. Si la suppression a fonctionné, le code de réponse 00 est retourné avec la date de suppression. Une requête deletePaymentMean inclut les éléments suivants :

  • Paramètres d'entrée
deletePaymentMean - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

keyVersion

Obligatoire

WS_2.0

merchantId

Obligatoire

WS_2.0

interfaceVersion

Obligatoire

WS_2.0

intermediateServiceProviderId

Facultatif

WS_2.12

merchantWalletId

Obligatoire

WS_2.0

paymentMeanId

Obligatoire

WS_2.0

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

Tableau 102 : Champs d’une requête deletePaymentMean

deletePaymentMean - Données de sortie

La réponse à une requête deletePaymentMean inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

walletActionDateTime

WS_2.0

Disponible si le code de réponse est 00

walletResponseCode

WS_2.0

errorFieldName

WS_2.0

Disponible si la valeur de walletResponseCode est 12 ou 30

seal

WS_2.0

Tableau 103 : Champs d’une requête deletePaymentMean

deletePaymentMean - Exemples

Exemple de requête deletePaymentMean
{"interfaceVersion" : "WR_WS_2.3","keyVersion" : "2","merchantId" : "011223344550000","merchantWalletId" : "walId011","paymentMeanId" : "2","seal" : "dc02b07a50eaae5007be184ede9a1b03150809ced6fca81c81f7a54929129b44"}
Exemple de réponse à une requête deletePaymentMean
{"walletActionDateTime":"2014-05-19T23:22:08-12:00","walletResponseCode":"00","seal":"e721a45f7decf017ba079dd0c25b1e7916c6c9e6c7e86d6cef37bec2cf42ba04"}


Service getWalletData

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/wallet/getWalletData Cette fonction permet de consulter un « portefeuille » et les moyens de paiement associés. Si le compte n'existe pas, un code de réponse 01 est retourné. Si la requête a réussi, le code de réponse 00 est retourné, ainsi que avec les informations relatives aux moyens de paiement. Une requête getWalletData inclut les éléments suivants :

  • Paramètres d'entrée
getWalletData - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

keyVersion

Obligatoire

WS_2.0

merchantId

Obligatoire

WS_2.0

interfaceVersion

Obligatoire

WS_2.0

intermediateServiceProviderId

Facultatif

WS_2.12

merchantWalletId

Obligatoire

WS_2.0

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

Tableau 104 : Champs d’une requête getWalletData

getWalletData - Données de sortie

La réponse à une requête getWalletData inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

walletCreationDateTime

WS_2.0

Disponible si le code de réponse est 00

walletLastActionDateTime

WS_2.0

Disponible si le code de réponse est 00

walletResponseCode

WS_2.0

walletPaymentMeanDataList

WS_2.0

Liste de champs conteneurs walletPaymentMeanData ; voir plus bas

errorFieldName

WS_2.0

Disponible si la valeur de walletResponseCode est 12 ou 30

seal

WS_2.0

Tableau 105: Champs de la réponse à une requête getWalletData

Élément walletPaymentMeanData

Champ

A partir de la version

Commentaires

paymentMeanId

WS_2.0

mandateId

WS_2.18

maskedPan

WS_2.0

paymentMeanAlias

WS_2.0

panExpiryDate

WS_2.0

paymentMeanBrand

WS_2.0

transactionActors

WS_2.0

pspData

WS_2.15

Pour usage futur ; voir conteneur pspData ci-dessous

Tableau 106: Champs de l'élément walletPaymentMeanData

Élément pspData

Champ

A partir de la version

Commentaires

pspData1

WS_2.15

Pour usage futur

Tableau 107: Champs de l'élément pspData

getWalletData - Exemples

Exemple de requête getWalletData
{"interfaceVersion" : " WR_WS_2.3","keyVersion" : "1","merchantId" : "011223344550000","merchantWalletId" : " walId011","seal" : "8217a6163368bee3b5baebc47a822d40327344ce578411055f95d6e5752d00f4"}
Exemple de réponse à une requête getWalletData
{"walletCreationDateTime":"2013-12-23T05:17:26-12:00","walletLastActionDateTime":"2014-01-19T23:16:00-12:00","walletResponseCode":"00","walletPaymentMeanDataList":[{"paymentMeanId":"14","maskedPan":"4977##########02","paymentMeanBrand":"SEPA_DIRECT_DEBIT"},{"paymentMeanId":"13","maskedPan":"4977##########55","paymentMeanAlias":"MySDD","panExpiryDate":"201501","paymentMeanBrand":"CB"}],"seal":"4579cfc4044c29550327f9cba0be400129e95cb5b2639c6e301484930b4f9f94"}

Service getPaymentMeanData

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/wallet/getPaymentMean

Cette fonction permet de consulter un « portefeuille » et les informations de ses moyens de paiement.

Si le compte ou le moyen de paiement n'existe pas, un code de réponse 01 est retourné. Si la requête a réussi, le code de réponse 00 est retourné, ainsi que les informations relatives au moyen de paiement. Une requête getPaymentMeanData inclut les éléments suivants :

  • Paramètres d’entrée
getPaymentMeanData - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.0

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.0

merchantId

Obligatoire

WS_2.0

merchantWalletId

Obligatoire

WS_2.0

paymentMeanId

Obligatoire

WS_2.0

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

Tableau 108 : Champs d’une requête getPaymentMeanData

getPaymentMeanData - Données de sortie

La réponse à une requête getPaymentMeanData inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

errorFieldName

WS_2.0

Disponible si la valeur de walletResponseCode est 12 ou 30

seal

WS_2.0

walletPaymentMeanData

WS_2.0

Champ conteneur ; voir getWalletdata.

walletResponseCode

WS_2.0

Tableau 109 : Champs de la réponse à une requête getPaymentMeanData

getPaymentMeanData - Exemples

Exemple de requête getPaymentMeanData
{"interfaceVersion" : "WR_WS_2.3","keyVersion" : "1","merchantId" : "011223344550000","merchantWalletId" : " walId011","paymentMeanId" : "14","seal" : "7ba62b5dc8583a636fa35ec8399025e67d5a6335de4e04e25e99d21209e0bd4e"}
Exemple de réponse à une requête getPaymentMeanData
{"walletResponseCode":"00","walletPaymentMeanData":{"paymentMeanId":"14","maskedPan":"4977##########02","paymentMeanBrand":"SEPA_DIRECT_DEBIT"},"seal":"17f797e25668662aa51d59dbbd51c7094410f46326d15568f73f27621380c34a"}

Description du service Web paymentMeanInfo

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/paymentMeanInfo Ce service permet de consulter les informations relatives à un moyen de paiement. Pour l’instant, il n’est disponible que pour les cartes.

La valeur du champ interfaceVersion est fixée à PMR_WS_2.18

Service getCardData

The URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/paymentMeanInfo/getCardData Cette fonction permet de consulter les informations associées à un numéro ou IIN de carte. Si le numéro ou l'IIN de la carte n'existe pas, un code de réponse 05 est retourné. Si la requête a réussi, le code de réponse 00 est retourné, ainsi que les informations relatives à la carte. La requête de consultation d'un numéro ou d'un IIN de carte inclut les éléments suivants :

  • Paramètres d'entrée
getCardData - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

cardIIN

Facultatif

WS_2.5

Doit être défini si cardNumber ne l’est pas

cardNumber

Facultatif

WS_2.5

Doit être défini si cardIIN ne l’est pas

interfaceVersion

Obligatoire

WS_2.5

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.5

merchantId

Obligatoire

WS_2.5

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

Tableau 110 : Champs d’une requête getCardData

getCardData - Données de sortie

La réponse à une requête getCardData inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

paymentMeanInfoResponseCode

WS_2.5

cardDataList

WS_2.5

Liste de champs conteneurs cardData ; voir plus bas

errorFieldName

WS_2.5

Disponible si la valeur de paymentMeanInfoResponseCode est 12 ou 30

seal

WS_2.0

Tableau 111 : Champs de la réponse à une requête getPaymentMeanData

Élément cardData

Champ

A partir de la version

Commentaires

cardBrand

WS_2.5

cardCorporateIndicator

WS_2.5

cardEffectiveDateIndicator

WS_2.5

cardProductCode

WS_2.5

cardProductName

WS_2.5

cardProductProfile

WS_2.5

cardScheme

WS_2.5

cardSeqNumberIndicator

WS_2.5

issuerCode

WS_2.5

issuerCountryCode

WS_2.5

issuerName

WS_2.5

issuerRegionCode

WS_2.5

panCheckAlgorithm

WS_2.5

panLengthMax

WS_2.5

panLengthMin

WS_2.5

Tableau 112 : Champs de l'élément cardData

getCardData - Exemples

Exemple de requête getCardData
{"cardNumber" : "4975000000000000","interfaceVersion" : "PMR_WS_2.5","keyVersion" : "1","merchantId" : "011223344550000","seal" : "97fccfbfde4570019236f31e3bb521be477bbc7bf7cf09c30f8fbc3a635a3011"}
Exemple de réponse à une requête getCardData
{"paymentMeanInfoResponseCode":"00","cardDataList":[{"cardScheme":"CB","cardBrand":"CB","cardProductCode":"2","cardProductName":"CARTE NATIONALE DE RETRAIT ET DE PAIEMENT","issuerCode":"10107","issuerCountryCode":"FRA","panLengthMin":16,"panLengthMax":16,"panCheckAlgorithm":"L","cardProductProfile":"D"},{"cardScheme":"VISA","cardBrand":"VISA","cardProductCode":"F","cardProductName":"VISA CLASSIC","cardCorporateIndicator":"N","issuerCode":"10107","issuerCountryCode":"FRA","issuerRegionCode":"D","panLengthMin":16,"panLengthMax":16,"panCheckAlgorithm":"L"}],"seal":"c10bc66f574d22c4eb68250fe80c7d764a420a4fa22fde23f69e3a67bf60d131"}

Description du service web Fraud

L’URL en est Ce service Web vous permet de vérifier si une transaction existante est frauduleuse.

La valeur du champ interfaceVersion est fixée à FR_WS_2.18

Service getVelocityData

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/fraud/getVelocityData Cette fonction permet de contrôler l'activité d'un champ de données spécifique au cours d'une période déterminée. Une requête getVelocityData inclut les éléments suivants :

  • Paramètres d'entrée par défaut
getVelocityData - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

interfaceVersion

Obligatoire

WS_2.0

intermediateServiceProviderId

Facultatif

WS_2.12

keyVersion

Obligatoire

WS_2.0

merchantId

Obligatoire

WS_2.0

seal

Obligatoire

WS_2.0

sealAlgorithm

Facultatif

WS_2.11

velocityElementType

Obligatoire

WS_2.0

velocityElementValue

Obligatoire

WS_2.0

velocityPeriod

Facultatif

WS_2.0

Tableau 123 : Champs d’une requête getVelocityData

getVelocityData - Données de sortie

La réponse à une requête getVelocityData inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

currencyCode

WS_2.0

responseCode

WS_2.0

seal

WS_2.0

velocityNbTransaction

WS_2.0

velocityProfileDateTime

WS_2.0

velocityProfileMaxNbTrans

WS_2.0

velocityProfileMaxTotalAmount

WS_2.0

velocityProfileMaxTransAmount

WS_2.0

velocityProfileName

WS_2.0

velocityProfilePeriod

WS_2.0

velocityTotalAmount

WS_2.0

Tableau 124 : Champs de la réponse à une requête getVelocityData

getVelocityData - Exemples

Exemple de requête getVelocityData
{"interfaceVersion" : "FR_WS_2.9","keyVersion" : "1","merchantId" : "011223344550000","velocityElementType" : "customerId","velocityElementValue" : "cust010","velocityPeriod" : "50","seal" : "fc24b9e6bd7a433d258a1df1a8af2698b917d1632aaa1bc12c5c8f45adbeba11"}
Exemple de réponse à une requête getVelocityData
{"responseCode":"00","velocityTotalAmount":0,"velocityNbTransaction":0,"velocityProfilMaxTotalAmount":1000,"velocityProfilMaxNbTrans":10,"velocityProfilMaxTransAmount":100,"currencyCode":"978","velocityProfileName":"all_controls","velocityProfilPeriod":10,"velocityProfileDateTime":"2014-11-19T14:21:32+01:00","seal":"5a65b70f786047ef13f80a55a6642211daa52df74039c605e70ac7d752f52731"}

Service addToFraudList

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/fraud/addToFraudList L’opération addToFraudLidt de Mercanet Gestion Plus sera créée pour permettre la gestion des types de listes par insertion de PAN, TOKEN, Tid /Date, Tref.

addToFraudList - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

merchantId

Obligatoire

WS_2.15

interfaceVersion

Obligatoire

WS_2.15

intermediateServiceProviderId

Facultatif

WS_2.15

fraudListType

Obligatoire

WS_2.15

fraudListLevel

Obligatoire

WS_2.15

fraudListElementType

Obligatoire si fraudListType = cardList

WS_2.15

fraudListElementValue

Obligatoire

WS_2.15

seal

Obligatoire

WS_2.15

sealAlgorithm

Facultatif

WS_2.15

fraudListReasonCode

Facultatif

WS_2.15

secretKey

Obligatoire

WS_2.15

keyVersion

Obligatoire

WS_2.15

Tableau 125 : Champs d’une requête addToFraudList

addToFraudList - Données de sortie

La réponse à une requête addToFraudList inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

fraudResponseCode

WS_2.15

seal

WS_2.15

errorFieldName

WS_2.15

Tableau 126 : Champs de la réponse à une requête addtoFraudList

addToFraudList - Exemples

Exemple de requête addToFraudList
{"fraudListElementType":"PAN","fraudListElementValue":"5017674000000200","fraudListLevel":"WHITE","fraudListType":"CARD_LIST","interfaceVersion":"FR_WS_2.15","keyVersion":"1","merchantId":"226000009630001","seal":"b3f44355e912ebb9c3fed0e3a00a5782762afd604055f3a56438971a4e9ec58f"}
Exemple de réponse à une requête addToFraudList
{"fraudResponseCode":"00","seal":"0a7c1ab8fa767313e0631d166843eb55b9f783426241690a2b6e23ca40087811"}

Service removeFromFraudList

L’URL en est https://office-server.mercanet.bnpparibas.net/rs-services/v2/fraud/removeFromFraudList Cette fonction permet de contrôler l'activité d'un champ de données spécifique au cours d'une période déterminée. Les demandes relatives aux opérations de validation incluent les éléments suivants :

  • Paramètres d'entrée par défaut
removeFromFraudList - Paramètres d’entrée par défaut

Champ

Présence

A partir de la version

Commentaires

merchantId

Obligatoire

WS_2.15

interfaceVersion

Obligatoire

WS_2.15

intermediateServiceProviderId

Facultatif

WS_2.15

fraudListType

Obligatoire

WS_2.15

fraudListLevel

Obligatoire

WS_2.15

fraudListElementType

Obligatoire si fraudListType = cardList

WS_2.15

fraudListElementValue

Obligatoire

WS_2.15

seal

Obligatoire

WS_2.15

sealAlgorithm

Facultatif

WS_2.15

fraudListReasonCode

Facultatif

WS_2.15

secretKey

Obligatoire

WS_2.15

keyVersion

Obligatoire

WS_2.15

Tableau 127 : Champs d’une requête removeFromFraudList

removeFromFraudList - Données de sortie

La réponse à une requête removeFromFraudList inclut les éléments suivants :

  • Données de sortie par défaut

Champ

A partir de la version

Commentaires

fraudResponseCode

WS_2.15

seal

WS_2.15

errorFieldName

WS_2.15

Tableau 128 : Champs de la réponse à une requête removeFromFraudList

removeFromFraudList - Exemples

Exemple de requête removeFromFraudList
{"fraudListElementType":"PAN","fraudListElementValue":"5017674000000200","fraudListLevel":"WHITE","fraudListType":"CARD_LIST","interfaceVersion":"FR_WS_2.15","keyVersion":"1","merchantId":"226000009630001","seal":"b3f44355e912ebb9c3fed0e3a00a5782762afd604055f3a56438971a4e9ec58f"}
Exemple de réponse à une requête removeFromFraudList
{"fraudResponseCode":"00","seal":"0a7c1ab8fa767313e0631d166843eb55b9f783426241690a2b6e23ca40087811"}