Webservice - getPaymentRecordRequest

S’abonner

La fonction « getPaymentRecordRequest » permet de récupérer les informations d’un dossier de paiement récurrent.

Requête à envoyer


La requête « getPaymentRecordRequest » doit uniquement transmettre les éléments contractNumber et paymentRecordID retournés par Payline lors de l’enregistrement d’un dossier de paiement.

Élément

Description

Requis

Type

Exemple

version

Version des web services Payline

oui

AN2

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

contractNumberLe numéro du contrat qui a été utilisé pour créer le dossier de paiement et le portefeuille virtuel.ouiAN50
paymentRecordIdL’identifiant du dossier de paiementouiAN12

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

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


Object recurring


FieldDescriptionMandatoryFormatExample

firstAmount

The amount of the first amount to be made. It must be formulated in the smallest unit of the currency.
For an amount of 100 €, you must set the value 10000

No

N12

10000

amount

The amount of a maturity. It must be formulated in the smallest unit of the currency.
For an amount of 5 €, you must put the value 500

Yes

N12

500

billingCycle

The code of the frequency of payments. Values : 

40: Monthly 
60: Quarterly

cf. complete list in annex table "  Frequency list "

Yes

N2

40

billingLeftNumber of due datesNoN33
billingDayDay when the deadlines must be processed. Format : ddNoAN220

startDate

The date of the first expiry (only in REC mode). If this field is not filled in, Payline assigns the current date.
Format : dd/mm/yyyy

No

AN10

01/01/2018

endDateThe date of the end of payment deadlines.  Format : dd/mm/yyyy HH24:MINoAN16

31/12/2018 12:00

newAmountNew amount changed. For an amount of 60 €, you must put the value 6000
NoN126000
amountModificationDateThe date of the modification of the amount. Format : dd/mm/yyyy HH24:MINoAN16

06/06/2018 12:00


Example :

Payment in = REC mode with the following values:

  • recurring.billingCycle = 40 (monthly)
  • a CB card
  • 24 months with disbursements at the end of every month 
  • recurring.billingDay=31
  • recurring.EndDate = today's date +2 years

The first transaction is made on the current date and then every month, at the end of the month for 2 years until the endDate.

For the even months and the month of February, the day selected when creating the deadlines is 30 for even months and 28 or 29 for February.



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

Object - result

00000


transaction

Payline transaction information

NoObject - transaction



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




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


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

Values for deliveryTime

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

Values for deliveryMode
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




Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0
Vous avez d’autres questions ? Envoyer une demande

Commentaires

Réalisé par Zendesk