Webservice - getPaymentRecordResponse

S’abonner

Le message « getPaymentRecordResponse » est la réponse faite par Payline à une demande d’information sur un dossier de paiement. Il vous permet d’obtenir entre autres les échéances associées au dossier de paiement. La réponse a la structure suivante :


La réponse a la structure suivante :

Élément

Description

Requis

Format

Exemple

Condition

result

Information sur le résultat de la demande d'information sur un dossier de paiement :

02500 : Operation successful
02507 : Can not found payment record

oui

Object result

Voir les éléments ci-dessous


recurringrecurringouiObject recurringVoir les éléments ci-dessous
isDisabled

Le statut du dossier de paiement

0 : actif

1 : inactif
nonAN1

disableDateLa date de désactivation du dossier de paiementnonAN14

billingRecordListInformation sur le tableau d’échéancesnonObject billingRecordListVoir les éléments ci-dessous
privateDataListInformation sur les données personnellesnonObject privateDataListVoir les éléments ci-dessous
orderInformation sur la commandenonObject orderVoir les éléments ci-dessous
walletIdIdentifiant du portefeuille utiliséouiAN50

Les éléments de référence

Object result


Élément

Description

Format

Exemple

code

Le code de retour du web service :

Opération acceptée : 00000, 02400, 02500, 02501, 02517, 02520 ,02616, 03000, 04000.

Autre code : Transaction non acceptée

N5

Voir le détail des Codes retour Payline

shortMessage

Message court du résultat de la transaction

AN50


longMessage

Message du résultat de la transaction

AN255


partnerCodeCode retour issu du partenaire (moyen de paiement) et de l'acquéreur SAAAN50à partir de la version 14
partnerCodeLabelLibellé du partenaireAN255à partir de la version 14


Object recurring

ÉlémentDescriptionRequisFormatExemple 

firstAmount

Le montant du premier montant à effectuer. Il doit être formulé dans la plus petite unité de la devise.

non

N12

pour un montant de 100 €, vous devez mettre la valeur 10000.

 

amount

Le montant d’une échéance. Il doit être formulé dans la plus petite unité de la devise.

oui

N12

pour un montant de 5 €, vous devez mettre la valeur 500.

 

billingCycle

Le code de la fréquence des paiements.

 

oui

N2

40 : mensuel
60 : trimestriel

cf. liste complète en annexe tableau « Liste des fréquences de paiement »

 

billingLeftNombre d’échéancenonN33 
billingDayJour où les échéances doivent être traitées.nonAN2Format à respecter : dd 

startDate

La date de la première échéance (uniquement en mode REC). Si ce champ n’est pas renseigné, Payline y affecte la date du jour.

 

non

AN10

Format à respecter : dd/mm/yyyy

 

endDateLa date de la fin des échéances des paiementsnonAN16

Format à respecter : dd/mm/yyyy

HH24:MI

 
newAmountNouveau montant modifiénonN12pour un montant de 60 €, vous devez mettre la valeur 6000. 
amountModificationDateLa date de la modification du montantnonAN16

Format à respecter : dd/mm/yyyy

HH24:MI

 

 

Exemple :

Paiement en mode=REC avec les valeurs suivantes :

  • recurring.billingCycle=40 (mensuel)
  • une carte CB
  • sur 24 mois avec des echéances à chaque fin du mois 
  • recurring.billingDay=31
  • recurring.EndDate=date du jour +2 ans

La première transaction est effectuée à la date du jour puis tous les mois, en fin de mois pendant 2 ans jusqu'à la endDate.

Pour les mois pairs et le mois de février, le jour retenu lors de la création des échéances est 30 pour les mois pairs et 28 ou 29 pour février.



Object billingRecordList


Élément

Commentaire

Requis

Format

Exemple

Conditions

billingRecord

Information de la facture

Nombre d’occurrence : 0 à 100

--

object

 

 



Object billingRecord


Élément

Commentaire

Requis

Format

Exemple

Conditions

date

La date de l’échéance

oui

AN10

Format : dd/mm/yyyy


amount

Le montant de l’échéance dans la plus petite unité de la devise.

oui

N12

pour un montant de 100 €, vous devez mettre la valeur 10000.


status

Le statut d’une échéance

oui

AN1

0 : échéance à venir.
1 : échéance acceptée.
2 : échéance refusée.
3: échéance en cours (une retentative est programmée après un ou plusieur échecs)


result

Le code de retour du traitement de l’échéance

non

Object

cf. liste complète en annexe tableau « Liste des codes retours »

00000 : Transaction approved
01xxx : Transaction refused
02302 : Transaction invalid


transaction

Informations de la transaction Payline

nonObject



authorization

Informations sur l’autorisation délivré par le serveur d’autorisation acquéreur


non

Object



nbTry

Nombre de tentatives de paiement effectuées

non

N3


version supérieure ou égale à 8

rank

Rang de l’échéance au sein du dossier de paiement.

Permet la modification via updateBillingRecord

non

N12


version supérieure ou égale à 8




Object privateDataList

Élément

Description

Requis

Format

Exemple

privateData

Liste contenant les privateData

Nombre d'élément 0 à 100

oui

Object privateData

 


Object privateData

Élément

Description

Requis

Format

Exemple

key

Le nom de la clef de la valeur

oui

AN50

user

value

Valeur associée à la clef

oui

AN50

dupond or durand, etc.


Object order


Élément

Description

Requis

Type

Exemple

Condition

ref

Référence de la commande. Cette référence doit être unique car elle est utilisée pour le contrôle dans demande en double.
Le caractères \ est interdit.

Oui

AN50

12345678


origin

Origine de la commande. Si vous avez souscrit à l’option Mail Order et Téléphone Order alors les valeurs sont MO ou TO.

Non

AN50

SVI_#12


country

Code du pays dans lequel la commande a été effectuée, voir la liste.

Oui

AN3

FR


taxes

Le montant des taxes sur la commande dans la plus petite unité de la devise.
Un montant de 1 € correspond à 100

Non

N12

100


amount

Le montant de la commande dans la plus petite unité de la devise. Généralement le même montant que payment.amount.
Un montant de 60 € correspond à

Oui

N12

6000


currency

Le code ISO de la devise du paiement :

978 : euros
840 : dollars US

cf. liste complète en annexe tableau « Liste des devises »

Oui

N3

978

date

La date de la commande chez le commerçant :

Format à respecter : dd/mm/yyyy HH24:MI

Oui

AN16

07/04/2016 11:00

details

Informations sur les articles commandés

Non

Object OrderDetails



deliveryTime

Délai de livraison :

1 = express
2 = standard

Non

N

1


deliveryMode

Mode de livraison :

1 : retrait de la marchandise chez le marchand
2 : Utilisation d'un réseau de points-retrait tiers (type kiala, alveol, etc.)
3 : Retrait dans un aéroport, une gare ou une agence de voyage
4 : Transporteur (La Poste, Colissimo, UPS, DHL... ou tout transporteur privé)
5 : Emission d’un billet électronique, téléchargements

Oui

N

4


deliveryChargeMontant des frais de livraison dans la plus petite unité de la devise : exemple 250 pour 2,50 eurosNonAN
version 18 ou supérieure RELEASE 4.53
deliveryExpectedDate

Date prévue de livraison doit être supérieure à la date du jour. Format  : dd/mm/yyyy

NonAN1807/04/2016Transmis à Limonetik
deliveryExpectedDelayDélai prévu de livraison (en jours)NonN210Transmis à Limonetik



Vous avez d’autres questions ? Envoyer une demande

Commentaires

Réalisé par Zendesk