Webservice - getWebPaymentDetailsRequest – Support Payline

Il est impératif après un doWebPayment de faire un getWebPaymentDetails, afin de garantir le résultat obtenu.

Le message « getWebPaymentDetailsRequest » vous permet de réaliser une demande du résultat d’un paiement web. Il vous suffit de préciser un jeton d’authentification lié à un paiement web pour obtenir un résultat détaillé.

Requête à envoyer

La requête « getWebPaymentDetailsRequest » doit uniquement transmettre l’élément token associé au paiement d’une commande.

Élément	Commentaire	Requis	Format	Exemple
version	Version des web services Payline	Oui	N2	A valoriser avec la dernière version : voir le tableau des versions.
token	Jeton horodaté qui permet d’identifier le commerçant	Oui	AN50	sC5hTf3YCCUmSOvoMXgm1191189604975

Réponse en retour

Le message « getWebPaymentDetailsResponse » est la réponse faite par Payline à une demande du résultat d’un paiement web. Il vous permet d’obtenir, entre autres, le numéro unique de la transaction sur Payline et le n° d’autorisation de débit délivré par votre établissement bancaire.
La réponse a la structure suivante :

Élément	Description	Requis	Format	Exemple	Condition
result	Information sur le résultat de la demande d'information du paiement : 00000 : Transaction approved 01xxx : Transaction refused 021xx : Internal Error	oui	Object result	Voir ci-dessous les éléments
transaction	Information sur la transaction	oui	Object transaction	Voir ci-dessous les éléments
payment	Information sur le paiement	oui	Object payment	Voir ci-dessous les éléments
authorization	Information sur l'autorisation	oui	Object authorization	Voir ci-dessous les éléments
privateDataList	Information sur les données privées	non	Object privateDataList	Voir ci-dessous les éléments
paymentRecordId	Identifiant du dossier de paiement	non	AN	173661
billingRecordList	Tableau d’échéances	non	Object billingRecordList	Voir ci-dessous les éléments	Uniquement dans le cas d’un paiement récurrent ou par abonnement.
authentication3DSecure	Renvoyé en POST par l’ACS	non	Object authentication3DSecure	Voir ci-dessous les éléments
card	Information sur la carte	non	Object cardOut	Voir ci-dessous les éléments
extendedCard	Information supplémentaire sur la carte	non	Object extendedCardType	Voir ci-dessous les éléments
order	Information sur la commande	non	Object order	Voir ci-dessous les éléments
paymentAdditionalList	Tableau des paiements complémentaires	non	Object paymentAdditionalList	Voir ci-dessous les éléments	Uniquement dans le cas de paiement(s) complémentaire(s)
media	Détection du média par Payline utilisé lors du paiement. Les valeurs possibles de cette balise sont : - Computer - Mobile - Tablet - TV - Console - Undefined	non	AN25	Computer
numberOfAttempt	Le nombre de tentatives faites par le 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 l’option rejeu de la transaction)	non	N1	3	version 5 ou supérieure
wallet	Information sur le portefeuille	non	Object wallet	Voir ci-dessous les éléments
contractNumberWalletList	Un tableau des numéros de contrat du wallet	non	Object contractNumberWalletList	Voir ci-dessous les éléments	Non utilisé en mode Widget. RELEASE 4.53
contractNumber	Numéro du contrat sur lequel a été réalisé l'opération	non	AN
bankAccountData	Information sur le compte bancaire	non	Object bankAccountData	Voir ci-dessous les éléments
subMerchant	Information du Payment Facilitator	non	Voir ci-dessous

Les éléments de référence

Object result

Élément	Description	Format	Exemple
code	Le code de retour du web service : Opération acceptée : 00000, 02400, 02500, 02501, 02517, 02520 ,02616, 03000, 04000. Autre code : Transaction non acceptée	N5	Voir le détail des Codes retour Payline
shortMessage	Message court du résultat de la transaction	AN50
longMessage	Message du résultat de la transaction	AN255
partnerCode	Code retour issu du partenaire (moyen de paiement)	AN50	à partir de la version 14
partnerCodeLabel	Libellé du partenaire	AN255	à partir de la version 14

Object transaction

Élément	Description	Format	Exemple	Condition
id	Identifiant unique de la transaction Payline	N50
date	Date et heure de la transaction Payline	AN16	Format : dd/mm/yyyy HH24:MI
isDuplicated	Cet indicateur est retourné par Payline dans le cas de transaction en doublon : 1 = transaction en doublon 0 = pas de doublon détecté	AN1	1
isPossibleFraud	Cet indicateur est calculé en fonction des critères définis par le commerçant : 1 = Il existe un risque de fraude 0 = Aucun risque de fraude détecté	AN1	1
fraudResult	Code de la fraude	AN50
fraudResultDetails	Details de la fraude	Object fraudResultDetails
explanation	Motif du refus en cas de fraude	AN50
threeDSecure	Cet indicateur permet de savoir si la transaction est 3DSecure ou non : Y = Transaction 3DS N = Transaction non 3DS D = cas de rétrogradation (version 14 ou supérieur)	AN1
softDescriptor	Information affichée sur le relevé de compte de l'acheteur, limite avec certains moyens de paiement. Cette information sera affichée sur le ticket de paiement. Les caractères spéciaux (non A..Z et 1..9) sont spécifiques à chaque acquéreur/moyen de paiement.	AN64*	www.boutique.fr	version 13 ou supérieure. version 16 ou supérieure pour Paypal.
score	Scoring de la possibilité de fraude : Score de 0 à 10	N5	2
externalWalletType	Type de wallet utilisé lors de la transaction	AN20	Ex : V.Me, Masterpass
externalWalletContractNumber	Numéro du contrat VAD associé au paiement par Wallet	AN50
PartnerAdditionalData	Informations retournées au commerçant et provenant des partenaires : Paypal Carte Cadeau Carrefour Multibanco	AN		version 16 ou supérieure
avs	Service de vérification des adresses AVS	object avs		version 17 ou supérieure

Object fraudResultDetails

Elément

Description

Format

Exemple

code

Code de retour du web service.

00000 : Transaction approved

01xxx : Transaction refused

021xx : Internal Error

cf. liste complète en annexe tableau « Liste des codes retours »

shortMessage

Message court du résultat de la transaction

AN50

longMessage

Message du résultat de la transaction

AN255

Object payment

Élément	Description	Prérequis	Format	Exemple	Condition
amount	Informations transmises lors de l’appel de la fonction doWebPayment	oui	N12	100	La valeur 100 correspond à 1 €
currency	Devise du paiement	oui	N3	978
action	Code action	oui	N3	100	code 100 et 101 = paiement code 421 = remboursement voir la table
mode	Mode du paiement	oui	AN3	CPT	voir la table
contractNumber	Numéro de contrat	oui	AN50	1234567	doWebPayment (défini le point de vente), doCapture/doRefund (contractNumber retourné par le getPaymentDetails/getWebPaymentDetails).
differedActionDate	Date à laquelle le paiement sera réalisé	non	AN8	07/04/2016	Format : dd/mm/yy Si le champ mode = DIF, alors la date DifferedActionDate est obligatoire sinon ce champ doit être vide.
method	Nom de l’émetteur de la carte	non	AN20	CB	version 10 ou supérieure Ex : CB, PAYSAFECARD
softDescriptor	Information affichée sur le relevé de compte de l'acheteur, limite avec certains moyens de paiement. Cette information sera affichée sur le ticket de paiement. Les caractères spéciaux (non A..Z et 1..9) sont spécifiques à chaque acquéreur/moyen de paiement.	non	AN64	www.boutique.fr	version 13 ou supérieure
cardBrand	Indique la marque utilisée pour l'opération, voir les valeurs. Il n’est pris en compte que si le moyen de paiement permet le choix de la marque.	non	AN	15	version 15 ou supérieure voir table
registrationToken	Jeton utilisé en réponse dans les services. Il permet au partenaire de retourner un jeton afin d'identifier un consommateur et retrouve ces données lors d'une demande de paiement.	non	AN		version 18 ou supérieure RELEASE 4.53

Object authorization

Élément	Description	Requis	Format	Exemple
number	Numéro d’autorisation délivré par le serveur d’autorisation acquéreur. Ce champ est renseigné si la demande d’autorisation est accordée1.	oui	N6	123456
date	Date et heure de l’autorisation	oui	AN16	Format : dd/mm/yyyy HH24:MI

Object privateDataList

Élément

Description

Requis

Format

Exemple

privateData

Liste contenant les privateData

Nombre d'élément 0 à 100

oui

Object privateData

Élément	Description	Requis	Format	Exemple
key	Le nom de la clef de la valeur	oui	AN50	user
value	Valeur associée à la clef	oui	AN50	dupond or durand, etc.

Object billingRecord

Élément	Commentaire	Requis	Format	Exemple	Conditions
date	La date de l’échéance	oui	AN10	Format : dd/mm/yyyy
amount	Le montant de l’échéance dans la plus petite unité de la devise.	oui	N12	pour un montant de 100 €, vous devez mettre la valeur 10000.
status	Le statut d’une échéance	oui	AN1	0 : échéance à venir. 1 : échéance acceptée. 2 : échéance refusée. 3: échéance en cours (une retentative est programmée après un ou plusieur échecs)
result	Le code de retour du traitement de l’échéance	non	Object	cf. liste complète en annexe tableau « Liste des codes retours » 00000 : Transaction approved 01xxx : Transaction refused 02302 : Transaction invalid
transaction	Informations de la transaction Payline	non	Object
authorization	Informations sur l’autorisation délivré par le serveur d’autorisation acquéreur	non	Object
nbTry	Nombre de tentatives de paiement effectuées	non	N3		version supérieure ou égale à 8
rank	Rang de l’échéance au sein du dossier de paiement. Permet la modification via updateBillingRecord	non	N12		version supérieure ou égale à 8

Object authentication3DSecure

Élément	Description	Requis	Type	Exemple	Condition
md	Renvoyé en POST par l’ACS	non	AN20
pares	Renvoyé en POST par l’ACS	non	AN
xid	Identifiant de transaction Unique	non	AN20
eci	Electronic Commerce Indicator. A passer dans l’autorisation	non	AN2
cavv	Cardholder Authentication Verification Value déterminé par l’ACS.	non	AN28
cavvAlgorithm	Entier positif précisant l’algorithme utilisé pour la génération CAVV. Les valeurs possibles actuelles sont: 0 = HMAC (SET™ TransStain), 1 = CVV, 2 = CVV avec ATN, 3 = MasterCard AAV	non	N1
vadsResult	Résumé des opérations 3DSecure en hexadécimal. Ce champ n'est plus utilisé.	non	AN8
typeSecurisation	Champ utilisé à titre d'information pour l'authentification. Ce champ n'est plus utilisé.	non	AN10	20 : VADS sinon 9 : VAD
PaResStatus	Pour utiliser un MPI non Payline, alors il faut renseigner ce champ. Les valeurs sont : Y : authentification réussie N : authentification erronée A : prévue de passage par l'ACS U : appel à l'ACS effectué vide : time out sur l'ACS	non	AN1
VeResStatus	Pour utiliser un MPI non Payline, alors il faut renseigner ce champ. Les valeurs sont : Y/N/U ou vide	non	AN1

Object cardOut

Élément	Description	Requis	Format	Exemple	Condition
number	Carte marqué conforme à PCI DSS	non	AN	111122XXXXXX4444	Si le champ token est renseigné, le champ number doit être vide.
type	Type de la carte : CB, VISA, MASTERCARD, MAESTRO, AMEX	non	AN	CB
expirationDate	Date d’expiration de la carte	non	AN	0311
cardholder	Titulaire de la carte	non	AN20	Pierre Dupont
token	Alias du numéro de carte. La version doit être supérieure ou égale à 3	non	AN19	1111gPNzHtyu4444

Object extendedCardType

Élément	Commentaire	Requis	Exemple
country	Pays d’emission de la carte	AN2	CODE ISO : exemple FR
isCvd	La carte est elle une e carte bleu	AN1	Y OR N
bank	La banque de la carte utilisée pour le paiement	AN	Crédit Lyonnais
type	Le type de carte de paiement	AN20	MASTERCARD
network	Désigne le rattachement de la carte à une entité gérant l’acceptation de la carte à un niveau national ou international	AN20	MASTERCARD
product	Indique la catégorie à laquelle appartient le type de la carte : voir les codes produit	AN	Gold/Premier pour une carte type VISA

Object order

Élément	Description	Requis	Type	Exemple	Condition
ref	Référence de la commande. Cette référence doit être unique car elle est utilisée pour le contrôle dans demande en double. Le caractères \ est interdit.	Oui	AN50	12345678
origin	Origine de la commande. Si vous avez souscrit à l’option Mail Order et Téléphone Order alors les valeurs sont MO ou TO.	Non	AN50	SVI_#12
country	Code du pays dans lequel la commande a été effectuée, voir la liste.	Oui	AN3	FR
taxes	Le montant des taxes sur la commande dans la plus petite unité de la devise. Un montant de 1 € correspond à 100	Non	N12	100
amount	Le montant de la commande dans la plus petite unité de la devise. Généralement le même montant que payment.amount. Un montant de 60 € correspond à	Oui	N12	6000
currency	Le code ISO de la devise du paiement : 978 : euros 840 : dollars US cf. liste complète en annexe tableau « Liste des devises »	Oui	N3	978
date	La date de la commande chez le commerçant : Format à respecter : dd/mm/yyyy HH24:MI	Oui	AN16	07/04/2016 11:00
details	Informations sur les articles commandés	Non	Object OrderDetails
deliveryTime	Délai de livraison : 1 = express 2 = standard	Non	N	1
deliveryMode	Mode de livraison : 1 : retrait de la marchandise chez le marchand 2 : Utilisation d'un réseau de points-retrait tiers (type kiala, alveol, etc.) 3 : Retrait dans un aéroport, une gare ou une agence de voyage 4 : Transporteur (La Poste, Colissimo, UPS, DHL... ou tout transporteur privé) 5 : Emission d’un billet électronique, téléchargements	Oui	N	4
deliveryCharge	Montant des frais de livraison dans la plus petite unité de la devise : exemple 250 pour 2,50 euros	Non	AN		version 18 ou supérieure RELEASE 4.53
deliveryExpectedDate	Date prévue de livraison doit être supérieure à la date du jour. Format : dd/mm/yyyy	Non	AN18	07/04/2016	Transmis à Limonetik
deliveryExpectedDelay	Délai prévu de livraison (en jours)	Non	N2	10	Transmis à Limonetik

Object orderDetail

Element	Comment	Required	Format	Example
ref	Item reference	No	AN50
price	Item price, in the smallest currency unit	No	N12
quantity	Number of Items	No	N5
comment	Comment	No	AN255
category	Category of item	No	AN50	See table values
brand	Product brand	No	AN50	E.g.: HERMES
subcategory1	Rank 1 subcategory	No	AN50	E.g.: Watches & Jewellery
subcategory2	Rank 2 subcategory	No	AN50	E.g.: Jewellery
additionalData	List of specifications required for certain payment methods	No	AN255	E.g.: LegalAge=18&Discount=0105
taxRate	Item tax rate (expressed in hundredths)	No	N4	E.g.: 1580 for 15.8%

Object paymentAdditionalList

Élément

Comment

Requis

Format

Exemple

paymentAdditional

Liste contenant les paymentAdditional

Nombre d'élément 0 à 100

Object paymentAdditional

Élément	Description	Requis	Type	Exemple
transaction	Information sur la transaction	oui	Object transaction
payment	Information sur le paiement	oui	Object payment
authorization	Information surl'autorisation	oui	Object authorization
authentication3DSecure	Information sur le 3Dsecure de l'opération	non	Object authentication3DSecure
card	Informations de la carte de l'acheteur	oui	Object cardOut
extendedCard	Informations de la carte de l'acheteur	non	Object extendedCardType

Object wallet

Élément

Description

Requis

Type

Exemple

Condition

walletId

L’identifiant unique du portefeuille virtuel. Vous devez communiquer à Payline un identifiant unique qui correspond à un et un seul acheteur sur votre système d’information. C’est avec ce même identifiant vous pourrez demander un paiement par portefeuille virtuel.

oui

AN50

lastName

Le nom de l'acheteur. Ces informations sont utiles pour rechercher un portefeuille dans le Centre d’Administration Commercant.

non

AN100

firstName

Prénom de l'acheteur.

non

AN100

L’adresse de messagerie de l'acheteur. Payline utilisera cette information pour envoyer un justificatif de paiement à votre client.

non

AN150

shippingAddress

Adresse de livraison de l'acheteur

non

Object address

card

Informations de la carte de l'acheteur

oui

Object card

comment

Commentaires

non

AN255

default

Carte enregistrée par défaut

non

AN1

Y or N : Carte par défaut

cardStatus

Les valeurs possibles :
- EXP : Date expirée
- OPP : mise en opposition
- MAN : désactivation manuelle
- INT : règles internes

non

AN3

EXP

cardBrand

Indique la marque utilisée pour l'opération :

Code	Libellé
0	CB
1	VISA
4	MASTERCARD
5	MAESTRO
8	BCMC

Il n’est pris en compte que si le moyen de paiement permet le choix de la marque.

non

à partir de la version 15

Object address

Élément	Description	Requis	Type	Exemple
title	Titre, voir table des valeurs	non	AN2	1
Name	Nom ou numéro d’immeuble	non	AN100
firstName	Prénom	non	AN100
lastName	Nom	non	AN100
street1	Nom de rue	non	AN100
street2	Complément du nom de rue	non	AN100
cityName	Ville	non	AN40
zipCode	Code postal	non	AN20
country	Pays, voir la liste des valeurs.	non	AN2	FR
phone	Téléphone	non	AN15
state	Etat	non	AN15
county	Région	non	AN15
phoneType	Catégorie du téléphone, voir table des valeurs	non	N1

Object card

Élément	Description	Requis	Format	Exemple	Condition
encryptionKeyId	Identifiant de la clé RSA Payline de chiffrement. Ne pas tenir compte de ce champ.	non	N4
encryptedData	Les données carte chiffrées. Ne pas tenir compte de ce champ.	non	AN400
number	Numéro de carte masqué, conforme à PCI DSS	non	AN19	4970102121041646 en entrée de notre API. En sortie, le numéro est masqué : 497010XXXXXX1646	Si le champ token est renseigné, le champ number doit être vide.
type	Type de la carte : CB, VISA, MASTERCARD, MAESTRO, AMEX.	oui	AN	CB
expirationDate	Date d’expiration de la carte	non	N4	0311
cvx	Cryptogramme visuel au dos de la carte de crédit	non	N10
ownerBirthdayDate	Date d’anniversaire du porteur	non	N6	Format à respecter :ddmmyy
password	Mot de passe crypté	non	AN16
cardPresent	Ce service est utilisée uniquement si vous faites du Mail Order ou Telephone Order ou alors dans le cas où l’internaute est présent physiquement	non	N1	0 ou 1 (présent)
cardholder	Titulaire de la carte	non	AN20	Pierre Dupont
token	Alias du numéro de carte. La version doit être supérieure ou égale à 3	non	AN19	1111gPNzHtyu4444	Vous devez utilisez l’option de token PAN et la version doit être supérieure ou égale à 3.
paymentData	Object en entrée du service pour véhiculer les données du moyen de paiement ApplePay	non	Object PaymentData

Object contractNumberWalletList

Element

Comment

Required

Format

Exemple

Condition

contractNumberWallet

Liste contenant les numéros de contrat du portefeuille. Nombre d'élément 0 à 10.

Le mode Widget utilise le Wallet multi-PDV et multi-contrat : le wallet est lié au niveau du marchand.

Non utilisé en mode Widget. RELEASE 4.53

Object bankAccountData

Élément	Description	Requis	Format	Exemple
countryCode	Code du pays	non	AN
bankCode	Code du pays du numéro de compte	non	AN10
accountNumber	Numéro de la banque	non	AN
key	IBAN du compte	non	AN

Utilisé uniquement pour ELV

Object subMerchant

Object disponible en version 18 ou supérieure des web services

Élément	Description	Requis				Type
Élément	Description	Amex	CB	MSC	VISA	Type
subMerchantId	Identifiant du sous marchant (bénéficiaire final) défini par le fournisseur de paiement (Payment Facilitator)	oui	oui	oui		AN
subMerchantName	Nom du sous marchand	oui	non			AN
subMerchantMCC	Code MCC	oui	oui	oui		AN
subMerchantSIRET	Numéro de SIRET	non	oui	non	non	AN
subMerchantTaxCode	Tax : Obligatoire pour les pays : USA et CAN . C'est au Payment Facilitator de déterminer si cette information doit être fournie ou non.	non	non			AN
subMerchantStreet	Nom de rue	oui	non			AN
subMerchantCity	Ville	oui	non			AN
subMerchantZipCode	Code postal	oui	non			AN
subMerchantCountry	Pays, voir la liste des valeurs.	oui	non			AN2
subMerchantState	État	non	non			AN
subMerchantEmailAddress	Email	oui				ANS40
subMerchantPhoneNumber	Numéro de téléphone	oui				AN