Webservice - doWebPaymentRequest

S’abonner

Introduction

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

Valeurs possibles du payment.action = 100, 101, 108, 110, 120, 121.

returnURL

URL sur laquelle le navigateur de l’acheteur est redirigé en cas d'acceptation ou refus du paiement sur Payline.
Le commerçant doit faire appel à getWebPaymentDetails

oui

AN255

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


cancelURL

URL sur laquelle le navigateur de l’acheteur est redirigé en cas d'abandon de l'utilisateur, de Payline ou commerçant.

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
asynchronousRetryTimeout

Pour la fonction Retry Asynchrone, il s’agit d’un numérique qui précise la période en minutes. Il doit être comprise entre 5 et 10080 (7 jours).

non AN 10080 RELEASE 4.56

Les éléments de références

Object payment


Field

Description

Prerequisites

Format

Example

Condition

amount

Information passed when calling the doWebPayment function. The value 100 corresponds to 1 €

Yes

N12

100


currency

Currency of payment

Yes

N3

978


action

Action Code

Yes

N3

100

see the table

mode

Payment mode

Yes

AN3

CPT

see the table

contractNumber

Contract number

Yes

AN50

1234567

doWebPayment (defined point of sale), doCapture / doRefund (contractNumber returned by getPaymentDetails / getWebPaymentDetails).

differedActionDate

Date on which payment will be made. 
Format : dd/mm/yy

No

AN8

07/04/2016

If the mode = DIF field, then the DifferedActionDate date is required otherwise this field must be empty.

method

Name of card issuer

No

AN20

CB

version 10 or higher

Ex : CB, PAYSAFECARD

softDescriptor

Information displayed on the account statement of the buyer, limited with certain means of payment. This information will be displayed on the payment ticket. 
Special characters (not A..Z and 1..9) are specific to each acquirer / payment method.

No AN64 www.boutique.fr version 13 or higher
cardBrand

Indicates the mark used for the operation, see the values. 
It is taken into account only if the means of payment allows the choice of the mark.

No AN 15

version 15 or higher

see table


registrationToken

Token used in response in services. 
It allows the partner to return a token to identify a consumer and finds this data when making a payment request.
No AN

version 18 ou supérieure

RELEASE 4.53


Object order


Field

Description

Mandatory

Type

Example

Condition

ref

Reference of order. This reference must be unique because it is used for control in duplicate request. 
The \ character is forbidden.


AN50

12345678


origin

Origin of the order. If you have subscribed to the Mail Order and Telephone Order option then the values ​​are MO or TO.

No

AN50

SVI_#12


country

Code of the country in which the order was made, see the list.

Yes

AN2

FR


taxes

The amount of taxes on the order in smallest unit of currency. 
An amount of 1 € corresponds to 100

No

N12

100


amount

The amount of order in smallest unit of currency. Usually the same amount as payment.amount. 
An amount of 60 € corresponds to 600

Yes

N12

6000


currency

The ISO code of payment currency:

978: euros 
840: US dollars

cf. complete list in the appendix table "List of currencies"

Yes

N3

978

date

The merchant order date.  Format : dd / mm / yyyy HH24: MI

Yes

AN16

07/04/2016 11:00

details

Information about the ordered items

No

Object OrderDetails



deliveryTime

Delivery time :

1 = express 
2 = standard

No

N

1


deliveryMode

Delivery method :

1: Withdrawal of goods from the merchant 
2: Use of network of points-withdrawal third (type kiala, alveol, etc.) 
3: Withdrawal in airport, station or travel agency 
4: Carrier (La Poste , Colissimo, UPS, DHL ... or any private carrier) 
5: Issuing an electronic ticket, downloads

No

N

4


deliveryCharge Amount of delivery charges in smallest unit of currency, example 250 for 2.50 euros No N
version 18 ou supérieure
deliveryExpectedDate

Expected delivery date must be greater than the current date. Format: dd/mm/yyyy

No AN18 07/04/2016 Posted to Limonetik
deliveryExpectedDelay Expected delivery time (in days) No N2 10 Posted to Limonetik


Object orderDetail


Field

Description

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

HERMES

subcategory1

Rank 1 subcategory

No

AN50

Watches & Jewellery

subcategory2

Rank 2 subcategory

No

AN50

Jewellery

additionalData

List of specifications required for certain payment methods

No

AN255

LegalAge=18&Discount=0105

taxRate

Item tax rate (expressed in hundredths). Format : 1580 for 15.8%

No

N4

1580


Object selectedContractList


Field

Description

Mandatory

Type

Condition

selectedContractList

The list of contract numbers you want to use for this payment. Payline displays the list of payment methods in the order in which the list has been filled.

If this field is not filled in, Payline displays all of your active means of payment at the point of sale.

Number of occurrences: 1 to 99

No

 AN50

Filed required as following  :

  • No, if Webservice Version is empty or <4
  • Yes, if Webservice Version> = 4


Object privateDataList


Field

Description

Mandatory

Format

Example

privateData

List containing privateData

Number of items 0 to 100

Yes

Object - privateData



Object privateData


Field

Description

Mandatory

Format

Example

key

Key name of value

Yes

AN50

user

value

Key value

Yes

AN50

Martin


Object buyer


Field

Description

Mandatory

Type

Example

Condition
title Title of civility No AN1


See the table of values

lastName

Name of the buyer

No

AN100



firstName

Buyer's name

No

AN100



email

Buyer's email address

No

AN150


Do not put more than 12 consecutive digits (eg test123456789101@test.test )

shippingAdress

Delivery address.

No

Object Address



billingAddress

Billing address

No

Object Address



accountCreateDate

The date of creation of the buyer's account. Format  : dd/mm/yy 

No

AN10

01/04/16


accountAverageAmount

The average amount of this buyer's purchases

No

N10



accountOrderCount

The number of orders placed by this buyer

No

N10



walletId

The identifier of the virtual wallet of your client.

No

AN50


Mandatory for wallet payment

walletDisplayed

Management of the display of the means of payment of your customer.

To not display the customer payment data, enter the value "none".

To display the customer payment data, the tag must be empty or absent.

No

AN5



walletSecured

Nature of the control added to the payment kinematics WEB.

No

AN12


See the table of values

walletCardInd

Specifies the index of the map to use.

No

AN2

1

The index of the map, default value "1" 

ip

The IP address of the buyer. Format : IPv4 or IPv6 

No

AN50



mobilePhone

The mobile number of the buyer

No

N15

0033691666666



customerId

Customer ID

No

AN50

894492568

Clearsale: This data can be an identifier or an email
legalStatus Type of status of the actor: person or company No N1 1 Clearsale: see the table of value.
legalDocument Identification number of the official document No AN100 X5446119U
birthDate Birth date. Format: yyyy-mm-dd  No AN10

2016-04-27


fingerprintID Device ID fingerprint No AN50

deviceFingerprint DeviceFingerPrint information. No AN
from version 15
isBot DeviceFingerPrint information. Possible value: Y or N No AN1
from version 15
isIncognito DeviceFingerPrint information. Possible value: Y or N No AN1
from version 15
isBehindProxy DeviceFingerPrint information. Possible value: Y or N No AN1
from version 15
isFromTor DeviceFingerPrint information. Possible value: Y or N No AN1
from version 15
isEmulator DeviceFingerPrint information. Possible value: Y or N No AN1
from version 15
isRooted DeviceFingerPrint information. Possible value: Y or N No AN1
from version 15
hasTimezoneMismatch DeviceFingerPrint information. Possible value: Y or N No AN1
from version 15


Object owner


Field

Description

Mandatory

Type

Example

Condition

lastName

Owner lastname

No

AN30

Pierre

Applicable only for AMEX

firstName

Owner firstname

No

AN15

Paul

Applicable only for AMEX

billingAddress

Billing adress

No

Object - addressOwner


Applicable only for AMEX

issueCardDate

Issue card date. Format : mmyy

No

AN4

0118

Applicable only for AMEX


Object addressOwner


Field

Description

Mandatory

Type

Example

street

Street name

No

AN100


cityName

City

No

AN40


zipCode

Postal code

No

AN20


country

Country, the list of values.

No

AN2

FR

phone

Phone

No

AN15



Object address


Field

Description

Mandatory

Type

Example

title

Title, see table values

No

AN2

1

Name

Name or building number

No

AN100


firstName

First name

No

AN100


lastName

Last name

No

AN100


street1

Street name

No

AN100


street2

Complement of street name

No

AN100


cityName

City

No

AN40


zipCode

Postal code

No

AN20


country

Country, see table values

No

AN2

FR

phone

Phone

No

AN15


state

State

No

AN15


county Région No AN15
phoneType Phone category, see table values No N1



Object recurring


Field Description Mandatory Format Example

firstAmount

The amount of the first amount to be made. It must be formulated in the smallest unit of the currency.
For an amount of 100 €, you must set the value 10000

No

N12

10000

amount

The amount of a maturity. It must be formulated in the smallest unit of the currency.
For an amount of 5 €, you must put the value 500

Yes

N12

500

billingCycle

The code of the frequency of payments. Values : 

40: Monthly 
60: Quarterly

cf. complete list in annex table "  Frequency list "

Yes

N2

40

billingLeft Number of due dates No N3 3
billingDay Day when the deadlines must be processed. Format : dd No AN2 20

startDate

The date of the first expiry (only in REC mode). If this field is not filled in, Payline assigns the current date.
Format : dd/mm/yyyy

No

AN10

01/01/2018

endDate The date of the end of payment deadlines.  Format : dd/mm/yyyy HH24:MI No AN16

31/12/2018 12:00

newAmount New amount changed. For an amount of 60 €, you must put the value 6000
No N12 6000
amountModificationDate The date of the modification of the amount. Format : dd/mm/yyyy HH24:MI No AN16

06/06/2018 12:00


Example :

Payment in = REC mode with the following values:

  • recurring.billingCycle = 40 (monthly)
  • a CB card
  • 24 months with disbursements at the end of every month 
  • recurring.billingDay=31
  • recurring.EndDate = today's date +2 years

The first transaction is made on the current date and then every month, at the end of the month for 2 years until the endDate.

For the even months and the month of February, the day selected when creating the deadlines is 30 for even months and 28 or 29 for February.



Object contractNumberWalletList


Field

Description

Required

Format

Example

Condition

contractNumberWallet

List containing the contract numbers of portfolio. Number of elements 0 to 10.

The Widget mode uses the multi-PDV and multi-contract wallet: the wallet is linked to merchant level.

No



Not used in Widget mode. 

RELEASE 4.53


Object subMerchant

Object available in version 18 or higher of web services

Field

Description

Mandatory

Type

Amex

CB MSC VISA

subMerchantId

Identifier of the sub-market (final beneficiary) defined by the payment provider (Payment Facilitator)

Yes

Yes Yes

AN

subMerchantName

Sub-merchant's name

Yes

No

AN

subMerchantMCC

MCC Code

Yes

Yes Yes

AN

subMerchantSIRET

Numéro de SIRET

No

Yes No No

AN

subMerchantTaxCode

Tax: Mandatory for countries: USA and CAN. It is up to the Payment Facilitator to determine whether that information should be provided or not.

No

No

AN

subMerchantStreet

Street name

Yes

No

AN

subMerchantCity

City

Yes

No

AN

subMerchantZipCode

Postal code

Yes

No

AN

subMerchantCountry

Country, see the list of values

Yes

No

AN2

subMerchantState

state

No

No

AN

subMerchantEmailAddress Email Yes


ANS40
subMerchantPhoneNumber

Phone number

Yes


AN


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

<impl:miscData>
    <![CDATA[
        { "ContratVAD": "{'optionalTravelDetails':
                                {'class':'First',
                                 'departureDate':'2014-10-05T08:43:00',
                                 'destinationCountry':'GN',
                                 'insurance':'SIMPLE',
                                 'mainDepartureCompany':'Luftansa',
                                 'ownTicket':false,
                                 'ticketCount':1,
                                 'travellerCount':2,
                                 'travellerPassportList':[{'expirationDate':'2018-12-31T08:45:00','issuanceCountry':'FR'},
                                                          {'expirationDate':'2019-01-01T08:45:00','issuanceCountry':'DE'}],
                                 'type':'TwoWay'
                                },
                            'additionalNumericFieldList':[{'index':'1', 'value':'10'},
                                                          {'index':'2', 'value':'20'}],
                            'additionalTextFieldList':[{'index':'11', 'value':'val11'},
                                                       {'index':'22', 'value':'val22'}]
                          }"
        }
      ]]>
</impl:miscData>






Vous avez d’autres questions ? Envoyer une demande

Commentaires

Réalisé par Zendesk