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 | Yes | |||
payment | Payment Information | Yes | See below the elements | ||
authorization | Authorization Information | Yes | |||
privateDataList | Information on private data | no | |||
paymentRecordId | Identifier of the payment record | no | YEAR | 173661 | |
billingRecordList | Deadline table | no | Only in the case of a recurring or subscription payment. | ||
authentication3DSecure | Referred to POST by CSA | no | Object authentication3DSecure | ||
card | Card Information | no | |||
extendedCard | Additional information on the map | no | ExtendedCardType Object | ||
order | Order Information | no | Object order | ||
paymentAdditionalList | Table of supplementary payments | 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 Information | no | |||
contractNumberWalletList | A chart of the contract numbers of the wallet | 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 | no | Object bankAccountData | See below the elements | |
| subMerchant | Payment Facilitator Information | no | Object subMerchant | See below the elements | |
| buyer | Buyer Information | no | Object buyer | See below the elements | version 19 or higher |
The reference elements
Object result
Element | Description | Format | 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 | |
| partnerCode | Return code from partner (payment method) and SAA acquirer | AN50 | from version 14 |
| partnerCodeLabel | Partner's wording | AN255 | from version 14 |
Object transaction
Element | Description | Format | Example | Condition |
|---|---|---|---|---|
| id | Unique identifier of the Payline transaction | AN50 | ||
| dated | Date and time of Payline transaction | AN17 | Format: dd / mm / yyyy HH24: MI | |
| isDuplicated | This indicator is returned by Payline in the case of a duplicate transaction: 1 = duplicate transaction | AN1 | 1 | |
| isPossibleFraud | This indicator is calculated according to the criteria defined by the merchant: 1 = There is a risk of fraud | AN1 | 1 | |
| fraudResult | Fraud Code | AN50 | ||
| fraudResultDetails | Fraud Details | Object fraudResultDetails | ||
| explanation | Reason for refusal in case of fraud | AN50 | ||
| threeDSecure | This indicator lets you know if the transaction is 3DSecure or not: Y = 3DS Transaction | 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. | AN64 * | www.boutique.fr | version 13 or higher. version 16 or higher for Paypal. |
| score | Scoring the possibility of fraud: Score from 0 to 10 | N5 | 2 | |
| externalWalletType | Type of wallet used during the transaction | AN20 | Ex: V.Me, Masterpass | |
| externalWalletContractNumber | VAD contract number associated with Wallet payment | AN50 | ||
| PartnerAdditionalData | Information returned to the merchant from the partners:
| YEAR | version 16 or higher | |
| avs | AVS Address Verification Service | object avs | version 17 or higher |
Object fraudResultDetails
Element | Description | Format | Example |
|---|---|---|---|
| code | Return code of the web service. | N5 | 00000: Transaction approved 01xxx: Transaction refused 021xx: Internal Error cf. complete list in the appendix table "List of return codes" |
| ShortMessage | Short message of the result of the transaction | AN50 | |
| longMessage | Message of the result of the transaction | AN255 |
Object payment
Element | Description | Prerequisites | Format | Example | Condition |
amount | Information passed when calling the doWebPayment function | Yes | N12 | 100 | The value 100 corresponds to 1 € |
currency | Currency of payment | Yes | N3 | 978 | |
action | Action Code | Yes | N3 | 100 | |
fashion | Payment method | 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 | no | 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 | 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. | no | AN64 | www.boutique.fr | version 13 or higher |
| cardBrand | Indicates the mark used for the operation, see the values. | no | YEAR | 15 | version 15 or higher |
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 | YEAR | version 18 or later RELEASE 4.53 |
Object authorization
Element | Description | Required | 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 |
dated | Date and time of authorization | Yes | 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 | Required | Format | Example | terms |
dated | The date of the expiry | Yes | AN10 | Format: dd / mm / yyyy | |
amount | The amount of maturity in the smallest unit of the currency. | Yes | N12 | for an amount of 100 €, you must set the value 10000. | |
status | The status of a deadline | Yes | AN1 | 0: future deadline. | |
result | The return code of the due date processing | no | cf. complete list in the appendix table "List of return codes" 00000: Transaction approved | ||
transaction | Payline transaction information | no | Object | ||
authorization | Information about the authorization issued by the acquirer authorization server | no | |||
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
Element | Description | Required | Type | Example | Condition |
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), W = Cryptogram generated by a Wallet solution | no | N1 | W: UEP Wallet | |
vadsResult | Summary of 3DSecure operations in hexadecimal. This field is no longer used. | no | AN8 | ||
| typeSecurisation | Field used as information for authentication. This field is no longer used. | no | AN10 | 20: VADS otherwise 9: VAD | |
| PaResStatus | To use a non-Payline MPI, you must fill in this field. Values are: | no | AN1 | ||
| VeResStatus | To use a non-Payline MPI, you must fill in this field. Values are: Y / N / U or empty | no | AN1 |
Object cardOut
Element | Description | Required | Format | Example | Condition |
number | Card marked according to PCI DSS | no | YEAR | 111122XXXXXX4444 | If the token field is populated, the number field must be empty. |
type | Type of card: CB, VISA, MASTERCARD, MAESTRO, AMEX | no | YEAR | CB | |
expirationDate | Expiration date of the card | no | YEAR | 0311 | |
card holder | Cardholder | no | AN20 | Pierre Dupont | |
token | Alias of the card number. The version must be greater than or equal to 3 | no | 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 | Condition |
ref | Reference of the order. This reference must be unique because it is used for control in duplicate request. | 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. | No | N12 | 100 | |
amount | The amount of the order in the smallest unit of the currency. Usually the same amount as payment.amount. | Yes | N12 | 6000 | |
currency | The ISO code of the payment currency: 978: euros cf. complete list in the appendix table "List of currencies" | Yes | N3 | 978 | |
dated | The date of the order at the merchant: Format to be respected: dd / mm / yyyy HH24: MI | Yes | AN16 | 07/04/2016 11:00 | |
details | Information about the ordered items | No | |||
deliveryTime | Delivery time : 1 = express | No | NOT | 1 | |
deliveryMode | Delivery method : 1: withdrawal of the goods from the merchant | No | NOT | 4 | |
| deliveryCharge | Amount of delivery charges in the smallest unit of the currency: example 250 for 2.50 euros | No | NOT | version 18 or higher | |
| 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
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 | See table values |
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 | |||
| payment | Payment Information | Yes | Object payment | ||
authorization | Authorization information | Yes | |||
authentication3DSecure | Information on the 3Dsecure of the operation | no | |||
| card | Buyer card information | Yes | Object cardOut | ||
| extendedCard | Buyer card information | no | ExtendedCardType Object | ||
Object wallet
Element | Description | Required | Type | Example | 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 | ||||||||||||||||||||||||||
| lastName | The name of the buyer. This information is useful for finding a portfolio in the Trading Administration Center. | no | AN100 | ||||||||||||||||||||||||||
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 | AN150 | |||||||||||||||||||||||||||
shippingAddress | Delivery address of the buyer | no | |||||||||||||||||||||||||||
| card | Buyer card information | Yes | Object card | ||||||||||||||||||||||||||
| how | comments | no | AN255 | ||||||||||||||||||||||||||
| default | Card saved by default | no | AN1 | Y or N: Default card | |||||||||||||||||||||||||
| cardStatus | Possible values: | no | AN3 | EXP | |||||||||||||||||||||||||
| cardBrand | Indicates the mark used for the operation:
It is taken into account only if the means of payment allows the choice of the mark. | no | N1 | CB | from version 15 | ||||||||||||||||||||||||
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 | State | no | AN15 | |||||||||||
| county | Region | no | AN15 | |||||||||||
| PHONETYPE | Phone category, see table of values | no | N1 | |||||||||||
Object card
Element | Description | Required | 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 | no | AN19 | 4970102121041646 as input to our API. | If the token field is populated, the number field must be empty. |
type | Card type: CB, VISA, MASTERCARD, MAESTRO, AMEX. | Yes | YEAR | CB | |
expirationDate | Expiration date of the card | no | N4 | 0311 | |
cvx | Visual cryptogram on the back of the credit card | no | N10 | XXX |
|
ownerBirthdayDate | Bearer's birthday | no | N6 | Format to respect: 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 or 1 (present) | |
card holder | Cardholder | 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. |
| paymentData | Object at the input of the service to convey the data of the payment method ApplePay | no | Object PaymentData |
Object contractNumberWalletList
Element | How | required | Format | Example | Condition |
|---|---|---|---|---|---|
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. | Not used in Widget mode. RELEASE 4.53 |
Object bankAccountData
Element | Description | Required | Format | Example | |||||||
| countryCode | Country code | no | YEAR | ||||||||
BANKCODE | Country code of the account number | no | AN10 | ||||||||
| accountNumber | Bank number | no | YEAR | ||||||||
| key | IBAN account | no | YEAR | ||||||||
Used only for ELV
Object subMerchant
Object available in version 18 or higher of web services
Element | Description | Required | Type | |||
Amex | CB | MSC | VISA | |||
subMerchantId | Identifier of the sub-market (final beneficiary) defined by the payment provider (Payment Facilitator) | Yes | Yes | Yes | YEAR | |
subMerchantName | Sub-merchant's name | Yes | no | YEAR | ||
subMerchantMCC | MCC Code | Yes | Yes | Yes | YEAR | |
subMerchantSIRET | Number Siret | no | Yes | no | 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 | no | YEAR | ||
subMerchantStreet | Street name | Yes | no | YEAR | ||
subMerchantCity | City | Yes | no | YEAR | ||
subMerchantZipCode | Postal code | Yes | no | YEAR | ||
subMerchantCountry | Country, see the list of values. | Yes | no | AN2 | ||
subMerchantState | state | no | no | YEAR | ||
| subMerchantEmailAddress | Yes | years.40 | ||||
| subMerchantPhoneNumber | Phone number | Yes | YEAR | |||
Object buyer
Element | Description | Required | Type | Example | Condition |
| title | title | no | AN1 | See the table of values | |
lastName | Name of the buyer | no | AN100 | ||
firstName | Buyer's name | no | AN100 | ||
Buyer's email address | no | AN150 | Do not put more than 12 consecutive digits (egtest123456789101@test.test ) | ||
shippingAdress | Delivery address. | no | |||
billingAddress | Billing address | no | Object Address | ||
accountCreateDate | The date of creation of the buyer's account | no | AN10 | 04/01/16 | Format to respect: dd / mm / yy |
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 payments | |
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 | no | AN50 | Format to respect: IPv4 or IPv6 | |
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 | no | AN10 | 2016-04-27 | Format: yyyy-mm-dd |
| fingerprintID | Device ID fingerprint | no | AN50 | ||
| deviceFingerprint | DeviceFingerPrint information. | no | YEAR | 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 |