| Align | ||
|---|---|---|
| ||
|
Response
The "getWebPaymentDetailsResponse" message is Payline's response to a request for the result of a web payment. It allows you to obtain, among other things, the unique transaction number on Payline and the debit authorization number issued by your bank.
The answer has the following structure:
Element | Description | Required | Format | Example | Condition | ||||
result | Information on the result of the request for payment information: 00000: Transaction approved | Yes | |||||||
transaction | Transaction Information : See below the elements | transaction | Transaction Information | Yes | |||||
payment | Payment Information : See below the elements | payment | Payment Information | Yes | |||||
authorization | Authorization Information : See below the elements | authorization | Authorization Information | Yes | |||||
privateDataList | Information on private data : See below the elements | no | |||||||
paymentRecordId | Identifier of the payment record | no | YEAR | 173661 | |||||
billingRecordList | Deadline table : See below the elements | no | Only in the case of a recurring or subscription payment. | ||||||
authentication3DSecure | Referred to POST by CSA : See below the elements | no | Object authentication3DSecure | ||||||
card | Card Information : See below the elements card | Card Information | no | ||||||
extendedCard | Additional information on the map : See below the elements | no | ExtendedCardType Object | ||||||
order | Order Information : See below the elements | order | Order Information | no | Object order | ||||
paymentAdditionalList | Table of supplementary payments : See below the elements | no | Object paymentAdditionalList | Only in the case of additional payment (s) | |||||
media | Detection of the media by Payline used during the payment. The possible values of this tag are: - Computer | no | AN25 | Computer | |||||
numberOfAttempt | The number of attempts made by the customer during his web payment List of possible values: - 0: No payment attempt | no | N1 | 3 | version 5 or higher | ||||
wallet | Portfolio InformationWallet Information : See below the elements | no | |||||||
contractNumberWalletList | A chart of the contract numbers of the wallet : See below the elements | no | Object contractNumberWalletList | Not used in Widget mode. | |||||
| contractNumber | Number of the contract on which the transaction was carried out | no | YEAR | ||||||
| bankAccountData | Bank account information : See below the elements | no | Object bankAccountData | See below the elements | |||||
| subMerchant | Payment Facilitator Information : See below the elements | no | Object subMerchant | ||||||
| buyer | Buyer Information : See below the elements | buyer | Buyer Information | no | Object buyerSee below the elements | version 19 or higher |
The reference elements
Object result| Extrait |
|---|
|
|
|
Example
code
The return code of the web service:
Accepted transaction: 00000, 02400, 02500, 02501, 02517, 02520, 02616, 03000, 04000.
Other code: Transaction not accepted
N5
See details of Payline Return Codes
ShortMessage
Short message of the result of the transaction
AN50
longMessage
Message of the result of the transaction
AN255
Object transaction
This indicator is returned by Payline in the case of a duplicate transaction:
1 = duplicate transaction
0 = no duplicate detected
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
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)
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.
version 13 or higher.
version 16 or higher for Paypal.
Information returned to the merchant from the partners:
- PayPal
- Carrefour Gift Card
- multibanco
- Casino
- PayPal
version 16 or higher
Object fraudResultDetails
Return code of the web service.
00000: Transaction approved
01xxx: Transaction refused
021xx: Internal Error
cf. complete list in the appendix table "List of return codes"Object payment
Element
Description
Format
Example
amount
Information passed when calling the doWebPayment function
N12
100
currency
Currency of payment
N3
978
action
Action Code
N3
100
fashion
Payment method
AN3
CPT
contractNumber
Contract number
AN50
1234567
differedActionDate
Date on which payment will be made
AN8
07/04/2016
Format: dd / mm / yy
If the mode = DIF field, then the DifferedActionDate date is required otherwise this field must be empty.
method
Name of the card issuer
AN20
CB
version 10 or higher
Ex: CB, PAYSAFECARD
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.
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.
version 15 or higher
registrationToken
It allows the partner to return a token to identify a consumer and finds this data when making a payment request.
Object authorization
Element
Description
Format
Example
number
Authorization number issued by the acquirer authorization server. This field is filled in if the authorization request is granted1.
N6
123456
dated
Date and time of authorization
AN16
Format: dd / mm / yyyy HH24: MI
Object privateDataList
Element
Description
Required
Format
Example
privateData
List containing privateData
Number of items 0 to 100
Yes
Object privateData
Element
Description
Required
Format
Example
key
The name of the key of value
Yes
AN50
wear
value
Value associated with the key
Yes
AN50
dupond or durand, etc.
Object billingRecord
Element
Comment
Format
Example
dated
The date of the expiry
AN10
Format: dd / mm / yyyy
amount
The amount of maturity in the smallest unit of the currency.
N12
for an amount of 100 €, you must set the value 10000.
status
The status of a deadline
AN1
0: future deadline.
1: accepted deadline
2: deadline refused.
3: current deadline (a retry is scheduled after one or more failures)
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
transaction
Payline transaction information
authorization
Information about the authorization issued by the acquirer authorization server
nbTry
Number of payment attempts made
N3
rank
Rank of the due date within the payment record.
Allows editing via updateBillingRecord
N12
Object authentication3DSecure
Element
Description
Required
Type
Example
md
Referred to POST by CSA
no
AN20
pares
Referred to POST by CSA
no
YEAR
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
Object result
Object transaction
Object fraudResultDetails
Object payment
Object authorization
Object privateDataList
Object privateData
Object billingRecord
Object authentication3DSecure
Object cardOut
Object extendedCardType
Object order
Object orderDetail
Object paymentAdditionalList
Object paymentAdditional
Object wallet
Object address
Object card
Object contractNumberWalletList
Object bankAccountData
Object subMerchant
Object buyer
|
vadsResult
Summary of 3DSecure operations in hexadecimal. This field is no longer used.
no
AN8
otherwise 9: VAD
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
To use a non-Payline MPI, you must fill in this field.
Values are: Y / N / U or empty
Object cardOut
Element
Description
Format
Example
number
Card marked according to PCI DSS
YEAR
111122XXXXXX4444
If the token field is populated, the number field must be empty.
type
Type of card: CB, VISA, MASTERCARD, MAESTRO, AMEX
YEAR
CB
expirationDate
Expiration date of the card
YEAR
0311
card holder
Cardholder
AN20
Pierre Dupont
token
Alias of the card number.
The version must be greater than or equal to 3
AN19
1111gPNzHtyu4444
ExtendedCardType Object
Element
Comment
Required
Example
country
Country of issue of the card
AN2
ISO CODE: example FR
isCvd
The card is it a blue card
AN1
Y OR N
bank
The bank of the card used for payment
YEAR
Credit Lyonnais
type
The type of payment card
AN20
MASTERCARD
network
Refers to the attachment of the card to an entity managing the acceptance of the card at a national or international level
AN20
MASTERCARD
product
Indicates the category to which the card type belongs: see product codes
YEAR
Gold / Premier for a VISA card
Object order
Element
Description
Required
Type
Example
ref
Reference of the order. This reference must be unique because it is used for control in duplicate request.
The \ character is forbidden.
Yes
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
EN
taxes
The amount of taxes on the order in the smallest unit of the currency.
An amount of 1 € corresponds to 100
No
N12
100
amount
The amount of the order in the smallest unit of the currency. Usually the same amount as payment.amount.
An amount of 60 € corresponds to
Yes
N12
6000
currency
The ISO code of the payment currency:
978: euros
840: US dollars
cf. complete list in the appendix table "List of currencies"
Yes
N3
dated
The date of the order at the merchant:
Format to be respected: dd / mm / yyyy HH24: MI
Yes
AN16
details
Information about the ordered items
No
deliveryTime
Delivery time :
1 = express
2 = standard
No
NOT
1
deliveryMode
Delivery method :
1: withdrawal of the goods from the merchant
2: Use of a network of points-withdrawal third (type kiala, alveol, etc.)
3: Withdrawal in an airport, a station or a travel agency
4: Carrier (La Poste , Colissimo, UPS, DHL ... or any private carrier)
5: Issuing an electronic ticket, downloads
No
NOT
4
Expected delivery date must be greater than the current date. Format: dd / mm / yyyy
Object orderDetail
Element
How
required
Format
example
ref
Item reference
No.
AN50
price
Item price, in the smallest currency unit
No.
N12
quantity
Number of Items
No.
N5
how
How
No.
AN255
category
Category of item
No.
AN50
brand
Product brand
No.
AN50
Eg: HERMES
subcategory1
Rank 1 subcategory
No.
AN50
Eg: Watches & Jewelery
subcategory2
Rank 2 subcategory
No.
AN50
Eg: Jewelery
additionalData
List of specifications required for certain payment methods
No.
AN255
Eg: LegalAge = 18 & Discount = 0105
TaxRate
Item tax rate (expressed in hundredths)
No.
N4
Eg: 1580 for 15.8%
Object paymentAdditionalList
Element
How
Required
Format
Example
paymentAdditional
List containing paymentAdditional
Number of items 0 to 100
Object paymentAdditional
Element
Description
Required
Type
Example
transaction
Transaction Information
Yes
authorization
Authorization information
Yes
authentication3DSecure
Information on the 3Dsecure of the operation
no
Object wallet
Element
Description
Required
Type
Condition
walletId
The unique identifier of the virtual wallet. You must provide Payline with a 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
firstName
First name of the buyer.
no
AN100
The email address of the buyer. Payline will use this information to send a proof of payment to your customer.
no
shippingAddress
Delivery address of the buyer
no
Possible values:
- EXP: Date expired
- OPP: setting opposition
- MAN: manual deactivation
- INT: internal rules
Indicates the mark used for the operation:
It is taken into account only if the means of payment allows the choice of the mark.
Object address
Element
Description
Required
Type
Example
title
Title, see table of values
no
AN2
1
name
Name or building number
no
AN100
firstName
First name
no
AN100
lastName
Name
no
AN100
street1
Street name
no
AN100
street2
Complement of the street name
no
AN100
CityName
City
no
AN40
zipCode
Postal code
no
AN20
country
Country, see the list of values.
no
AN2
EN
phone
Phone
no
AN15
state
no
AN15
Object card
Element
Description
Format
Example
encryptionKeyId
RSA Payline key identifier for encryption. Disregard this field.
N4
encryptedData
The encrypted card data. Disregard this field.
AN400
number
Masked card number, PCI DSS compliant
AN19
4970102121041646 as input to our API.
In output, the number is hidden: 497010XXXXXX1646
type
Card type: CB, VISA, MASTERCARD, MAESTRO, AMEX.
YEAR
CB
expirationDate
Expiration date of the card
0311
cvx
Visual cryptogram on the back of the credit card
N10
XXX
- if presence cavv, put "xxx"
- if cavv absence, put "null"
ownerBirthdayDate
Bearer's birthday
N6
Format to respect: ddmmyy
password
Encrypted password
AN16
cardPresent
This service is used only if you make the Mail Order or Telephone Order or if the user is physically present
N1
0 or 1 (present)
card holder
Cardholder
AN20
Pierre Dupont
token
Alias of the card number.
The version must be greater than or equal to 3
AN19
1111gPNzHtyu4444
You must use the PAN token option and the version must be greater than or equal to 3.
Object contractNumberWalletList
Element
How
required
Format
Example
contractNumberWallet
List containing the contract numbers of the portfolio. Number of elements 0 to 10.
The Widget mode uses the multi-PDV and multi-contract wallet: the wallet is linked to the merchant level.
No.
Object bankAccountData
Element
Description
Required
Format
Example
BANKCODE
no
AN10
Bank number
no
YEAR
Used only for ELV
Object subMerchant
Object available in version 18 or higher of web services
Element
Description
Type
Amex
subMerchantId
Identifier of the sub-market (final beneficiary) defined by the payment provider (Payment Facilitator)
Yes
YEAR
subMerchantName
Sub-merchant's name
Yes
YEAR
subMerchantMCC
MCC Code
Yes
YEAR
subMerchantSIRET
Number Siret
no
YEAR
subMerchantTaxCode
Tax: Mandatory for countries: USA and CAN. It is up to the Payment Facilitator to determine whether this information should be provided or not.
no
YEAR
subMerchantStreet
Street name
Yes
YEAR
subMerchantCity
City
Yes
YEAR
subMerchantZipCode
Postal code
Yes
YEAR
subMerchantCountry
Country, see the list of values.
Yes
AN2
subMerchantState
no
YEAR
Phone number
Object buyer
Element
Description
Required
Type
Example
lastName
Name of the buyer
no
AN100
firstName
Buyer's name
no
AN100
Buyer's email address
no
AN150
shippingAdress
Delivery address.
no
billingAddress
Billing address
no
accountCreateDate
The date of creation of the buyer's account
no
AN10
04/01/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
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
walletCardInd
Specifies the index of the map to use.
no
AN2
1
ip
The IP address of the buyer
no
AN50
mobilephone
The mobile number of the buyer
no
N15
0033691666666
customerId
Customer ID
no
AN50
894492568
2016-04-27