Vous êtes sur la page 1sur 164

Descriptif des API webservice, utiliss par la

solution de paiement Payline


Version 3.A

Payline

PROPRIETAIRE Page 1/164

Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Version du modle : DocStd_50
Page des volutions
Date Version Modifications
04/10/07 1.0 Livraison version initiale
13/11/07 1.1 Ajout de la description des fonctions de lAPI web service
10/01/08 1.2 Ajout des fonctions de paiement multiple : paiement par portefeuille client,
paiement par abonnement et paiement en N fois
10/04/08 1.3 Ajout du moyen de paiement PAYPAL et des fonctions de cration et modification
dun portefeuille client par linterface web
09/07/08 1.4 Ajout des fonctions de recherche et rcupration du dtail dune transaction de
paiement
Ajout des codes retour pour le module de dtection de fraude (LCLF)
Ajout de la carte privilge
Ajout des fonctions et cinmatiques de paiement 3DSecure
09/02/09 1.5 Ajout de la fonction doDebit
15/04/09 1.6 Mise jour de lobjet AUTHENTIFICATION_3DSECURE
Mise jour des services Web createWallet et updateWallet pouvant implmenter
lauthentification 3Dsecure
26/10/09 1.7 Ajout du moyen de paiement IDEAL
Ajout de la fonction doReset
Ajout des acteurs viss par les messages derreur Payline
23/11/09 1.8 Liste des langues
29/12/09 1.8 Complment sur lajout du paiement iDEAL
03/03/10 2.A Refonte de la documentation
22/04/10 2.B Cration de lobjet OWNER pour spcifier le titulaire de la carte AMEX
Mise jour de lobjet Buyer pour lenvoi des SMS (champ mobilePhone)
02/06/10 2.C Mise jour des services Web : le champ order.date est dsormais obligatoire.
Modification de la fonctionnalit TransactionSearch
12/10/10 2.D Ajout du service web : doScoringCheque
Dans la version V4.23 du produit Payline
23/12/2010 2.E Modification des codes langues selon la norme ISO
10/03/2011 2.F Ajout de la version V4.24 : Mise de lensemble des WebServices, Cration des
webservices : doreauthorisation
05/04/2011 2.G Ajout de la version V4.25 : Mise jour du moyen de paiement ELV
07/09/2011 2.H Ajout de la version V4.26 : Nouveaux moyens de paiement
14/11/2011 2.I Correction du champ authentification3Dsecure du DoAuthorization()
27/01/2012 2.J Mise jour de lobjet Buyer (champs IP)
16/02/2012 2.K Mise aux couleurs Monext
09/05/2012 2.L Correction des majuscules pages 18
07/06/2012 2.M Ajout de la version V4.27 : Mise jour du champ Buyer
04/07/2012 2.N Ajout de la version V4.30
06/07/2012 2.O Mise jour de lobjet Card
Modification des web services getWebWallet, createWebWallet et
getWebPaymentDetails
21/11/2012 2.P Correction du code utiliser dans le doImmedaiteWalletPayment
Ajout des balises
Correction du tableau de la reautor
Reformulation du DoWebPaiement
06/12/2012 2.Q Maj du tableau des codes actions
Correction du format de la date du retour du WS doAutor
19/02/2013 2.R Ajout de la version V4.32
23/04/2013 2.S Ajout de la version V4.33 : Mise jour des web services createWallet,
updateWallet, updateWebWallet, getWebWallet, doWebPayment,
getWebPaymentDetails
Cration du web service manageWebWallet
16/07/2013 2.T Mise jour des web service avec la version 4.34.
14/10/2013 2.U Mise jour des web service avec la version 4.35.
17/01/2014 2.V Mise jour des web service avec la version 4.36.
Modification des codes retours de la fonction getWebPaymentDetails()

Page 2/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
28/03/2014 2.W Mise jour des web service avec la version 4.37
Possiblit de tokenizer de nouveaux moyens de paiements.
10/09/2014 2.X Mise jour des web service avec la version 4.38 et 4.39
28/11/2014 2.Y A jout de 3 codes retour pour grer le statut en cours de traitement ou in
progress dune transaction (02000, 02005, 02009)
13/01/2015 2.Z Mise jour des web services doImmediateWalletPayment et verifyEnrollement
pour raliser une transaction 3DS partir dune carte enregistre dans un wallet.
Ajout de la demande dinformation pour vrifier la carte dun porteur lors de son
enregistrement dans un portefeuille.
Ajout des 4 codes retours (02724, 02726, 02727 et 02728)
25/03/2016 3.A Prcision sur lutilisation du paramtre recurring.startDate

Page 3/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Table des matires

1. INTRODUCTION ................................................................................................................................................ 7
1.1 OBJET DU DOCUMENT..................................................................................................................................... 7
1.2 PUBLIC VIS .................................................................................................................................................... 7
1.3 LISTE DES DOCUMENTS DE RFRENCE ........................................................................................................ 7
1.4 AVERTISSEMENT ............................................................................................................................................. 7
1.5 CONTACTS ....................................................................................................................................................... 7
2 PRINCIPE GENERAL DE LAPI ..................................................................................................................... 8
3 INTERFACE WEB DE PAYLINE .................................................................................................................... 9
3.1 WEB SERVICE - DO WEB PAYMENT ............................................................................................................... 9
3.1.1 Requte envoyer ............................................................................................................................ 11
3.1.2 Rponse en retour ............................................................................................................................ 17
3.2 WEB SERVICE - GET WEB PAYMENT DETAILS............................................................................................ 17
3.2.1 Requte envoyer ............................................................................................................................ 17
3.2.2 Rponse en retour ............................................................................................................................ 18
3.3 WEB SERVICE - CREATE WEB WALLET ...................................................................................................... 26
3.3.1 Requte envoyer ............................................................................................................................ 26
3.3.2 Rponse en retour ............................................................................................................................ 30
3.4 UPDATE WEB WALLET ................................................................................................................................. 30
3.4.1 Requte envoyer ............................................................................................................................ 30
3.4.2 Rponse en retour ............................................................................................................................ 33
3.5 WEB SERVICE - GET WEB WALLET ............................................................................................................. 34
3.5.1 Requte envoyer ............................................................................................................................ 34
3.5.2 Rponse en retour ............................................................................................................................ 34
3.6 WEB SERVICE - MANAGE WEB WALLET ..................................................................................................... 38
3.6.1 Requte envoyer ............................................................................................................................ 38
3.6.2 Rponse en retour ............................................................................................................................ 42
4 INTERFACE DIRECT DE PAYLINE ............................................................................................................. 43
4.1 WEBSERVICE - DO AUTHORIZATION ............................................................................................................ 44
4.1.1 Requte envoyer ............................................................................................................................ 45
4.1.2 Rponse en retour ............................................................................................................................ 51
4.2 WEB SERVICE-DOREAUTHORIZATION ......................................................................................................... 53
4.2.1 Requte envoyer ............................................................................................................................ 53
4.2.2 Requte la rponse ....................................................................................................................... 56
4.3 WEB SERVICE - DO CAPTURE ...................................................................................................................... 57
4.3.1 Requte envoyer ............................................................................................................................ 57
4.3.2 Rponse en retour ............................................................................................................................ 58
4.4 WEB SERVICE - DO REFUND ........................................................................................................................ 59
4.4.1 Requte envoyer ............................................................................................................................ 59
4.4.2 Rponse en retour ............................................................................................................................ 60
4.5 WEB SERVICE - DO RESET ........................................................................................................................... 61
4.5.1 Requte envoyer ............................................................................................................................ 61
4.5.2 Rponse en retour ............................................................................................................................ 62
4.6 WEB SERVICE - DO CREDIT .......................................................................................................................... 63
4.6.1 Requte envoyer ............................................................................................................................ 63
4.6.2 Rponse en retour ............................................................................................................................ 67
4.7 WEB SERVICE - DO DEBIT ............................................................................................................................ 68
4.7.1 Requte envoyer ............................................................................................................................ 68
Page 4/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.7.2 Rponse en retour ............................................................................................................................ 73
4.8 CREATE WALLET .......................................................................................................................................... 74
4.8.1 Requte envoyer ............................................................................................................................ 74
4.8.2 Rponse en retour ............................................................................................................................ 79
4.9 UPDATE WALLET .......................................................................................................................................... 80
4.9.1 Requte envoyer ............................................................................................................................ 80
4.9.2 Rponse en retour ............................................................................................................................ 85
4.10 WEB SERVICE - GET WALLET .................................................................................................................... 86
4.10.1 Requte envoyer ............................................................................................................................ 86
4.10.2 Rponse en retour ............................................................................................................................ 86
4.11 WEB SERVICE - DISABLE WALLET ............................................................................................................ 89
4.11.1 Requte envoyer ............................................................................................................................ 89
4.11.2 Rponse en retour ............................................................................................................................ 89
4.12 WEB SERVICE - GETCARDS ....................................................................................................................... 90
4.12.1 Requte envoyer ............................................................................................................................ 90
4.12.2 Rponse en retour ............................................................................................................................ 90
4.13 WEB SERVICE- ENABLE WALLET .............................................................................................................. 92
4.13.1 Requte envoyer ............................................................................................................................ 92
4.13.2 Rponse en retour ............................................................................................................................ 92
4.14 WEB SERVICE - DO IMMEDIATE WALLET PAYMENT ................................................................................. 93
4.14.1 Requte envoyer ............................................................................................................................ 93
4.14.2 Rponse en retour ............................................................................................................................ 96
4.15 WEB SERVICE- DO SCHEDULED WALLET PAYMENT ............................................................................... 97
4.15.1 Requte envoyer ............................................................................................................................ 97
4.15.2 Rponse en retour ............................................................................................................................ 99
4.16 WEB SERVICE- DORECURRENTWALLETPAYMENT ................................................................................ 100
4.16.1 Requte envoyer .......................................................................................................................... 100
4.16.2 Rponse en retour .......................................................................................................................... 103
4.17 GET PAYMENT RECORD........................................................................................................................... 105
4.17.1 Requte envoyer .......................................................................................................................... 105
4.17.2 Rponse en retour .......................................................................................................................... 105
4.18 WEB SERVICE DISABLEPAYMENTRECORD ............................................................................................ 108
4.18.1 Requte envoyer .......................................................................................................................... 108
4.18.2 Rponse en retour .......................................................................................................................... 108
4.19 WEB SERVICE TRANSACTION SEARCH ................................................................................................... 108
4.19.1 Requte envoyer .......................................................................................................................... 109
4.19.2 Rponse en retour .......................................................................................................................... 110
4.20 WEB SERVICE GET TRANSACTION DETAILS ........................................................................................... 110
4.20.1 Requte envoyer .......................................................................................................................... 110
4.20.2 Rponse en retour .......................................................................................................................... 111
4.21 WEB SERVICE VERIFYENROLLMENT ....................................................................................................... 115
4.21.1 Requte envoyer .......................................................................................................................... 115
4.21.2 Requte en rponse ....................................................................................................................... 117
4.22 WEB SERVICE GETENCRYPTIONKEY ....................................................................................................... 118
4.22.1 Requte envoyer .......................................................................................................................... 118
4.22.2 Rponse en retour .......................................................................................................................... 118
4.23 WEB SERVICE GETTOKEN ........................................................................................................................ 120
4.23.1 Requte envoyer .......................................................................................................................... 121
4.23.2 Rponse en retour .......................................................................................................................... 121
4.24 WEB SERVICE GETALERTDETAILS .......................................................................................................... 121
4.24.1 Requte envoyer .......................................................................................................................... 121
4.24.2 Rponse en retour .......................................................................................................................... 121
4.25 WEB SERVICE GETMERCHANTSETTING .................................................................................................. 124
Page 5/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.25.1 Le message getMerchantSettingsRequest .............................................................................. 124
4.25.2 Le message getMerchantSettingsResponse .......................................................................... 124
4.26 WEB SERVICE UPDATEPAYMENTRECORD .............................................................................................. 126
4.26.1 Le message updatePaymentRecordRequest .......................................................................... 126
4.26.2 Le message updatePaymentRecordResponse ...................................................................... 127
4.27 WEB SERVICE GETBILLINGRECORD ....................................................................................................... 128
4.27.1 Le message getBillingRecordRequest ...................................................................................... 128
4.27.2 Le message getBillingRecordResponse ................................................................................... 128
4.1 WEB SERVICE UPDATEBILLINGRECORD ................................................................................................... 130
4.1.1 Le message updateBillingRecordRequest ............................................................................... 130
4.1.2 Le message updateBillingRecordResponse............................................................................ 131
5 TICKET DE PAIEMENT ................................................................................................................................ 133
6 RETOUR LA BOUTIQUE ......................................................................................................................... 133
7 ANNEXES ....................................................................................................................................................... 135
7.1 CODE RETOUR ET MESSAGE PAYLINE POUR LUTILISATION DES CARTES BANCAIRES .......................... 135
7.2 CODE RETOUR ET MESSAGE LIES AU CHEQUE ....................................................................................... 139
7.3 CODE RETOUR ET MESSAGE LIES AU WALLET ....................................................................................... 140
7.4 CODE RETOUR ET MESSAGE LA FONCTION ANNULATION, REJEU DUNE TRANSACTION
(REAUTORISATION)................................................................................................................................................ 142
7.5 CODE RETOUR ET MESSAGE LIE A LUTILISATION DE PAYPAL ................................................................. 143
7.6 CODE RETOUR ET MESSAGE LIE A CONNEXION WEBSERVICE .................................................................. 143
7.7 CODE RETOUR ET MESSAGE LIE A LUTILISATION IDEAL .......................................................................... 143
7.8 CODE RETOUR ET MESSAGE LIE A LUTILISATION TICKETSURF........................................................... 145
7.9 CODE RETOUR ET MESSAGE LIE A LUTILISATION PAYSAFECARD ..................................................... 146
7.10 CODE RETOUR ET MESSAGE LIE A LUTILISATION MONEYBOOKER ................................................. 149
7.11 CODE RETOUR ET MESSAGE 3DSECURE ................................................................................................ 151
7.12 CODE RETOUR DES MESSAGES DERREURS POUR LCLF..................................................................... 151
7.13 CODE RETOUR DES MESSAGES DERREURS LIE AU MOYEN DE PAIEMENT ELV .................................. 152
7.14 CODES RETOUR DES MESSAGES DERREURS LIE AU MOYEN DE PAIEMENT BUYSTER .................... 154
7.15 GESTION DES TIMEOUT ............................................................................................................................ 155
7.16 IDENTIFICATION DES DEMANDES IDENTIQUES ........................................................................................ 155
7.17 TABLEAU : LISTE DES TYPES DE CARTE ................................................................................................. 156
7.18 TABLEAU : LISTE DES MOYENS DE PAIEMENT ........................................................................................ 157
7.19 TABLEAU : LISTE DES CHAMPS OBLIGATOIRES PAR TYPE DE CARTE................................................... 157
7.20 TABLEAU: LISTE DES TYPES DACTION ................................................................................................... 158
7.21 TABLEAU : LISTE DES MODES DE PAIEMENT .......................................................................................... 159
7.22 TABLEAU: LISTE DES PAYS ..................................................................................................................... 160
7.23 TABLEAU: LISTE DES LANGUES .............................................................................................................. 160
7.24 TABLEAU: LISTE DES DEVISES ................................................................................................................ 161
7.25 TABLEAU: LISTE DES MODES SCURIT ................................................................................................. 161
7.26 TABLEAU : LISTE DE MONTANTS A TRANSMETTRE POUR SIMULER UN CODE RETOUR ....................... 162
7.27 TABLEAU : LISTE DES FREQUENCES DE PAIEMENT ............................................................................... 163
7.28 TABLEAU : LISTE DES CONTROLES REALISABLES PAR PORTEFEUILLE ............................................... 164

Page 6/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
1. Introduction

1.1 Objet du document


Ce document dcrit les webservice disponible dans la solution de paiement scuris en ligne
Payline.

1.2 Public vis

Ce document est destin aux commerants et intgrateurs qui souhaitent utiliser la solution de
paiement Payline.

1.3 Liste des documents de rfrence

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

1.4 Avertissement

Ce document est la proprit exclusive de Monext. Toute reproduction intgrale ou partielle, toute
utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit de Monext
est illicite.
Monext, marque communautaire et internationale proprit exclusive de Monext Ltd et/ou des
socits du groupe.
Payline, marque nationale et internationale proprit exclusive de Monext et/ou des socits du
groupe.

1.5 Contacts

Vous avez besoin daide, de conseil ou vous souhaitez simplement nous poser une question.
Contactez lAssistance Payline par email

support@payline.com

Pour toute question lie la mise en place de la solution Payline, vous pouvez joindre notre
assistance technique par mail support@payline.com, du lundi au vendredi de 09h00 18h00.
Page 7/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
2 Principe gnral de lAPI

LAPI Payline fournit laccs aux diffrentes fonctionnalits de la solution de paiement Payline. Elle
est base sur des composants Web Service standards, qui incluent le protocole SOAP et les
langages de dfinition WSDL et XSD. Ces standards sont supports par une large gamme doutils
de dveloppement sur des plateformes multiples.
Lutilisation du client Java Axis2 avec XMLBeans est trs fortement prconis car il permet de
garantir une continuit de service en cas d'volution des Web Services. Lutilisation dun client
Java Axis2 est dconseille avec ADB.

LAPI Payline recouvre lintgralit des fonctions disponible sur la solution de paiement Payline.
Elles sont dcrites en fonction du mode dintgration choisit par le commerant, et il est tout fait
possible dintgrer les 3 modes dintgrations sur votre site e-commerce.

Prconisation : viter les caractres avec accent et les caractres spciaux (",#,&,(,),*,+,,,-
,.,/,:,;,<,=,>,_,|, ,^,\,\\,',!,\",%,$,?,@,[,],`,{,},~)

Page 8/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
3 Interface web de Payline

Mthode Description

doWebPayment Initialisation dune transaction de paiement web


getWebPaymentDetails Rcupre le rsultat dune transaction de paiement web
createWebWallet Cration dun portefeuille client au travers de pages web
updateWebWallet Modification dun portefeuille client au travers de pages web
getWebWallet Rcupre les informations dun portefeuille virtuel cre via linterface
web.
manageWebWallet Gestion dun portefeuille depuis linterface web.

Prconisation : chaque appel webservice, il est impratif de raliser un getWebPaymentDetails ou


getWebWallet

3.1 Web service - Do Web Payment

La fonction do web payment permet dinitialiser une transaction de paiement web avant de rediriger votre client
sur les pages de paiement Payline. Elle permet de realiser des paiements comptants, immediats ou differs, des
paiements en Nfois ou par abonnement

Le paiement comptant vous permet de raliser soit une autorisation + validation, soit une autorisation simple.
Dans le cas lautorisation simple, la validation est faite soit en automatique par la solution de paiement Payline, soit
par le commerant, en utilisant les appels webservice ou via notre outil de back office centre administration
Payline . Elle peut tre aussi programme des la demande dautorisation et toujours dans un delai de 7 jours en
utilisant la fonctionnalit interface batch ou le webservice DoCapture en rensignant la date daction

NOTE : Avec une autorisation de dbit, vous avez jusqu' 7 jours pour valider la demande de paiement. Au-del
des 7 jours, votre autorisation expire et devient inutilisable.

Pour tre inform du paiement de votre client une fois la demande dautorisation accepte et ce mme sil ne
revient pas de lui-mme sur votre site, vous devez renseigner le champ notificationURL sur votre configuration
point de vente ou lors de votre demande dinitialisation dun paiement web. Payline contacte une page de votre site
et vous transmet en paramtre GET de la requte HTTP le jeton li au paiement. Cette page doit tre accessible
par Internet au moyen du protocole HTTP/S.

A rception dune notification, votre site doit raliser une demande de rsultat du paiement web notifi.

Page 9/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
NOTE : Si votre site nest pas joignable, Payline ralise une tentative toute les minutes pendant 2 heures. Aprs ce
dlai, la notification de ce paiement est dsactive. Vous retrouverez vos paiements dans linterface web du Centre
dAdministration Commerant.

Le paiement en n fois ou par abonnement est possible laide dun portefeuille virtuel :WALLET.
Payline prend en charge la cration du portefeuille virtuel aprs la validation des donnes collectes lors du
premier paiement. Lorsque votre client ralise un second achat sur votre boutique en ligne, Payline lui propose
dutiliser son portefeuille. Dans ce cas, on parle dun paiement en un clic car votre client ne doit saisir aucune
information de paiement.

Payline prend en charge le paiement de votre commande en plusieurs mensualits. Lorsque le paiement est
ralis vous avez la possibilit dtre prvenu par email en activant loption envoi dun email commerant dans
le Centre dAdministration Commerant. Dans le cas dune difficult de paiement, Payline reprsente trois fois la
transaction de paiement sur un dlai dune semaine. Lors de chaque tentative en chec, vous tes prvenu de
lchec de paiement.

Un document dcrivant lutilisation de la gestion des portefeuilles virtuels est votre disposition sur simple
demande notre quipe support : support@payline.com

Option autre moyen de paiement : cette fonctionnalit permet au commerant, en cas de refus bancaire, de
proposer ses clients de pouvoir payer avec un autre moyen de paiement.
Le client est redirig sur la page de propositions des moyens de paiement afin quil puisse en changer pour raliser
son paiement. Cette nouvelle fonctionnalit est applicable seulement sur une mme commande dun acheteur,
lors de son premier paiement et en cas de refus bancaire. Et quune liste de nouveaux moyens de paiement a t
renseigne dans le doWebPayment (SecondSelectedContractList)

Page 10/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
3.1.1 Requte envoyer

La requte doWebPaymentRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


version Version des web services Oui N1 A valoriser la valeur 3
Payline
Requis depuis 2011
payment.amount Montant de la transaction dans oui N12 la valeur 100 correspond
la plus petite unit de la devise 1
payment.currency Code de la devise du paiement oui N3 978 : euros
840 : dollars US
cf. liste complte en annexe
tableau Liste des
devises
payment.action Code de la fonction de oui N3 100 : Autorisation
paiement 101 : Autorisation +
validation
payment.mode Mode de paiement : comptant, oui AN3 CPT : Comptant
diffr, N fois, rcurrent. DIF : Diffr
NX : N fois
REC : rcurrent
cf. liste complte en annexe
tableau Liste des modes
de paiement
payment.contractNumber Le code ou numro de votre oui AN50
contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser.
2
payment.differedActionDate Date effective de laction. Elle Non AN8 Format respecter :
doit tre infrieure la date du dd/mm/yy
jour + 7 jours.
media Cette balise est prise en compte uniquement dans les web services
getWebPaymentDetails et getWebWallet pour linterface WEB
returnURL URL sur laquelle le navigateur oui AN255 http://... ou https://...
de lacheteur est redirig aprs
validation du paiement sur
Payline.

Page 11/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
cancelURL URL sur laquelle le navigateur oui AN255 http://... ou https://...
de lacheteur est redirig sil
dcide de ne pas valider le
paiement ou que Payline ne
peut pas autoriser le paiement
de ce client.
order.ref Rfrence de la commande. oui AN50 12345678
Cette rfrence doit tre unique
car elle est utilise pour le
contrle des doublons.
order.origin Origine de la commande non AN2 MO TO
Ce champs est utilis
uniquement dans le cadre de
loption choisi Mail Order ou
Telephone Order
order.country Le code du pays dans lequel la non AN3 FR
commande a t effectue
order.taxes Le montant des taxes sur la non N12 la valeur 100 correspond
commande dans la plus petite 1
unit de la devise
order.amount Le montant de la commande oui N12 la valeur 100 correspond
dans la plus petite unit de la 1
devise. Gnralement le mme
montant que payment.amount
order.currency Le code ISO de la devise oui N3 Pour la devise euro,
utilise lors de la commande. veuillez mettre la valeur
978.
978 : euros
840 : dollars US
cf. liste complte en annexe
tableau Liste des devises
order.date La date de la commande chez oui AN18 Format respecter :
le commerant dd/mm/yyyy
HH24:mi
order.details Informations sur les articles non Tableau details
commands
order. deliveryTime Dlai de livraison : Non N 1
1 = express
- 2 = standard

Page 12/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
order. deliveryMode Mode de livraison : Non N 4
1 : retrait de la marchandise
chez le marchand
2 : Utilisation d'un rseau de
points-retrait tiers (type kiala,
alveol, etc.)
3 : Retrait dans un aroport,
une gare ou une agence de
voyage
4: Transporteur (La Poste,
Colissimo, UPS, DHL... ou tout
transporteur priv)
5: Emission dun billet
lectronique, tlchargements
notificationURL URL sur laquelle Payline va non AN255 http://... ou https://...
demander au site commerant
de rcuprer le rsultat de la
transaction.
selectedContractList La liste des numros de contrat non
que vous souhaitez utiliser pour
ce paiement. Payline affiche la
liste des moyens de paiement
en respectant lordre dans
lequel la liste t renseigne.

Si ce champ nest pas


renseign, Payline affiche
lensemble de vos moyens de
paiement actif sur le point de
vente.
SecondSelectedContractList La liste des numros de contrat non
que vous souhaitez pouvoir
reproposer lors de lchec
dune premire tentative de
transaction
Si ce champ nest pas
renseign, Payline ne
reproposera pas de moyen de
paiement lors de lchec dune
premire tentative de
transaction
privateDataList Vos propres informations non Tableau privateData
personnelles

Page 13/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
languageCode Renseignez ce champ avec le non AN6 Pour afficher les pages en
code ISO de la langue dans italien, veuillez mettre la
laquelle vous souhaitez faire valeur IT.
afficher les pages web de
paiement Payline. Par dfaut,
cest le navigateur Internet de
votre client qui demande
Payline la page dans la langue
souhaite.

FR ou fra : Franais
eng : Anglais
cf. liste complte en annexe
tableau Liste des code
langues
customPaymentPageCode Lidentifiant de personnalisation non AN50 1fd51s2dfs51
des pages web du commerant
buyer.lastName Nom de lacheteur non AN100
buyer.firstName Prnom de lacheteur non AN100
buyer.email Adresse email de lacheteur non AN150
buyer.shippingAddress.name Nom ou numro dimmeuble non AN100
buyer.shippingAddress.street1 Nom de rue non AN100
buyer.shippingAddress.street2 Complment du nom de rue non AN100
buyer.shippingAddress.cityNa Ville non AN40
me
buyer.shippingAddress.zipCod Code postal non AN20
e
buyer.shippingAddress.country Pays non AN2 ISO 3166-1
buyer.shippingAddress.phone Tlphone non AN15 +351001110102
buyer.accountCreateDate La date de cration du compte non AN10 Format respecter :
de lacheteur dd/mm/yy
buyer.accountAverageAmount Le montant moyen des achats non N10
de cet acheteur
buyer.accountOrderCount Le nombre de commande non N10
pass par cet acheteur
3
buyer.walletId Lidentifiant du portefeuille Non AN50
virtuel de votre client.

Page 14/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
buyer.walletDisplayed Gestion de laffichage des non AN5 Pour ne pas affcicher les
moyens de paiement de votre donnes de paiement
client client, saisir la valeur
none .
Pour afficher les donnes
de paiement client, la balise
doit tre vide ou absente
buyer.walletSecured Nature du contrle ajout la non AN12 Liste des valeurs possibles
cinmatique de paiement WEB. en annexe (Cf. 7.27)
buyer.walletCardInd Spcifie lindex de la carte non AN2 Lindex de la carte, valeur
utiliser. par dfaut 1
buyer.ip Ladresse IP de lacheteur non AN50 Format respecter : IPv4
ou IPv6
buyer.mobilePhone Le numro de mobile de non N15 Ex : 0033691666666
lacheteur
buyer.customerId Identifiant client non AN50 Ex : 894492568
Cette donne peut tre un
identifiant ou un email
owner.lastName Nom du titulaire non AN30 Applicable uniquement pour
AMEX
owner.firstName Prnom du titulaire non AN15 Applicable uniquement pour
AMEX
owner.billingAddress.street Nom de rue du titulaire non AN20 Applicable uniquement pour
AMEX
owner.billingAddress.cityName Ville du titulaire non AN40 Applicable uniquement pour
AMEX
owner.billingAddress.zipCode Code postal du titulaire non AN9 Applicable uniquement pour
AMEX
owner.billingAddress.Country Pays du titulaire non AN2 Applicable uniquement pour
AMEX
owner.billingAddress.phone Tlphone du titulaire non AN10 Applicable uniquement pour
AMEX
owner.issueCardDate Date dmission de la carte non AN4 Format respecter : mmyy.
Applicable uniquement pour
AMEX
securityMode Slection du mode de scurit oui SSL
utiliser pour la transaction de
paiement
4
recurring.firstAmount Le montant du premier montant Non N12 pour un montant de 100 ,
effectuer. Il doit tre formul vous devez mettre la valeur
dans la plus petite unit de la 10000.
devise.

Page 15/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
4
recurring.amount Le montant dune chance. Il Oui N12 pour un montant de 5 ,
doit tre formul dans la plus vous devez mettre la valeur
petite unit de la devise. 500.
4
recurring.billingCycle Le code de la frquence des Oui N2 40 : mensuel
paiements. 60 : trimestriel
cf. liste complte en annexe
Tableau : Liste des
frquences de paiement
4
recurring.billingLeft Nombre dchance Non N3 3
recurring.billingDay Jour o les chances doivent Non AN2 Format respecter : dd de
tre traites. [01 30]
4
recurring.startDate La date de la premire Non AN10 Format respecter :
chance (mode REC dd/mm/yyyy
uniquement). Si ce champ nest
pas renseign, Payline y affecte
la date du jour.

customPaymentTemplateURL URL du template dynamique non AN255 https://.... Uniquement.


contractNumberWalletList Un tableau des numros de non
contrat du wallet
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.
3
- Obligatoire pour les paiements par portefeuille.
4
lobjet recurring est obligatoire pour le paiement en plusieurs fois (payment.mode = NX) ou par
abonnement (payment.mode = REC)

Pour chaque ligne de dtail dune commande (details) :


Elment Commentaire Requis Format Exemple
ref Rfrence de larticle Non AN50 O-123
price Prix de larticle dans la plus petite unit Non N12 pour un montant de 100 ,
de la devise vous devez mettre la
valeur 10000.
quantity Quantit darticles Non N5
comment Commentaire Non

Pour chaque donne prive (privateData) :


Elment Commentaire Requis Format Exemple
key La cl qui vous permet de filtrer vos oui AN50 user
transactions de paiement
value La valeur associe la cl oui AN50 dupond or durand, etc

Page 16/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
3.1.2 Rponse en retour

Le message doWebPaymentResponse est la rponse faite par Payline une demande


dinitialisation de paiement web. Vous retrouvez dans ce message de rponse ladresse Internet
des pages web de paiement Payline ainsi que le jeton dauthentification utiliser pour votre
client.La rponse a la structure suivante :

Elment Description Format Exemple


result.code Le code de retour du web service : N5 cf. liste complte en annexe
00000 : Transaction accepte Code retour et message
Autre code : Transaction non accepte Payline
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
token Jeton horodat qui permet didentifier la
demande de paiement web du
commerant
redirectURL URL sur laquelle le navigateur de AN255 https://webpayment.payline.com
lacheteur doit tre redirig pour procder
au paiement.
stepCode Identifiant de la classe Action appeler AN20
pour la perso de lURL
reqCode ldentifiant de la mthode de la classe AN20
Action appeler pour la perso de lURL
method le mode de fonctionnement de lurl AN4 POST ou GET
personnalis.

3.2 Web service - Get Web Payment Details

Il est impratif aprs un doWebPayment de faire un getWebPaymentDetails, afin de garantir le


rsultat obtenu.
Le message getWebPaymentDetailsRequest vous permet de raliser une demande du rsultat
dun paiement web. Il vous suffit de prciser un jeton dauthentification li un paiement web pour
obtenir un rsultat dtaill.

3.2.1 Requte envoyer

La requte getWebPaymentDetailsRequest doit uniquement transmettre llment token


associ au paiement dune commande.
Elment Commentaire Requis Format Exemple
1
version Version des web services Payline Oui N1 A valoriser la valeur 3

Page 17/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Requis depuis 2011
token Jeton horodat qui permet didentifier le Oui AN50 sC5hTf3YCCUmSOvoMXg
commerant m1191189604975
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

3.2.2 Rponse en retour

Le message getWebPaymentDetailsResponse est la rponse faite par Payline une demande


du rsultat dun paiement web. Il vous permet dobtenir, entre autres, le numro unique de la
transaction sur Payline et le n dautorisation de dbit dlivr par votre tablissement bancaire. La
rponse a la structure suivante :

Elment Description Format Exemple


result.code Code de retour du web service. N5 00000 : Transaction
approved
01xxx : Transaction
refused
021xx : Internal Error
cf. liste complte en
annexe tableau Liste
des codes retours
result.shortMessage Message court du rsultat de la transaction AN50
result.longMessage Message du rsultat de la transaction AN255
transaction.id Identifiant unique de la transaction Payline N50
transaction.date Date et heure de la transaction Payline AN16 Format : dd/mm/yyyy
HH24:MI
transaction.isDuplicated Cet indicateur est retourn par Payline AN1 1 = transaction en
dans le cas de transaction en doublon doublon
0 = pas de doublon
dtect
transaction.isPossibleFraud Cet indicateur est calcul en fonction des AN1 1 = Il existe un risque de
critres dfinis par le commerant fraude
0 = Aucun risque de
fraude dtect
transaction.fraudResult Code de la fraude AN50
transaction.fraudResultDetails Details de la fraude
transaction.explanation Motif du refus en cas de fraude AN50
transaction.threeDSecure Cet indicateur permet de savoir si la AN1 Y = Transaction 3DS
transaction est 3DSecure ou non. N = Transaction non
3DS
transaction.score Scoring de la possibilit de fraude N5 Score de 0 10
transaction.externalWalletType Type de wallet utilis lors de la transaction AN20 Ex : V.Me, Masterpass
transaction.externalWalletCont Numro du contrat VAD associ au AN50
ractNumber paiement par Wallet
Page 18/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
payment.amount Informations transmises lors de lappel de N12
la fonction doWebPayment
payment.currency Idem N3
payment.action Idem N3
payment.mode Idem AN3
payment.contractNumber Idem AN50
payment.differedActionDate Idem AN8 Format : dd/mm/yy
payment.method Nom de lmetteur de la carte (version 10 AN20 Ex : CB,
ou suprieure) PAYSAFECARD
authorization.number Numro dautorisation dlivr par le N6 123456
serveur dautorisation acqureur. Ce
champ est renseign si la demande
dautorisation est accorde1.
authorization.date Date et heure de lautorisation AN16 Format : dd/mm/yyyy
HH24:MI
privateDataList Informations transmises lors de lappel de AN Tableau de privateData
la fonction doWebPayment
paymentRecordId Identifiant du dossier de paiement AN 173661
2
billingRecordList Tableau dchances Tableau de
billingRecord
authentication3DSecure.md Renvoy en POST par lACS AN20
authentication3DSecure.pares Renvoy en POST par lACS AN
authentication3DSecure.xid Identifiant de transaction Unique AN20
authentication3DSecure.eci Electronic Commerce Indicator. A passer AN2
dans lautorisation
authentication3DSecure.cavv Cardholder Authentication Verification AN26-
Value dtermin par lACS. 28
authentication3DSecure.cavvA Entier positif prcisant lalgorithme utilis AN20
lgorithm pour la gnration CAVV. Les valeurs
possibles actuelles sont:
0 = HMAC (SET TransStain),
1 = CVV,
2 = CVV avec ATN,
3 = MasterCard AAV
authentication3DSecure.vadsR Rsum des oprations 3DSecure AN4
esult
authentication3DSecure.typeS Renvoie la valeur du type de scurisation N2
ecurisation
Card. encryptionKeyId Identifiant de la cl RSA Payline de chiffrement N4
Ne pas tenir compte de ce champ.
Card.encryptedData Les donnes carte chiffres AN400
Ne pas tenir compte de ce champ.
card.number Carte marqu conforme PCI DSS 111122XXXXXX4444
Page 19/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
card.type Type de la carte Ex Visa parchase, MC
business
card.expirationDate Date dexpiration de la carte 0311
card.cvx Cryptogramme visuel au dos de la carte de N10
crdit
card.ownerBirthdayDate Date danniversaire du porteur N6 Format respecter
:ddmmyy
card.password Mot de passe crypt AN16
card.cardPresent Ce service est utilise uniquement si vous faites N1 0 ou 1 (prsent)
du Mail Order ou Telephone Order ou alors
dans le cas o linternaute est prsent
physiquement
card.cardholder Titulaire de la carte AN20 Pierre Dupont
1
card.token Alias du numro de carte. AN19 1111gPNzHtyu4444
La version doit tre suprieure ou gale
3
extendedCard.country Pays demission de la carte 2 CODE ISO : exemple
FR
extendedCard.isCvd La carte est elle une e carte bleu A1 Y OR N
extendedCard.bank La banque de la carte utilise pour le AN Crdit Lyonnais
paiement
extendedCard.type Le type de carte de paiement AN20 MASTERCARD
extendedCard.network Dsigne le rattachement de la carte une AN20 MASTERCARD
entit grant lacceptation de la carte un
niveau national ou international
extendedCard.product Indique la catgorie laquelle appartient le AN Gold/Premier pour une
type de la carte carte type VISA
order.ref Rfrence de larticle AN50
order.origin Origine de la commande AN2 MO TO
Ce champs est utilis uniquement dans le
cadre de loption choisi Mail Order ou
Telephone Order
order.country Pays FR
order.taxes Taxe
order.amount Montant
order.currency La devise 978
order.date Date de la commande 2011-02-16
order.details Informations sur les articles commands
Tableau OrderDetails
order.deliveryTime Dlai de livraison (version 4 et suprieure) N1 Ex : 1
1 (Express),
2 (Standard)

Page 20/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
order.deliveryMode Mode de livraison (version 4 et suprieure) N1 Ex : 2
1 Retrait chez le marchand
2 Retrait dans un rseau de points retraits
3 Retrait dans un aroport, gare, etc
4 Transporteur (La Poste, etc)
5 Electronique (tlchargement,)
order.deliveryExpectedDate Date prvue de livraison AN
order.deliveryExpectedDelay Dlai prvu de livraison (en jours) N
3
paymentAdditionalList Tableau des paiements complmentaires Tableau de
paymentAdditional
media
1
Dtection du mdia par Payline utilis lors AN25 Computer

du paiement.

Les valeurs possibles de cette balise sont :


- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined
1
numberOfAttempt Le nombre de tentatives faites par le client N1 3
lors de son paiement web
Liste des valeurs possibles :
-0 : Aucune tentative de paiement
- 1, 2 ou 3 tentatives de paiement
- 4, 5 ou 6 tentatives de paiement
(uniquement possible avec loption rejeu de
la transaction)
wallet -

contractNumberWalletList Un tableau des numros de contrat du


wallet

1
- Vous devez utilisez loption de token PAN et la version doit tre suprieure ou gale 3.
2
- Uniquement dans le cas dun paiement rcurrent ou par abonnement.
3
- Uniquement dans le cas de paiement(s) complmentaire(s)
4
- Uniquement dans le cas o la balise version est remplie avec la valeur 5 ou plus dans la
requte

Page 21/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Pour chaque chance (billingRecord) :

Elment Commentaire Requis Exemple


2
billingRecord.date La date de lchance AN10 Format : dd/mm/yyyy
2
billingRecord.amount Le montant de lchance dans la plus N12
petite unit de la devise.
2
billingRecord.status Le statut dune chance : AN1
0 : chance venir.
1 : chance accept.
2 : chance refus.
2
billingRecord.result.code Le code de retour du traitement de N5 cf. liste complte en
lchance annexe tableau Liste
00000 : Transaction approved des codes retours
01xxx : Transaction refused
billingRecord.result.shortMessag Message court du rsultat de la AN50
2
e transaction
billingRecord.result.longMessage Message du rsultat de la transaction AN255
2

2
billingRecord.transaction.Id Identifiant unique de la transaction N50
Payline
billingRecord.transaction.isPossi Cet indicateur est calcul en fonction des AN1 1 = Il existe un risque
2
bleFraud critres dfinis par le commerant de fraude
0 = Aucun risque de
fraude dtect
billingRecord.transaction.isDuplic Cet indicateur est retourn par Payline AN1 1 = Il existe un risque
2
ated dans le cas de transaction en doublon de fraude
0 = Aucun risque de
fraude dtect
2
billingRecord.transaction.date Date et heure de la transaction Payline AN16 Format :dd/mm/yyyy
HH24:MI
billingRecord.authorization.numb Numro dautorisation dlivr par le N6 123456
2
er serveur dautorisation acqureur. Ce
champ est renseign si la demande
dautorisation est accorde*.

2
billingRecord.authorization.date Date et heure de lautorisation AN16 Format :dd/mm/yyyy
HH24:MI
billingRecord.nbTry Nombre de tentatives de paiement N3
effectues (version suprieure ou gale
8)
billingRecord.rank Rang de lchance au sein du dossier de N12
paiement ((version suprieure ou gale
8))

Page 22/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Commentaire Requis Exemple
billingRecord.executionDate Date de la prochaine tentative de AN10 Format : dd/mm/yyyy
paiement

Pour chaque ligne de dtail dune commande (OrderDetails) :


Elment Commentaire Requis Format Exemple
ref Rfrence de larticle Non AN50
price Prix de larticle dans la plus petite unit Non N12
de la devise
quantity Quantit darticles Non N5
comment Texte libre Non AN255
category Non AN50
brand Marque du produit Non AN50 Ex : HERMES
Subcategory1 Sous-categorie de rang 1 Non AN50 Ex : Bijoux & Montres
Subcategory2 Sous-categorie de rang 2 Non AN50 Ex : Bijoux
additionalData Liste de caractristiques Non AN255 Ex :
LegalAge=18&Discount=0105
taxRate Taux de la taxe de larticle (exprime en Non N4 Ex : 1580 pour 15,8 %
centime)

Page 23/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Pour chaque paiement complmentaire (paymentAdditional) :

Elment Commentaire Requis Exemple


3
transaction.id Identifiant unique de la transaction N50
Payline
3
transaction.date Date et heure de la transaction Payline AN16 Format :dd/mm/yyyy
HH24:MI
3
transaction.isDuplicated Cet indicateur est retourn par Payline AN1 1 = Il existe un risque
dans le cas de transaction en doublon de fraude
0 = Aucun risque de
fraude dtect
3
transaction.isPossibleFraud Cet indicateur est calcul en fonction des AN1 1 = Il existe un risque
critres dfinis par le commerant de fraude
0 = Aucun risque de
fraude dtect
3
transaction.fraudResult Code de la fraude AN50
transaction.fraudResultDetails Details de la fraude
3
transaction.explanation Motif du refus en cas de fraude AN50
3
transaction.score Scoring de la possibilit de fraude N5 Score de 0 10
transaction.externalWalletType Type de wallet utilis lors de la AN20 Ex : V.Me, Masterpass
transaction
transaction.externalWalletContr Numro du contrat VAD associ au AN50
actNumber paiement par Wallet
3
payment.amount Informations transmises lors de lappel de N12
la fonction doWebPayment
3
payment.currency Idem N3
3
payment.action Idem N3
3
payment.mode Idem AN3
3
payment.contractNumber Idem AN50
3
payment.differedActionDate Idem AN8 Format : dd/mm/yy
1
media Dtection du mdia par Payline utilis AN25 Mobile
lors du paiement.
3
authorization.number Numro dautorisation dlivr par le N6 123456
serveur dautorisation acqureur. Ce
champ est renseign si la demande
dautorisation est accorde1.
3
authorization.date Date et heure de lautorisation AN16 Format : dd/mm/yyyy
HH24:MI
3
authentication3DSecure.md Renvoy en POST par lACS AN20
3
authentication3DSecure.xid Identifiant de transaction Unique AN20
3
authentication3DSecure.eci Electronic Commerce Indicator. A passer AN2
dans lautorisation
3
authentication3DSecure.cavv Cardholder Authentication Verification AN26-
Value dtermin par lACS. 28
Page 24/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Commentaire Requis Exemple
authentication3DSecure.cavvAl Entier positif prcisant lalgorithme utilis AN20
3
gorithm pour la gnration CAVV. Les valeurs
possibles actuelles sont:
0 = HMAC (SET TransStain),
1 = CVV,
2 = CVV avec ATN,
3 = MasterCard AAV
authentication3DSecure.vadsR Rsum des oprations 3DSecure AN4
3
esult
3
card.number Carte marqu conforme PCI DSS 111122XXXXXX4444
3
card.expirationDate Date dexpiration de la carte 0311
1
card.token Alias du numro de carte AN19 1111gPNzHtyu4444
3
extendedCard.country Pays demission de la carte 2 CODE ISO : exemple
FR
3
extendedCard.isCvd La carte est elle une e carte bleu A1 Y OR N
3
extendedCard.bank La banque de la carte utilise pour le AN Crdit Lyonnais
paiement
3
extendedCard.type Le type de carte de paiement AN20 MASTERCARD
3
extendedCard.network Dsigne le rattachement de la carte AN20 MASTERCARD
une entit grant lacceptation de la carte
un niveau national ou international
3
extendedCard.product Indique la catgorie laquelle appartient AN Gold/Premier pour une
le type de la carte carte type VISA
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Uniquement dans le cas dun paiement rcurrent ou par abonnement.
3
- Uniquement dans le cas de paiement(s) complmentaire(s)

Page 25/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
3.3 Web service - Create Web Wallet

La fonction create web wallet permet dinitialiser la cration dun portefeuille virtuel via
linterface web. Une fois votre client redirig, il sera invit saisir ses donnes bancaires pour
crer son portefeuille virtuel. Payline contrle ces informations par une demande dautorisation de
dbit pour un montant dun euro seulement (la validation na pas lieu, donc aucune carte nest
crdit lors de la cration) et enregistre le portefeuille de votre client avec lidentifiant (walletID)
que vous avez fourni.
Il est ncessaire que le contrat VAD fournit par la banque, autorise le commerant pouvoir
raliser des paiements sans cryptogramme soit obtenir un contrat VAD autorisant deffectuer des
paiements rcurrent.

Cette fonctionnalit permettra, partir de la version V4.31, livre en octobre 2012, la gestion des
cartes du portefeuille client. Une fois votre client redirig, votre client pourra :
- consulter la ou les cartes enregistres sur son portefeuille
- supprimer une carte enregistre sur son portefeuille
- ajouter une carte dans son portefeuille
- positionner comme moyen de paiement par dfaut une carte de son portefeuille

3.3.1 Requte envoyer

La requte createWebWalletRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la valeur
Payline 3
Requis depuis 2011
contractNumber le code ou numro de votre oui AN50
contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser.
selectedContractList La liste des numros de contrat non Si 1 seul contrat est
que vous souhaitez utiliser pour rempli, Payline
ce paiement. Payline affiche la affiche une page de
liste des moyens de paiement saisie des
en respectant lordre dans coordonnes
lequel la liste t renseigne. bancaires.

Si ce champ nest pas Si 2 contrats ou plus


renseign, Payline affiche sont indiqus,
lensemble de vos moyens de Payline affiche une
paiement actif sur le point de page de slection
vente. des moyens de

Page 26/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
paiement
updatePersonalDetails Indicateur de possibilit de oui AN1
mise jour des donnes
personnelles par le porteur du
portefeuille.
Vide : Mise jour interdite
0 : Mise jour interdite
1 : Mise jour autorise.
buyer.lastName Nom de lacheteur oui AN100
buyer.firstName Prnom de lacheteur oui AN100
buyer.email Adresse email de lacheteur non AN150
buyer.shippingAddress.name Nom ou numro dimmeuble non AN100
buyer.shippingAddress.street1 Nom de rue non AN100
buyer.shippingAddress.street2 Complment du nom de rue non AN100
buyer.shippingAddress.cityNa Ville non AN40
me
buyer.shippingAddress.zipCod Code postal non AN20
e
buyer.shippingAddress.country Pays non AN2 ISO 3166-1
buyer.shippingAddress.phone Tlphone non AN15
buyer.accountCreateDate La date de cration du compte non AN8 Format respecter :
de lacheteur dd/mm/yy
accountAverageAmount Le montant moyen des achats non N10
de cet acheteur
buyer.accountOrderCount Le nombre de commande non N10
pass par cet acheteur
buyer.walletId Lidentifiant du portefeuille oui AN50
virtuel de votre client.
buyer.walletDisplayed Gestion de laffichage des non AN5 Pour ne pas affcicher
moyens de paiement de votre les donnes de
client paiement client, saisir
la valeur none .
Pour afficher les
donnes de paiement
client, la balise doit
tre vide ou absente
buyer.walletSecured Nature du contrle ajout la non AN12 Pour raliser un
cinmatique de paiement WEB. contrle sur le
crytpogramme visuel,
saisir la valeur
CVV

Page 27/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
buyer.walletCardInd Spcifie lindex de la carte non AN2 Lindex de la carte,
utiliser. valeur par dfaut
1
buyer.ip Ladresse IP de lacheteur non AN50 Format respecter :
IPv4 ou IPv6
buyer.mobilePhone Le numro de mobile de non N15 Ex : 0033691666666
lacheteur Pour envoi de SMS
lacheteur
buyer.customerId Identifiant client non AN50 Ex : 894492568
Cette donne peut
tre un identifiant ou
un email
owner.lastName Nom du titulaire non AN30 Applicable
uniquement pour
AMEX
owner.firstName Prnom du titulaire non AN15 Applicable
uniquement pour
AMEX
owner.billingAddress.Street Nom de rue du titulaire non AN20 Applicable
uniquement pour
AMEX
owner.billingAddress.CityNam Ville du titulaire non AN40 Applicable
e uniquement pour
AMEX
owner.billingAddress.ZipCode Code postal du titulaire non AN9 Applicable
uniquement pour
AMEX
owner.billingAddress.Country Pays du titulaire non AN2 Applicable
uniquement pour
AMEX
owner.billingAddress.phone Tlphone du titulaire non AN10 Applicable
uniquement pour
AMEX
owner.issueCardDate Date dmission de la carte non AN4 Format respecter :
mmyy. Applicable
uniquement pour
AMEX
languageCode renseignez ce champ avec le non AN6 Pour afficher les
code ISO de la langue dans pages en italien,
laquelle vous souhaitez faire veuillez mettre la
afficher les pages web de valeur IT.
paiement Payline. Par dfaut,
cest le navigateur Internet de

Page 28/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
votre client qui demande
Payline la page dans la langue
souhaite.

fre/fra : Franais
eng : Anglais
cf. liste complte en annexe
tableau Liste des code
langues
customPaymentPageCode Lidentifiant de personnalisation non AN50 1fd51s2dfs51
des pages web du commerant
securityMode Slection du mode de scurit oui SSL
utiliser pour la transaction de cf. liste complte en
paiement annexe tableau
Liste des mode
scurit
returnURL URL sur laquelle le navigateur oui AN255 http://... ou https://...
de lacheteur est redirig aprs
validation du paiement sur
Payline.
cancelURL URL sur laquelle le navigateur oui AN255 http://... ou https://...
de lacheteur est redirig sil
dcide de ne pas valider le
paiement ou que Payline ne
peut pas autoriser le paiement
de ce client.
notificationURL URL sur laquelle Payline va non AN255 http://... ou https://...
demander au site commerant
de rcuprer le rsultat de la
transaction.
privateDataList Vos propres informations non Tableau
personnelles PrivateData
customPaymentTemplateURL URL du template dynamique Non AN255 https://....
Uniquement.
contractNumberWalletList Un tableau des numros de non
contrat du wallet

Page 29/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
3.3.2 Rponse en retour

Vous retrouvez dans ce message de rponse ladresse Internet des pages web de cration de
portefeuille virtuel ainsi que le jeton dauthentification utiliser pour votre client. La rponse a la
structure suivante :

Elment Description Format Exemple


result.code Le code de retour du web service : N5 cf. liste complte en annexe
00000 : Transaction approved Code retour et message
023xx : Invalid Transaction Payline
02502 : Wallet with the same identifier exist
02511 : Wallet is not supported for this
card
02101 : Internal Error
result.shortMessage Message court du rsultat de la transaction AN50
result.longMessage Message du rsultat de la transaction AN255
token Jeton horodat qui permet didentifier la AN50
demande de paiement web du commerant
redirectURL URL sur laquelle le navigateur de AN255 https://webpayment.payline.com
lacheteur doit tre redirig pour procder
au paiement.

3.4 Update Web Wallet

La fonction updateWebWallet permet dinitialiser la modification dun portefeuille virtuel via


linterface web. Une fois votre client redirig, il sera invit saisir ses donnes bancaires pour
modifier son portefeuille virtuel. Payline contrle ces informations et met jour le portefeuille de
votre client avec lidentifiant (walletID) que vous avez fourni.

3.4.1 Requte envoyer

La requte updateWebWalletRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la
Payline valeur 3
Requis depuis 2011
contractNumber le code ou numro de votre oui AN50
contrat VAD qui reprsente le
moyen de paiement que vous
Page 30/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
souhaitez utiliser.
cardInd Ce champs est obligatoire si non 2 Lindex de la carte,
vous utilisez les multiwallet valeur par dfaut
01
walletId Lidentifiant du portefeuille oui AN50
virtuel de votre client.
updatePersonalDetails Indicateur de possibilit de oui AN1
mise jour des donnes
personnelles par le porteur du
portefeuille.
Vide : Mise jour interdite
0 : Mise jour interdite
1 : Mise jour autorise.
updatePaymentDetails Indicateur de possibilit de oui AN1
mise jour des donnes de
paiement par le porteur du
portefeuille.
Vide : Mise jour interdite
0 : Mise jour interdite
1 : Mise jour autorise.
updateOwnerDetails Indicateur de possibilit de non AN1 Applicable
mise jour des donnes du uniquement pour
titulaire de la carte. AMEX
Vide : Mise jour interdite
0 : Mise jour interdite
1 : Mise jour autorise.
languageCode renseignez ce champ avec le non AN6 Pour afficher les
code ISO de la langue dans pages en italien,
laquelle vous souhaitez faire veuillez mettre la
afficher les pages web de valeur IT.
paiement Payline. Par dfaut,
cest le navigateur Internet de
votre client qui demande
Payline la page dans la
langue souhaite.

FR ou fra : Franais
eng : Anglais
cf. liste complte en annexe
tableau Liste des code
langues
customPaymentPageCode Lidentifiant de non AN50 1fd51s2dfs51
personnalisation des pages
web du commerant
Page 31/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
securityMode Slection du mode de oui SSL
scurit utiliser pour la cf. liste complte en
transaction de paiement annexe
Tableau: Liste
des modes
scurit
returnURL URL sur laquelle le oui AN255 http://... ou https://...
navigateur de lacheteur est
redirig aprs validation du
paiement sur Payline.
cancelURL URL sur laquelle le oui AN255 http://... ou https://...
navigateur de lacheteur est
redirig si il dcide de ne pas
valider le paiement ou que
Payline ne peut pas autoriser
le paiement de ce client.
notificationURL URL sur laquelle Payline va non AN255 http://... ou https://...
demander au site
commerant de rcuprer le
rsultat de la transaction.
privateDataList Vos propres informations non Tableau
personnelles PrivateData
customPaymentTemplateURL URL du template dynamique non https://....
Uniquement.
contractNumberWalletList Un tableau des numros de non
contrat du wallet
buyer.lastName Nom de lacheteur non AN100
buyer.firstName Prnom de lacheteur non AN100
buyer.email Adresse email de lacheteur non AN150
buyer.shippingAddress.name Nom ou numro dimmeuble non AN100
buyer.shippingAddress.street1 Nom de rue non AN100
buyer.shippingAddress.street2 Complment du nom de rue non AN100
buyer.shippingAddress.cityNa Ville non AN40
me
buyer.shippingAddress.zipCod Code postal non AN20
e
buyer.shippingAddress.country Pays non AN2 ISO 3166-1
buyer.shippingAddress.phone Tlphone non AN15 +351001110102
buyer.accountCreateDate La date de cration du non AN10 Format
compte de lacheteur respecter :
dd/mm/yy
buyer.accountAverageAmount Le montant moyen des achats non N10
de cet acheteur
Page 32/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
buyer.accountOrderCount Le nombre de commande non N10
pass par cet acheteur
3
buyer.walletId Lidentifiant du portefeuille Non AN50
virtuel de votre client.
buyer.walletDisplayed Gestion de laffichage des non AN5 Pour ne pas
moyens de paiement de votre affcicher les
client donnes de
paiement client,
saisir la valeur
none .
Pour afficher les
donnes de
paiement client, la
balise doit tre vide
ou absente
buyer.walletSecured Nature du contrle ajout la non AN12 Pour raliser un
cinmatique de paiement contrle sur le
WEB. crytpogramme
visuel, saisir la
valeur CVV
buyer.walletCardInd Spcifie lindex de la carte non AN2 Lindex de la carte,
utiliser. valeur par dfaut
1
buyer.ip Ladresse IP de lacheteur non AN50 Format respecter
: IPv4 ou IPv6
buyer.mobilePhone Le numro de mobile de non N15 Ex :
lacheteur 0033691666666
Pour envoi de SMS
lacheteur
buyer.customerId Identifiant client non AN50 Ex : 894492568
Cette donne peut
tre un identifiant
ou un email

3.4.2 Rponse en retour

Vous retrouvez dans ce message de rponse ladresse Internet des pages web de cration de
portefeuille virtuel ainsi que le jeton dauthentification utiliser pour votre client. La rponse a la
structure suivante :

Elment Description Format Exemple


result.code Le code de retour du web service : N5 cf. liste complte en annexe
00000 : Transaction Approved tableau Liste des codes

Page 33/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
023xx : Invalid Transaction retours
02502 : Wallet with the same identifier exist
02503 : Wallet does not exist
02511 : Wallet is not supported for this
card
02101 : Internal Error
result.shortMessage Message court du rsultat de la transaction AN50
result.longMessage Message du rsultat de la transaction AN255
token Jeton horodat qui permet didentifier la AN50
demande de paiement web du commerant
redirectURL URL sur laquelle le navigateur de AN255 https://webpayment.payline.com
lacheteur doit tre redirig pour procder
au paiement.

3.5 Web service - Get Web Wallet

Il est impratif aprs la cration ou la mise jour dun WALLET, dutiliser le webservice
getWebWallet, qui vous garantira le rsultat obtenu.
La mthode permet de rcuprer les informations dun portefeuille virtuel cre via linterface web.

3.5.1 Requte envoyer

La requte getWebWalletRequest comprend :

Elment Description Requis Type Exemple


version Version des web services Payline oui N1 A valoriser la
Requis depuis 2011 valeur 3
token Jeton horodat qui permet didentifier le oui AN50
commerant.

3.5.2 Rponse en retour

Le message getWebWalletResponse est la rponse dune demande dinformations dun


portefeuille virtuel

Elment Description Format Exemple

Page 34/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
result.code Le code de retour du web service N5 cf. liste complte en
02500: Operation Successful annexe Code retour et
02304: Invalid Transaction message Payline
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
wallet.walletId Lidentifiant unique du portefeuille AN50
virtuel. Vous devez communiquer
Payline un identifiant unique qui
correspond un et un seul client sur
votre systme dinformation. Cest avec
ce mme identifiant vous pourrez
demander un paiement par portefeuille
virtuel.
wallet.lastName Le nom de votre client. Ces informations AN100
sont utiles pour rechercher un
portefeuille dans le Centre
dAdministration Commercant.
wallet.firstName Le prnom de votre client. AN100
wallet.email Ladresse de messagerie de votre client. AN150
Payline utilisera cette information pour
envoyer un justificatif de paiement
votre client.
wallet.shippingAddress.name Nom ou numro dimmeuble AN100
wallet.shippingAddress.street1 Nom de rue AN100
wallet.shippingAddress.street2 Complment du nom de rue AN100
wallet.shippingAddress.cityName Ville AN40
wallet.shippingAddress.zipCode Code postal AN20
wallet.shippingAddress.country Pays AN2
wallet.shippingAddress.phone Tlphone AN15
wallet.card.number Numro de carte N19
wallet.card.type Type de carte utilis pour la transaction AN40 CB : visa / mastercard
AMEX : American
express
cf. liste complte en
annexe Tableau : Liste
des types de carte
wallet.card.expirationDate Date dexpiration de la carte N4 Format respecter :
mmyy
wallet.card.cvx Cryptogramme visuel au dos de la carte N10
de crdit
wallet.card.ownerBirthdayDate Date danniversaire du porteur N6 Format respecter :
ddmmyy
wallet.card.password Mot de passe crypt AN16
Page 35/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
wallet.card.cardholder Titulaire de la carte AN20 Pierre Dupont
1
Wallet.card.token Alias du numro de carte AN19 1111gPNzHtyu4444
wallet.comment Commentaires AN255
media
1
Dtection du mdia utilis par Payline. AN25 Computer

Les valeurs possibles de cette balise sont :


- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

numberOfAttempt
1
Le nombre de tentatives faites par le N1 5

client lors de son paiement web


Liste des valeurs possibles :
-0 : Aucune tentative de paiement
- 1, 2 ou 3 tentatives de paiement
- 4, 5 ou 6 tentatives de paiement
(uniquement possible avec loption rejeu de
la transaction)

privateDataList Vos informations prives que vous Tableau de donnes


souhaitez transmettre prives
extendedcard.country Pays demission de la carte 2 CODE ISO : exemple
FR
extendedcard.isCvd La carte est elle une e carte bleu N1 Y OR N
extendedCard.bank La banque de la carte utilise pour le AN Crdit Lyonnais
paiement
extendedCard.type Le type de carte de paiement AN20 MASTERCARD
extendedCard.network Dsigne le rattachement de la carte AN20 MASTERCARD
une entit grant lacceptation de la
carte un niveau national ou
international
extendedCard.product Indique la catgorie laquelle appartient AN Gold/Premier pour une
le type de la carte carte type VISA
owner.lastName Nom du titulaire AN30 Applicable uniquement
pour AMEX
owner.firstName Prnom du titulaire AN15 Applicable uniquement
pour AMEX
owner.issueCardDate Date dmission de la carte AN4 Format respecter :
mmyy. Applicable
uniquement pour AMEX
owner.billingAddress.Street Nom de rue du titulaire AN20 Applicable uniquement
pour AMEX

Page 36/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
owner.billingAddress.CityName Ville du titulaire AN40 Applicable uniquement
pour AMEX
owner.billingAddress.ZipCode Code postal du titulaire AN9 Applicable uniquement
pour AMEX
owner.billingAddress.Country Pays du titulaire AN2 Applicable uniquement
pour AMEX
owner.billingAddress.Phone Tlphone du titulaire AN10 Applicable uniquement
pour AMEX
contractNumberWalletList Un tableau des numros de contrat du
wallet
2
buyer.lastName Nom de lacheteur AN100
2
buyer.firstName Prnom de lacheteur AN100
2
buyer.email Adresse email de lacheteur AN150
2
buyer.shippingAddress.name Nom ou numro dimmeuble AN100
2
buyer.shippingAddress.street1 Nom de rue AN100
2
buyer.shippingAddress.street2 Complment du nom de rue AN100
2
buyer.shippingAddress.cityName Ville AN40
2
buyer.shippingAddress.zipCode Code postal AN20
2
buyer.shippingAddress.country Pays AN2 ISO 3166-1
2
buyer.shippingAddress.phone Tlphone AN15 +351001110102
2
buyer.accountCreateDate La date de cration du compte de AN10 Format respecter :
lacheteur dd/mm/yy
2
buyer.accountAverageAmount Le montant moyen des achats de cet N10
acheteur
2
buyer.accountOrderCount Le nombre de commande pass par cet N10
acheteur
2
buyer.walletId Lidentifiant du portefeuille virtuel de AN50
votre client.
2
buyer.walletDisplayed Gestion de laffichage des moyens de AN5 Pour ne pas affcicher
paiement de votre client les donnes de
paiement client, saisir la
valeur none .
Pour afficher les
donnes de paiement
client, la balise doit tre
vide ou absente
2
buyer.walletSecured Nature du contrle ajout la AN12 Pour raliser un contrle
cinmatique de paiement WEB. sur le crytpogramme
visuel, saisir la valeur
CVV
2
buyer.walletCardInd Spcifie lindex de la carte utiliser. AN2 Lindex de la carte,
valeur par dfaut 1
2
buyer.ip Ladresse IP de lacheteur AN50 Format respecter :
IPv4 ou IPv6
Page 37/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
2
buyer.mobilePhone Le numro de mobile de lacheteur N15 Ex : 0033691666666
Pour envoi de SMS
lacheteur
2
buyer.customerId Identifiant client AN50 Ex : 894492568
Cette donne peut tre
un identifiant ou un
email
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Uniquement dans le cas o la balise version est remplie avec la valeur 5 ou plus dans la requte

3.6 Web service - Manage Web Wallet

La fonction manage web wallet permet linstar de la fonction create web wallet dinitialiser
la cration dun portefeuille virtuel via linterface web. (cf. p 22)

Cette fonctionnalit vous permet galement la gestion des cartes du portefeuille client. Une fois
votre client redirig, il lui sera possible de :
- consulter la ou les cartes enregistres sur son portefeuille
- supprimer une carte enregistre sur son portefeuille
- ajouter autant de carte que souhait dans son portefeuille
- positionner comme moyen de paiement par dfaut une carte de son portefeuille

3.6.1 Requte envoyer

La requte manageWebWalletRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la valeur
Payline 3
Requis depuis 2011
contractNumber le code ou numro de votre oui AN50
contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser.
selectedContractList La liste des numros de contrat non Si 1 seul contrat est
que vous souhaitez utiliser pour rempli, Payline
ce paiement. Payline affiche la affiche une page de
liste des moyens de paiement saisie des
en respectant lordre dans coordonnes
lequel la liste t renseigne. bancaires.

Si ce champ nest pas Si 2 contrats ou plus


Page 38/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
renseign, Payline affiche sont indiqus,
lensemble de vos moyens de Payline affiche une
paiement actif sur le point de page de slection
vente. des moyens de
paiement
updatePersonalDetails Indicateur de possibilit de oui AN1
mise jour des donnes
personnelles par le porteur du
portefeuille.
Vide : Mise jour interdite
0 : Mise jour interdite
1 : Mise jour autorise.
buyer.lastName Nom de lacheteur oui AN100
buyer.firstName Prnom de lacheteur oui AN100
buyer.email Adresse email de lacheteur non AN150
buyer.shippingAddress.name Nom ou numro dimmeuble non AN100
buyer.shippingAddress.street1 Nom de rue non AN100
buyer.shippingAddress.street2 Complment du nom de rue non AN100
buyer.shippingAddress.cityNa Ville non AN40
me
buyer.shippingAddress.zipCod Code postal non AN20
e
buyer.shippingAddress.country Pays non AN2 ISO 3166-1
buyer.shippingAddress.phone Tlphone non AN15
buyer.accountCreateDate La date de cration du compte non AN8 Format respecter :
de lacheteur dd/mm/yy
accountAverageAmount Le montant moyen des achats non N10
de cet acheteur
buyer.accountOrderCount Le nombre de commande non N10
pass par cet acheteur
buyer.walletId Lidentifiant du portefeuille oui AN50
virtuel de votre client.
buyer.walletDisplayed Gestion de laffichage des non AN5 Pour ne pas affcicher
moyens de paiement de votre les donnes de
client paiement client, saisir
la valeur none .
Pour afficher les
donnes de paiement
client, la balise doit
tre vide ou absente

Page 39/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
buyer.walletSecured Nature du contrle ajout la non AN12 Pour raliser un
cinmatique de paiement WEB. contrle sur le
crytpogramme visuel,
saisir la valeur
CVV
buyer.walletCardInd Spcifie lindex de la carte non AN2 Lindex de la carte,
utiliser. valeur par dfaut
1
buyer.ip Ladresse IP de lacheteur non AN50 Format respecter :
IPv4 ou IPv6
buyer.mobilePhone Le numro de mobile de non N15 Ex : 0033691666666
lacheteur Pour envoi de SMS
lacheteur
buyer.customerId Identifiant client non AN50 Ex : 894492568
Cette donne peut
tre un identifiant ou
un email
owner.lastName Nom du titulaire non AN30 Applicable
uniquement pour
AMEX
owner.firstName Prnom du titulaire non AN15 Applicable
uniquement pour
AMEX
owner.billingAddress.Street Nom de rue du titulaire non AN20 Applicable
uniquement pour
AMEX
owner.billingAddress.CityNam Ville du titulaire non AN40 Applicable
e uniquement pour
AMEX
owner.billingAddress.ZipCode Code postal du titulaire non AN9 Applicable
uniquement pour
AMEX
owner.billingAddress.Country Pays du titulaire non AN2 Applicable
uniquement pour
AMEX
owner.billingAddress.phone Tlphone du titulaire non AN10 Applicable
uniquement pour
AMEX
owner.issueCardDate Date dmission de la carte non AN4 Format respecter :
mmyy. Applicable
uniquement pour
AMEX
languageCode renseignez ce champ avec le non AN6 Pour afficher les

Page 40/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
code ISO de la langue dans pages en italien,
laquelle vous souhaitez faire veuillez mettre la
afficher les pages web de valeur IT.
paiement Payline. Par dfaut,
cest le navigateur Internet de
votre client qui demande
Payline la page dans la langue
souhaite.

fre/fra : Franais
eng : Anglais
cf. liste complte en annexe
tableau Liste des code
langues
customPaymentPageCode Lidentifiant de personnalisation non AN50 1fd51s2dfs51
des pages web du commerant
securityMode Slection du mode de scurit oui SSL
utiliser pour la transaction de cf. liste complte en
paiement annexe tableau
Liste des mode
scurit
returnURL URL sur laquelle le navigateur oui AN255 http://... ou https://...
de lacheteur est redirig aprs
validation du paiement sur
Payline.
cancelURL URL sur laquelle le navigateur oui AN255 http://... ou https://...
de lacheteur est redirig sil
dcide de ne pas valider le
paiement ou que Payline ne
peut pas autoriser le paiement
de ce client.
notificationURL URL sur laquelle Payline va non AN255 http://... ou https://...
demander au site commerant
de rcuprer le rsultat de la
transaction.
privateDataList Vos propres informations non Tableau
personnelles PrivateData
customPaymentTemplateURL URL du template dynamique Non AN255 https://....
Uniquement.
contractNumberWalletList Un tableau des numros de non
contrat du wallet

Page 41/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
3.6.2 Rponse en retour

Vous retrouvez dans ce message de rponse ladresse Internet des pages web de gestion de
portefeuille virtuel ainsi que le jeton dauthentification utiliser pour votre client. La rponse a la
structure suivante :

Elment Description Format Exemple


result.code Le code de retour du web service : N5 cf. liste complte en annexe
00000 : Transaction approved Code retour et message
023xx : Invalid Transaction Payline
02502 : Wallet with the same identifier exist
02511 : Wallet is not supported for this
card
02101 : Internal Error
result.shortMessage Message court du rsultat de la transaction AN50
result.longMessage Message du rsultat de la transaction AN255
token Jeton horodat qui permet didentifier la AN50
demande de paiement web du commerant
redirectURL URL sur laquelle le navigateur de AN255 https://webpayment.payline.com
lacheteur doit tre redirig pour procder
au paiement.

Page 42/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4 Interface direct de Payline

Mthode Description

doAuthorization Ralise une demande dautorisation de paiement


doCapture Valide une demande dautorisation accepte
doRefund Rembourse un paiement partir dun n da utorisation accepte
doCredit Recrdite une carte de paiement partir du compte commerant
doReset Annule une transaction partir dune transaction autorise et valide
mais non remise en banque.
createWallet Cration dun portefeuille client.
updateWallet Mise jour dun portefeuille client
getWallet Rcupre les informations qui constituent un portefeuille client
disableWallet Dsactive un portefeuille client
enableWallet Ractive un portefeuille client
doImmediateWalletPayment Ralise une demande de paiement partir dun portefeuille client
doScheduledWalletPayment Planifie une demande de paiement un jour fix
doRecurrentWalletPayment Programme une demande de paiement dun montant fixe
(abonnement)
getPaymentRecord Rcupre un dossier de paiement
disablePaymentRecord Dsactive un dossier de paiement
transactionSearch Permet dobtenir la liste des transactions correspondant aux critres
de recherche saisis par lutilisateur.
getTransactionDetails Permet dobtenir le dtail dune transaction de paiement quelque soit
son tat.
verifyEnrollment Vrifie que la carte de lacheteur est 3DSecure.

doScoringCheque Vrifie la validit dun chque bancaire


doReauthorisation Permet le rejeu dune transaction
getCards Rcupre les informations sur les cartes dun portefeuille multicartes.
getEncryptionKey Fourni la cl publique de chiffrement des donnes cartes

Page 43/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.1 Webservice - Do Authorization

La fonction do Authorization ralise une demande dautorisation de dbit au serveur


dautorisation de votre tablissement bancaire.

1. Une autorisation simple et/ou un paiement immdiat

Paiement comptant : est un paiement dit comptant avec un payment.mode CPT,


vous ralisez soit une autorisation + validation avec un code action 101 , soit une
autorisation avec un code action 100 , et la validation est faite soit en automatique par
la solution de paiement Payline, soit par le commerant , en utilisant les appels
webservice ou via notre outil de back office centre administration Payline .

NOTE : Avec une autorisation de dbit, vous avez jusqu' 7 jours pour valider la demande
de paiement. Au-del des 7 jours, votre autorisation expire et devient inutilisable.

2. Paiement diffr : Un paiement programm (< 7 jours)

Paiement diffr : est un paiement dit diffr, le commerant fait une demande
dautorisation et la validation du paiement est faite par exemple lors de lexpdition du
produit.

Une demande dautorisation est valable pendant 7 jours.

Cette validation peut tre ralise soit en automatique via Payline, soit par le commerant
en utilisant soit la fonctionnalit interface batch, soit en appelant le webservice do
capture , soit via le centre administration

Pour dbiter votre client quau traitement, lenvoi ou rception de sa commande et que
cette date est dans la limite des 7 jours, vous devez renseigner les champs
payment.action 100, payment.mode DIF et differedActionDate la date
souhaite de validation du paiement. La date de validation souhaite doit respecter la
contrainte suivante : differedActionDate <= autorizationDate + 6.

Payline ralise une demande dautorisation auprs de lacqureur et, dans le cas dun
accord, programme une action de validation la date souhaite.

Page 44/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.1.1 Requte envoyer

La requte doAuthorizationRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la valeur 3
Payline
Requis depuis 2011
payment.amount Montant de la transaction Oui N12 la valeur 100 correspond
dans la plus petite unit de la 1
devise
payment.currency Code de la devise du Oui N3 978 : euros
paiement 840 : dollars US
cf. liste complte en
annexe Tableau: Liste
des devises

payment.action Code de la fonction de Oui N3 201 : VALIDATION
paiement
payment.mode Mode de paiement : comptant, Oui AN3 CPT : Comptant
diffr DIF : Diffr
cf. liste complte en
annexe Tableau : Liste
des modes de paiement
payment.contractNumber Le code ou numro de votre Oui AN50
contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser
2
payment.differedActionDate Date effective de laction. Elle Non AN8 Format respecter :
doit tre infrieure la date du dd/mm/yy
jour + 7 jours.
media Dtection du mdia utilis lors Non
1
AN25 Mobile

du paiement

Les valeurs possibles de cette


balise sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

bankAccountData.countryCode Utilis uniquement pour ELV


bankAccountData.bankCode Utilis uniquement pour ELV
Page 45/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
bankAccountData.accountNum Utilis uniquement pour ELV
ber
bankAccountData.key Utilis uniquement pour ELV
card.encryptionKeyId Identifiant de la cl RSA Non N4 Si cest champs sont
Payline de chiffrement renseigns alors les
donnes cartes doivent
tre null
card.encryptedData Les donnes carte chiffrs Non Base6 Si cest champs sont
4 renseigns alors les
donnes cartes doivent
tre null
card.number Numro de carte Oui N19
card.type Type de carte utilis pour la Oui AN40 CB : visa / mastercard
transaction AMEX : American express
cf. liste complte en
annexe Tableau : Liste
des types de carte
4
card.expirationDate Date dexpiration de la carte non N4 Format respecter :
mmyy
4
card.cvx Cryptogramme visuel au dos non N10
de la carte de crdit
4
card.ownerBirthdayDate Date danniversaire du porteur non N6 Format respecter :
ddmmyy
4
card.password Mot de passe crypt Non AN16
card.cardPresent Ce service est utilise Non N1 0 ou 1 : present
uniquement si vous faites du
Mail Order ou Telephone
Order ou alors dans le cas o
linternaute est prsent
physiquement
card.cardholder Titulaire de la carte Non AN20 Pierre Dupont
1
card.token Alias du numro de carte Non AN19 1111gPNzHtyu4444
A renseigner la place du
card.number condition que
la balilse version soit
suprieure ou gale 3.
order.ref Rfrence de la commande. Oui AN50 12345678
Cette rfrence doit tre
unique car elle est utilise
pour le contrle des doublons.
5
order.origin Origine de la commande Non AN2 MO ou TO
(utilise uniquement si vous
avez souscrit loption Mail

Page 46/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
Order et Tlphone Order)
order.country Le code du pays dans lequel Non AN3 FR
la commande a t effectu
order.taxes Le montant des taxes sur la Non N12 la valeur 100 correspond
commande dans la plus petite 1
unit de la devise
order.amount Le montant de la commande Oui N12 la valeur 100 correspond
dans la plus petite unit de la 1
devise. Gnralement le
mme montant que
payment.amount
order.currency Le code de la devise utilise Oui N3 978 : euros
lors de la commande. 840 : dollars US
cf. liste complte en
annexe tableau Liste
des devises
order.date La date de la commande chez Oui AN18 Format respecter :
le commerant dd/mm/yyyy
HH24:mi
order.deliveryTime Dlai de livraison :1 = express Non N 1
2 = standard
-
order.deliveryMode Mode de livraison : Non N 4
1 : retrait de la marchandise
chez le marchand
2 : Utilisation d'un rseau de
points-retrait tiers (type kiala,
alveol, etc.)
3 : Retrait dans un aroport,
une gare ou une agence de
voyage
4 : Transporteur (La Poste,
Colissimo, UPS, DHL... ou
tout transporteur priv)
5: Emission dun billet
lectronique, tlchargements
order.deliveryExpectedDate Date prvue de livraison AN
order.deliveryExpectedDelay Dlai prvu de livraison (en N
jours)
order.details Informations sur les articles Non Tableau OrderDetails
commands
buyer.lastName Nom de lacheteur Non AN100
buyer.firstName Prnom de lacheteur Non AN100

Page 47/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
buyer.email Adresse email de lacheteur Non AN150
buyer.billingAddress.Title Titre Non AN
buyer.billingAddress.Name Nom ou numro dimmeuble Non AN100
buyer.billingAddress.firstName Prnom Non AN100
buyer.billingAddress.lastName Nom Non AN100
buyer.billingAddress.Street1 Nom de rue Non AN100
buyer.billingAddress.Street2 Complment du nom de rue Non AN100
buyer.billingAddress.CityName Ville Non AN40
buyer.billingAddress.ZipCode Code postal Non AN20
buyer.billingAddress.Country Pays Non AN2 ISO 3166-1
buyer.billingAddress.Phone Tlphone Non AN15
buyer.billingAddress.state Tlphone Non AN15
buyer.shippingAddress.Title Titre Non AN
buyer.shippingAddress.Name Nom ou numro dimmeuble Non AN100
buyer.shippingAddress.firstNa Prnom Non AN100
me
buyer.shippingAddress.lastNa Nom Non AN100
me
buyer.shippingAddress.Street1 Nom de rue Non AN100
buyer.shippingAddress.Street2 Complment du nom de rue Non AN100
buyer.shippingAddress.CityNa Ville Non AN40
me
buyer.shippingAddress.ZipCod Code postal Non AN20
e
buyer.shippingAddress.Countr Pays Non AN2 ISO 3166-1
y
buyer.shippingAddress.Phone Tlphone Non AN15
buyer.accountCreateDate La date de cration du compte Non AN8 Format respecter :
de lacheteur dd/mm/yy
buyer.accountAverageAmount Le montant moyen des achats Non N10
de cet acheteur
buyer.accountOrderCount Le nombre de commande Non N10
pass par cet acheteur
3
buyer.walletId Lidentifiant du portefeuille Non AN50
virtuel de votre client.
buyer.walletCardInd Spcifie lindex de la carte non AN2 Lindex de la carte, valeur
utiliser. par dfaut 1
buyer.ip Ladresse IP de lacheteur non AN50 Format respecter : IPv4
ou IPv6
buyer.mobilePhone Le numro de mobile de non N15 Ex : 0033691666666
lacheteur Pour envoi de SMS
lacheteur

Page 48/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
buyer.customerId Identifiant client non AN50 Ex : 894492568
Cette donne peut tre un
identifiant ou un email
privateDataList Vos propres informations Non Tableau PrivateData
personnelles
5
authentication3DSecure.md Renvoy en POST par lACS Non AN20
5
authentication3DSecure.pares Renvoy en POST par lACS Non AN
authentication3DSecure.xid Identifiant de transaction Non AN20 Ne plus utiliser, champ
Unique obsolte
authentication3DSecure.eci Electronic Commerce Non AN2 Ne plus utiliser, champ
Indicator. A passer dans obsolte
lautorisation
authentication3DSecure.cavv Cardholder Authentication Non AN26- Ne plus utiliser, champ
Verification Value dtermin 28 obsolte
par lACS.
authentication3DSecure.cavvA Entier positif prcisant Non N1 Ne plus utiliser, champ
lgorithm lalgorithme utilis pour la obsolte
gnration CAVV. Les valeurs
possibles actuelles sont:
0 = HMAC (SET
TransStain),
1 = CVV,
2 = CVV avec ATN,
3 = MasterCard AAV
authentication3DSecure.vadsR Rsum des oprations Non AN4 Ne plus utiliser, champ
esult 3DSecure obsolte
owner.lastName Nom du titulaire Non AN30 Applicable uniquement
pour AMEX
owner.firstName Prnom du titulaire Non AN15 Applicable uniquement
pour AMEX
owner.issueCardDate Date dmission de la carte Non AN4 Format respecter :
mmyy. Applicable
uniquement pour AMEX
owner.billingAddress.street Nom de rue du titulaire Non AN20 Applicable uniquement
pour AMEX
owner.billingAddress.cityName Ville du titulaire Non AN40 Applicable uniquement
pour AMEX
owner.billingAddress.zipCode Code postal du titulaire Non AN9 Applicable uniquement
pour AMEX
owner.billingAddress.country Pays du titulaire Non AN2 Applicable uniquement
pour AMEX
owner.billingAddress.phone Tlphone du titulaire Non AN10 Applicable uniquement
pour AMEX
Page 49/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
1 La balise version doit tre suprieure ou gale 3, si le champ card.token est renseign, le
champ card.number doit tre vide.
Si le format du token PAN ne tient pas compte de la date dexpiration, la balise est
card.expirationDate obligatoire.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.
3
- Ne pas renseigner pour cette fonction.
4
Si vous utilisez le card.token et que votre format de token PAN ne tient pas compte de la date
dexpiration, ce champ devient obligatoire.
Veuillez vous rfrer lannexe Tableau : Liste des champs obligatoires par type de carte .
5
- Obligatoire pour toutes les transactions 3DSecure.
6
- Si vous avez souscrit loption Mail Order et Telephone Order MO TO et elle est active, alors
la valeur de lattribut order.Orign sera MO ou TO .

Pour chaque ligne de dtail dune commande (OrderDetails) :

Elment Commentaire Requis Format Exemple


ref Rfrence de larticle Non AN50
price Prix de larticle dans la plus petite unit Non N12
de la devise
quantity Quantit darticles Non N5
comment Commentaire Non
category Non AN50
brand Marque du produit Non AN50 Ex : HERMES
Subcategory1 Sous-categorie de rang 1 Non AN50 Ex : Bijoux & Montres
Subcategory2 Sous-categorie de rang 2 Non AN50 Ex : Bijoux
additionalData Liste de caractristiques Non AN255 Ex :
LegalAge=18&Discount=0
105
taxRate Taux de la taxe de larticle (exprime en Non N4 Ex : 1580 pour 15,8 %
centime)

Pour chaque donne prive (PrivateData) :

Elment Commentaire Requis Format Exemple


key La cl qui vous permet de filtrer vos Oui AN50 user
transactions de paiement
value La valeur associe la cl Oui AN50 dupond or durand, etc

Page 50/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.1.2 Rponse en retour

Le message doAuthorizationResponse est la rponse faite par Payline une demande


dautorisation de dbit. Il vous permet dobtenir, entre autres, le numro unique de la transaction
sur Payline et le n dautorisation de dbit dliv r par votre tablissement bancaire.

Forma
Elment Description Exemple
t
result.code Code de retour du web service. N5 00000 : Transaction approved
01xxx : Transaction refused
021xx : Internal Error
cf. liste complte en annexe
tableau Liste des codes
retours
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
transaction.id Identifiant unique de la transaction Payline N50
transaction.isPossibleFraud Cet indicateur est calcul en fonction des AN1 1 = Il existe un risque de fraude
critres dfinis par le commerant 0 = Aucun risque de fraude
dtect
transaction.isDuplicated Cet indicateur est retourn par Payline AN1 1 = Il existe un risque de fraude
dans le cas de transaction en doublon 0 = Aucun risque de fraude
dtect
transaction.date Date et heure de la transaction Payline AN16 Format : dd/mm/yyyy HH24:MI
transaction.fraudResult Code de la fraude AN50
transaction.fraudResultDetail Details de la fraude
s
transaction.explanation Motif du refus en cas de fraude AN50
transaction.threeDSecure Cet indicateur est retourn par Payline AN1 Y= Transaction en mode
lors dune transaction 3DSecure 3DSecure
N = Transaction en mode non
3DSecure
transaction.score Scoring de la possibilit de fraude N5 Score de 0 10
transaction.externalWalletTy Type de wallet utilis lors de la AN20 Ex : V.Me, Masterpass
pe transaction
transaction.externalWalletCo Numro du contrat VAD associ au AN50
ntractNumber paiement par Wallet

Page 51/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Forma
Elment Description Exemple
t
authorization.number Numro dautorisation dlivr par le N6 123456
serveur dautorisation acqureur. Ce
champ est renseign si la demande
dautorisation est accorde*.

authorization.date Date et heure de lautorisation AN16 Format : dd/mm/yy HH24:MI


card.number Le numro de la carte masque conforme 111122XXXXXX4444
PCI DSS
card.type Le type de carte : soit Carte visa, gold AN50
visa,
card.expirationDate Date dexpiration 0311
1
card.token Alias du numro de carte AN19 1111gPNzHtyu4444
extendedcard.country Pays demission de la carte 2 CODE ISO : exemple FR
extendedcard.isCvd La carte est elle une e carte bleu N1 Y OR N
extendedCard.bank La banque de la carte utilise pour le AN Crdit Lyonnais
paiement
extendedCard.type Le type de carte de paiement AN20 MASTERCARD
extendedCard.network Dsigne le rattachement de la carte une AN20 MASTERCARD
entit grant lacceptation de la carte un
niveau national ou international
extendedCard.product Indique la catgorie laquelle appartient AN Gold/Premier pour une carte type
le type de la carte VISA
privateDataList Vos propres informations personnelles

*- en fonction de votre configuration de compte, Payline peut accorder un paiement sans en faire la
demande la banque du commerant. Dans ce cas, le n dautorisation est vide.
1
La balise version doit tre renseigne ave une version suprieure ou gale 3.

Page 52/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.2 Web service-doReAuthorization

Cette mthode permet de rejouer une transaction qui a t accepte, les rgles sont dfinies ci-
dessous :
Les autorisations (valide partiellement ou entirement) ou autorisation+valide acceptes
peuvent tre r autorise
Une r autorisation peut tre r autorise
Pas de rgle sur le montant pour une reautorisation mais pour la validation dune r autorisation
nous utilisons la mme mthode quune autorisation normale donc les offset de capture.
La nouvelle autorisation doit avoir la mme devise que celle dorigine sinon une erreur est
renvoye sans stockage en base : 02620 Currency must be the same as the original
authorization
Lautorisation dorigine ne doit pas tre effectu en 3DSecure: 02622 3DS Transaction is not
allowed
Une r-autorisation peut tre effectu sur des autorisations allant jusqu' 11 mois aprs sa date
de cration
La rfrence de la r-autorisation est rcupre de la transaction dorigine si elle na pas de
nouvelle rfrence associe.
La r-autorisation est une transaction part entire, donc si la r-autorisation est effectue
moins de 24h de la transaction dorigine alors elle sera considre comme un doublon sauf si la
rfrence de la commande est diffrente de celle de la transaction dorigine.
Loption r-autorisation doit tre active dans un contrat pour pouvoir faire une r autorisation,
sinon un code erreur est renvoy : 02619 You don't have the reauthorization option

4.2.1 Requte envoyer

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la valeur 3
Payline
Requis depuis 2011
transactionID Identifiant de la transaction oui AN50
dautorisation r-autoriser
payment.amount Montant de la transaction oui N12 la valeur 100 correspond 1
dans la plus petite unit de
la devise
payment.currency Code de la devise du oui N3 978 : euros
paiement 840 : dollars US
cf. liste complte en annexe
tableau Liste des devises
payment.action Code de la fonction de oui AN50 Le code action peut tre 100 ou
paiement 101

Page 53/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
payment.mode Mode de paiement : oui AN3 CPT : Comptant
comptant, diffr DIF : Diffr
cf. liste complte en annexe
tableau Liste des modes de
paiement
payment.contractNumbe le code ou numro de votre oui AN50 1234567
r contrat VAD qui reprsente
le moyen de paiement que
vous souhaitez utiliser
2
payment.differedActionD Date effective de laction. Non N12 Format respecter : dd/mm/yy
ate Elle doit tre infrieure la
date du jour + 7 jours.
media Dtection du mdia utilis Non
1
AN25 TV

lors du paiement.

Les valeurs possibles de cette


balise sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

order.ref Rfrence de la non AN50


commande. Cette rfrence
doit tre unique car elle est
utilise pour le contrle des
doublons.
3
order.origin Origine de la commande Non N2 MO ou TO
(utilise uniquement si vous
avez souscrit loption Mail
Order et Tlphone Order)
order.country Le code du pays dans Non AN3 FR
lequel la commande a t
effectu
order.taxes Le montant des taxes sur la non N12 la valeur 100 correspond 1
commande dans la plus
petite unit de la devise

Page 54/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
order.amount Le montant de la Oui si N12 la valeur 100 correspond 1
commande dans la plus Order
petite unit de la devise. Ref est
Gnralement le mme renseign
montant que
payment.amount
order.currency Le code de la devise Oui si AN3 978 : euros
utilise lors de la Order 840 : dollars US
commande. Ref est cf. liste complte en annexe
renseign tableau Liste des devises

order.date La date de la commande Oui si AN50 Format respecter : dd/mm/yy
chez le commerant Order
Ref est
renseign

order.details Informations sur les articles Non AN8 Tableau OrderDetails
commands
order. deliveryTime Dlai de livraison : Non N 1
1 = express
2 = standard
order. deliveryMode Mode de livraison : Non N 4
1 : retrait de la marchandise
chez le marchand
2 : Utilisation d'un rseau
de points-retrait tiers (type
kiala, alveol, etc.)
3: Retrait dans un
aroport, une gare ou une
agence de voyage
4 : Transporteur (La Poste,
Colissimo, UPS, DHL... ou
tout transporteur priv)
- 5 : Emission dun billet
lectronique,
tlchargements
privateDataList Vos propres informations Non Tableau PrivateData
personnelles
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.
3
- Si vous avez souscrit loption Mail Order et Telephone Order MO TO et elle est active, alors
la valeur de lattribut order.Orign sera MO ou TO .

Page 55/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.2.2 Requte la rponse

Le message doReAuthorizationResponse est la rponse faite par Payline une demande de


validation dune autorisation de dbit. La rponse a la structure suivante :

Elment Description Format Exemple


result.code Code de retour du web service. N5 00000 : Transaction approved
01xxx : Transaction refused
021xx : Internal Error
cf. liste complte en annexe
tableau Liste des codes
retours
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
transaction.id Identifiant unique de la transaction N50
Payline
transaction.isPossibleFrau Cet indicateur est calcul en fonction AN1 1 = Il existe un risque de
d des critres dfinis par le commerant fraude
0 = Aucun risque de fraude
dtect
transaction.isDuplicated Cet indicateur est retourn par AN1 1 = Il existe un risque de
Payline dans le cas de transaction en fraude
doublon 0 = Aucun risque de fraude
dtect
transaction.date Date et heure de la transaction AN16 Format :dd/mm/yy HH24:MI
Payline
cardNumber Numero de la carte masqu N19
card.Type Type de la carte
card.ExpirationDate Date dexpiration de la carte
1
card.token Alias du numro de carte AN19 1111gPNzHtyu4444
extendedCard.bank La banque de la carte utilise pour le AN Crdit Lyonnais
paiement
extendedCard.type Le type de carte de paiement AN20 MASTERCARD
extendedCard.network Dsigne le rattachement de la carte AN20 MASTERCARD
une entit grant lacceptation de la
carte un niveau national ou
international
extendedCard.product Indique la catgorie laquelle AN Gold/Premier pour une carte
appartient le type de la carte type VISA
extendedCard.Country Le pays metteur de la carte
extendedCard.IsCVD Flag pour les cartes virtuelles
Page 56/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

4.3 Web service - Do Capture

La fonction do Capture ralise une demande de validation dune autorisation accepte. Une
fois la validation prise en compte, un fichier contenant toutes les validations est remis la banque
du commerant ; Payline effectue une remise des demandes de paiement votre tablissement
bancaire.

4.3.1 Requte envoyer

La requte doCaptureRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Payline Oui N1 A valoriser la valeur 3
Requis depuis 2011
transactionID Identifiant de la transaction oui AN50
dautorisation
payment.amount Montant de la transaction dans la oui N12 la valeur 100 correspond
plus petite unit de la devise 1
payment.currency Code de la devise du paiement oui N3 978 : euros
840 : dollars US
cf. liste complte en annexe
tableau Liste des
devises
payment.action Code de la fonction de paiement Oui N3 201 : Validation
payment.mode Mode de paiement : comptant, Oui AN3 CPT : Comptant
diffr, N fois, rcurrent. DIF : Diffr
NX : N fois
REC : rcurrent
cf. liste complte en annexe
tableau Liste des modes
de paiement
payment.contractNumbe le code ou numro de votre Oui AN50
r contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser
2
payment.differedActionD Date effective de laction. Elle doit Non AN8 Format respecter :
ate tre infrieure la date du jour + dd/mm/yy
7 jours.

Page 57/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
media Dtection du mdia utilis lors du Non
1
AN25 TV

paiement

Les valeurs possibles de cette balise


sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

privateDataList Vos propres informations Non Tableau PrivateData


personnelles
sequenceNumber Numro de squence utilise lors non AN50
de la transaction

1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.

4.3.2 Rponse en retour

Le message doCaptureResponse est la rponse faite par Payline une demande de validation
dune autorisation de dbit. La rponse a la structure suivante :

Elment Description Format Exemple


result.code Code de retour du web service. N5 00000 : Transaction approved
01xxx : Transaction refused
021xx : Internal Error
cf. liste complte en annexe
tableau Liste des codes
retours
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
transaction.id Identifiant unique de la transaction N50
Payline
transaction.isPossibleFrau Cet indicateur est calcul en fonction AN1 1 = Il existe un risque de
d des critres dfinis par le commerant fraude
0 = Aucun risque de fraude
dtect

Page 58/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
transaction.isDuplicated Cet indicateur est retourn par Payline AN1 1 = Il existe un risque de
dans le cas de transaction en doublon fraude
0 = Aucun risque de fraude
dtect
transaction.date Date et heure de la transaction AN16 Format :dd/mm/yy HH24:MI
Payline
reAuthorization Cet indicateur permet de savoir un re- N1 1 = Re-autorisation ralise
autorisation a t ralise 0 = Aucune re-autorisation
ralise

4.4 Web service - Do Refund

Remboursement : une demande de remboursement dun paiement valid et remis en banque,


donc le client a t dbit et le commerant a t crdit.
Le dlai de remboursement est de 6 mois.

4.4.1 Requte envoyer

La requte doRefundRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Payline Oui N1 A valoriser la valeur 3
Requis depuis 2011
transactionID Identifiant de la transaction oui AN50
dautorisation
payment.amount Montant de la transaction dans la oui N12 la valeur 100 correspond
plus petite unit de la devise 1
payment.currency Code de la devise du paiement oui N3 978 : euros
840 : dollars US
cf. liste complte en
annexe Tableau: Liste
des devises

payment.action Code de la fonction de paiement oui N3 421 : Remboursement
payment.mode Mode de paiement : comptant, oui AN3 CPT : Comptant
diffr. DIF : Diffr
payment.contractNumbe le code ou numro de votre oui AN50
r contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser

Page 59/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
2
payment.differedActionD Date effective de laction. Elle doit Non AN8 Format respecter :
ate tre infrieure la date du jour + dd/mm/yy
7 jours.
media Dtection du mdia utilis lors du Non
1
AN25 Console

paiement

Les valeurs possibles de cette balise


sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

comment Description du motif de non AN255


remboursement. Peut tre
consult sur le relev des
transactions accessible via le
Centre dAdministration
Commerant.
privateDataList Vos propres informations non Tableau PrivateData
personnelles
sequenceNumber Numro de squence utilise lors non AN50
de la transaction
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.

4.4.2 Rponse en retour

Le message doRefundResponse est la rponse faite par Payline une demande de


remboursement.
La rponse a la structure suivante :

Elment Description Format Exemple


result.code Code de retour du web service. N5 00000 : Transaction approved
01xxx : Transaction refused
021xx : Internal Error
cf. liste complte en annexe
tableau Liste des codes
retours
result.shortMessage Message court du rsultat de la AN50
transaction
Page 60/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
result.code Code de retour du web service. N5 00000 : Transaction approved
01xxx : Transaction refused
021xx : Internal Error
cf. liste complte en annexe
tableau Liste des codes
retours
result.longMessage Message du rsultat de la transaction AN255
transaction.id Identifiant unique de la transaction N50
Payline
transaction.isPossible Cet indicateur est calcul en fonction AN1 1 = Il existe un risque de fraude
Fraud des critres dfinis par le commerant 0 = Aucun risque de fraude
dtect
transaction.isDuplicate Cet indicateur est retourn par Payline AN1 1 = Il existe un risque de fraude
d dans le cas de transaction en doublon 0 = Aucun risque de fraude
dtect
transaction.date Date et heure de la transaction Payline AN16 Format : dd/mm/yy HH24:MI

4.5 Web service - Do Reset

Annulation : lannulation dune transaction est possible uniquement si la transaction a t valide


et non remis en banque, donc le client na pas t dbit sur son compte bancaire

La fonction do Reset permet dannuler lenvoi votre banque dune transaction de dbit ou de
crdit ralise partir des fonctions suivantes : doAuthorization, doDebit, doCredit, doRefund.

4.5.1 Requte envoyer

La requte doResetRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Payline Oui N1 A valoriser la valeur
Requis depuis 2011 3
transactionID Identifiant de la transaction annuler oui N50
Les transactions PAYPAL peuvent
galemetre annules.

Page 61/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Media Dtection du mdia utilis Non1 AN25 Console

Les valeurs possibles de cette balise


sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

comment Description du motif de lannulation. Peut non AN255


tre consult sur le relev des
transactions accessible via le Centre
dAdministration Commerant.

1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

4.5.2 Rponse en retour

Le message doResetResponse est la rponse faite par Payline une demande de


remboursement.

La rponse a la structure suivante :


Elment Description Format Exemple
result.code Le code de retour du web service : N5 cf. liste complte en annexe
00000 : Transaction approved Code retour et message
02600 : Reset is not supported for Payline
transaction type 02601 : Reset already
done
02602 : Authorization is already expired
02603 : Transaction status isnt to be
remit
02604 : This transaction does not exist
01917 : This transaction is already send
to the acquirer

result.shortMessage Message court du rsultat de la AN50


transaction
result.longMessage Message du rsultat de la transaction AN255

Page 62/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
transaction.id Identifiant unique de la transaction N50
Payline
transaction.isPossible Cet indicateur est calcul en fonction des AN1 1 = Il existe un risque de fraude
Fraud critres dfinis par le commerant 0 = Aucun risque de fraude
dtect
transaction.isDuplicate Cet indicateur est retourn par Payline AN1 1 = Il existe un risque de fraude
d dans le cas de transaction en doublon 0 = Aucun risque de fraude
dtect
transaction.date Date et heure de la transaction Payline AN16 Format : dd/mm/yy HH24:MI

4.6 Web service - Do Credit

La fonction do Credit permet de raliser une demande de recrdit de la carte bancaire


paiement de votre client. Cette fonction est utile pour rembourser votre client si vous navez pas
conserv lidentifiant de la transaction dautorisation ncessaire la fonction doRefund.

4.6.1 Requte envoyer


La requte doCreditRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
versiondoautho Version des web services Payline Oui N1 A valoriser la valeur 3
Requis depuis 2011
payment.amount Montant de la transaction dans la oui N12 la valeur 100 correspond
plus petite unit de la devise 1
payment.currency Code de la devise du paiement oui N3 978 : euros
840 : dollars US
cf. liste complte en
annexe tableau Liste
des devises
payment.action Code de la fonction de paiement oui N3 422 : Recrdit
payment.mode Mode de paiement : comptant, oui AN3 CPT : Comptant
diffr, N fois, rcurrent. DIF : Diffr
NX : N fois
REC : rcurrent
cf. liste complte en
annexe tableau Liste
des modes de paiement
payment.contractNumber le code ou numro de votre oui AN50
contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser
Page 63/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
2
payment.differedActionDate Date effective de laction. Elle doit Non AN8 Format respecter :
tre infrieure la date du jour + dd/mm/yy
7 jours.
media Dtection du mdia utilis lors du Non
1
AN25 TV

paiement

Les valeurs possibles de cette balise


sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

card.encryptionKeyId Identifiant de la cl RSA Payline non N4 Si cest champs sont


de chiffrement renseigns alors les
donnes cartes doivent
tre null
card.encryptedData Les donnes carte chiffrs non Base64 Si cest champs sont
renseigns alors les
donnes cartes doivent
tre null
card.number Numro de carte oui N19
card.type Type de carte utilis pour la oui AN40 CB : visa / mastercard
transaction AMEX : American
express
cf. liste complte en
annexe tableau Liste
des types de carte sauf
Aurore
3
card.expirationDate Date dexpiration de la carte Non N4 Format respecter :
mmyy
3
card.CVX Cryptogramme visuel au dos de non N10
la carte de crdit
3
card.ownerBirthdayDate Date danniversaire du porteur non N6 Format respecter :
ddmmyy
3
card.password Mot de passe crypt non AN16
card.cardPresent Ce service est utilise Non N1 0 ou 1 : present
uniquement si vous faites du Mail
Order ou Telephone Order ou
alors dans le cas o linternaute
est prsent physiquement
card.cardholder Titulaire de la carte Non AN20 Pierre Dupont
Page 64/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
4
card.token Alias du numro de carte Non AN19 1111gPNzHtyu4444
A renseigner la place du
card.number condition que la
balilse version soit suprieure ou
gale 3.
order.ref Rfrence de la commande. Oui AN50 12345678
Cette rfrence doit tre unique
car elle est utilise pour le
contrle des doublons.
order.origin Origine de la commande (utilise Non AN2 MO ou TO
uniquement si vous avez souscrit
loption Mail Order et Tlphone
Order)
order.country Le code du pays dans lequel la non AN3 FR
commande a t effectu
order.taxes Le montant des taxes sur la non N12 la valeur 100 correspond
commande dans la plus petite 1
unit de la devise
order.amount Le montant de la commande dans oui N12 la valeur 100 correspond
la plus petite unit de la devise. 1
Gnralement le mme montant
que payment.amount
order.currency Le code de la devise utilise lors oui N3 978 : euros
de la commande. 840 : dollars US
cf. liste complte en
annexe tableau Liste
des devises
order.date La date de la commande chez le oui AN18 Format respecter :
commerant dd/mm/yyyy
HH24:mi
order.details Informations sur les articles non Tableau OrderDetails
commands
order. deliveryTime Dlai de livraison : Non N 1
1 = express
2 = standard
order. deliveryMode Mode de livraison : Non N 4
1 : retrait de la marchandise chez
le marchand
2 : Utilisation d'un rseau de
points-retrait tiers (type kiala,
alveol, etc.)
3 : Retrait dans un aroport, une
gare ou une agence de voyage

Page 65/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
4: Transporteur (La Poste,
Colissimo, UPS, DHL... ou tout
transporteur priv)
5: Emission dun billet
lectronique, tlchargements
buyer.lastName Nom de lacheteur non AN100
buyer.firstName Prnom de lacheteur non AN100
buyer.email Adresse email de lacheteur non AN150
buyer.shippingAddress.name Nom ou numro dimmeuble non AN100
buyer.shippingAddress.street1 Nom de rue non AN100
buyer.shippingAddress.street2 Complment du nom de rue non AN100
buyer.shippingAddress.cityNa Ville non AN40
me
buyer.shippingAddress.zipCod Code postal non AN20
e
buyer.shippingAddress.country Pays non AN2 ISO 3166-1
buyer.shippingAddress.phone Tlphone non AN15
buyer.accountCreateDate La date de cration du compte de non AN8 Format respecter :
lacheteur dd/mm/yy
AccountAverageAmount Le montant moyen des achats de non N10
cet acheteur
buyer.accountOrderCount Le nombre de commande pass non N10
par cet acheteur
buyer.walletId Lidentifiant du portefeuille virtuel non AN50
de votre client.
buyer.mobilePhone Le numro de mobile de non N15 Ne pas utiliser. Lenvoi de
lacheteur SMS nest pas
implment dans cette
mthode
comment Description du motif de non AN255
remboursement. Peut tre
consult sur le relev des
transactions accessible via le
Centre dAdministration
Commerant.
privateDataList Vos propres informations non Tableau PrivateData
personnelles
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.
3
- Veuillez vous rfrer au tableau "Liste des champs obligatoires par type de carte en annexe
du document.

Page 66/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Si vous utilisez le card.token et que votre format de token PAN ne tient pas compte de la date
dexpiration, ce champ devient obligatoire
4
- La balise version doit tre suprieure ou gale 3, si le champ card.token est renseign, le
champ card.number doit tre vide.
Si le format du token PAN ne tient pas compte de la date dexpiration, la balise est
card.expirationDate obligatoire.

4.6.2 Rponse en retour

Le message doCreditResponse est la rponse faite par Payline une demande de recrdit.
La rponse a la structure suivante :

Elment Description Format Exemple


result.code Code de retour du web service. N5 00000 : Transaction approved
01xxx : Transaction refused
021xx : Internal Error
cf. liste complte en annexe
tableau Liste des codes
retours
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la AN255
transaction
transaction.id Identifiant unique de la transaction N50
Payline
transaction.isPossibleFrau Cet indicateur est calcul en AN1 1 = Il existe un risque de
d fonction des critres dfinis par le fraude
commerant 0 = Aucun risque de fraude
dtect
transaction.isDuplicated Cet indicateur est retourn par AN1 1 = Il existe un risque de
Payline dans le cas de transaction fraude
en doublon 0 = Aucun risque de fraude
dtect
transaction.date Date et heure de la transaction AN16 Format : dd/mm/yy HH24:MI
Payline
card.number Le numro de la carte masque 111122XXXXXX4444
conforme PCI DSS
card.type Le type de carte : soit Carte visa, AN50
gold visa,
card.expirationDate Date dexpiration 0311
1
card.token Alias du numro de carte AN19 1111gPNzHtyu4444
extendedcard.country Pays demission de la carte 2 CODE ISO : exemple FR
Page 67/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
extendedcard.isCvd La carte est elle une e carte bleu N1 Y OR N
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

4.7 Web service - Do Debit

La fonction doDebit est utilise suite un appel phonie, cest un dbit forc le commerant a
contact sa banque et la banque lui fournit un numro dautorisation, et ce dernier lui permet de
raliser une demande de dbit sur la carte bancaire de son client.

4.7.1 Requte envoyer

La requte doDebitRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la valeur 3
Payline
Requis depuis 2011
payment.amount Montant de la transaction dans oui N12 la valeur 100 correspond
la plus petite unit de la devise 1
payment.currency Code de la devise du paiement oui N3 978 : euros
840 : dollars US
cf. liste complte en
annexe Tableau: Liste
des devises

payment.action Code de la fonction de oui N3 204 : Dbit
paiement
payment.mode Mode de paiement : comptant, oui AN3 CPT : Comptant
N fois, rcurrent.
payment.contractNumber le code ou numro de votre oui AN50
contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser
2
payment.differedActionDate Date effective de laction. Elle Non AN8 Format respecter :
doit tre infrieure la date du dd/mm/yy
jour + 7 jours.

Page 68/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
media Dtection du mdia utilis lors Non
1
AN25 Computer

du paiement

Les valeurs possibles de cette


balise sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

card.encryptionKeyId Identifiant de la cl RSA non N4 Si cest champs sont


Payline de chiffrement renseigns alors les
donnes cartes doivent
tre null
card.encryptedData Les donnes carte chiffrs non Base64 Si cest champs sont
renseigns alors les
donnes cartes doivent
tre null
card.number Numro de carte oui N19
card.type Type de carte utilis pour la oui AN40 CB : visa / mastercard
transaction AMEX : American
express
cf. liste complte en
annexe Tableau : Liste
des types de carte
3
card.expirationDate Date dexpiration de la carte Non N4 Format respecter :
mmyy
3
card.cvx Cryptogramme visuel au dos de non N10
la carte de crdit
3
card.ownerBirthdayDate Date danniversaire du porteur non N6 Format respecter :
ddmmyy
3
card.password Mot de passe crypt non AN16
6 1
card.token Alias du numro de carte Non AN19 1111gPNzHtyu4444
A renseigner la place du
card.number condition que la
balilse version soit suprieure
ou gale 3.
authorization.number Numro dautorisation non AN6
authorization.date Date de lautorisation non AN18 Format respecter :
dd/mm/yyyy
HH24:mi
order.ref Rfrence de la commande. oui AN50 12345678
Page 69/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
Cette rfrence doit tre unique
car elle est utilise pour le
contrle des doublons.
4
order.origin Origine de la commande Non AN2 MO ou TO
(utilise uniquement si vous
avez souscrit loption Mail
Order et Tlphone Order)
order.country Le code du pays dans lequel la non AN3 FR
commande a t effectu
order.taxes Le montant des taxes sur la non N12 la valeur 100 correspond
commande dans la plus petite 1
unit de la devise
order.amount Le montant de la commande oui N12 la valeur 100 correspond
dans la plus petite unit de la 1
devise. Gnralement le mme
montant que payment.amount
order.currency Le code de la devise utilise oui N3 978 : euros
lors de la commande. 840 : dollars US
cf. liste complte en
annexe tableau Liste
des devises
order.date La date de la commande chez oui AN18 Format respecter :
le commerant dd/mm/yyyy
HH24:mi
order.details Informations sur les articles non Tableau OrderDetails
commands
order. deliveryTime Dlai de livraison : Non N 1
1 = express
2 = standard
order. deliveryMode Mode de livraison : Non N 4
1 : retrait de la marchandise
chez le marchand
2 : Utilisation d'un rseau de
points-retrait tiers (type kiala,
alveol, etc.)
3 : Retrait dans un aroport,
une gare ou une agence de
voyage
4: Transporteur (La Poste,
Colissimo, UPS, DHL... ou tout
transporteur priv)
5: Emission dun billet
lectronique, tlchargements

Page 70/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
buyer.lastName Nom de lacheteur non AN100
buyer.firstName Prnom de lacheteur non AN100
buyer.email Adresse email de lacheteur non AN150
buyer.shippingAddress.name Nom ou numro dimmeuble non AN100
buyer.shippingAddress.street1 Nom de rue non AN100
buyer.shippingAddress.street2 Complment du nom de rue non AN100
buyer.shippingAddress.cityName Ville non AN40
buyer.shippingAddress.zipCode Code postal non AN20
buyer.shippingAddress.country Pays non AN2 ISO 3166-1
buyer.shippingAddress.phone Tlphone non AN15
buyer.accountCreateDate La date de cration du compte non AN8 Format respecter :
de lacheteur dd/mm/yy
accountAverageAmount Le montant moyen des achats non N10
de cet acheteur
buyer.accountOrderCount Le nombre de commande non N10
pass par cet acheteur
buyer.walletId Lidentifiant du portefeuille Non AN50
virtuel de votre client.
buyer.walletCardInd Spcifie lindex de la carte non AN2 Lindex de la carte, valeur
utiliser. par dfaut 1
buyer.ip Ladresse IP de lacheteur non AN50 Format respecter : IPv4
ou IPv6
buyer.mobilePhone Le numro de mobile de non N15 Ne pas utiliser. Lenvoi de
lacheteur SMS nest pas
implment dans cette
mthode
privateDataList Vos propres informations non Tableau PrivateData
personnelles
5
authentication3DSecure.md Renvoy en POST par lACS Non AN20 Non utilis
5
authentication3DSecure.pares Renvoy en POST par lACS Non AN
authentication3DSecure.xid Identifiant de transaction Non AN20
Unique
authentication3DSecure.eci Electronic Commerce Indicator. Non AN2
A passer dans lautorisation
authentication3DSecure.cavv Cardholder Authentication Non AN26-
Verification Value dtermin 28
par lACS.
authentication3DSecure.cavvAlg Entier positif prcisant Non AN20
orithm lalgorithme utilis pour la
gnration CAVV. Les valeurs
possibles actuelles sont:
0 = HMAC (SET TransStain),
1 = CVV,
Page 71/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
2 = CVV avec ATN,
3 = MasterCard AAV
authentication3DSecure.vadsRe Rsum des oprations Non AN4
sult 3DSecure
owner.lastName Nom du titulaire non AN30 Applicable uniquement
pour AMEX
owner.firstName Prnom du titulaire non AN15 Applicable uniquement
pour AMEX
owner.issueCardDate Date dmission de la carte non AN4 Format respecter :
mmyy. Applicable
uniquement pour AMEX
owner.billingAddress.street Nom de rue du titulaire non AN20 Applicable uniquement
pour AMEX
owner.billingAddress.cityName Ville du titulaire non AN40 Applicable uniquement
pour AMEX
owner.billingAddress.zipCode Code postal du titulaire non AN9 Applicable uniquement
pour AMEX
owner.billingAddress.country Pays du titulaire non AN2 Applicable uniquement
pour AMEX
owner.billingAddress.phone Tlphone du titulaire non AN10 Applicable uniquement
pour AMEX
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.
3
- veuillez vous rfrer au tableau "Liste des champs obligatoires par type de carte en annexe
du document.
Si vous utilisez le card.token et que votre format de token PAN ne tient pas compte de la date
dexpiration, ce champ devient obligatoire
4
- Si vous avez souscrit loption Mail Order et Telephone Order MO TO et elle est active, alors
la valeur de lattribut order.Orign sera MO ou TO .
5
- Obligatoire pour toutes les transactions 3DSecure.
6
- La balise version doit tre suprieure ou gale 3, si le champ card.token est renseign, le
champ card.number doit tre vide.
Si le format du token PAN ne tient pas compte de la date dexpiration, la balise est
card.expirationDate obligatoire.

Page 72/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.7.2 Rponse en retour

Le message doDebitResponse est la rponse faite par Payline une demande de dbit.
La rponse a la structure suivante :

Elment Description Format Exemple


result.code Code de retour du web service. N5 00000 : Transaction
approved
01xxx : Transaction refused
021xx : Internal Error
cf. liste complte en annexe
tableau Liste des codes
retours
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la AN255
transaction
transaction.id Identifiant unique de la transaction N50
Payline
transaction.isPossibleFrau Cet indicateur est calcul en AN1 1 = Il existe un risque de
d fonction des critres dfinis par le fraude
commerant 0 = Aucun risque de fraude
dtect
transaction.isDuplicated Cet indicateur est retourn par AN1 1 = Il existe un risque de
Payline dans le cas de transaction fraude
en doublon 0 = Aucun risque de fraude
dtect
transaction.date Date et heure de la transaction AN16 Format : dd/mm/yy
Payline HH24:MI
card.number Carte marqu conforme PCI DSS 111122XXXXXX4444
card.type Type de la carte Ex Visa parchase, MC
business
card.expirationDate Date dexpiration de la carte 0311
card.cardholder Titulaire de la carte AN20 Pierre Dupont
1
card.token Alias du numro de carte AN19 1111gPNzHtyu4444
extendedCard.country Pays demission de la carte 2 CODE ISO : exemple FR
extendedCard.isCvd La carte est elle une e carte bleu A1 Y OR N
extendedCard.bank La banque de la carte utilise pour AN Crdit Lyonnais
le paiement
extendedCard.type Le type de carte de paiement AN20 MASTERCARD

Page 73/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
extendedCard.network Dsigne le rattachement de la carte AN20 MASTERCARD
une entit grant lacceptation de
la carte un niveau national ou
international
extendedCard.product Indique la catgorie laquelle AN Gold/Premier pour une
appartient le type de la carte carte type VISA
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

4.8 Create Wallet

La fonction createWallet permet de crer un portefeuille virtuel pour votre client. Afin de valider
lutilisation du portefeuille, Payline ralise un contrle montique du moyen de paiement par une
transaction dautorisation 1 euro qui ne sera pas valide (pas de paiement rel).

Dans le cas o vous possdez plusieurs points de vente sur un mme compte commerant, le
portefeuille sera associ au point de vente prcis lors de la demande de cration.

La cration est rejete dans les cas suivants :


Lidentifiant du portefeuille virtuel fourni nest pas unique
La date dexpiration de la carte est dpasse
Le rsultat du contrle montique de la carte de paiement est un refus
Les informations obligatoires ne sont pas renseignes
Lauthentification 3DSecure a chou

4.8.1 Requte envoyer

La requte createWalletRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la valeur 3
Payline
Requis depuis 2011
contractNumber le code ou numro de votre oui AN50
contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser

Page 74/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
wallet.walletId lidentifiant unique du oui AN50
portefeuille virtuel. Vous devez
communiquer Payline un
identifiant unique qui
correspond un et un seul
client sur votre systme
dinformation. Cest avec ce
mme identifiant vous pourrez
demander un paiement par
portefeuille virtuel.
wallet.lastName Le nom de votre client. Ces oui AN100
informations sont utiles pour
rechercher un portefeuille dans
le Centre dAdministration
Commercant.
wallet.firstName Le prnom de votre client. oui AN100
wallet.email Ladresse de messagerie de non AN150
votre client. Payline utilisera
cette information pour envoyer
un justificatif de paiement
votre client.
wallet.shippingAddress.name Nom ou numro dimmeuble non AN100
wallet.shippingAddress.street1 Nom de rue non AN100
wallet.shippingAddress.street2 Complment du nom de rue non AN100
wallet.shippingAddress.cityNa Ville non AN40
me
wallet.shippingAddress.zipCod Code postal non AN20
e
wallet.shippingAddress.country Pays non AN2
wallet.shippingAddress.phone Tlphone non AN15
wallet.card.encryptionKeyId Identifiant de la cl RSA Payline non N4 Si cest champs sont
de chiffrement renseigns alors les
donnes cartes doivent
tre null
wallet.card.encryptedData Les donnes carte chiffrs non Base64 Si cest champs sont
renseigns alors les
donnes cartes doivent
tre null
2
wallet.card.number Numro de carte Oui N19

Page 75/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
2
wallet.card.type Type de carte utilis pour la oui AN40 CB : visa / mastercard
transaction AMEX : American
express
cf. liste complte en
annexe Tableau : Liste
des types de carte
3
wallet.card.expirationDate Date dexpiration de la carte non N4 Format respecter :
mmyy
3
wallet.card.cvx Cryptogramme visuel au dos de Non N10
la carte de crdit
3
wallet.card.ownerBirthdayDate Date danniversaire du porteur Non N6 Format respecter :
ddmmyy
3
wallet.card.password Mot de passe crypt Non AN16
Wallet.card.cardPresent Ce service est utilise Non N1 0 ou 1 : present
uniquement si vous faites du
Mail Order ou Telephone Order
ou alors dans le cas o
linternaute est prsent
physiquement
wallet.card.cardholder Titulaire de la carte Non AN20 Pierre Dupont
5 1
wallet.card.token Alias du numro de carte Non AN19 1111gPNzHtyu4444
A renseigner la place du
card.number condition que la
balilse version soit suprieure
ou gale 3.
wallet.comment Commentaires Non AN255
wallet.default Carte enregistre par dfaut Non A1 Y or N : Carte par dfaut
1
media Dtection du mdia utilis lors Non AN25 Computer
du paiement.

Les valeurs possibles de cette


balise sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

privateDataList Vos propres informations Non Tableau PrivateData


personnelles
4
authentication3DSecure.md Renvoy en POST par lACS Non AN20
4
authentication3DSecure.pares Renvoy en POST par lACS Non AN

Page 76/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
authentication3DSecure.xid Identifiant de transaction Non AN20 Ne plus utiliser, champ
Unique obsolte
authentication3DSecure.eci Electronic Commerce Indicator. Non AN2 Ne plus utiliser, champ
A passer dans lautorisation obsolte
authentication3DSecure.cavv Cardholder Authentication Non AN26- Ne plus utiliser, champ
Verification Value dtermin par 28 obsolte
lACS.
authentication3DSecure.cavvAl Entier positif prcisant Non AN20 Ne plus utiliser, champ
gorithm lalgorithme utilis pour la obsolte
gnration CAVV. Les valeurs
possibles actuelles sont:
0 = HMAC (SET TransStain),
1 = CVV,
2 = CVV avec ATN,
3 = MasterCard AAV
authentication3DSecure.vadsR Rsum des oprations Non AN4 Ne plus utiliser, champ
esult 3DSecure obsolte
owner.lastName Nom du titulaire non AN30 Applicable uniquement
pour AMEX
owner.firstName Prnom du titulaire non AN15 Applicable uniquement
pour AMEX
owner.issueCardDate Date dmission de la carte non AN4 Format respecter :
mmyy. Applicable
uniquement pour AMEX
owner.billingAddress.street Nom de rue du titulaire non AN20 Applicable uniquement
pour AMEX
owner.billingAddress.cityName Ville du titulaire non AN40 Applicable uniquement
pour AMEX
owner.billingAddress.zipCode Code postal du titulaire non AN9 Applicable uniquement
pour AMEX
owner.billingAddress.country Pays du titulaire non AN2 Applicable uniquement
pour AMEX
owner.billingAddress.phone Tlphone du titulaire non AN10 Applicable uniquement
pour AMEX
contractNumberWalletList Un tableau des numros de
contrat du wallet
buyer.lastName Nom de lacheteur non AN100
buyer.firstName Prnom de lacheteur non AN100
buyer.email Adresse email de lacheteur non AN150
buyer.shippingAddress.name Nom ou numro dimmeuble non AN100
buyer.shippingAddress.street1 Nom de rue non AN100
buyer.shippingAddress.street2 Complment du nom de rue non AN100

Page 77/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
buyer.shippingAddress.cityNa Ville non AN40
me
buyer.shippingAddress.zipCod Code postal non AN20
e
buyer.shippingAddress.country Pays non AN2 ISO 3166-1
buyer.shippingAddress.phone Tlphone non AN15 +351001110102
buyer.accountCreateDate La date de cration du compte non AN10 Format respecter :
de lacheteur dd/mm/yy
buyer.accountAverageAmount Le montant moyen des achats non N10
de cet acheteur
buyer.accountOrderCount Le nombre de commande non N10
pass par cet acheteur
3
buyer.walletId Lidentifiant du portefeuille Non AN50
virtuel de votre client.
buyer.walletDisplayed Gestion de laffichage des non AN5 Pour ne pas affcicher les
moyens de paiement de votre donnes de paiement
client client, saisir la valeur
none .
Pour afficher les
donnes de paiement
client, la balise doit tre
vide ou absente
buyer.walletSecured Nature du contrle ajout la non AN12 Pour raliser un contrle
cinmatique de paiement WEB. sur le crytpogramme
visuel, saisir la valeur
CVV
buyer.walletCardInd Spcifie lindex de la carte non AN2 Lindex de la carte,
utiliser. valeur par dfaut 1
buyer.ip Ladresse IP de lacheteur non AN50 Format respecter : IPv4
ou IPv6
buyer.mobilePhone Le numro de mobile de non N15 Ex : 0033691666666
lacheteur Pour envoi de SMS
lacheteur
buyer.customerId Identifiant client non AN50 Ex : 894492568
Cette donne peut tre
un identifiant ou un email
1
Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- non obligatoire pour une mise jour dun portefeuille.
3
- veuillez vous rfrer au tableau "Liste des champs obligatoires par type de carte en annexe
du document.
Si vous utilisez le card.token et que votre format de token PAN ne tient pas compte de la date
dexpiration, ce champ devient obligatoire
4
- Obligatoire pour toutes les transactions 3DSecure.
Page 78/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
5
- La balise version doit tre suprieure ou gale 3, si le champ card.token est renseign, le
champ card.number doit tre vide.
Si le format du token PAN ne tient pas compte de la date dexpiration, la balise est
card.expirationDate obligatoire.

4.8.2 Rponse en retour

Le message createWalletResponse est la rponse faite par Payline une demande de


cration dun portefeuille virtuel. La rponse a la structure suivante :
Elment Description Format Exemple
result.code Le code de retour du web service N5 cf. liste complte en annexe
02500: Operation Successful Code retour et message
02502 : Wallet with the same identifier Payline
exist
01xxx : Transaction refused
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
card.number La numro de la carte masque 111122XXXXXX4444
conforme PCI DSS
card.type Le type de carte : soit Carte visa, gold AN50
visa,
card.expirationDate Date dexpiration 0311
card.cardholder Titulaire de la carte AN20 Pierre Dupont
1
card.token Alias du numro de carte AN19 1111gPNzHtyu4444
extendedCard.country Pays demission de la carte 2 CODE ISO : exemple FR
extendedCard.isCvd La carte est elle une e carte bleu A1 Y OR N
extendedCard.bank La banque de la carte utilise pour le AN Crdit Lyonnais
paiement
extendedCard.type Le type de carte de paiement AN20 MASTERCARD
extendedCard.network Dsigne le rattachement de la carte AN20 MASTERCARD
une entit grant lacceptation de la
carte un niveau national ou
international
extendedCard.product Indique la catgorie laquelle AN Gold/Premier pour une
appartient le type de la carte carte type VISA
contractNumberWalletLi Un tableau des numros de contrat du
st wallet
1 - Evolution livre en octobre 2012, dans la version V4.31 de Payline.

Page 79/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.9 Update Wallet

La fonction update Wallet permet de mettre jour un portefeuille virtuel.

Lorsque les donnes du moyen de paiement sont renseignes, Payline ralise un contrle
montique du moyen de paiement pour le valider et met jour le portefeuille. Pour ne pas modifier
le moyen de paiement, veuillez ne pas renseigner les champs Wallet.card.* .

La mise jour est rejete dans les cas suivants :


Lidentifiant du portefeuille virtuel nexiste pas sur le point de vente indiqu
La date dexpiration de la carte est dpasse
Le rsultat du contrle montique de la carte de paiement est un refus
Les informations obligatoires ne sont pas renseignes
Lauthentification 3DSecure a chou

4.9.1 Requte envoyer

La requte updateWalletRequest a la mme structure que le message createWalletRequest


.

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la valeur 3
Payline
Requis depuis 2011
contractNumber le code ou numro de votre Oui AN50
contrat VAD qui reprsente le
moyen de paiement que vous
souhaitez utiliser
cardInd Ce champ est obligatoire si Non 2 Lindex de la carte, valeur
vous utilisez les multiwallet par dfaut 01
wallet.walletId lidentifiant unique du Oui AN50
portefeuille virtuel. Vous devez
communiquer Payline un
identifiant unique qui
correspond un et un seul
client sur votre systme
dinformation. Cest avec ce
mme identifiant vous pourrez
demander un paiement par
portefeuille virtuel.
wallet.lastName Le nom de votre client. Ces Oui AN100
informations sont utiles pour
rechercher un portefeuille dans

Page 80/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
le Centre dAdministration
Commercant.
wallet.firstName Le prnom de votre client. Oui AN100
wallet.email Ladresse de messagerie de Non AN150
votre client. Payline utilisera
cette information pour envoyer
un justificatif de paiement
votre client.
wallet.shippingAddress.name Nom ou numro dimmeuble Non AN100
wallet.shippingAddress.street1 Nom de rue Non AN100
wallet.shippingAddress.street2 Complment du nom de rue Non AN100
wallet.shippingAddress.cityNa Ville Non AN40
me
wallet.shippingAddress.zipCod Code postal Non AN20
e
wallet.shippingAddress.country Pays Non AN2
wallet.shippingAddress.phone Tlphone Non AN15
wallet.card.encryptionKeyId Identifiant de la cl RSA Payline Non N4 Si cest champs sont
de chiffrement renseigns alors les
donnes cartes doivent
tre null
wallet.card.encryptedData Les donnes carte chiffrs Non Base6 Si cest champs sont
4 renseigns alors les
donnes cartes doivent
tre null
wallet.card.number Numro de carte Oui2 N19
wallet.card.type Type de carte utilis pour la Oui 2 AN40 CB : visa / mastercard
transaction AMEX : American express
cf. liste complte en
annexe Tableau : Liste
des types de carte
wallet.card.expirationDate Date dexpiration de la carte non 3 N4 Format respecter :
mmyy
wallet.card.cvx Cryptogramme visuel au dos de Non 3 N10
la carte de crdit
wallet.card.ownerBirthdayDate Date danniversaire du porteur Non 3 N6 Format respecter :
ddmmyy
wallet.card.password Mot de passe crypt Non 3 AN16
wallet.card.cardPresent Ce service est utilise Non N1 0 ou 1 : present
uniquement si vous faites du
Mail Order ou Telephone Order
ou alors dans le cas o
linternaute est prsent
Page 81/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
physiquement
wallet.card.cardholder Titulaire de la carte Non AN20 Pierre Dupont
5 1
wallet.card.token Alias du numro de carte Non AN19 1111gPNzHtyu4444
A renseigner la place du
card.number condition que la
balilse version soit suprieure
ou gale 3.
wallet.comment Commentaires Non AN255
wallet.default Carte enregistre par dfaut Non A1 Y or N : Carte par dfaut
1
media Dtection du mdia lors de la Non AN25 Computer
mise jour du portefeuille.

Les valeurs possibles de cette


balise sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

privateDataList Vos propres informations non Tableau PrivateData


personnelles.
authentication3DSecure.md Renvoy en POST par lACS Non4 AN20
authentication3DSecure.pares Renvoy en POST par lACS Non4 AN
authentication3DSecure.xid Identifiant de transaction Non AN20 Ne plus utiliser, champ
Unique obsolte
authentication3DSecure.eci Electronic Commerce Indicator. Non AN2 Ne plus utiliser, champ
A passer dans lautorisation obsolte
authentication3DSecure.cavv Cardholder Authentication Non AN26- Ne plus utiliser, champ
Verification Value dtermin par 28 obsolte
lACS.
authentication3DSecure.cavvA Entier positif prcisant Non AN20 Ne plus utiliser, champ
lgorithm lalgorithme utilis pour la obsolte
gnration CAVV. Les valeurs
possibles actuelles sont:
0 = HMAC (SET TransStain),
1 = CVV,
2 = CVV avec ATN,
3 = MasterCard AAV
authentication3DSecure.vadsR Rsum des oprations Non AN4 Ne plus utiliser, champ
esult 3DSecure obsolte
owner.lastName Nom du titulaire non AN30 Applicable uniquement
pour AMEX
Page 82/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
owner.firstName Prnom du titulaire non AN15 Applicable uniquement
pour AMEX
owner.issueCardDate Date dmission de la carte non AN4 Format respecter :
mmyy. Applicable
uniquement pour AMEX
owner.billingAddress.street Nom de rue du titulaire non AN20 Applicable uniquement
pour AMEX
owner.billingAddress.cityName Ville du titulaire non AN40 Applicable uniquement
pour AMEX
owner.billingAddress.zipCode Code postal du titulaire non AN9 Applicable uniquement
pour AMEX
owner.billingAddress.country Pays du titulaire non AN2 Applicable uniquement
pour AMEX
owner.billingAddress.phone Tlphone du titulaire non AN10 Applicable uniquement
pour AMEX
contractNumberWalletList Un tableau des numros de non
contrat du wallet
buyer.lastName Nom de lacheteur non AN100
buyer.firstName Prnom de lacheteur non AN100
buyer.email Adresse email de lacheteur non AN150
buyer.shippingAddress.name Nom ou numro dimmeuble non AN100
buyer.shippingAddress.street1 Nom de rue non AN100
buyer.shippingAddress.street2 Complment du nom de rue non AN100
buyer.shippingAddress.cityNa Ville non AN40
me
buyer.shippingAddress.zipCod Code postal non AN20
e
buyer.shippingAddress.country Pays non AN2 ISO 3166-1
buyer.shippingAddress.phone Tlphone non AN15 +351001110102
buyer.accountCreateDate La date de cration du compte non AN10 Format respecter :
de lacheteur dd/mm/yy
buyer.accountAverageAmount Le montant moyen des achats non N10
de cet acheteur
buyer.accountOrderCount Le nombre de commande non N10
pass par cet acheteur
3
buyer.walletId Lidentifiant du portefeuille Non AN50
virtuel de votre client.

Page 83/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
buyer.walletDisplayed Gestion de laffichage des non AN5 Pour ne pas affcicher les
moyens de paiement de votre donnes de paiement
client client, saisir la valeur
none .
Pour afficher les donnes
de paiement client, la
balise doit tre vide ou
absente
buyer.walletSecured Nature du contrle ajout la non AN12 Pour raliser un contrle
cinmatique de paiement WEB. sur le crytpogramme
visuel, saisir la valeur
CVV
buyer.walletCardInd Spcifie lindex de la carte non AN2 Lindex de la carte, valeur
utiliser. par dfaut 1
buyer.ip Ladresse IP de lacheteur non AN50 Format respecter : IPv4
ou IPv6
buyer.mobilePhone Le numro de mobile de non N15 Ex : 0033691666666
lacheteur Pour envoi de SMS
lacheteur
buyer.customerId Identifiant client non AN50 Ex : 894492568
Cette donne peut tre un
identifiant ou un email
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Non obligatoire pour une mise jour dun portefeuille.
3
- Veuillez vous rfrer lannexe au Tableau : Liste des champs obligatoires par type de
carte .
Si vous utilisez le card.token et que votre format de token PAN ne tient pas compte de la date
dexpiration, ce champ devient obligatoire
4
- Obligatoire pour toutes les transactions 3DSecure.
5
- La balise version doit tre suprieure ou gale 3, si le champ card.token est renseign, le
champ card.number doit tre vide.
Si le format du token PAN ne tient pas compte de la date dexpiration, la balise est
card.expirationDate obligatoire.

Page 84/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.9.2 Rponse en retour

Le message updateWalletResponse est la rponse faite par Payline une demande de


modification dun portefeuille virtuel. La rponse a la mme structure que le message
createWalletResponse

Elment Description Format Exemple


result.code Le code de retour du web service N5 cf. liste complte en annexe
02500: Operation Successful Code retour et message
02503: Wallet does not exist Payline
result.shortMessage Message court du rsultat de la transaction AN50
result.longMessage Message du rsultat de la transaction AN255
card.number Le numro de la carte masque conforme 111122XXXXXX4444
PCI DSS
card.type Le type de carte : soit Carte visa, gold visa, AN50
card.expirationDate Date dexpiration 0311
card.cardholder Titulaire de la carte AN20 Pierre Dupont
1
card.token Alias du numro de carte AN19 1111gPNzHtyu4444
extendedCard.country Pays demission de la carte 2 CODE ISO : exemple FR
extendedCard.isCvd La carte est elle une e carte bleu A1 Y OR N
extendedCard.bank La banque de la carte utilise pour le AN Crdit Lyonnais
paiement
extendedCard.type Le type de carte de paiement AN20 MASTERCARD
extendedCard.network Dsigne le rattachement de la carte une AN20 MASTERCARD
entit grant lacceptation de la carte un
niveau national ou international
extendedCard.product Indique la catgorie laquelle appartient le AN Gold/Premier pour une carte
type de la carte type VISA
contractNumberWalletLi Un tableau des numros de contrat du
st wallet
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

Page 85/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.10 Web service - Get Wallet

La fonction getWallet rcupre les donnes dun portefeuille virtuel.

4.10.1 Requte envoyer

La requte getWalletRequest doit transmettre le champ walletID et contractNumber pour


identifier un portefeuille.

Elment Description Requis Type Exemple


1
version Version des web services Payline Oui N1 A valoriser la valeur 3
Requis depuis 2011
contractNumbe Le n de contrat VAD qui a t utilis pour oui AN50
r la cration du portefeuille
walletId Lidentifiant du portefeuille virtuel. oui AN50
1
media Dtection du mdia utilis lors de la cration Non AN25 TV
ou mise jour du portefeuille.

Les valeurs possibles de cette balise sont :


- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

cardInd Ce champ est obligatoire si vous utilisez les non 2 Lindex de la carte, valeur par
multiwallet dfaut 01
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

4.10.2 Rponse en retour

Le message getWalletResponse est la rponse faite par Payline une demande de


rcupration des donnes dun portefeuille virtuel. La rponse a la structure suivante :

Elment Description Format Exemple


result.code Le code de retour du web service N5 cf. liste complte en annexe
02500: Operation Successful Code retour et message
02503 : Wallet does not exist Payline
01xxx : Transaction refused

Page 86/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
wallet.walletId Lidentifiant unique du portefeuille AN50
virtuel
wallet.lastName Le nom de votre client. AN100
wallet.firstName Le prnom de votre client. AN100
wallet.email Ladresse de messagerie de votre AN150
client
wallet.shippingAddress.name Nom ou numro dimmeuble AN100
wallet.shippingAddress.street Nom de rue AN100
1
wallet.shippingAddress.street Complment du nom de rue AN100
2
wallet.shippingAddress.cityNa Ville AN40
me
wallet.shippingAddress.zipCo Code postal AN20
de
wallet.shippingAddress.countr Pays AN2
y
wallet.shippingAddress.phone Tlphone AN15
wallet.card.number Numro de carte masqu N19
wallet.card.type Type de carte utilis pour la AN40
transaction
wallet.card.expirationDate Date dexpiration de la carte N4 mmyy
wallet.card.cvx champ vide N10
wallet.card.ownerBirthdayDat Date danniversaire du porteur N6
e
wallet.card.password Mot de passe crypt AN16
wallet.card.cardholder Titulaire de la carte AN20 Pierre Dupont
1
wallet.card.token Alias du numro de carte AN19 1111gPNzHtyu4444
wallet.comment Commentaires AN255
wallet.default Carte enregistre par dfaut A1 Y or N : Carte par dfaut
isDisabled Indicateur qui vous informe que le N1 1 = Dsactiv
portefeuille virtuel est actif ou inactif 0 = Actif
disableDate Date de dsactivation du portefeuille AN14 Format : dd/mm/yy
HH24 :MI
disableStatus Motif de la dsactivation du AN3 EXP : date expire
portefeuille OPP : mise en opposition
MAN : dsactivation
manuelle
INT : rgles internes

Page 87/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
privateDataList Informations transmises lors de
lappel de la fonction doWebPayment
owner.lastName Nom du titulaire AN30 Applicable uniquement pour
AMEX
owner.firstName Prnom du titulaire AN15 Applicable uniquement pour
AMEX
owner.issueCardDate Date dmission de la carte AN4 Format respecter : mmyy.
Applicable uniquement pour
AMEX
owner.billingAddress.street Nom de rue du titulaire AN20 Applicable uniquement pour
AMEX
owner.billingAddress.cityNam Ville du titulaire AN40 Applicable uniquement pour
e AMEX
owner.billingAddress.zipCode Code postal du titulaire AN9 Applicable uniquement pour
AMEX
owner.billingAddress.country Pays du titulaire AN2 Applicable uniquement pour
AMEX
extendedCard.country Pays demission de la carte AN2 CODE ISO : exemple FR
extendedCard.isCvd La carte est elle une e carte bleu A1 Y OR N
extendedCard.bank La banque de la carte utilise pour le AN Crdit Lyonnais
paiement
extendedCard.type Le type de carte de paiement AN20 MASTERCARD
extendedCard.network Dsigne le rattachement de la carte AN20 MASTERCARD
une entit grant lacceptation de la
carte un niveau national ou
international
extendedCard.product Indique la catgorie laquelle AN Gold/Premier pour une
appartient le type de la carte carte type VISA
contractNumberWalletList Un tableau des numros de contrat
du wallet
1
media Dtection du mdia utilis par AN25 Computer
Payline.

Les valeurs possibles de cette balise


sont :
- Computer
- Mobile
- Tablet
- TV
- Console

Undefined
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

Page 88/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.11 Web service - Disable Wallet

La fonction disable Wallet permet de dsactiver un portefeuille virtuel.


Lorsquun portefeuille est dsactiv, il nest plus possible deffectuer des paiements via celui-ci.

4.11.1 Requte envoyer

La requte disableWalletRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


contractNumber Le n de contrat VAD qui a t oui AN50
utilis pour la cration du
portefeuille
walletIdList.WalletId Lidentifiant du portefeuille virtuel. oui AN50
cardInd Dans le cadre du WALLET non 2 Lindex de la carte,
multicarte, il faut indiquer lindex de valeur par dfaut 01
la carte, sinon par dfaut la
premire carte qui a t enregistr
sera dsactiv.

4.11.2 Rponse en retour

Le message disableWalletResponse est la rponse faite par Payline une demande de


dsactivation dun portefeuille virtuel. La rponse a la structure suivante :

Elment Description Format Exemple


result.code Le code de retour du web service N5 cf. liste complte en annexe
02500: Operation Successful Code retour et message
02501: Operation Successful with Payline
warning
02503: Wallet does not exist
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
walletIdList.WalletId Lidentifiant du portefeuille virtuel AN50

Page 89/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.12 Web service - Getcards

La mthode permet de rcuprer les informations sur les cartes dun portefeuille multicartes.

4.12.1 Requte envoyer

Elment Description Requis Type Exemple


walletId Lidentifiant du portefeuille Oui AN50
multicarte virtuel renvoyer
contractNumber Le numro du contrat de paiement Oui AN50
li au portefeuille virtuel.
cardInd Ce champ est obligatoire si vous non 2 Lindex de la carte,
utilisez les multiwallet valeur par dfaut 01

4.12.2 Rponse en retour

Elment Description Type Exemple


result.code Le code de retour du web service N5 Si le wallet existe, le code
02500: Operation Successful retour renvoy sera
02503 : Wallet does not exist 02500
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la AN255
transaction
cardsList.cards.walletId Lidentifiant unique du portefeuille AN50
virtuel
cardsList.cards.lastName Le nom de votre client. AN100
cardsList.cards.firstName Le prnom de votre client. AN100
cardsList.cards.email Ladresse de messagerie de votre AN150
client
cardsList.cards.shippingAddress. Nom ou numro dimmeuble AN100
name
cardsList.cards.shippingAddress. Nom de rue AN100
street1
cardsList.cards.shippingAddress. Complment du nom de rue AN100
street2
cardsList.cards.shippingAddress. Ville AN40
cityName
cardsList.cards.shippingAddress. Code postal AN20
zipCode

Page 90/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
cardsList.cards.shippingAddress. Pays AN2
country
cardsList.cards.shippingAddress. Tlphone AN15
phone
cardsList.cards.card.number Numro de carte masqu N19
cardsList.cards.card.type Type de carte utilis pour la AN40
transaction
cardsList.cards.card.expirationDat Date dexpiration de la carte N4 mmyy
e
cardsList.cards.card.cvx champ vide N10
cardsList.cards.card.ownerBirthda Date danniversaire du porteur N6
yDate
cardsList.cards.card.password Mot de passe crypt AN16
cardsList.cards.card.cardholder Titulaire de la carte AN20 Pierre Dupont
cardsList.cards.cardInd Lindex de la carte N2 Valeur par dfaut 01

cardsList.cards.comment Commentaires AN255


cardsList.cards.isDisabled Indicateur qui vous informe que le N1 1 = Dsactiv
portefeuille virtuel est actif ou inactif 0 = Actif
cardsList.cards.disableDate Date de dsactivation du AN14 Format : dd/mm/yy
portefeuille HH24 :MI
cardsList.cards.disableStatus Motif de la dsactivation du AN3 EXP : date expire
portefeuille OPP : mise en opposition
MAN : dsactivation
manuelle
INT : rgles internes
cardsList.cards.extendedCard.typ Type de la carte enregistre AN20 Par exemple : CB
e
cardsList.cards.default Carte enregistre par dfaut A1 Y or N : Carte par dfaut
privateDataList Vos informations prives que vous
souhaitez transmettre
owner.lastName Nom du titulaire AN30 Applicable uniquement pour
AMEX
owner.firstName Prnom du titulaire AN15 Applicable uniquement pour
AMEX
owner.issueCardDate Date dmission de la carte AN4 Format respecter : mmyy.
Applicable uniquement pour
AMEX
owner.billingAddress.street Nom de rue du titulaire AN20 Applicable uniquement pour
AMEX
owner.billingAddress.cityName Ville du titulaire AN40 Applicable uniquement pour
AMEX
owner.billingAddress.zipCode Code postal du titulaire AN9 Applicable uniquement pour
AMEX
Page 91/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
owner.billingAddress.country Pays du titulaire AN2 Applicable uniquement pour
AMEX

4.13 Web service- Enable Wallet

La fonction enable Wallet permet dactiver un portefeuille virtuel.

4.13.1 Requte envoyer

La requte enableWalletRequest transmettre le champ walletID et contractNumber pour


identifier un portefeuille.
REQUEST

Elment Description Requis Type Exemple


contractNumber Le n de contrat VAD qui a t oui AN50
utilis pour la cration du
portefeuille
walletId Lidentifiant du portefeuille virtuel. oui AN50
cardInd Ce champ est obligatoire si vous non 2 Lindex de la carte,
utilisez les multiwallet valeur par dfaut 01

4.13.2 Rponse en retour

Le message enableWalletResponse est la rponse faite par Payline une demande de


dsactivation dun portefeuille virtuel. La rponse a la structure suivante :

Elment Description Format Exemple


result.code Le code de retour du web service N5 cf. liste complte en annexe
02500: Operation Successful Code retour et message
02503 : Wallet does not exist Payline
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255

Page 92/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.14 Web service - Do Immediate Wallet Payment

La fonction doImmediateWalletPayment ralise un paiement partir dun portefeuille virtuel.

Vous pouvez utiliser les modes de paiement comptant CPT et diffr DIF avec cette fonction.
Payline retourne un code rsultat 02308 : mode de paiement non accept pour les autres modes.

La rponse votre demande de paiement vous est communique en temps rel (synchrone).

Le paiement est refus dans les cas suivants :


Lidentifiant du portefeuille virtuel fourni nexiste pas ou le portefeuille est inactif
La demande dautorisation est refuse
Le mode de paiement nest pas accept

4.14.1 Requte envoyer

La requte doImmediateWalletPaymentRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la valeur 3
Payline
Requis depuis 2011
payment.amount le montant du paiement oui N12 pour un montant de 60 ,
raliser. Le montant doit tre vous devez mettre la
formul dans la plus petite valeur 6000.
unit de la devise.

payment.currency le code ISO de la devise du oui N3 978 : euros


paiement 840 : dollars US
cf. liste complte en
annexe tableau Liste
des devises
payment.action Code de la fonction de oui N3 100 : autorisation
paiement 101 : autorisation +
validation
payment.mode choisir entre les modes CPT et oui AN3 CPT : Comptant
DIF DIF : Diffr
payment.contractNumber Le numro du contrat de oui AN50
paiement qui reprsente un
moyen de paiement
payment.DifferedActionDate Date effective de laction. Elle non 2 AN8 Format respecter :
doit tre infrieure la date du dd/mm/yy

Page 93/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
jour + 7 jours.
media Dtection du mdia utilis lors Non
1
AN25 Computer

du paiement
Les valeurs possibles de cette
balise sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

order.ref Rfrence de la commande. oui AN50 12345678


Cette rfrence doit tre
unique car elle est utilise pour
le contrle dans demande en
double.
order.origin Origine de la commande non AN50 SVI_#12
order.country Code du pays dans lequel la non AN3 FR
commande a t effectue
order.taxes Le montant des taxes sur la non N12
commande dans la plus petite
unit de la devise.
order.amount Le montant de la commande oui N12 pour un montant de 60 ,
dans la plus petite unit de la vous devez mettre la
devise. Gnralement le valeur 6000.
mme montant que
payment.amount
order.currency le code ISO de la devise du oui N3 978 : euros
paiement 840 : dollars US
cf. liste complte en
annexe tableau Liste
des devises
order.date La date de la commande chez oui AN16 Format respecter :
le commerant dd/mm/yyyy
HH24:MI
order.details Informations sur les articles non Tableau OrderDetails
commands
order. deliveryTime Dlai de livraison : Non N 1
1 = express
- 2 = standard
order. deliveryMode Mode de livraison : Non N 4
1 : retrait de la marchandise
chez le marchand
Page 94/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
2 : Utilisation d'un rseau de
points-retrait tiers (type kiala,
alveol, etc.)
3 : Retrait dans un aroport,
une gare ou une agence de
voyage
4 : Transporteur (La Poste,
Colissimo, UPS, DHL... ou tout
transporteur priv)
5: Emission dun billet
lectronique, tlchargements
walletId lidentifiant unique du oui AN50
portefeuille virtuel. Cest
lidentifiant que vous avez
communiqu lors de la
demande de cration du
portefeuille.
cardInd Ce champ est obligatoire si non N2 Lindex de la carte, valeur
vous utilisez les multiwallet par dfaut 01
Cvx Contrle du CVV lors de la non N 123
ralisation du paiement

privateDataList Vos informations prives que non Tableau PrivateData


vous souhaitez transmettre
3
authentication3DSecure.md Renvoy en POST par lACS Non AN20
3
authentication3DSecure.pares Renvoy en POST par lACS Non AN
authentication3DSecure.xid Identifiant de transaction Non AN20 Ne plus utiliser, champ
Unique obsolte
authentication3DSecure.eci Electronic Commerce Non AN2 Ne plus utiliser, champ
Indicator. A passer dans obsolte
lautorisation
authentication3DSecure.cavv Cardholder Authentication Non AN26- Ne plus utiliser, champ
Verification Value dtermin 28 obsolte
par lACS.
authentication3DSecure.cavv Entier positif prcisant Non N1 Ne plus utiliser, champ
Algorithm lalgorithme utilis pour la obsolte
gnration CAVV. Les valeurs
possibles actuelles sont:
0 = HMAC (SET
TransStain),
1 = CVV,
2 = CVV avec ATN,
3 = MasterCard AAV
authentication3DSecure.vads Rsum des oprations Non AN4 Ne plus utiliser, champ
Page 95/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
Result 3DSecure obsolte
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.
3
- Obligatoire pour toutes les transactions 3DSecure. Cette balise va permettre dauthentifier la
transaction comme 3DSecure. Lorsque vous souhaiterez effectuer un paiement par wallet en
mode 3DS via un doImmediateWalletPayment, vous devrez au pralable fournir les lments
walletId et walletCardInd en entre du web service verifyEnrollment afin que Payline sassure de
lligibilit de la carte du portefeuille.

4.14.2 Rponse en retour

Le message doImmediateWalletPaymentResponse est la rponse faite par Payline une


demande de paiement par portefeuille. Il vous permet dobtenir, entre autres, le numro unique de
la transaction sur Payline et le n dautorisation de dbit dlivr par votre tablissement bancaire.

La rponse a la structure suivante :

Elment Description Format Exemple


result.code Le code de retour de votre demande : N5 cf. liste complte en
00000 : Transaction approved annexe Code retour et
01001 : Transaction approved message Payline
02302 : Transaction invalid
02503 : Wallet does not exist
02505 : Wallet is disabled
02308 : Payment Mode invalid
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
transaction.id Identifiant unique de la transaction N50
Payline
transaction.isPossibleFrau Cet indicateur est calcul en fonction AN1 1 = Il existe un risque de
d des critres dfinis par le commerant fraude
0 = Aucun risque de
fraude dtect
transaction.isDuplicated Cet indicateur est retourn par Payline AN1 1 = Il existe un risque de
dans le cas de transaction en doublon fraude
0 = Aucun risque de
fraude dtect
transaction.date Date et heure de la transaction Payline AN16 Format : dd/mm/yy
HH24:MI

Page 96/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
authorization.number Numro dautorisation dlivr par le N6 123456
serveur dautorisation acqureur. Ce
champ est renseign si la demande
dautorisation est accorde.
authorization.date Date et heure de lautorisation AN16 Format : dd/mm/yyyy
HH24:MI

4.15 Web service- Do Scheduled Wallet Payment

La fonction do Scheduled Wallet Payment enregistre une demande de paiement programme


et ralise le jour souhait une demande dautorisation de dbit avec les donnes dun portefeuille.

Le dossier de paiement est caractris par :


les informations dun portefeuille virtuel existant
des chances de paiement : un montant, une devise, une date dchance, un statut, etc.

Lenregistrement de la demande est refus dans les cas suivants :


Lidentifiant du portefeuille virtuel fourni nexiste pas ou le portefeuille est inactif
La date de paiement souhaite est au del de la date dexpiration du moyen de paiement
Le mode de paiement nest pas accept.

Le paiement est refus uniquement si la demande dautorisation est refuse.

Payline vous informe, par sa fonction de notification, du traitement de votre demande de paiement.
LURL de notification utilise est dfinie au niveau de votre point de vente sur le Centre
dAdministration Commerant.

4.15.1 Requte envoyer

La requte doScheduledWalletPaymentRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Payline Oui N1 A valoriser la valeur 3
Requis depuis 2011
payment.amount le montant du paiement raliser. oui N12 pour un montant de 60 ,
Le montant doit tre formul dans vous devez mettre la
la plus petite unit de la devise. valeur 6000.

payment.currency le code ISO de la devise du oui N3 978 : euros


paiement 840 : dollars US
cf. liste complte en
annexe tableau Liste
des devises
Page 97/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
payment.action Code de la fonction de paiement oui N3 201 : Validation
payment.mode vous devez mettre la valeur CPT oui AN3
pour enregistrer un paiement
programm.
payment.contractNumbe Le numro du contrat de oui AN50
r paiement qui reprsente un
moyen de paiement
payment.differedActionD Date effective de laction. Elle doit non 2 AN8 Format respecter :
ate tre infrieure la date du jour + dd/mm/yy
7 jours.
media Dtection du mdia utilis lors du Non
1
AN25 Computer

paiement

Les valeurs possibles de cette balise


sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

orderRef Rfrence commande non AN50


orderDate Date de la commande non dd/mm/yyyy hh:mm
scheduledDate la date souhaite pour la oui AN10 Format respecter :
demande dautorisation dd/mm/yyyy
walletId lidentifiant unique du portefeuille oui AN50
virtuel. Cest lidentifiant que vous
avez communiqu lors de la
demande de cration du
portefeuille.
cardInd Ce champ est obligatoire si vous non 2 Lindex de la carte, valeur
utilisez les multiwallet par dfaut 01
order.ref Rfrence de la commande. oui AN50 12345678
Cette rfrence doit tre unique
car elle est utilise pour le
contrle dans demande en
double.
order.origin Origine de la commande non AN50 SVI_#12
order.country Code du pays dans lequel la non AN3 FR
commande a t effectue
order.taxes Le montant des taxes sur la non N12
commande dans la plus petite
unit de la devise.
Page 98/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
order.amount Le montant de la commande dans oui N12 pour un montant de 60 ,
la plus petite unit de la devise. vous devez mettre la
Gnralement le mme montant valeur 6000.
que payment.amount
order.currency le code ISO de la devise du oui N3 978 : euros
paiement 840 : dollars US
cf. liste complte en
annexe tableau Liste
des devises
order.date La date de la commande chez le oui AN16 Format respecter :
commerant dd/mm/yyyy
HH24:MI
order.details Informations sur les articles non Tableau OrderDetails
commands
order. deliveryTime Dlai de livraison : Non N 1
1 = express
- 2 = standard
order. deliveryMode Mode de livraison : Non N 4
1 : retrait de la marchandise chez
le marchand
2 : Utilisation d'un rseau de
points-retrait tiers (type kiala,
alveol, etc.)
3 : Retrait dans un aroport, une
gare ou une agence de voyage
4: Transporteur (La Poste,
Colissimo, UPS, DHL... ou tout
transporteur priv)
5: Emission dun billet
lectronique, tlchargements
privateDataList Vos propres informations non Tableau PrivateData
personnelles.
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.

4.15.2 Rponse en retour

Le message doScheduledWalletPaymentResponse est la rponse faite par Payline une


demande de paiement programm par portefeuille. Il vous permet dobtenir, entre autres,
lidentifiant du dossier de paiement enregistr. La rponse a la structure suivante :
Elment Description Format Exemple

Page 99/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
result.code Le code de retour de votre demande : N5 cf. liste complte en annexe
02500 : Operation successfull tableau Code retour et
02501 : Operation successful with warning message Payline
02503 : Wallet does not exist
02505 : Wallet is disabled
02308 : Payment Mode invalid
result.shortMessage Message court du rsultat AN50
result.longMessage Message du rsultat AN255
paymentRecordId Lidentifiant du dossier de paiement cr N12

4.16 Web service- DoRecurrentWalletPayment

La fonction doRecurrentWalletPayment enregistre un dossier de paiement pour une facturation


automatique et rcurrente de votre client. Payline traite, jour par jour, les chances raliser et
vous informe du rsultat par la fonction de notification.

Le dossier de paiement est caractris par :


les informations dun portefeuille virtuel existant
des chances de paiement : un montant, une devise, une date dchance, un statut, etc.

Lenregistrement du dossier de paiement est refus dans les cas suivants :


Lidentifiant du portefeuille virtuel fourni nexiste pas ou le portefeuille est inactif
Le montant du champ payment.Amout na pas la bonne valeur
Le mode de paiement nest pas accept

Dans le cas o la date dexpiration de la carte bancaire ne couvre pas lintgralit des chances
venir, Payline vous alerte par le code retour 02506.

Un paiement est refus uniquement si la demande dautorisation est refuse.

4.16.1 Requte envoyer

La requte doRecurrentWalletPaymentRequest doit avoir la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Oui N1 A valoriser la valeur 3
Payline
Requis depuis 2011
payment.amount le montant total du paiement oui N12 pour un montant de 60 ,
raliser. Le montant doit tre la vous devez mettre la valeur
somme des chances 6000.
demandes. Il doit tre formul
Page 100/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
dans la plus petite unit de la
devise.

payment.currency le code ISO de la devise du oui N3 978 : euros


paiement 840 : dollars US
cf. liste complte en
annexe tableau Liste des
devises
payment.action Code de la fonction de oui N3 201 : Validation
paiement
payment.mode vous devez mettre la valeur oui AN3 REC : Rcurrent
REC pour raliser un paiement NX : n fois
rcurrent ou NX pour raliser
un paiement en n-fois.
payment.contractNumber Le numro du contrat de oui AN50
paiement qui reprsente un
moyen de paiement
2
payment.differedActionDat Date effective de laction. Elle non AN8 Format respecter :
e doit tre infrieure la date du dd/mm/yy
jour + 7 jours.
media Dtection du mdia utilis lors nngCyc AN25 TV
1
du paiement leon

Les valeurs possibles de cette


balise sont :
- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

orderRef Ne pas utiliser


orderDate Ne pas utiliser
scheduledDate la date souhaite pour la non AN10 Format respecter :
demande dautorisation dd/mm/yyyy
walletId lidentifiant unique du oui AN50
portefeuille virtuel. Cest
lidentifiant que vous avez
communiqu lors de la
demande de cration du
portefeuille.
cardInd Ce champ est obligatoire si non 2 Lindex de la carte, valeur
vous utilisez les multiwallet par dfaut 01
Page 101/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
recurring.firstAmount Le montant du premier montant non N12 pour un montant de 100 ,
effectuer. Il doit tre formul vous devez mettre la valeur
dans la plus petite unit de la 10000.
devise.
recurring.amount Le montant dune chance. Il oui N12 pour un montant de 5 ,
doit tre formul dans la plus vous devez mettre la valeur
petite unit de la devise. 500.
recurring.billingCycle Le code de la frquence des oui N2 40 : mensuel
paiements. 60 : trimestriel
cf. liste complte en
annexe tableau Liste des
frquences de paiement
recurring.startDate La date de la premire non AN10 Format respecter :
chance (uniquement en dd/mm/yyyy
mode REC). Si ce champ nest
pas renseign, Payline y affecte
la date du jour.

recurring.billingLeft Nombre dchance non N3 3


recurring.billingDay Jour o les chances doivent non AN2 Format respecter : dd
tre traites.
order.ref Rfrence de la commande. oui AN50 12345678
Cette rfrence doit tre unique
car elle est utilise pour le
contrle dans demande en
double.
order.origin Origine de la commande non AN50 MO TO
order.country Code du pays dans lequel la non AN3 FR
commande a t effectue
order.taxes Le montant des taxes sur la non N12
commande dans la plus petite
unit de la devise.
order.amount Le montant de la commande oui N12 pour un montant de 60 ,
dans la plus petite unit de la vous devez mettre la valeur
devise. Gnralement le mme 6000.
montant que payment.amount
order.currency le code ISO de la devise du oui N3 978 : euros
paiement 840 : dollars US
cf. liste complte en
annexe tableau Liste des
devises
order.date La date de la commande chez oui AN16 Format respecter :
le commerant dd/mm/yyyy

Page 102/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
HH24:MI
order.details Informations sur les articles non Tableau OrderDetails
commands
order. deliveryTime Dlai de livraison : Non N 1
1 = express
- 2 = standard
order. deliveryMode Mode de livraison : Non N 4
1 : retrait de la marchandise
chez le marchand
2 : Utilisation d'un rseau de
points-retrait tiers (type kiala,
alveol, etc.)
3 : Retrait dans un aroport,
une gare ou une agence de
voyage
4: Transporteur (La Poste,
Colissimo, UPS, DHL... ou tout
transporteur priv)
5: Emission dun billet
lectronique, tlchargements
privateDataList Vos propres informations non Tableau PrivateData
personnelles.
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Lorsque le champ payment.mode prend la valeur DIF , la date payment.DifferedActionDate
est obligatoire. Dans les autres modes de paiement, ce champ doit tre vide.

4.16.2 Rponse en retour

Le message doRecurrentWalletPaymentResponse est la rponse faite par Payline une


demande de paiement programm par portefeuille. Il vous permet dobtenir, entre autres,
lidentifiant du dossier de paiement enregistr. La rponse a la structure suivante :

Forma
Elment Description Exemple
t
result.code Le code de retour de votre demande : N5 cf. liste complte
02500 : Operation successfull en annexe
02501 : Operation successful with tableau Code
warning retour et message
02502 : Wallet with the same ID exist Payline
02503 : Wallet does not exist
02505 : Wallet is disabled
02509 : Invalid recurring option
Page 103/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Forma
Elment Description Exemple
t
result.shortMessage Message court du rsultat AN50
result.longMessage Message du rsultat AN255
paymentRecordId Lidentifiant du dossier de paiement N12
2
billingRecordList Tableau dchances Tableau de
billingRecord

Pour chaque chance (billingRecord) :

Elment Commentaire Requis Exemple


2
billingRecord.date La date de lchance AN10 Format : dd/mm/yyyy
2
billingRecord.amount Le montant de lchance dans la plus N12
petite unit de la devise.
2
billingRecord.status Le statut dune chance : AN1
0 : chance venir.
1 : chance accept.
2 : chance refus.
2
billingRecord.result.code Le code de retour du traitement de N5 cf. liste complte en
lchance annexe tableau Liste
00000 : Transaction approved des codes retours
01xxx : Transaction refused
02302 : Transaction invalid
billingRecord.result.shortMessag Message court du rsultat de la AN50
2
e transaction
billingRecord.result.longMessage Message du rsultat de la transaction AN255
2

2
billingRecord.transaction.Id Identifiant unique de la transaction N50
Payline
billingRecord.transaction.isPossi Cet indicateur est calcul en fonction des AN1 1 = Il existe un risque
2
bleFraud critres dfinis par le commerant de fraude
0 = Aucun risque de
fraude dtect
billingRecord.transaction.isDuplic Cet indicateur est retourn par Payline AN1 1 = Il existe un risque
2
ated dans le cas de transaction en doublon de fraude
0 = Aucun risque de
fraude dtect
2
billingRecord.transaction.date Date et heure de la transaction Payline AN16 Format :dd/mm/yyyy
HH24:MI
billingRecord.authorization.numb Numro dautorisation dlivr par le N6 123456
2
er serveur dautorisation acqureur. Ce
champ est renseign si la demande
dautorisation est accorde*.

Page 104/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Commentaire Requis Exemple
2
billingRecord.authorization.date Date et heure de lautorisation AN16 Format :dd/mm/yyyy
HH24:MI
billingRecord.nbTry Nombre de tentatives de paiement N3
effectues (version suprieure ou gale
8)
billingRecord.rank Rang de lchance au sein du dossier de N12
paiement ((version suprieure ou gale
8))
billingRecord.executionDate Date de la prochaine tentative de AN10 Format : dd/mm/yyyy
paiement

4.17 Get Payment Record

La fonction get Payment Record permet de rcuprer les informations dun dossier de
paiement rcurrent.

4.17.1 Requte envoyer

La requte getPaymentRecordRequest doit uniquement transmettre les lments


contractNumber et paymentRecordID retourns par Payline lors de lenregistrement dun dossier
de paiement.

Elment Description Requis Type Exemple


contractNumber Le numro du contrat qui a t oui AN50
utilis pour crer le dossier de
paiement et le portefeuille virtuel.
paymentRecordId Lidentifiant du dossier de oui N12 12345
paiement

4.17.2 Rponse en retour

Le message getPaymentRecordResponse est la rponse faite par Payline une demande


dinformation sur un dossier de paiement. Il vous permet dobtenir entre autres les chances
associes au dossier de paiement. La rponse a la structure suivante :

Elment Description Format Exemple


result.code Le code de retour de votre N5 cf. liste complte en
demande : annexe tableau Liste
des codes retours
02500 : Operation successful

Page 105/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
02507 : Can not found
payment record
result.shortMessage Message court du rsultat AN50
result.longMessage Message du rsultat AN255
recurring.firstAmount Le montant du premier N12 pour un montant de
montant effectuer. Il doit tre 100 , vous devez
formul dans la plus petite mettre la valeur 10000.
unit de la devise.
recurring.amount Le montant dune chance. Il N12 pour un montant de 5
doit tre formul dans la plus , vous devez mettre
petite unit de la devise. la valeur 500.
recurring.billingCycle Le code de la frquence des N2 40 : mensuel
paiements. 60 : trimestriel
cf. liste complte en
annexe tableau Liste
des frquences de
paiement
recurring.startDate La date de la premire AN10 Format : dd/mm/yyyy
chance. Si ce champ nest
pas renseign, Payline y
affecte la date du jour.

recurring.billingLeft Nombre dchance N3 3


recurring.billingDay Jour o les chances doivent AN2 Format : dd
tre traites.
isDisabled Le statut du dossier de N1
paiement
0 : actif
1 : inactif
disableDate La date de dsactivation du AN14 Format : dd/mm/yy
dossier de paiement HH24:MI
2
billingRecordList Tableau dchances Tableau de
billingRecord
order La commande associe
privateDataList Vos donnes personnelles
walletId Identifiant du portefeuille utilis AN50

Pour chaque chance (billingRecord) :

Elment Description Format Exemple


billingRecord.date La date de lchance AN10 Format : dd/mm/yyyy
billingRecord.amount Le montant de lchance N12
dans la plus petite unit de la

Page 106/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
devise.
billingRecord.status Le statut dune chance : AN1
0 : chance venir.
1 : chance accept.
2 : chance refus.
billingRecord.result.code Le code de retour du N5 cf. liste complte en
traitement de lchance annexe tableau Liste
00000 : Transaction approved des codes retours
01xxx : Transaction refused
02302 : Transaction invalid
billingRecord.result.shortMessage Message court du rsultat de AN50
la transaction
billingRecord.result.longMessage Message du rsultat de la AN255
transaction
billingRecord.transaction.id Identifiant unique de la N50
transaction Payline
billingRecord.transaction.isPossibleFrau Cet indicateur est calcul en AN1 1 = Il existe un risque
d fonction des critres dfinis de fraude
par le commerant 0 = Aucun risque de
fraude dtect
billingRecord.transaction.isDuplicated Cet indicateur est retourn par AN1 1 = Il existe un risque
Payline dans le cas de de fraude
transaction en doublon 0 = Aucun risque de
fraude dtect
billingRecord.transaction.date Date et heure de la transaction AN16 Format : dd/mm/yyyy
Payline HH24:MI
billingRecord.authorization.number Numro dautorisation dlivr N6 123456
par le serveur dautorisation
acqureur. Ce champ est
renseign si la demande
dautorisation est accorde*.

billingRecord.authorization.date Date et heure de lautorisation AN16 Format : dd/mm/yyyy


HH24:MI

Page 107/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.18 Web service DisablePaymentRecord

La fonction disablePaymentRecord permet de dsactiver un dossier de paiement.


Lorsquun dossier de paiement est dsactiv, ses chances associes ne seront plus traites.

4.18.1 Requte envoyer

La requte disablePaymentRecordRequest doit uniquement transmettre les lments


contractNumber et paymentRecordID retourns par Payline lors de lenregistrement dun dossier
de paiement.
REQUEST

Elment Description Requis Type Exemple


contractNumber Le numro du contrat qui a t oui AN50
utilis pour crer le dossier de
paiement et le portefeuille virtuel.
paymentRecordId Lidentifiant du dossier de paiement oui N12 12345

4.18.2 Rponse en retour


Le message disablePaymentRecordResponse est la rponse faite par Payline une demande
de dsactivation dun dossier de paiement. La rponse a la structure suivante :

Elment Description Format Exemple


result.code Le code de retour de votre demande : N5 cf. liste complte en annexe
02500 : Operation successful tableau Code retour et
02508 : Can not found payment record message Payline
02508 : Payment is disabled
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255

4.19 Web service Transaction Search

La fonction de recherche de transactions permet dobtenir la liste des transactions correspondant


aux critres de recherche saisis par lutilisateur.

Page 108/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.19.1 Requte envoyer

La requte transactionsSearchRequest est utilise afin de rechercher une ou plusieurs


transactions.
La requte a la structure suivante :

Elment Description Requis Type Exemple


1
version Version des web services Payline Oui N1 A valoriser la valeur
Requis depuis 2011 3
transactionID Lidentifiant de la transaction non AN50
orderRef Lidentifiant de la commande chez oui AN50
le commerant
startDate Dbut de la priode pour laquelle oui Date7 22/01/2010
on recherche les transactions
endDate Fin de la priode pour laquelle on oui Date7 22/01/2010
recherche les transactions
Doit tre identique startDate
contractNumber Numro de contrat associ la non AN50
transaction
autorizationNumber Numro dautorisation de la non AN6
transaction
returnCode Code retour transmis lutilisateur non AN5
paymentMean Le moyen de paiement utilis non AN3
transactionType Le type de transaction non N3
name Le nom de lacheteur non AN100
firstName Le prnom de lacheteur non AN100
email Ladresse email de lacheteur non AN150
cardNumber Le numro de carte utilise pour non AN20
effectuer la transaction
1
token Alias du numro de carte Non AN19 1111gPNzHtyu4444
currency Le code de la monnaie utilise pour non N3
effectuer la transaction
minAmount Montant minimal de la transaction non N12
maxAmount Montant maximal de la transaction non N12
walletId Lidentifiant du wallet utilis pour la non AN50
transaction
sequenceNumber Numro de squence utilise lors non AN50
de la transaction
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

Page 109/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.19.2 Rponse en retour

Le message transactionsSearchResponse est la rponse obtenue suite une demande de


recherche de transactions. La rponse a la structure suivante :

Elment Description Format Exemple


result.code Le code de retour du web service N5 cf. liste complte en
02500: Operation Successful annexe tableau
Code retour et
message Payline
result.shortMessage Message court du rsultat de la transaction AN50
result.longMessage Message du rsultat de la transaction AN255
transactionsList La liste des transactions correspondant aux Liste dobjet
critres de recherche Transaction

Pour chaque transaction :

Elment Commentaire Requis Format Exemple


transactionId Lidentifiant de la transaction associe Non AN50
date Date de la transaction associe Non AN16 Format yyyy-dd-mm hh:mm:ss
isDuplicated Cet indicateur est retourn par Payline Non AN1 1 = Il existe un risque de
dans le cas de transaction en doublon fraude
0 = Aucun risque de fraude
dtect
isPossibleFraud Cet indicateur est calcul en fonction Non AN1 1 = Il existe un risque de
des critres dfinis par le commerant fraude
0 = Aucun risque de fraude
dtect

4.20 Web service Get Transaction Details

La fonction de recherche dune transaction permet dobtenir le dtail dune transaction de paiement
quelque soit son tat.

4.20.1 Requte envoyer

Le message getTransactionDetailsRequest est utilise pour rechercher le dtail dune


transaction de paiement.
La requte a la structure suivante :

Page 110/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Requis Type Exemple
1
version Version des web services Payline Oui N1 A valoriser la valeur 3
Requis depuis 2011
transactionID Lidentifiant de la transaction oui AN50
communique par Payline
orderRef Lidentifiant de la commande chez le non AN50
commerant
startDate Dbut de la priode pour laquelle on non 2 Date 22/01/2010
recherche les transactions 7
endDate Fin de la priode pour laquelle on non 2 Date 22/01/2010
recherche les transactions 7

transactionHistory Cet indicateur permet de rcuprer la non A1 Cette fonctionnalit est


liste des paiements associs ainsi optionnelle
que lhistorique des statuts pour une Les valeurs possibles
transaction donne sont :
- Y: affichage de
lhistorique des statuts
- N: absence de
lhistorique des statuts
- Null ou non renseign :
absence de lhistorique
des statuts

archiveSearch non
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.
2
- Nous prconisons lutilisation des champs startDate et endDate pour optimiser les temps de
rponses

4.20.2 Rponse en retour

Le message getTransactionDetailsResponse contient :

Elment Description Format Exemple


result.code Le code de retour du web service N5 cf. liste complte en annexe
02500: Operation Successful tableau Code retour et
message Payline
result.ShortMessage Message court du rsultat de la AN50
transaction
result.LongMessage Message du rsultat de la transaction AN255
transaction.id Lidentifiant de la transaction N50
communique par Payline
transaction.date Date et heure de la transaction Payline AN16 Format : dd/mm/yy HH24:MI

Page 111/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
transaction.isDuplicated Cet indicateur est retourn par Payline AN1 1 = Il existe un risque de
dans le cas de transaction en doublon fraude
0 = Aucun risque de fraude
dtect
transaction.IsPossibleFraud Cet indicateur est calcul en fonction des AN1 1 = Il existe un risque de
critres dfinis par le commerant fraude
0 = Aucun risque de fraude
dtect
transaction.threeDSecure Cet indicateur permet de savoir si la AN1 Y = Transaction 3DS
transaction est 3DSecure ou non. N = Transaction non 3DS
payment.amount le montant du paiement raliser. Le N12
montant doit tre formul dans la plus
petite unit de la devise.
payment.currency le code ISO de la devise du paiement N3
payment.action Code de la fonction de paiement N3
payment.mode vous devez mettre la valeur CPT pour AN3
enregistrer un paiement programm.
payment.contractNumber Le numro du contrat de paiement qui AN50
reprsente un moyen de paiement
payment.DifferedActionDate Date effective de laction. Elle doit tre AN81
infrieure la date du jour + 7 jours.
payment.method Nom de lmetteur de la carte (version 10 AN20 Ex : CB, PAYSAFECARD
ou suprieure)
media
1
Dtection du mdia utilis lors du AN25 Computer

paiement

Les valeurs possibles de cette balise sont :


- Computer
- Mobile
- Tablet
- TV
- Console
- Undefined

authorization.number Numro dautorisation dlivr par le N6


serveur dautorisation acqureur. Ce
champ est renseign si la demande
dautorisation est accorde*.
authorization.date Date et heure de lautorisation AN16 Format : dd/mm/yyyy
HH24:MI
order.ref Rfrence de la commande. Cette AN50
rfrence doit tre unique car elle est
utilise pour le contrle dans demande en
double.
Page 112/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
order.origin Origine de la commande AN50
order.country Le code du pays dans lequel la AN3
commande a t effectu
order.taxes Le montant des taxes sur la commande N12
dans la plus petite unit de la devise
order.amount Le montant de la commande dans la plus N12
petite unit de la devise. Gnralement le
mme montant que payment.amount
order.currency Le code de la devise utilise lors de la N3
commande.
order.date La date de la commande chez le AN18
commerant
order.details Informations sur les articles commands
order. deliveryTime Dlai de livraison : Non N
1 = express
- 2 = standard
order. deliveryMode Mode de livraison : Non N
1 : retrait de la marchandise chez le
marchand
2 : Utilisation d'un rseau de points-retrait
tiers (type kiala, alveol, etc.)
3 : Retrait dans un aroport, une gare ou
une agence de voyage
4 : Transporteur (La Poste, Colissimo,
UPS, DHL... ou tout transporteur priv)
5 : Emission dun billet lectronique,
tlchargements
buyer.lastName Nom de lacheteur AN100
buyer.firstName Prnom de lacheteur AN100
buyer.email Adresse email de lacheteur AN150
buyer.shippingAddress.name Nom ou numro dimmeuble AN100
buyer.shippingAddress.street Nom de rue AN100
1
buyer.shippingAddress.street Complment du nom de rue AN100
2
buyer.shippingAddress.cityN Ville AN40
ame
buyer.shippingAddress.zipC Code postal AN20
ode
buyer.shippingAddress.count Pays AN2 ISO 3166-1
ry
buyer.shippingAddress.phon Tlphone AN15
e
Page 113/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
buyer.accountCreateDate La date de cration du compte de AN8
lacheteur
buyer.accountAverageAmou Le montant moyen des achats de cet N10
nt acheteur
buyer.accountOrderCount Le nombre de commande pass par cet N10
acheteur
buyer.walletId Lidentifiant du portefeuille virtuel de votre AN50
client.
privateDataList Les informations prives du commerant. N50
card.number La numro de la carte masque conforme 111122XXXXXX4444
PCI DSS
card.type Le type de carte : soit Carte visa, gold AN50
visa,
card.expirationDate Date dexpiration 0311
1
card.token Alias du numro de carte AN19 1111gPNzHtyu4444
extendedcard.country Pays demission de la carte 2 CODE ISO : exemple FR
extendedcard.isCvd La carte est elle une e carte bleu N1 Y OR N
extendedCard.bank La banque de la carte utilise pour le AN Crdit Lyonnais
paiement
extendedCard.type Le type de carte de paiement AN20 MASTERCARD
extendedCard.network Dsigne le rattachement de la carte une AN20 MASTERCARD
entit grant lacceptation de la carte un
niveau national ou international
extendedCard.product Indique la catgorie laquelle appartient AN Gold/Premier pour une carte
le type de la carte type VISA
associatedTransactionsList Tableau de transactions associes Tableau dobjet de type
associatedTransactions
Cette fonctionnalit est
optionnelle
statusHistoryList Tableau de lhistorique des statuts de la Tableau dobjet de type
transaction statusHistory
Cette fonctionnalit est
optionnelle
1
- Evolution livre en octobre 2012, dans la version V4.31 de Payline.

Pour chaque transaction associe (associatedTransactions) :

Elment Commentaire Requis Format Exemple


transactionId Lidentifiant de la transaction associe Non AN50
type Type de la transaction associe Non AN20 Liste des valeurs possibles :
AUTHOR
CAPTURE
Page 114/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
RESET
REFUND
CREDIT
AUTHOR+CAP
ORDER
REAUTH+CAP
DEBIT
SCORING CHEQUE
MICROVALID
REAUTHO
MICROCANCEL
date Date de la transaction associe Non AN16 Format yyyy-dd-mm hh:mm:ss
amount Montant de la transaction associe Non N12
status Statut de la transaction associe Non AN2 OK ou KO
originTransactio Identifiant de la transaction dorigine Non AN50
nId associe

Pour chaque statut de la transaction (statusHistory) :

Elment Commentaire Requis Format Exemple


transactionId Lidentifiant de la transaction historise Non AN50
date Date de la transaction historise Non AN16 Format yyyy-dd-mm hh:mm:ss
amount Montant de la transaction historise Non N12
fees Montant des commissions appliques Non AN2 OK ou KO
historise
status Statut de la transaction historise Non AN2 OK ou KO
originTransactio Identifiant de la transaction dorigine Non AN50
nId historise

4.21 Web service VerifyEnrollment

Ce Web Service permet au commerant de vrifier que la carte de lacheteur est compatible
3DSecure.

4.21.1 Requte envoyer


Le message verifyEnrollmentRequest doit avoir la structure suivante :

Elment Commentaire Requis Type Exemple


payment.amount le montant du paiement raliser. Le oui N12 pour un montant de 60
montant doit tre formul dans la plus , vous devez mettre la
petite unit de la devise. valeur 6000.
Page 115/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Commentaire Requis Type Exemple

payment.currency le code ISO de la devise du paiement oui N3 978 : euros


840 : dollars US
cf. liste complte en
annexe tableau Liste
des devises
payment.action Code de la fonction de paiement oui N3 100 : Autorisation
101 : Autorisation +
Validation
payment.mode Mode CPT oui AN3 CPT : Comptant
payment.contractNum Le numro du contrat de paiement qui oui AN50
ber reprsente un moyen de paiement
payment.differedAction Date effective de laction. Elle doit tre non AN8 Format respecter :
Date infrieure la date du jour + 7 jours. dd/mm/yy
card.encryptionKeyId Identifiant de la cl RSA Payline de non N4 Si cest champs sont
chiffrement renseigns alors les
donnes cartes doivent
tre null
card.encryptedData Les donnes carte chiffrs non Base64 Si cest champs sont
renseigns alors les
donnes cartes doivent
tre null
card.number Numro de carte oui N19
card.type Type de carte utilis pour la transaction oui AN40 CB : Carte Bleu / VISA /
Mastercard
VISA : visa
MASTERCARD :
Mastercard
1
card.expirationDate Date dexpiration de la carte non N4 Format respecter :
mmyy
card.cvx Cryptogramme visuel au dos de la carte non N10
de crdit
card.ownerBirthdayDat Date danniversaire du porteur non N6 Format respecter :
e ddmmyy
card.password Mot de passe crypt non AN16
2
card.token Alias du numro de carte Non AN19 1111gPNzHtyu4444
A renseigner la place du card.number
condition que la balilse version soit
suprieure ou gale 3.
orderRef Rfrence de la commande. oui AN50 12345678
mdFieldValue Valeur du merchantData (Cette valeur non AN20 Ex :
doit tre unique). Lutilisation de champ OS0hZDbJH75NiDrAo0
nest pas recommande. yo
Page 116/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Commentaire Requis Type Exemple
UserAgent UserAgent du terminal de paiement. non AN255
Pour connaitre lorigine de la demande
de paiement
Cette valeur est spcifique
PayFair@POS
walletId Lidentifiant du portefeuille de non AN50
lacheteur. La balise version doit tre
remplie avec la valeur gale ou
suprieure 10.
walletCardInd Lindex de la carte de lacheteur non AN5
enregistr dans le portefeuille. La balise
version doit tre remplie avec la valeur
gale ou suprieure 10.

1
- Veuillez vous rfrer au tableau "Liste des champs obligatoires par type de carte en annexe
du document.
Si vous utilisez le card.token et que votre format de token PAN ne tient pas compte de la date
dexpiration, ce champ devient obligatoire
2
- La balise version doit tre suprieure ou gale 3, si le champ card.token est renseign, le
champ card.number doit tre vide.
Si le format du token PAN ne tient pas compte de la date dexpiration, la balise est
card.expirationDate obligatoire.

4.21.2 Requte en rponse

Elment Description Format Exemple


result.code Le code de retour du web service : N5 cf. liste complte en
00000 : Transaction approved annexe tableau Code
01xxx : Transaction refused retour et message
021xx : Internal Error Payline
result.shortMessage Message court du rsultat de la transaction AN50
result.longMessage Message du rsultat de la transaction AN255
actionUrl URL de lACS AN255
actionMethod Mthode denvoi .Retourne une valeur POST ou AN255
GET. Post par dfaut.
pareqFieldName Nom du champ Pareq Poster AN5
pareqFieldValue Contient la Valeur du champ PaReq AN100
400
termurlFieldName Contient le nom du champ "TermUrl" Poster AN50
termurlFieldValue Contient la valeur du champ "TermUrl". AN255
mdFieldName Contient le nom du champ "MD field" AN50
mdFieldValue Contient la valeur du champ "MD field" Poster AN20
Page 117/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
mpiResult Renvoie un indicateur concernant le rsultat de A1 Y = Succs lors de
lenrlement lenrlement
N = Echec lors de
lenrlement
U = enrlement
indisponible
authentication3DSecure. Contient la valeur du champ "MD field" Poster AN20 Mme valeur que
md mdFieldValue
authentication3DSecure. Identifiant de transaction Unique AN20 Ne plus utiliser, champ
xid obsolte
authentication3DSecure. Cardholder Authentication Verification Value AN26- Ne plus utiliser, champ
cavv 28 obsolte
authentication3DSecure. Entier positif prcisant lalgorithme utilis pour la N1 Ne plus utiliser, champ
cavvAlgorithm gnration CAVV. Les valeurs possibles actuelles obsolte
sont:
0 = HMAC (SET TransStain),
1 = CVV,
2 = CVV avec ATN,
3 = MasterCard AAV
authentication3DSecure. Rsum des oprations 3DSecure AN8 Ne plus utiliser, champ
vadsResult obsolte
authentication3DSecure.t Renvoie la valeur du type de scurisation N2 Ne plus utiliser, champ
ypeSecurisation obsolte
authentication3DSecure. Electronic Commerce Indicator. AN2 Ne plus utiliser, champ
eci obsolte

4.22 Web service getEncryptionKey

Ce Web Service permet de fournir la cl publique de chiffrement des donnes carte. Le chiffrement
est ralis via l'algorithme asymtrique RSA.

4.22.1 Requte envoyer


Aucun lment ncessaire.

4.22.2 Rponse en retour

La rponse a la structure suivante :

Element Description Format Exemple


result.code Le code de retour du web service N5
00000: Operation Successful

Page 118/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Element Description Format Exemple
result.shortMessage Message court du rsultat de la AN50
transaction
result.longMessage Message du rsultat de la transaction AN255
key.keyId Lidentifiant de la cl N4
key.modulus Le modulo de la cl Base64
key.publicExponent L'exposant public de la cl Base64
key.expirationDate La date d'expiration de la cl AN10 Format : DD/MM/YY

Si vous utiliser le webservice getEncryptionKey, alors vous devez appliquer une modification sur
les webservices suivant
Les WS suivants sont concerns :
doAuthorization
doCredit
doDebit
createWallet
updateWallet
verifyEnrollment
verifyAuthentication

Les modifications de la structure card de la requte envoyer sont surligns en bleu :

Elment Commentaire Requis Type Exemple


card.encryptionKeyId Identifiant de la cl RSA Payline de non N4
chiffrement
card.encryptedData Les donnes carte chiffrs non Base64
card.number Numro de carte non N19
card.type Type de carte utilis pour la oui AN40 CB : Carte Bleu / VISA /
transaction Mastercard
VISA : visa
MASTERCARD :
Mastercard
card.expirationDate Date dexpiration de la carte non N4 Format respecter :
mmyy
card.cvx Cryptogramme visuel au dos de la non N10
carte de crdit
card.ownerBirthdayDa Date danniversaire du porteur non N6 Format respecter :
te ddmmyy
card.password Mot de passe crypt non AN16

Page 119/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Si le champ encryptedData est non nul alors les champs suivants doivent tre vides :
card.number
card.expirationDate
card.CVX
card.ownerBirthdayDate
card.password
Les champs encryptionKeyId et encryptedData sont soit tous les deux nuls, soit tous les
deux non nuls.

4.23 Web service getToken

Ce web service doit permettre au commerant de rcuprer un token, ainsi quun certain nombre dautres
informations, partir dune carte et dune date dexpiration.

Page 120/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.23.1 Requte envoyer

Version Exemple
Element Commentaire Requis Type
WSDL
cardNumber Le numro de la carte en clair. O N(19) 1
expirationDate La date dexpiration de la carte au N AN(4) 1
format MMYY.
contractNumber Le numro de contrat VAD qui a t O N(7) 1
utilis pour le paiement.

4.23.2 Rponse en retour

La rponse a la structure suivante :


Nom du champ Commentaire Obligatoire Format
result.code Le code retour O String
result.shortMessage Le message court associ au code retour. O String
result.longMessage Le message long associ au code retour. O String
token Le token O String(19)
maskedCardNumber Le numro de carte masqu O String(19)
expirationDate La date dexpiration de la carte au format O String(4)
MMYY.
virtualCard Indique si la carte est virtuelle. O String(1)
cardType Le type de la carte. O String(30)
cardProduct Le produit de la carte O String(128)
acceptanceNetwork Le rseau dacceptation de la carte. O String(20)
bank La banque mettrice de la carte. O String(128)

4.24 Web service getAlertDetails

Ce web service permet de rcuprer toutes les informations relatives une alerte LCLF, alerte qui
a t envoye suite une fraude dtecte lors du contrle de la rgle concerne

4.24.1 Requte envoyer


Version Exemple
Element Commentaire Requis Type
WSDL
AlertId Identifiant de lalerte. O N 1
MerchantId Identifiant du commerant. O N 1
TransactionId Identifiant de la transaction LCLF. O AN(20) 1

4.24.2 Rponse en retour


Page 121/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
La rponse a la structure suivante :

Version
Nom du champ Commentaire Obligatoire Format
WSDL
AlertId Identifiant de lalerte. O N 1
ExplanationCode Le code du motif LCLF. N AN(20) 1
ExplanationLabel Le libell du motif LCLF. N AN(100) 1
TransactionStatus Statut de la transaction. O AN(50) 1
MerchantLabel Le libell du commerant. O AN(100) 1
PosLabel Le libell du point de vente. O AN(50) 1
TransactionId Identifiant de la transaction LCLF. O AN(20) 1
SecurityLevel Niveau de scurit de la transaction compos de O AN(50) 1
deux champs : champ1, champ2 correspondant
deux infos : utilisation de cvv , utilisation de
3dsecure

Exemple : avec cvv, sans 3dSecure

TransactionDate Date de la transaction. O AN 1


dd/MM/yy
HH:mm
TransactionAmount Montant de la transaction. O AN 1
TransactionCurrency Devise de la transaction. O AN 1
PaymentType Type du moyen de paiement de la transaction. O AN(20) 1
PaymentData Donnes du porteur. O AN 1
transaction.masked_card_number ou
transactionPaypal.external_payer_email
ou transactionMoneybooker.buyer_email
HolderName Nom du porteur de la carte. N AN 1
ReferenceData Rfrence de la transaction. O AN(50) 1
CustomerId Id du consommateur. N AN(50) 1
BuyerFirstName Id du consommateur. N AN(100) 1
BuyerLastName Id du consommateur. N AN(100) 1
CustomerTransHist Tableau de lhistorique des transactions du moyen de paiement.
CustomerTrans.IsLCLF Flag permettant de savoir si une alerte pour cette O N 1
Alerted transaction a t envoye ou non :
1 : alerte envoye
0 : aucune alerte envoye
CustomerTrans.Extern Identifiant de la transaction : O AN(50) 1
alTransavtionId
CustomerTrans.Refere Rfrence de la transaction. O AN(50) 1
nceOrder
Page 122/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
CustomerTrans.CardC Type du moyen de paiement de la transaction. O AN(20) 1
ode
CustomerTrans.Transa Date de la transaction. O AN 1
ctionDate dd/MM/yy
HH:mm
CustomerTrans.Amoun Montant de la transaction. O AN 1
t
CustomerTrans.Status Statut de la transaction. O AN(50) 1
CustomerTrans.PosLab Le libell du point de vente. O AN(50) 1
el
PaymentMeansTransHi Tableau de lhistorique des transactions du moyen de paiement.
st
PaymentMeansTrans.Is Flag permettant de savoir si une alerte pour cette O N 1
LCLFAlerted transaction a t envoye ou non :
1 : alerte envoye
0 : aucune alerte envoye
PaymentMeansTrans.E Identifiant de la transaction : O AN(50) 1
xternalTransavtionId
PaymentMeansTrans.R Rfrence de la transaction. O AN(50) 1
eferenceOrder
PaymentMeansTrans.C Donnes du consommateur N AN 1
ustomerData
PaymentMeansTrans.T Date de la transaction. O AN 1
ransactionDate Format : dd/MM/yy HH:mm
PaymentMeansTrans.A Montant de la transaction. O AN 1
mount
PaymentMeansTrans.S Statut de la transaction. O AN(50) 1
tatus
PaymentMeansTrans.P Le libell du point de vente. O AN(50) 1
osLabel
AlertsTransHist Tableau de lhistorique des alertes.
AlertsTrans.AlertId Identifiant de lalerte. O N 1
AlertsTrans.Explanatio Le code du motif LCLF O AN(100) 1
nLabel
AlertsTrans.Explanatio Le code du motif LCLF. O AN(20) 1
nCode
AlertsTrans.RuleName Le nom de la rgle : O AN 1
AlertsTrans.RuleAction Laction de la rgle. N AN(50) 1
AlertsTrans.RuleCriteri Le message de la raison de la fraude. N 1
a

Page 123/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.25 Web service getMerchantSetting

Ce web service permet de rcuprer toutes les donnes concernant tous les moyens de paiement.

4.25.1 Le message getMerchantSettingsRequest

Aucun lment ncessaire.

4.25.2 Le message getMerchantSettingsResponse

Elment Type Commentaire


result Un objet de type Les informations sur le traitement de la demande
Result
listPointOfSell Une liste dobjet de Les informations concernant les points de vente. Chaque point de
type PointOfSell vente contiendra la liste des moyens de paiements associ (liste
dobjet de type contract)

Pour chaque point de vente (pointOfSell) :


Elment Commentaire Format Exemple
siret Numro de Siret AN14 87567125800016
codeMCC Le Merchant Category Code ou code AN4 7995
MCC, est utilis en montique pour indiquer
le type de commerant l'origine d'une
opration carte bancaire.
label Libell du point de vente AN100 Ma boutique
webmasterEmail Email du webmaster AN150 Pierre.dupont@maboutique
;fr
webstoreURL URL du site de vente AN255 http://maboutique.fr
notificationURL URL de notification AN255 http://maboutique.fr/notificat
ion
endOfPaymentRedirection Retour automatique la boutique Boole true = retour automatique
n active
false = retour automatique
inactif
ticketSend Ticket de paiement Objet de type ticketSend
contracts Liste de moyen de paiements associs Tableau dobjet de type
contract

Page 124/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Ticket de paiement (ticketSend) :

Elment Commentaire Format Exemple


toBuyer Envoi du ticket de paiement lacheteur Boolen false
toMerchant Envoi du ticket de paiement au commerant Boolen true

Pour chaque moyen de paiement associ (contract) :

Elment Commentaire Format Exemple


cardType Type du contrat. AN BUYSTER
label Libell du contrat VAD AN Contrat Buyster
contractNumber Numro du contrat VAD AN BUYSTER
currency Devise AN 978 (Euro)
description Description du moyen de paiement AN255
logoEnable Disponibilit de logo pour ce moyen de Boolen True : disponible
paiement False : indisponible
smallLogoMime Type mime du logo petite taille AN20 image/png
smallLogo Petit logo du moyen de paiement encod au AN255
format base64
normalLogoMime Type mime du logo grande taille AN20 image/png
normalLogo Logo grande taille du moyen de paiement AN255
encod au format base64
contribution Frais applicable sur le moyen de paiement AN255 Objet de type contribution
Cette fonctionnalit est
optionnelle

Frais applicable au moyen de paiement (contribution) :

Elment Commentaire Format Exemple


enable Envoi du ticket de paiement lacheteur Boolen False
type Type de frais appliquer AN1 -P : pourcentage du
montant ajouter
-D : pourcentage du
montant dduire
value Pourcentage du montant AN10 0
nbFreeTransaction Nombre de paiement sans participation aux AN20 0
frais
minAmountTransaction Montant minimum dacceptation par AN30 5 ou 5.0
transaction
maxAmountTransaction Montant maximum dacceptation par AN30 750 ou 25.10
transaction

Page 125/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.26 Web service updatePaymentRecord

Ce web service permet de modifier un ou plusieurs paramtres dun dossier de paiement.


Les paramtres modifiables sont :
Le nombre dchances
La date de fin
Le jour des chances
Le couple (nouveau montant, date de modification).

4.26.1 Le message updatePaymentRecordRequest

Element Commentaire Requis Type Exemple


1
version Version des web services Payline Oui N A valoriser la valeur 7
Requis depuis 2011
contractNumber Le numro du contrat qui a t utilis O AN50
pour crer le dossier de paiement et le
portefeuille virtuel.
paymentRecordId Lidentifiant du dossier de paiement O N
recurring.billingLeft Nombre dchances Non N3 3
recurring.billingDay Jour o les chances doivent tre Non AN2 Format respecter : dd de
traites. [01 28]
recurring.newAmoun Nouvelle valeur du montant des Non N12 Pour un montant de 100 ,
t chances vous devez mettre la valeur
10000.
recurring.amountMo Date de modification du montant des Non AN10 Format respecter :
dificationDate chances dd/mm/yyyy
recurring.endDate La date de dsactivation du dossier de Non AN10 Format : dd/mm/yy
paiement

Page 126/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.26.2 Le message updatePaymentRecordResponse

Elment Description Format Exemple


result.code Le code de retour de votre demande : N5 cf. liste complte en annexe
02500 : Operation successful tableau Liste des codes
02507 : Cannot found payment record retours
02508 : Payment is disabled

result.shortMessage Message court du rsultat AN50


result.longMessage Message du rsultat AN255
recurring.firstAmount Le montant du premier montant N12 pour un montant de 100 ,
effectuer. Il doit tre formul dans la plus vous aurez la valeur 10000.
petite unit de la devise.
recurring.amount Le montant dune chance. Il doit tre N12 pour un montant de 5 ,
formul dans la plus petite unit de la vous devez mettre la valeur
devise. 500.
recurring.billingCycle Le code de la frquence des paiements. N2 40 : mensuel
60 : trimestriel
cf. liste complte en annexe
tableau Liste des
frquences de paiement
recurring.startDate La date de la premire chance. Si ce AN10 Format : dd/mm/yyyy
champ nest pas renseign, Payline y
affecte la date du jour.

recurring.billingLeft Nombre dchance N3 3


recurring.billingDay Jour o les chances doivent tre AN2 Format : dd
traites.
recurring.endDate La date de dsactivation du dossier de AN10 Format : dd/mm/yyyy
paiement
recurring.newamount Le nouveau montant des chances N12 pour un montant de 100 ,
vous aurez la valeur 10000.
recurring.amount Date deffet de la modification du montant AN10 Format : dd/mm/yyyy
ModificationDate des chances
isDisabled Le statut du dossier de paiement N1
0 : actif
1 : inactif
disableDate La date de dsactivation du dossier de AN14 Format : dd/mm/yy HH24:MI
paiement
order La commande associe
privateDataList Vos donnes personnelles
walletId Identifiant du portefeuille utilis AN50

Page 127/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.27 Web service getBillingRecord

Ce web service permet de rcuprer les caractristiques dune chance de paiement.

4.27.1 Le message getBillingRecordRequest

Elment Description Requis Type Exemple


contractNumber Le numro du contrat qui a t Oui AN50
utilis pour crer le dossier de
paiement et le portefeuille virtuel.
paymentRecordId Lidentifiant du dossier de paiement oui N12 12345
billingRecordId Lidentifiant de lchance de oui N12 12345
paiement

4.27.2 Le message getBillingRecordResponse

Elment Description Format Exemple


result.code Le code de retour de votre demande : N5 cf. liste complte en
02500 : Operation successful annexe tableau
02507 : Cannot found payment record Liste des codes
02508 : Payment is disabled retours
02543 billingRecord not found
result.shortMessage Message court du rsultat AN50
result.longMessage Message du rsultat AN255
recurring.firstAmount Le montant du premier montant effectuer. Il N12 pour un montant de
doit tre formul dans la plus petite unit de la 100 , vous avez la
devise. valeur 10000.
recurring.amount Le montant dune chance. Il doit tre formul N12 pour un montant de 5
dans la plus petite unit de la devise. , vous avez la valeur
500.
recurring.billingCycle Le code de la frquence des paiements. N2 40 : mensuel
60 : trimestriel
cf. liste complte en
annexe tableau
Liste des
frquences de
paiement
recurring.startDate La date de la premire chance. Si ce champ AN10 Format : dd/mm/yyyy
nest pas renseign, Payline y affecte la date
du jour.

recurring.billingLeft Nombre dchance N3 3


recurring.billingDay Jour o les chances doivent tre traites. AN2 Format : dd
Page 128/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
recurring.endDate La date de dsactivation du dossier de AN10 Format : dd/mm/yyyy
paiement
recurring.newAmount Le nouveau montant des chances N12 pour un montant de
100 , vous aurez la
valeur 10000.
recurring.amount Date deffet de la modification du montant des AN10 Format : dd/mm/yyyy
ModificationDate chances
isDisabled Le statut du dossier de paiement N1
0 : actif
1 : inactif
disableDate La date de dsactivation du dossier de AN14 Format : dd/mm/yy
paiement HH24:MI
billingRecord.date La date de lchance AN10 Format : dd/mm/yyyy
billingRecord.rank Rang de lchance N12
billingRecord.amount Le montant de lchance dans la plus petite N12
unit de la devise.
billingRecord.status Le statut dune chance : AN1
0 : chance venir.
1 : chance accept.
2 : chance refus.
3 : chance en cours
billingRecord.nbTry Nombre de tentatives dautorisation de N3
paiement effectues
billingRecord.execution Date de la prochaine tentative de paiement AN10 Format : dd/mm/yyyy
Date
billingRecord.result.code Le code de retour du traitement de lchance N5 cf. liste complte en
00000 : Transaction approved annexe tableau
01xxx : Transaction refused Liste des codes
retours
billingRecord.result.shor Message court du rsultat de la transaction AN50
tMessage
billingRecord.result.long Message du rsultat de la transaction AN255
Message
billingRecord.transaction Identifiant unique de la transaction Payline AN50
.id
billingRecord.transaction Cet indicateur est calcul en fonction des AN1 1 = Il existe un risque
.isPossibleFraud critres dfinis par le commerant de fraude
0 = Aucun risque de
fraude dtect
billingRecord.transaction Cet indicateur est retourn par Payline dans le AN1 1 = Il existe un risque
.isDuplicated cas de transaction en doublon de fraude
0 = Aucun risque de
fraude dtect

Page 129/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
billingRecord.transaction Date et heure de la transaction Payline AN16 Format : dd/mm/yyyy
.date HH24:MI
billingRecord.authorizati Numro dautorisation dlivr par le serveur N6 123456
on.number dautorisation acqureur. Ce champ est
renseign si la demande dautorisation est
accorde*.

billingRecord.authorizati Date et heure de lautorisation AN16 Format : dd/mm/yyyy


on.date HH24:MI
Order La commande associe
privateDataList Vos donnes personnelles
walletId Identifiant du portefeuille utilis AN50

4.1 Web service updateBillingRecord

Ce web service permet de modifier la date dchance ou le montant dune chance NX.
Il permet aussi de relancer une srie de tentatives de paiement quand chance ltat En chec
(NX et REC)

4.1.1 Le message updateBillingRecordRequest

Elment Description Requis Type Exemple


contractNumber Le numro du contrat qui a t Oui AN50
utilis pour crer le dossier de
paiement et le portefeuille virtuel.
paymentRecordId Lidentifiant du dossier de paiement oui N12 12345
billingRecordId Lidentifiant de lchance de oui N12 12345
paiement
billingRecordForUpdate. La date de lchance Non AN10 Format : dd/mm/yyyy
date
billingRecordForUpdate. Le montant de lchance dans la Non N12 Le montant de
amount plus petite unit de la devise. lchance dans la
plus petite unit de la
devise.
billingRecordForUpdate. Le statut dune chance Non Seule valeur admise 0
status chance venir
billingRecordForUpdate. Date de la prochaine tentative de Non AN10 Format : dd/mm/yyyy
executionDate paiement

Page 130/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
4.1.2 Le message updateBillingRecordResponse

Elment Description Format Exemple


result.code Le code de retour de votre N5 cf. liste complte en
demande : annexe tableau
Liste des codes
02500 : Operation successful retours
02507 : Cannot found payment
record
result.shortMessage Message court du rsultat AN50
result.longMessage Message du rsultat AN255
recurring.firstAmount Le montant du premier N12 pour un montant de
montant effectuer. Il doit tre 100 , vous avez la
formul dans la plus petite valeur 10000.
unit de la devise.
recurring.amount Le montant dune chance. Il N12 pour un montant de 5
doit tre formul dans la plus , vous avez la valeur
petite unit de la devise. 500.
recurring.billingCycle Le code de la frquence des N2 40 : mensuel
paiements. 60 : trimestriel
cf. liste complte en
annexe tableau
Liste des
frquences de
paiement
recurring.startDate La date de la premire AN10 Format : dd/mm/yyyy
chance. Si ce champ nest
pas renseign, Payline y
affecte la date du jour.

recurring.billingLeft Nombre dchance N3 3


recurring.billingDay Jour o les chances doivent AN2 Format : dd
tre traites.
recurring.endDate La date de dsactivation du AN10 Format : dd/mm/yyyy
dossier de paiement
recurring.amount Le nouveau montant des N12 pour un montant de
chances 100 , vous aurez la
valeur 10000.
recurring.amount Date deffet de la modification AN10 Format : dd/mm/yyyy
ModificationDate du montant des chances
isDisabled Le statut du dossier de N1
paiement
0 : actif

Page 131/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
Elment Description Format Exemple
1 : inactif
disableDate La date de dsactivation du AN14 Format : dd/mm/yy
dossier de paiement HH24:MI
billingRecord.date La date de lchance AN10 Format : dd/mm/yyyy
billingRecord.rank Rang de lchance N12
billingRecord.amount Le montant de lchance dans N12
la plus petite unit de la
devise.
billingRecord.status Le statut dune chance : AN1
0 : chance venir.
1 : chance accept.
2 : chance refus.
3 : chance en cours
billingRecord.nbTry Nombre de tentatives N3
dautorisation de paiement
effectues
billingRecord.executionDate Date de la prochaine tentative AN10 Format : dd/mm/yyyy
de paiement
order La commande associe
privateDataList Vos donnes personnelles
walletId Identifiant du portefeuille utilis AN50

Page 132/164
Ce document est la proprit exclusive de MONEXT. Toute reproduction intgrale ou partielle, toute utilisation par des tiers, ou toute communication des tiers, sans accord pralable crit est illicite.
5 Ticket de paiement
Il est conseill de faire apparatre un ticket de paiement (ou ticket de caisse), similaire ce quun
commerce traditionnel remet son client. Le tableau ci-dessous prcise le format prconis par le
GIE Carte Bancaire.
Libell du Composant Valeur par
Valeurs Format Commentaire / Remarque
champ IHM dfaut
Texte Intitul du CARTE toujours Intitul du moyen de paiement
moyen de BANCAIRE en
paiement majuscule
utilis
LE Texte Date jj/mm/aa Date locale de la transaction
A Texte Heure hh/mm/ss Heure locale de la transaction
Texte Enseigne 3 lignes Enseigne du commerant
de 20 car.
Texte N contrat N de contrat, identifiant acce pteur ou
n SIRET du commerant.
Texte DEBIT Type de transaction
Texte N carte porteur N de carte masqu du por teur
Texte 3 + 4 + 14 Identifiant terminal + identifiant
accepteur + n de transaction Payline
Texte SAISIE Mode de lecture du numro porteur
MANUELLE
Texte