Webservice - getWebPaymentDetailsResponse

S’abonner

Response

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

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

nonObject - extendedCardType

Voir ci-dessous les éléments


order

Information sur la commande

nonObject - order


Voir ci-dessous les éléments


paymentAdditionalList

Tableau des paiements complémentaires

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

nonObject - contractNumberWalletList

Voir ci-dessous les éléments

Non utilisé en mode Widget. 
contractNumberNuméro du contrat sur lequel a été réalisé l'opérationnonAN

bankAccountDataInformation sur le compte bancairenonObject - bankAccountDataVoir ci-dessous les éléments
subMerchantInformation du Payment FacilitatornonObject - subMerchantVoir ci-dessous les éléments
buyerInformation du BuyernonObject - buyerVoir ci-dessous les élémentsversion 19 ou supérieure


Les éléments de référence

Object result

Erreur du rendu de la macro 'excerpt-include' : No link could be created for 'Object result'.


Object transaction


FieldDescriptionFormatExampleCondition
idUnique identifier of the Payline transactionAN50

dateDate and time of Payline transaction. Format : dd/mm/yyyy HH24:MIAN1701/01/2018 12:00
isDuplicated

This indicator is returned by Payline in the case of a duplicate transaction:

1 = duplicate transaction 
0 = no duplicate detected

AN11
isPossibleFraud

This indicator is calculated according to the criteria defined by the merchant:

1 = There is a risk of fraud 
0 = No risk of fraud detected

AN11
fraudResultFraud CodeAN50

fraudResultDetailsFraud DetailsObject - fraudResultDetails

explanationReason for refusal in case of fraudAN50

threeDSecure

This indicator lets you know if the transaction is 3DSecure or not:

Y = 3DS Transaction 
N = Non-3DS Transaction 
D = Demotion Case (Version 14 or higher)

AN1

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.

AN64www.boutique.fr

version 13 or higher.

version 16 or higher for Paypal.

scoreScoring the possibility of fraud: Score from 0 to 10N52
externalWalletTypeType of wallet used during the transaction. Ex : V.Me, MasterpassAN20Masterpass
externalWalletContractNumberVAD contract number associated with Wallet paymentAN50

PartnerAdditionalData

Information returned to the merchant from the partners:

AN


version 16 or higher


avsAVS Address Verification Serviceobject avs
version 17 or higher


Object fraudResultDetails


FieldDescriptionFormatExample
code

Return code of the web service.

00000: Transaction approved
01xxx: Transaction refused
021xx: Internal Error
cf. complete list in the appendix table "Return codes"

N5

00000

shortMessageMessage court du résultat de la transactionAN50ACCEPTED
longMessageMessage du résultat de la transactionAN255Transaction approved


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.

NoAN64www.boutique.frversion 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.

NoAN15

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.
NoAN

version 18 ou supérieure

RELEASE 4.53


Object authorization


Field

Description

Mandatory

Format

Example

number

Authorization number issued by the acquirer authorization server. This field is filled in if the authorization request is granted1.

Yes

N6

123456

date

Date and time of authorization : Format : dd/mm/yyyy HH24:MI

Yes

AN17

18/05/18 16:12:29


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 billingRecord


Field

Description

Mandatory

Format

Example

Conditions

date

The date of the expiry, Format: dd/mm/yyyy

Yes

AN10



amount

The amount of maturity in the smallest unit of the currency.
For an amount of 100 €, you must set the value 10000.

Yes

N12

10000


status

The status of deadline. Values : 
0: future deadline. 
1: accepted deadline 
2: deadline refused. 
3: current deadline (a retry is scheduled after one or more failures)

Yes

AN1

0


result

The return code of the due date processing. 

cf. complete list in the appendix table "List of return codes" :

00000: Transaction approved 
01xxx: Transaction refused 
02302: Transaction invalid

No

Object - result

00000


transaction

Payline transaction information

NoObject - transaction



authorization

Information about the authorization issued by the acquirer authorization server


No

Object - authorization



nbTry

Number of payment attempts made

No

N3


version greater than or equal to 8

rank

Rank of the due date within the payment record.

Allows editing via updateBillingRecord

No

N12


version greater than or equal to 8




Object authentication3DSecure


Field

Description

Mandatory

Type

Example

Condition

md

Referred to POST by ACS

No

AN20



pares

Referred to POST by ACS

No

AN



xid

Unique transaction identifier

No

AN20



eci

Electronic Commerce Indicator. To pass in the authorization

No

AN2



cavv

Cardholder Authentication Verification Value determined by the ACS.

No

AN28



cavvAlgorithm

Positive integer specifying the algorithm used for CAVV generation. The current possible values ​​are:

0 = HMAC (SET ™ TransStain), 
1 = CVV, 
2 = CVV with ATN, 
3 = AAV MasterCard

W = Cryptogram generated by a Wallet solution

No

N1


W : Wallet UEP

vadsResult

Summary of 3DSecure operations in hexadecimal. This field is no longer used.

No

AN8



typeSecurisationField used as information for authentication.This field is no longer used.NoAN102020 :  VADS
else  9 : VAD
PaResStatus

To use a non-Payline MPI, you must fill in this field.

Values ​​are: 
Y: Successful authentication 
N: Erroneous authentication 
A: Planned passage through ACS 
U: Call to ACS performed 
empty: Time out on ACS

NoAN1

VeResStatus

To use a non-Payline MPI, you must fill in this field.

Values ​​are: Y / N / U or empty

NoAN1


Object cardOut


Field

Description

Mandatory

Format

Example

Condition

number

Card marked according to PCI DSS

non

AN

111122XXXXXX4444

If the token field is populated, the number field must be empty.

type

Type of card: CB, VISA, MASTERCARD, MAESTRO, AMEX

non

AN

CB


expirationDate

Expiration date of the card

non

AN

0311


cardholder

Cardholder's name

non

AN20

Pierre Dupont


token

Alias ​​of the card number.

The version must be greater than or equal to 3

non

AN19

1111gPNzHtyu4444



Object extendedCardType


Field

Description

Mandatory

Example

country

Card country issuer : CODE ISO 

AN2

FR

isCvd

The card is it a Carte Bleue : Y or N

AN1

Y

bank

The bank of the card used for payment

AN

Crédit Lyonnais

type

The type of payment card

AN20

MASTERCARD

network

Refers to attachment of card to an entity managing the acceptance of card at national or international level

AN20

MASTERCARD

product

Indicates the category to which the card type belongs: see product codes

AN

Gold/Premier


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


deliveryChargeAmount of delivery charges in smallest unit of currency, example 250 for 2.50 eurosNoN
version 18 ou supérieure
deliveryExpectedDate

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

NoAN1807/04/2016Posted to Limonetik
deliveryExpectedDelayExpected delivery time (in days)NoN210Posted 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 paymentAdditionalList


Field

Description

Mandatory

Format

Example

paymentAdditional

List containing paymentAdditional

Number of items 0 to 100


Object - paymentAdditional



Object paymentAdditional


Field

Description

Mandatory

Type

Example

transaction

Transaction Information

Yes

Object - transaction


paymentPayment InformationYesObject - payment

authorization

Authorization information

Yes

Object - authorization


authentication3DSecure

Information on the 3Dsecure of the operation

No

 Object authentication3DSecure


cardBuyer card informationYesObject cardOut
extendedCardBuyer card informationNoObject - extendedCardType


Object wallet


Field

Description

Mandatory

Type

Example

Condition

walletId

The unique identifier of virtual wallet. You must provide Payline with an unique identifier that corresponds to one and only one buyer on your information system. It is with this same identifier you can request a payment by virtual wallet.

Yes

AN50



lastNameThe name of the buyer. This information is useful for finding a portfolio in the Trading Administration Center.NoAN100

firstName

First name of the buyer

No

AN100



email

The email address of the buyer. Payline will use this information to send a proof of payment to your customer.

No

AN150


shippingAddress

Delivery address of the buyer

No

Object - address



cardBuyer card informationYesObject - card

commentCommentsNoAN255

defaultCard saved by defaultNoAN1Y or N: Default card
cardStatus

Possible values: 
- EXP: Date expired 
- OPP: setting opposition 
- MAN: manual deactivation 
- INT: internal rules

NoAN3EXP
cardBrand

Indicates the mark used for the operation:


CodeDescription
0CB
1VISA
4MASTERCARD
5MAESTRO
8BCMC

It is taken into account only if the means of payment allows the choice of the mark.

NoN1CBfrom version 15


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


countyRégionNoAN15
phoneTypePhone category, see table valuesNoN1



Object card


Field

Description

Mandatory

Format

Example

Condition

encryptionKeyId

RSA Payline key identifier for encryption. Disregard this field

No

N4



encryptedData

The encrypted card data. Disregard this field

No

AN400



number

Masked card number, PCI DSS compliant : 4970102121041646 as input to our API. 
In output, the number is hidden: 497010XXXXXX1646

No

AN19

497010XXXXXX1646

If the token field is populated, the number field must be empty

type

Card type: CB, VISA, MASTERCARD, MAESTRO, AMEX

Yes

AN

CB


expirationDate

Expiration date of the card

NoN4

0311


cvx

Visual cryptogram on the back of the credit card

No

N10

XXX

  • if presence cavv, put "xxx"
  • if cavv absence, put "null"

ownerBirthdayDate

Cardholder's birthday

No

N6

01/01/2018

Format à respecter :ddmmyy

password

Encrypted password

No

AN16



cardPresent

This service is used only if you make the Mail Order or Telephone Order or if the user is physically present

No

N1

0

0 ou 1 (present)

cardholder

Cardholder's name

No

AN20

Pierre Dupont


token

Alias ​​of the card number.

The version must be greater than or equal to 3

No

AN19

1111gPNzHtyu4444

You must use the PAN token option and the version must be greater than or equal to 3.

paymentDataObject at the input of the service to convey the data of the payment method ApplePayNoObject PaymentData


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 bankAccountData


Field

Description

Mandatory

Format

Example

countryCodeCountry codeNoAN

bankCode

Country code of the account number

No

AN10


accountNumber

Bank number

No

AN


keyIBAN accountNoAN


Used only for ELV



Object subMerchant

Object available in version 18 or higher of web services

Field

Description

Mandatory

Type

Amex

CBMSCVISA

subMerchantId

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

Yes

YesYes

AN

subMerchantName

Sub-merchant's name

Yes

No

AN

subMerchantMCC

MCC Code

Yes

YesYes

AN

subMerchantSIRET

Numéro de SIRET

No

YesNoNo

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

subMerchantEmailAddressEmailYes


ANS40
subMerchantPhoneNumber

Phone number

Yes


AN



Object buyer


Field

Description

Mandatory

Type

Example

Condition
titleTitle of civilityNoAN1


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
legalStatusType of status of the actor: person or companyNoN11Clearsale: see the table of value.
legalDocumentIdentification number of the official documentNoAN100X5446119U
birthDateBirth date. Format: yyyy-mm-dd NoAN10

2016-04-27


fingerprintIDDevice ID fingerprintNoAN50

deviceFingerprintDeviceFingerPrint information.NoAN
from version 15
isBotDeviceFingerPrint information. Possible value: Y or NNoAN1
from version 15
isIncognitoDeviceFingerPrint information. Possible value: Y or NNoAN1
from version 15
isBehindProxyDeviceFingerPrint information. Possible value: Y or NNoAN1
from version 15
isFromTorDeviceFingerPrint information. Possible value: Y or NNoAN1
from version 15
isEmulatorDeviceFingerPrint information. Possible value: Y or NNoAN1
from version 15
isRootedDeviceFingerPrint information. Possible value: Y or NNoAN1
from version 15
hasTimezoneMismatchDeviceFingerPrint information. Possible value: Y or NNoAN1
from version 15


Vous avez d’autres questions ? Envoyer une demande

Commentaires

Réalisé par Zendesk