Content

Sommaire

maxLevel	2
style	none

Presentation

In Widget mode, Payline offers to manage the installments, first you call doWebPayment service and read the result with getWebPaymentDetails service.

Step 1: Initialize the web payment request

This step is realized with the doWebPayment web service.

Développer

title	Les balises à utiliser..

Element	Description	Required	Type	Example
payment.mode	Mode de paiement : comptant, différé, N fois, récurrent.	Method of payment: cash, deferred, installment, recurring.	yesoui	AN3	NX : N fois installment
recurring.firstAmount	Le montant du premier montant à effectuer. Il doit être formulé dans la plus petite unité de la devise.	The amount of the first amount to be realized. It must be done in the smallest currency unit.	NoNon⁴	N12	pour un montant de 100 €, vous devez mettre la valeur 10000.
recurring.amount	Le montant d’une échéance. Il doit être formulé dans la plus petite unité de la devise.	The first installment amount. It must be done in the smallest currency unit.	yesOui⁴	N12	pour un montant de 5 €, vous devez mettre la valeur 500.
recurring.billingCycleLe	code de la fréquence des paiementsThe code for the frequency of payments.	Ouiyes⁴	N2	40 : mensuel monthly 60 : trimestriel quarterly see list cf. liste complète
recurring.billingLeft	Nombre d’échéance	Number of installment	noNon⁴	N3	3
recurring.billingDay	Jour où les échéances doivent être traitées.	Day on which the deadlines must be processed.	noNon	AN2	Format à respecter : dd de [01 à 30]
recurring.startDate La date de la première échéance. Si ce champ n’est pas renseigné, Payline y affecte la date du jour.	The date of the first due date. If this field is not filled in, Monext assigns the current date to it.	noNon⁴	AN10	Format à respecter : dd/mm/yyyy

Développer

title	Voici un extrait d’appel au web service doWebPaymentHere is an extract from the call to the doWebPayment web service...

Bloc de code

language	xml
theme	Eclipse

<impl:payment>
  <obj:amount>150000</obj:amount>
  <obj:currency>978</obj:currency>
  <obj:action>100</obj:action>
  <obj:mode>NX</obj:mode>
  <obj:contractNumber>1234567</obj:contractNumber>
  <obj:differedActionDate />
</impl:payment>
….
<impl:recurring>
   <obj:firstAmount>50000</obj:firstAmount>
   <obj:amount>50000</obj:amount>
   <obj:billingCycle>40</obj:billingCycle>
   <obj:billingLeft>3</obj:billingLeft>
   <obj:billingDay>05</obj:billingDay>
   <obj:startDate></obj:startDate>
</impl:recurring>

Step 2: Read the details of the transaction

Cette étape est réalisée avec le web service getWebPaymentDetails.

This step is performed with the getWebPaymentDetails web service.

For each deadline Pour chaque échéance (billingRecord):

Développer

title	Les balises à utiliser..

ElementÉlément	CommentaireComment	Format	ExempleExample
billingRecord.date	La The due date de l’échéance	AN10	Format : dd/mm/yyyy
billingRecord.amountLe montant de l’échéance dans la plus petite unité de la devise	The amount of the due date in the smallest currency unit .	N12
billingRecord.status	Le statut d’une échéance The status of a deadline:0 : échéance à venir 0: due date to come. 1 1: échéance accepté deadline accepted. 2 2: échéance refusé deadline refused.	AN1
billingRecord.result.codeLe code de retour du traitement de l’échéance	The return code for processing the due date: 00000 : Transaction approved 01xxx : Transaction refused 02302 : Transaction invalid	N5cf. liste complète	check the list
billingRecord.result.shortMessage	Message court du résultat de la Short message of the result of the transaction	AN50
billingRecord.result.longMessage	Message du résultat de la transactionTransaction result message	AN255
billingRecord.transaction.IdIdentifiant unique	de la transaction PaylineUnique identifier of the Payline transaction	AN50
billingRecord.transaction.isPossibleFraudCet indicateur est calculé en fonction des critères définis par le commerçant	This indicator is calculated according to the criteria defined by the merchant	AN1	1 = Il existe un risque de fraude There is a risk of fraud 0 = Aucun risque de fraude détecté No risk of fraud detected
billingRecord.transaction.isDuplicatedCet indicateur	est retourné par Payline dans le cas de transaction en doublonThis indicator is returned by Payline in the case of a duplicate transaction	AN1	1 = Il existe un risque de fraude There is a risk of fraud 0 = Aucun risque de fraude détecté No risk of fraud detected
billingRecord.transaction.date	Date et heure de la transaction Paylineand time of the Payline transaction	AN16	Format :dd/mm/yyyy HH24:MI
billingRecord.authorization.numberNuméro d’autorisation délivré par le serveur d’autorisation acquéreur. Ce champ est renseigné si la demande d’autorisation est accordée*.	Authorization number issued by the acquiring authorization server. This field is completed if the authorization request is granted *	N6	123456
billingRecord.authorization.date	Date et heure de l’autorisationand time of authorization	AN16	Format :dd/mm/yyyy HH24:MI

Développer

title	Un exemple de lecture du détail de la An example of reading the details of the transaction..

Voici un exemple d’extrait de la réponse du web service getWebPaymentDetails.Here is an example of the response from the web service getWebPaymentDetails

Bloc de code

language	xml
theme	Eclipse

<billingRecordList>

<billingRecord xmlns="http://obj.ws.payline.experian.com">
      <date>10/09/2013</date>
      <amount>50000</amount>
      <status>1</status>
      <result>
            <code>00000</code>
            <shortMessage>Transaction approved</shortMessage>
            <longMessage>Transaction approved</longMessage>
      </result>
      <transaction>
            <id>10910171316416</id>
            <date>10/09/2013 17:13</date>
            <isDuplicated/>
            <isPossibleFraud/>
      </transaction>
      <authorization>
            <number>A55A</number>
            <date/>
      </authorization>
</billingRecord>

<billingRecord xmlns="http://obj.ws.payline.experian.com">
      <date>05/10/2013</date>
      <amount>50000</amount>
      <status>0</status>
</billingRecord>

<billingRecord xmlns="http://obj.ws.payline.experian.com">
      <date>05/11/2013</date>
      <amount>50000</amount>
      <status>0</status>
</billingRecord>

</billingRecordList>

Read the detail of the result of a deadline

Suite à la notification d’une échéance, vous devez venir chercher le résultat de la transaction en appelant le web service getPaymentRecord avec l’identifiant du dossier de paiement reçu en paramètre de l’URL de notificationFollowing the notification of a due date, you must collect the result of the transaction by calling the getPaymentRecord web service with the identifier of the payment file received as a parameter of the notification URL.

Développer

title	Un exemple de requêteExample..

Bloc de code

language	xml
theme	Eclipse

<impl:getPaymentRecordRequest>
  <impl:contractNumber>7891234</impl:contractNumber>
  <impl:paymentRecordId>185321</impl:paymentRecordId>
</impl:getPaymentRecordRequest>

Deactivate a payment record

Pour désactiver un dossier de paiement, vous devez réaliser un appel au web service disablePaymentRecordTo deactivate a payment record, you must make a call to the disablePaymentRecord web service.

Développer

title	Voici un exemple d’appel à ce Here is an example of a call to this web service..

Bloc de code

language	xml
theme	Eclipse

<impl:disablePaymentRecordRequest>
     <impl:contractNumber>7891234</impl:contractNumber>
     <impl:paymentRecordId>185531</impl:paymentRecordId>
</impl:disablePaymentRecordRequest>

Modify an installment

Changing a By clicking on the "Modify

a deadline

La modification d’une échéance peut être réalisée sur le centre d’administration.

Pour cela, il faut vous rendre dans l’onglet « Paiement récurrent » / « Gestion des dossiers de paiements », rechercher votre dossier de paiement avec son numéro.

" link from a deadline, you have access to this screen:can be done on the backoffice.

To do this, go to the "Recurring payment" / "Management of payment files" tab, find your payment file with its number.

In the details of the payment file, you can see your upcoming deadlinesDans le détail du dossier de paiement, vous pouvez consultez vos échéances à venir :

En cliquant sur le lien « Modifier » à partir d’une échéance, vous avez accès à cet écran :

Vous pouvez modifier le montant et/ou la date de l’échéance à partir de cet écranYou can change the amount and / or the due date from this screen.

The timetable display

La fonction en mode Widget est : The function in Widget mode is:

Développer

title	ExempleExample..

Bloc de code

language	xml
theme	Confluence

Payline.Underscore.forEach( Payline.Api.getRecurringDetails().schedules, function(key, value) { console.log(value + " " + key) } );

Le format de l'échéancier : The format of the schedule:

Développer

title	ExempleExample..

Bloc de code

language	xml
theme	Confluence

{
  "schedules": {
    "24/05/2018": "5,00 EUR",
    "31/05/2018": "5,00 EUR",
    "07/06/2018": "5,00 EUR",
    "14/06/2018": "5,00 EUR",
    "21/06/2018": "5,00 EUR",
    "28/06/2018": "5,00 EUR",
    "05/07/2018": "5,00 EUR",
    "12/07/2018": "5,00 EUR",
    "19/07/2018": "5,00 EUR",
    "26/07/2018": "5,00 EUR",
    "02/08/2018": "5,00 EUR",
    "09/08/2018": "5,00 EUR",
    "16/08/2018": "5,00 EUR",
    "23/08/2018": "5,00 EUR",
    "30/08/2018": "5,00 EUR",
    "06/09/2018": "5,00 EUR",
    "13/09/2018": "5,00 EUR",
    "20/09/2018": "5,00 EUR",
    "27/09/2018": "5,00 EUR",
    "04/10/2018": "5,00 EUR"
  },
  "type": "NX",
  "billingNumber": 20,
  "firstAmount": "5,00 EUR",
  "billingCycle": "Hebdomadaire",
  "amount": "5,00 EUR"
}

L'affichage de la page de paiement résume les informations de l'échéancier : The payment page display summarizes the schedule information:

Développer

title	ExempleExample

Le ticket de paiement reprend les informations de l'échéancier de paiement : The payment receipt contains the information of the payment schedule:

Pages linked

Contenu par étiquette

showLabels	false
showSpace	false
sort	title
cql	label in ("nfois","3x4x") and label in ("pageweb","paiementdirect","centreadmin","webservice","demarrage","fraude") and space = "DT"

Arborescence des pages

Comparaison des versions

Ancienne version 1

Nouvelle version 2

Légende

Presentation

Step 1: Initialize the web payment request

Step 2: Read the details of the transaction

Read the detail of the result of a deadline

Deactivate a payment record

Modify an installment

The timetable display

Pages linked

Arborescence des pages

Historique de la page

Comparaison des versions

Ancienne version 1

Nouvelle version 2

Légende

Presentation

Step 1: Initialize the web payment request

Step 2: Read the details of the transaction

Read the detail of the result of a deadline

Deactivate a payment record

Modify an installment

The timetable display

Pages linked