Response |
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 | Yes | |||
payment | Payment Information : See below the elements | Yes | |||
authorization | Authorization Information : See below the elements | 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 | no | |||
extendedCard | Additional information on the map : See below the elements | no | ExtendedCardType Object | ||
order | Order Information : See below the elements | 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 | Wallet 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 | ||
| subMerchant | Payment Facilitator Information : See below the elements | no | Object subMerchant | ||
| buyer | Buyer Information : See below the elements | no | Object buyer | version 19 or higher |
The reference elements
Object result Field Description Format code Web service return code : More information Return code and Payline message Accepted transaction: 00000, 02400, 02500, 02501, 03000, 04000. N5 shortMessage Short message of transaction status. See the list of values AN50 longMessage Message of transaction result : status detail AN255 Object transaction Date and time of Payline transaction. Format : dd/mm/yy HH24:MI pour les services : doRefund, doCapture, ... Format : dd/mm/yy HH24:MI:SS pour getWebPaymentDetailsResponse 01/01/18 12:00 01/01/18 12:00:00 This indicator is returned by Payline in case of transaction duplicated 1 = duplicate transaction This indicator is calculated according to the criteria defined by the merchant: 1 = There is a risk of fraud This indicator is returned by Payline during 3DSecure transactions : Y = 3DS Transaction Information displayed on the account statement of the buyer, limited with certain payment method. This information will be displayed on the payment ticket. Special characters (not A..Z and 1..9) are specific to each acquirer / payment method. Check acquirer for format and support (version CB2A 1.5). version 13 or higher. version 16 or higher for Paypal. Information returned to the merchant from the partners: version 16 or higher Object fraudResultDetails Return code of the web service. 00000: Transaction approved 00000 Object payment Field Description Mandatory Format Example amount Transaction amount in the smallest currency unit. The value 100 corresponds to 1 € N12 100 currency Payment currency code N3 978 action Payment function code : see the table N3 100 mode Payment mode full or deferred : see the table AN3 CPT contractNumber The e-commerce contract code or number which gives the payment method you wish to use AN20 1234567 differedActionDate Date of the action. It must be earlier than today + 7 days. Format : dd/mm/yy 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 : see the table values AN20 CB version 10 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. version 13 or higher version 15 or higher registrationToken version 18 or higher RELEASE 4.53 In case of installment or recurring payment this parameter specifies the amount paid up to now. The amount does not include this last payment. The amount is expressed in the smallest currency unit. version 21 or higher RELEASE 4.58 Object authorization Field Description Format Example number Authorization number issued by the acquirer authorization server. This field is filled in if the authorization request is granted. In test environment, the simulator is returned A55A. AN6 123456 date Date and time of authorization : Format : dd/mm/yyyy HH24:MI 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 Field Description Mandatory Format Example key Key name of value Yes AN50 user value Value associated to the key Yes AN50 Martin Object billingRecord Field Description Format Example date The date of the expiry, Format: dd/mm/yyyy AN10 amount The amount in the smallest unit of the currency. N12 10000 status The status of deadline. Values : AN1 0 result The return code of the due date processing. See complete list in the appendix table "List of return codes" : 00000: Transaction approved 00000 transaction Payline transaction information authorization Information about the authorization issued by the acquirer authorization server nbTry Number of payment attempts done N3 rank Rank of the due date within the payment record. Allows editing via updateBillingRecord N12 Object authentication3DSecure Field Description Required Format md 3DSecure merchant data : Referred to POST by ACS No AN20 pares Payer authentification response : Referred to POST by ACS No AN xid Unique transaction identifier, base-64 encoded No AN28 eci Electronic Commerce Indicator. to send in the authorization No AN2 cavv Cardholder Authentication Verification Value determined by the ACS. No AN28 cavvAlgorithm Algorithm used for CAVV generation. The current possible values are: Codes cavvAlgorithm N1 vadsResult Summary of 3DSecure operations in hexadecimal. This field is no longer used. No AN8 To use a non-Payline MPI, you must fill in this field. See values : Codes PaResStatus To use a non-Payline MPI, you must fill in this field. See values : Codes VeResStatus Container gathering the authentication result parameters. Object cardOut Field Description Format Example number Card marked according to PCI DSS AN 111122XXXXXX4444 If the token field is populated, the number field must be empty. type Type of card: CB, VISA, MASTERCARD, MAESTRO, AMEX AN CB expirationDate Expiration date of the card AN 0311 cardholder Cardholder's name AN20 Pierre Dupont token Alias of the card number. The version must be greater than or equal to 3 AN19 1111gPNzHtyu4444 In response card type used from XPay : TOKEN ou CARD_PAN Object extendedCardType Field Description Format Example country Card country issuer : CODE ISO AN3 FRA isCvd The card is it a Virtual Carte : Y or N AN1 Y bank The bank of the card used for payment AN50 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 MASTERCARD product Indicates the category to which the card type belongs: see product codes AN100 Gold/Premier Object order Field Description Mandatory Type Example ref Order reference. AN50 12345678 origin Type of order with the values : No AN country Code of the country in which the order is done, see the list No AN2 FR taxes The amount of tax added to the order in the smallest currency unit. No N12 100 amount The amount of order in smallest unit of currency. Yes N12 6000 currency Currency code used for order. The ISO code : 978: euros See complete list in List of currencies Yes N3 date The merchant order date. Format : dd/mm/yyyy HH24:MI Yes AN16 details Information about the ordered items. The order details is limited to 100 items. No deliveryTime Delivery time : Values for deliveryTime No N 1 deliveryMode Delivery method : Values for deliveryMode No N 4 Expected delivery date must be greater than the current date. Format: dd/mm/yyyy version 21 or higher version 21 or higher version 21 or higher version 21 or higher version 21 or higher Additionnal information about the order. In JSON format AN in JSON format version 21 or higher (3DSV2) Online Travel Agency information. AN in JSON format See Object OrderOTA version 21 or higher 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 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 some payment methods No AN255 LegalAge=18;Discount=0105 taxRate Item tax rate (expressed in hundredths). Format : 1580 for 15.8% No N4 1580 Type of seller. Values : 1: Professional Object paymentAdditionalList Field Description Mandatory Format Example paymentAdditional List containing paymentAdditional Number of items 0 to 100 Object paymentAdditional Field Description Mandatory Type Example transaction Transaction Information Yes authorization Authorization information Yes authentication3DSecure Information on the 3Dsecure of the operation No Object wallet Field Description Mandatory Type 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. This identifier will be used when you 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 Buyer card information For createWallet either card or transactionID are mandatory. createWallet:No other WS : Yes Possible values: Indicates the scheme to be used for processing the transaction: Not taken into account if the cardBrand given does not fit with the schemes actually handling the card. Object address Field Description Required Format title Title, see table values No AN2 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 AN12 country Country, see table values No AN2 phone Phone No AN15 state No AN100 Specificity of ShippingAdress: For electronic delivery, the email address to which the merchandise is delivered. version 21 or higher (3DSV2) RELEASE 4.58 version 21 or higher (3DSV2) RELEASE 4.58 Object card
PAYLANO-5380
-
Détails de la demande en cours d'obtention...
ÉTAT
Object contractNumberWalletList Field Description Required Format Example 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 bankCode No AN10 Bank number No AN Used only for ELV Object subMerchant Object available in version 18 or higher of web services Field Description Type Amex subMerchantId Identifier of the sub-market (final beneficiary) defined by the payment provider (Payment Facilitator). M AN15 subMerchantName Sub-merchant's name : see Payment Facilitator. M AN15 subMerchantMCC MCC Code M N4 subMerchantSIRET SIRET (French merchants) O AN14 subMerchantTaxCode Tax code (US and Canadian merchants) AN subMerchantStreet Street name M AN30 subMerchantCity City M AN15 subMerchantZipCode Postal code M AN15 subMerchantCountry Country code M AN2 subMerchantState O AN3 Phone number Object buyer Field Description Mandatory Type Example lastName Buyer's surname No AN50 firstName Buyer's first name No AN50 email Buyer's email address No AN150 shippingAdress Delivery address. No billingAddress Billing address No 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 virtual wallet identifier 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 card to use. No AN2 1 ip Buyer's IP address. Format : IPv4 or IPv6 Conditionnal AN50 mobilePhone The mobile number of the buyer No N15 0033691666666 customerId Customer ID No AN50 894492568 2016-04-27 0 : No program from version 21 or higher (3DSV2) RELEASE 4.58 from version 21 or higher (3DSV2) RELEASE 4.58 from version 21 or higher (3DSV2) RELEASE 4.58Condition
Other code: Transaction not accepted.partnerCode Return code from partner (payment method) and SAA acquirer AN50 From version 14 partnerCodeLabel Description of the partner error code AN255 From version 14 Field Description Format Example Condition id Unique Payline transaction identifier AN50 date AN17 Suivi les webservices le format peut changer. isDuplicated
0 = no duplicate detectedAN1 1 isPossibleFraud
0 = No risk of fraud detectedAN1 1 fraudResult Fraud Code AN50 fraudResultDetails Fraud Details Object fraudResultDetails explanation Reason for refusal in case of fraud AN50 threeDSecure
N = Non-3DS Transaction
D = 3DS Downgraded by issuer (Version 14 or higher)AN1 softDescriptor AN64 www.boutique.fr score Fraud scoring value : Score from 0 to 10 N5 2 scoring Activated with subscription for Clearsale Object scoring externalWalletType Type of wallet used during the transaction. Ex : V.Me, Masterpass AN20 Masterpass Not used in doAuthorization externalWalletContractNumber VAD contract number associated with Wallet payment AN50 Not used in doAuthorization PartnerAdditionalData AN avs AVS Address Verification Service object avs version 17 or higher customerId For specific use only. AN version 23 or higher type For specific use only. AN version 23 or higher orderReference For specific use only. AN version 23 or higher payment For specific use only. object payment version 23 or higher pointOfSell For specific use only. object pointOfSell version 23 or higher card For specific use only. object card version 23 or higher extendedCard For specific use only. object extendedCard version 23 or higher Field Description Format Example code
01xxx: Transaction refused
021xx: Internal Error
cf. complete list in the appendix table "Return codes"N5 shortMessage Message court du résultat de la transaction AN50 ACCEPTED longMessage Message du résultat de la transaction AN255 Transaction approved Condition Yes Yes Yes Yes Conditionnal No No
Ex : CB, PAYSAFECARDsoftDescriptor
Special characters (not A..Z and 1..9) are specific to each acquirer / payment method.No AN64 www.boutique.fr 
Not supported by all banks. Please check Soft Descriptor (DSD)cardBrand No AN 15 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 cumulatedAmount No N12 Mandatory Yes Yes authorizedAmount Amount authorized in transaction : 100 is 1,00 Euro No AN 100 authorizedCurrency Amount used in transaction. No AN 978 reattempt response to the authorisation request in version 1.6.2 from CB2A. No Object - reattempt Mandatory Conditions Yes
For an amount of 100 €, you must set the value 10000.Yes
0: future deadline.
1: accepted deadline
2: deadline refused.
3: current deadline (a retry is scheduled after one or more failures).Yes No No Object - transaction No No version greater than or equal to 8 No version greater than or equal to 8 Condition No W : Wallet UEP typeSecurisation Field used as information for authentication.This field is no longer used. No AN10 20 : VADS
else 9 : VADPaResStatus No AN1 Provided Version 27 in response services. VeResStatus No AN1 Provided Version 27 in response services. resultContainer No AN2048 Version 21 or higher (3DSV2) authenticationResult NOT USED Mandatory Condition No No No No No panType No AN TOKEN API version 22 or superior (4.60.1 ). AN20 Condition
This reference must be unique since it is used in duplicate request check.
The back slash character ("\") is forbidden.Yes
An amount of 1 € corresponds to 100.
An amount of 60 € corresponds to 6000. From version 28 of the API, this field must contain the amount to be authenticated (3DSV2)
840: US dollars978 07/04/2016 11:00 deliveryCharge Amount of delivery charges in smallest unit of currency, example 250 for 2.50 euros No N version 18 ou higher deliveryExpectedDate No datetime 07/04/2016 Posted to Limonetik deliveryExpectedDelay Expected delivery time (in days) No N2 10 Posted to Limonetik discountAmount Amount of the discount for this order (in the same currency than the order) No N12 OTAPackageType Type of package (flight only, journey+accomodation, …). See the table of values Codes - OTAPackageType No N2 OTADestinationCountry Country code of the destination, in ISO 3166-1 format. See the table of values Codes - country No AN2 bookingReference Booking reference or Id of the travel file No AN100 orderDetail Used only for origin = MO or TO. No AN4 orderExtended No orderOTA No Condition See table values seller Name or id of the final seller No AN100 Release 4.58 - version 21 or higher merchant.com sellerType
2: Private sellerNo N2 Release 4.58 - version 21 or higher 1 payment Payment Information Yes Object - payment card Buyer card information Yes Object cardOut extendedCard Buyer card information No Object - extendedCardType Example lastName The name of the buyer. This information is useful for finding a wallet in the Administration Center. No AN100 email AN150 card Object - card comment Comments No AN255 default Card used by default No AN1 Y or N: Default card cardStatus
- EXP: Date expired
- OPP: card blocked (lost/stolen/...)
- MAN: manual deactivation
- INT: internal rulesNo AN3 EXP cardBrand Code Description CB CB VISA VISA MASTERCARD MASTERCARD MAESTRO MAESTRO BCMC BCMC No N1 CB from version 15 Condition streetNumber Street number No N State county Région No AN15 phoneType Phone category, see table values No N1 email No AN150 addressCreateDate Creation date of the address in the merchant's system No AN10 Condition countryCode Country code No AN Country code of the account number accountNumber key IBAN account No AN Presence (Mandatory/Optional/Conditional) Conditions and notes CB MSC VISA iDEAL M M M M Limited to 15 char from version 26 or higher (was 25 char in version 18-25) M M M O O C C Mandatory for countries USA and CAN.
It is up to the Payment Facilitator to determine whether that information should be provided or not.O O O M see the list of values State O subMerchantEmailAddress Email M ANS40 subMerchantPhoneNumber M AN20 Condition title Title of civility, See the table of values No AN1 Do not put more than 12 consecutive digits (eg test123456789101@test.test ) Object Address Mandatory for wallet payment
See the table of valuesThe index, default value "1" Mandatory in a verifyEnrollmentRequest for browser based authentication. Clearsale: This data can be an identifier or an email legalStatus Legal status of the customer: person or company No N1 1 Clearsale: see the table of value. legalDocumentType Type of document : See the table of values No N1 1 legalDocument Identification number of the official document No AN100 X5446119U birthDate Birth date. Format: yyyy-mm-dd No AN10 fingerprintID ID Device 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 loyaltyMemberType Values :
1 : Standard/Normal
2 : Silver
3 : Gold/Premium
4 : Platinium
9 : Subscription in progress
99 : Special or OtherNo N2 0 buyerExtended Past events about buyer. See below for more information about buyerExtendedHistory No AN { "loyaltyMemberId": "buyerExtLoyMemId", "buyerExtendedHistory": {...}}merchantAuthentication Information about cardholder to authenticate to the merchant No Object merchantAuthentication