- Created by Guillaume VENTRE, last modified by Rodolphe GARIN on 20 Nov 2024
Request |
Introduction
The doWebPayment function initialises a web payment before Payline begins payment flow. This allows immediate or deferred full payments, instalments payments, and subscription payments to be made.
We recommend using notification by URL.
This notification functionality will only be used to manage cases of non-return to the merchant's shop.
The notification URL allows you to be informed of the end of a payment attempt on your pages so that you can extract the result of the transaction.
If the automatic return to the shop does not work, the notification will alert you so that you can retrieve the result of the transaction.
Once you have retrieved the final result of the transaction using the getWebPayment service, the notification will not be sent.
You must retrieve the final result of the transaction as soon as the buyer returns to the shop, without waiting for the notification.
Full payments allow you to carry out an authorisation+validation or a simple authorisation. If using simple authorisation, validation (or capture) takes place either automatically by the Payline payment solution, or by the merchant, using webservice calls or via our back office Payline administration centre. This can also be programmed from the authorisation request, always within 7 days, using the batch interface function or the doCapture web service by entering the date of action.
NOTE : With a debit authorization, you have up to 7 days to validate the payment request. Outside of those 7 days, your authorization expires and is no longer valid.
The notifications
To be informed that your customer has paid once the authorization request has been accepted, even if the customer does not return to your site, fill in the notificationURL field in your point-of-sale settings or when you make a web payment initialisation request. Payline will then contact a page from your site and send back the token linked to the payment in the GET parameter of the HTTP request. This page must be accessible by Internet using the HTTP/S protocol.
When a notification is received, your site must carry out a result request for the notified web payment.
NOTE : If your site cannot be accessed, Payline tries every minute during 2 hours. After this, notification is deactivated. You can find your payments in the Merchant Administration Centre web interface.
Instalments or subscription payment is possible using a virtual wallet.
Payline takes charge of the creation of a virtual wallet after the validation of data collected at first payment. When the customers make a second purchase on your online store, Payline suggests that they use their virtual wallet. In this case, “one click” payment is used and the customer does not need to enter any payment information.
Payline can manage instalment payments. When payment is carried out, you can be advised by email by activating the “send an email to merchant” option in the Merchant Administration Centre. If there is a problem with payment, Payline tries the transaction 3 times during one week. Each time an attempt fails, you are informed.
Alternative payment method : this feature allows the merchant, in case of bank refusal, to offer his customers to pay with another means of payment.
This function only applies: for the same order, at the time of the first payment and in the event of a bank refusal. A list of alternative payment methods must have been provided in doWebPayment (secondSelectedContractList).
Request
The doWebPaymentRequest request must have the following structure:
Element | Description | Required | Format | Example | Condition |
version | Payline web services version. To be valued with the latest version: see the table of versions. | Yes | N2 | 18 | |
payment | Information regarding payment. | Yes | Object payment | Possible values of payment.action = 100, 101, 108, 110, 120, 121. | |
order | Order Information. | Yes | |||
returnURL | URL on which the shopper's browser is used in case of acceptance or refusal of payment on Payline. | Yes | AN2048 | http: // ... or https: // ... | The URL can only contain one # symbol (max). |
cancelURL | URL on which the shopper's browser is used in case of cancellation by the user, Payline or merchant. | Yes | AN2048 | http: // ... or https: // ... | The URL can only contain one # symbol (max). |
notificationURL | URL on which Payline will ask the merchant site to retrieve the result of the transaction. | No | AN2048 | http: // ... or https: // ... | |
selectedContractList | The list of contract you wish to use for this payment. Payline displays the list of payment methods according to the list order. | Yes | Mandatory from version 4 | ||
secondSelectedContractList | The list of contract numbers that you want to be able to resubmit when the first transaction attempt fails. If this field is not filled in, Payline will not resubmit a payment method when the first transaction attempt fails. | No | |||
privateDataList | Your own personal information. | No | |||
languageCode | Fill in this field with the ISO 639-1 code of the language in which you want to display the Payline payment web pages. By default, the web browser of your shopper asks Payline for the page in the desired language : cf. complete list language code. | No | AN2 | en | |
customPaymentPageCode | The identifier of customization pages template. | No | AN50 | 1fd51s2dfs51 | |
buyer | Buyer information. | Yes | Object buyer | Mandatory version 22 or higher | |
owner | Cardholder Information. | No | Applicable only for AMEX | ||
securityMode | Selecting the security mode to use for the payment transaction. | Yes | AN | SSL | |
recurring | Recurring payment information. | No | |||
customPaymentTemplateURL | Dynamic template URL. | No | AN255 | https: // .... only | |
contractNumberWalletList | A chart of the contract numbers of the wallet. The Widget mode uses the multi-PDV Wallet and multi-contract. | No | Not used in Widget mode. | ||
merchantName | Name displayed on the ACS authentication page. | No | AN25 | WebShop | |
subMerchant | Payment Facilitator Information. | No | Object subMerchant | version 18 or higher | |
miscData | Additional data , without character limit and transmitted to the partners. Consult the payment method for each use. | No | AN | version 18 or higher | |
asynchronousRetryTimeout | For the Asynchronous Retry function , this is a numeric that specifies the period in minutes. It must be between 5 and 10080 (7 days). | No | AN | 10080 | version 19 or higher |
threeDSInfo | Information specific to 3DS authentication. | No | Object threeDSInfo | version 21 or higher (3DSV2) | |
merchantScore | Score calculated by the merchant (Used exclusively for CB Scoring). | No | AN | version 21 or higher (3DSV2) | |
skipSmartDisplay | Use to skip the smartdisplay rules : see Règles d'affichage de vos moyens de paiements. | No | Boolean | Version 28 or higher |