Webservice - doRecurrentWalletPaymentRequest

S’abonner

La fonction « doRecurrentWalletPayment » enregistre un dossier de paiement pour une facturation automatique et récurrente de votre client. Payline traite, jour par jour, les échéances à réaliser et vous informe du résultat par la fonction de notification. 

Le dossier de paiement est caractérisé par :

  • les informations d’un portefeuille virtuel existant
  • des échéances de paiement : un montant, une devise, une date d’échéance, un statut, etc.

L’enregistrement du dossier de paiement est refusé dans les cas suivants :

  • L’identifiant du portefeuille virtuel fourni n’existe pas ou le portefeuille est inactif
  • Le montant du champ payment.Amout n’a pas la bonne valeur
  • Le mode de paiement n’est pas accepté

Dans le cas où la date d’expiration de la carte bancaire ne couvre pas l’intégralité des échéances à venir, Payline vous alerte par le code retour 02506.

Un paiement est refusé uniquement si la demande d’autorisation est refusée.

Requête à envoyer


La requête « doRecurrentWalletPaymentRequest» doit avoir la structure suivante :

Élément

Description

Requis

Type

Exemple

version

Version des web services Payline

oui

N2

A valoriser avec la dernière version : voir le tableau des versions.

paymentInformations sur le paiementouiObject - payment

Voir les éléments ci-dessous

orderRefRéférence commandeouiAN50 
orderDateDate de la commandeouiAN16Format : dd/mm/yyyy hh:mm
scheduledDateLa date souhaitée pour la demande d’autorisationouiAN10Format : dd/mm/yyyy
walletIdL’identifiant unique du portefeuille virtuel. C’est l’identifiant que vous avez communiqué lors de la demande de création du portefeuille.ouiAN50 
cardInd

Ce champ est obligatoire si vous utilisez les multi-wallet

nonN2L’index de la carte, valeur par défaut ‘01’ si la carte par défaut est modifié le dossier de paiement garde la carte initiale.
recurringInformation sur les échéancesouirecurring objectVoir les éléments ci-dessous

privateDataList

Information sur les informations personnelles

non

Object PrivateDataList

Voir les éléments ci-dessous

order

Information sur la commande

nonObject - orderVoir les éléments ci-dessous

media

Détection du média utilisé lors du paiement.

Les valeurs possibles de cette balise sont :

-       Computer
-       Mobile
-       Tablet
-       TV
-       Console
-       Undefined

non

AN25

Mobile

Les éléments de référence

Object payment


Field

Description

Prerequisites

Format

Example

Condition

amount

Information passed when calling the doWebPayment function. The value 100 corresponds to 1 €

Yes

N12

100


currency

Currency of payment

Yes

N3

978


action

Action Code

Yes

N3

100

see the table

mode

Payment mode

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. 
Format : dd/mm/yy

No

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

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. 
Special characters (not A..Z and 1..9) are specific to each acquirer / payment method.

NoAN64www.boutique.frversion 13 or higher
cardBrand

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.

NoAN15

version 15 or higher

see table


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.
NoAN

version 18 ou supérieure

RELEASE 4.53

 

Object reccuring

Erreur du rendu de la macro 'excerpt-include' : No link could be created for 'recurring object'.


Object order


Field

Description

Mandatory

Type

Example

Condition

ref

Reference of order. This reference must be unique because it is used for control in duplicate request. 
The \ character is forbidden.


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

FR


taxes

The amount of taxes on the order in smallest unit of currency. 
An amount of 1 € corresponds to 100

No

N12

100


amount

The amount of order in smallest unit of currency. Usually the same amount as payment.amount. 
An amount of 60 € corresponds to 600

Yes

N12

6000


currency

The ISO code of payment currency:

978: euros 
840: US dollars

cf. complete list in the appendix table "List of currencies"

Yes

N3

978

date

The merchant order date.  Format : dd / mm / yyyy HH24: MI

Yes

AN16

07/04/2016 11:00

details

Information about the ordered items

No

Object OrderDetails



deliveryTime

Delivery time :

1 = express 
2 = standard

No

N

1


deliveryMode

Delivery method :

1: Withdrawal of goods from the merchant 
2: Use of network of points-withdrawal third (type kiala, alveol, etc.) 
3: Withdrawal in airport, station or travel agency 
4: Carrier (La Poste , Colissimo, UPS, DHL ... or any private carrier) 
5: Issuing an electronic ticket, downloads

No

N

4


deliveryChargeAmount of delivery charges in smallest unit of currency, example 250 for 2.50 eurosNoN
version 18 ou supérieure
deliveryExpectedDate

Expected delivery date must be greater than the current date. Format: dd/mm/yyyy

NoAN1807/04/2016Posted to Limonetik
deliveryExpectedDelayExpected delivery time (in days)NoN210Posted to Limonetik


Object privateDataList


Field

Description

Mandatory

Format

Example

privateData

List containing privateData

Number of items 0 to 100

Yes

Object - privateData


 

Object privateData


Field

Description

Mandatory

Format

Example

key

Key name of value

Yes

AN50

user

value

Key value

Yes

AN50

Martin


Réponse en retour

La réponse a la structure suivante :

Élément

Description

Requis

Format

Exemple

Condition

result

Information sur le résultat de la demande de paiement programmé par wallet :

02500 : Operation successfull
02501 : Operation successful with warning
02502 : Wallet with the same ID exist
02503 : Wallet does not exist
02505 : Wallet is disabled
02509 : Invalid recurring option

oui

Object result

Voir les éléments ci-dessous


paymentRecordId

L’identifiant du dossier de paiement créé

oui

N12



billingRecordListInformation sur la factureouiObject - billingRecordListVoir les éléments ci-dessous


Les éléments de référence

Object result

Erreur du rendu de la macro 'excerpt-include' : No link could be created for 'Object result'.


Object billingRecordList


Field

Description

Mandatory

Format

Exemple

Condition

billingRecord

Invoice information

Number of occurrences: 0 to 100


object billingRecord






Object billingRecord


Field

Description

Mandatory

Format

Example

Conditions

date

The date of the expiry, Format: dd/mm/yyyy

Yes

AN10



amount

The amount of maturity in the smallest unit of the currency.
For an amount of 100 €, you must set the value 10000.

Yes

N12

10000


status

The status of deadline. Values : 
0: future deadline. 
1: accepted deadline 
2: deadline refused. 
3: current deadline (a retry is scheduled after one or more failures)

Yes

AN1

0


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

No

result object

00000


transaction

Payline transaction information

Notransaction object



authorization

Information about the authorization issued by the acquirer authorization server


No

Object - authorization



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



 

Vous avez d’autres questions ? Envoyer une demande

Commentaires

Réalisé par Zendesk