Webservice - updatePaymentRecordRequest

S’abonner

Ce web service permet de modifier un ou plusieurs paramètres d’un dossier de paiement.

Les paramètres modifiables sont :

  • Le nombre d’échéances ;
  • La date de fin ;
  • Le jour des échéances ;
  • Le couple (nouveau montant, date de modification).

La procédure de mise à jour des échéances tourne une fois par jour en environnement d’homologation et de production, à 00h30.

Requête à envoyer


Élément

Description

Requis

Type

Exemple

Condition

version

Version des web services Payline

oui

AN3

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

Version 7 ou supérieure
contractNumberLe numéro du contrat qui a été utilisé pour créer le dossier de paiement et le portefeuille virtuel.ouiAN50  

paymentRecordId

L’identifiant du dossier de paiement

oui

AN

 

Version 7 ou supérieure

recurring

Information sur les échéances

oui

recurringForUpdate object

  

Les références

Object recurringForUpdate

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

Réponse en retour

Élément

Description

Requis

Type

Exemple

Condition
result

Informations sur le résultat de la demande de mise à jour du paiement programmé :

02500 : Operation successful
02507 : Cannot found payment record
02508 : Payment is disabled

ouiObject result

Voir les éléments ci-dessous


recurring

Identifiant de l’alerte.

oui

Object - recurring

Voir les éléments ci-dessous

isDisabled

Le statut du dossier de paiement

0 : actif
1 : inactif

oui

AN1

disableDate

La date de désactivation du dossier de paiement

oui

AN14Format : dd/mm/yy HH24:MI

privateDataList

Vos données personnelles

oui

Object - privateDataListVoir les éléments ci-dessous

order

La commande associée

oui

Object - orderVoir les éléments ci-dessous

walletId

Identifiant du portefeuille utilisé

oui

AN50

Les éléments de références

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


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

 


Vous avez d’autres questions ? Envoyer une demande

Commentaires

Réalisé par Zendesk