Webservice - doWebPaymentRequest

S’abonner

La fonction « doWebPayment » permet d’initialiser une transaction de paiement web avant de rediriger votre client sur les pages de paiement Payline. Elle permet de réaliser des paiements comptants, immédiats ou différés, des paiements en Nfois ou par abonnement


Le paiement comptant vous permet de réaliser soit  une autorisation + validation, soit une autorisation simple. Dans le cas l’autorisation simple, la validation est faite soit en automatique par la solution de paiement Payline, soit par le commerçant, en utilisant les appels « webservice » ou via notre outil de back office « centre administration Payline ». Elle peut être aussi programmée des la demande d’autorisation et toujours dans un délai de 7 jours en utilisant la fonctionnalité interface batch ou le webservice DoCapture en renseignant la date d’action

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


Les notifications

Pour être informé du paiement de votre client une fois la demande d’autorisation acceptée, vous devez renseigner le champ « notificationURL » sur votre configuration point de vente ou lors de votre demande d’initialisation d’un paiement web. Payline contacte une page de votre site et vous transmet en paramètre GET de la requête HTTP le jeton lié au paiement. Cette page doit être accessible par Internet au moyen du protocole HTTP/S.

A réception d’une notification, votre serveur doit réaliser une demande de résultat du paiement web notifié.

NOTE : Si votre serveur n’est pas joignable, Payline réalise une tentative toute les minutes pendant 2 heures. Après ce délai, la notification de ce paiement est désactivée. Vous retrouverez vos paiements dans l’interface web du Centre d’Administration Commerçant.


Le paiement en n fois ou par abonnement  est possible à l’aide d’un portefeuille virtuel :WALLET.

Payline prend en charge la création du portefeuille virtuel après la validation des données collectées lors du premier paiement. Lorsque votre client réalise un second achat sur votre boutique en ligne, Payline lui propose d’utiliser son portefeuille. Dans ce cas, on parle d’un 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 mensualités. Lorsque le paiement est réalisé vous avez la possibilité d’être prévenu par email en activant l’option « envoi d’un email commerçant » dans le Centre d’Administration Commerçant. Dans le cas d’une difficulté de paiement, Payline représente trois fois la transaction de paiement sur un délai d’une semaine. Lors de chaque tentative en échec, vous êtes prévenu de l’échec de paiement.

Un document décrivant l’utilisation 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 commerçant, 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 qu’il puisse en changer pour réaliser son paiement. Cette nouvelle fonctionnalité est applicable seulement  sur une même commande d’un acheteur, lors de son premier paiement et en cas de refus bancaire. Et qu’une liste de nouveaux moyens de paiement a été renseignée dans le doWebPayment (SecondSelectedContractList)

Requête à envoyer

La requête « doWebPaymentRequest » doit avoir la structure suivante :

Élément

Description

Requis

Type

Exemple

Condition
version Version des web services Payline oui N2

A valoriser avec la dernière version : voir le tableau des versions.


payment Informations sur le paiement oui Object payment

voir les éléments ci-dessous


returnURL

URL sur laquelle le navigateur de l’acheteur est redirigé après validation du paiement sur Payline.

oui

AN255

http://... ou https://...


cancelURL

URL sur laquelle le navigateur de l’acheteur est redirigé s’il décide de ne pas valider le paiement ou que Payline ne peut pas autoriser le paiement de ce client.

oui

AN255

http://... ou https://...


order

Informations sur la commande

oui

Object order

voir les éléments ci-dessous


notificationURL

URL sur laquelle Payline va demander au site commerçant de récupérer le résultat de la transaction.

non

AN255

http://... ou https://...


selectedContractList

La liste des numéros de contrat que vous souhaitez utiliser pour ce paiement. Payline affiche la liste des moyens de paiement en respectant l’ordre dans lequel la liste à été renseignée.

oui

Object selectedContractList

voir les éléments ci-dessous

Obligatoire à partir de la version 4

secondSelectedContractList

La liste des numéros de contrat que vous souhaitez pouvoir reproposer lors de l’échec d’une première tentative de transaction

Si ce champ n’est pas renseigné, Payline ne reproposera pas de moyen de paiement lors de l’échec d’une première tentative de transaction

non

Object selectedContractList

voir les éléments ci-dessous


privateDataList


Vos propres informations personnelles

non

Object privateDataList

voir les éléments ci-dessous


languageCode

Renseignez ce champ avec le code ISO de la langue dans laquelle vous souhaitez faire afficher les pages web de paiement Payline. Par défaut, c’est le navigateur Internet de votre client qui demande à Payline la page dans la langue souhaitée.

non

AN6

FR ou fra : Français
eng : Anglais

cf. liste complète « code langues »


customPaymentPageCode

L’identifiant de personnalisation des pages web du commerçant

non

AN50

1fd51s2dfs51


buyer

Information sur l’acheteur

non

Object buyer

voir les éléments ci-dessous


owner

Information sur le titulaire de la carte

non

Object owner

Applicable uniquement pour AMEX


securityMode

Sélection du mode de sécurité à utiliser pour la transaction de paiement

oui

AN

SSL


recurring

Information sur le paiement récurrent

non

Object recurring

voir les éléments ci-dessous


customPaymentTemplateURL

URL du template dynamique

non

AN255

https://.... Uniquement.


contractNumberWalletList

Un tableau des numéros de contrat du wallet.

Le mode Widget utilise le Wallet multi-PDV et multi-contrat.

non

Object contractNumberWalletList

voir les éléments ci-dessous

Non utilisé en mode Widget. RELEASE 4.53
merchantName Nom affiché sur la page d'authentification de l'ACS non AN25 Votre nom d'enseigne
subMerchant Information du Payment Facilitator non object subMerchant voir ci dessous version 18 ou supérieure RELEASE 4.53
miscData Données complémentaires, sans limite de caractères et transmises aux partenaires. Consulter le moyen de paiement pour chaque utilisation. non AN voir ci dessous version 18 ou supérieure RELEASE 4.53

Les éléments de références

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 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 selectedContractList

Elément

Description

Requis

Type

Exemple

selectedContractList

La liste des numéros de contrat que vous souhaitez utiliser pour ce paiement. Payline affiche la liste des moyens de paiement en respectant l’ordre dans lequel la liste à été renseignée.

Si ce champ n’est pas renseigné, Payline affiche l’ensemble de vos moyens de paiement actif sur le point de vente.

Nombre d’occurrence : 1 à 99

non

 AN50

 


Object privateDataList

Élément

Description

Requis

Format

Exemple

privateData

Liste contenant les privateData

Nombre d'élément 0 à 100

oui

Object privateData

 


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 buyer


Élément

Description

Requis

Type

Exemple

Condition
title titre non AN1

 

Voir la table des valeurs

lastName

Nom de l’acheteur

non

AN100

 

 

firstName

Prénom de l’acheteur

non

AN100

 

 

email

Adresse email de l’acheteur

non

AN150

 

Ne pas mettre plus de 12 chiffres consécutifs (ex.:test-123456789101@test.test)

shippingAdress

Adresse de livraison. Le paramètre doit bien être orthographié shippingAdress dans la trame d'appel.

non

Object Address

 

 

billingAddress

Adresse de facturation

non

Object Address

 

 

accountCreateDate

La date de création du compte de l’acheteur

non

AN10

01/04/16

Format à respecter : dd/mm/yy 

accountAverageAmount

Le montant moyen des achats de cet acheteur

non

N10

 

 

accountOrderCount

Le nombre de commande passé par cet acheteur

non

N10

 

 

walletId

L’identifiant du portefeuille virtuel de votre client.

Non

AN50

 

Obligatoire pour les paiements par portefeuille

walletDisplayed

Gestion de l’affichage des moyens de paiement de votre client.

Pour ne pas afficher les données de paiement client, saisir la valeur « none ».

Pour afficher les données de paiement client, la balise doit être vide ou absente

non

AN5



walletSecured

Nature du contrôle ajouté à la cinématique de paiement WEB.

non

AN12


Voir la table des valeurs

walletCardInd

Spécifie l’index de la carte à utiliser.

non

AN2

1

L’index de la carte, valeur par défaut « 1 » 

ip

L’adresse IP de l’acheteur

non

AN50


Format à respecter : IPv4 ou IPv6 

mobilePhone

Le numéro de mobile de l’acheteur

non

N15

0033691666666

 

 

customerId

Identifiant client

non

AN50

894492568

Clearsale : Cette donnée peut être un identifiant ou un email
legalStatus Type du status de l'acteur : personne ou entreprise non N1 1 Clearsale : voir la table de valeur.
legalDocument Numero d'identification du document officiel non AN100 X5446119U  
birthDate Date de naissance non AN10

2016-04-27

Format: yyyy-mm-dd 
fingerprintID ID Device fingerprint non AN50    
deviceFingerprint Information du DeviceFingerPrint. non AN   à partir de la version 15
isBot Information du DeviceFingerPrint. Valeur possible : Y ou N non AN1   à partir de la version 15
isIncognito Information du DeviceFingerPrint. Valeur possible : Y ou N non AN1   à partir de la version 15
isBehindProxy Information du DeviceFingerPrint. Valeur possible : Y ou N non AN1   à partir de la version 15
isFromTor Information du DeviceFingerPrint. Valeur possible : Y ou N non AN1   à partir de la version 15
isEmulator Information du DeviceFingerPrint. Valeur possible : Y ou N non AN1   à partir de la version 15
isRooted Information du DeviceFingerPrint. Valeur possible : Y ou N non AN1   à partir de la version 15
hasTimezoneMismatch Information du DeviceFingerPrint. Valeur possible : Y ou N non AN1   à partir de la version 15


Object owner

Elément

Description

Requis

Type

Exemple

 

lastName

Nom du titulaire

non

AN30

Pierre

Applicable uniquement pour AMEX

firstName

Prénom du titulaire

non

AN15

Paul

Applicable uniquement pour AMEX

billingAddress

Adresse de facturation

non

Object addressOwner

 

Applicable uniquement pour AMEX

issueCardDate

Date d’émission de la carte

non

AN4

Format : mmyy

Applicable uniquement pour AMEX


Object addressOwner

Elément

Description

Requis

Type

Exemple

street

Nom de la rue

Non

AN100


cityName

Ville

Non

AN40


zipCode

Code postal

Non

AN20


country

Pays, la liste des valeurs.

Non

AN2

FR

phone

Téléphone

Non

AN15



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 recurring

Élément Description Requis Format Exemple  

firstAmount

Le montant du premier montant à effectuer. Il doit être formulé dans la plus petite unité de la devise.

non

N12

pour un montant de 100 €, vous devez mettre la valeur 10000.

 

amount

Le montant d’une échéance. Il doit être formulé dans la plus petite unité de la devise.

oui

N12

pour un montant de 5 €, vous devez mettre la valeur 500.

 

billingCycle

Le code de la fréquence des paiements.

 

oui

N2

40 : mensuel
60 : trimestriel

cf. liste complète en annexe tableau « Liste des fréquences de paiement »

 

billingLeft Nombre d’échéance non N3 3  
billingDay Jour où les échéances doivent être traitées. non AN2 Format à respecter : dd  

startDate

La date de la première échéance (uniquement en mode REC). Si ce champ n’est pas renseigné, Payline y affecte la date du jour.

 

non

AN10

Format à respecter : dd/mm/yyyy

 

endDate La date de la fin des échéances des paiements non AN16

Format à respecter : dd/mm/yyyy

HH24:MI

 
newAmount Nouveau montant modifié non N12 pour un montant de 60 €, vous devez mettre la valeur 6000.  
amountModificationDate La date de la modification du montant non AN16

Format à respecter : dd/mm/yyyy

HH24:MI

 

 

Exemple :

Paiement en mode=REC avec les valeurs suivantes :

  • recurring.billingCycle=40 (mensuel)
  • une carte CB
  • sur 24 mois avec des echéances à chaque fin du mois 
  • recurring.billingDay=31
  • recurring.EndDate=date du jour +2 ans

La première transaction est effectuée à la date du jour puis tous les mois, en fin de mois pendant 2 ans jusqu'à la endDate.

Pour les mois pairs et le mois de février, le jour retenu lors de la création des échéances est 30 pour les mois pairs et 28 ou 29 pour février.



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.

No

 

 

Non utilisé en mode Widget. RELEASE 4.53


Object subMerchant

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

Élément

Description

Requis

Type

Amex

CB MSC VISA

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


Données Privées complémentaires (exemple)

    


Réponse en retour


Élément

Description

Requis

Format

Exemple

result

Information sur le résultat de la demande de paiement :

00000 : Transaction acceptée

Autre code : Transaction non acceptée

oui

Object result

voir les éléments ci-dessous

token

Jeton horodaté qui permet d’identifier la demande de paiement web du commerçant

oui



redirectURL

URL sur laquelle le navigateur de l’acheteur doit être redirigé pour procéder au paiement.

oui

AN255

https://webpayment.payline.com

stepCode

Identifiant de la classe Action à appeler pour la perso de l’URL

non

AN20


reqCode

ldentifiant de la méthode de la classe Action à appeler pour la perso de l’URL

non

AN20


method

Le mode de fonctionnement de l’url personnalisé.

non

AN4

POST ou GET


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



Vous avez d’autres questions ? Envoyer une demande

Commentaires

Réalisé par Zendesk