Webservice - doDebitRequest

S’abonner

La fonction « doDebit » est un débit forcé. Le commerçant a contacté sa banque qui lui fournit un numéro d’autorisation, et  ce dernier lui permet de réaliser une demande de débit sur la carte bancaire de son client.

Requête à envoyer

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

Élément

Description

Requis

Type

Exemple

Condition
versionVersion des web services PaylineouiN2A valoriser avec la dernière version: voir le tableau des versions.Requis depuis 2011
paymentInformations sur le paiementouiObject payment

Voir les éléments ci-dessous

 
cardInformation sur la carteouiObject cardVoir les éléments ci-dessous 

order

Informations sur la commande

oui

Object order

Voir les éléments ci-dessous

 

buyer

Information sur l’acheteur

non

Object buyer

Voir les éléments ci-dessous

 

owner

Information sur le titulaire de la carte

non

Object owner

Voir les éléments ci-dessous

Applicable uniquement pour AMEX

privateDataList

 

Vos propres informations personnelles

non

Object privateDataList

 

Voir les éléments ci-dessous

 
authorizationInformation sur l'autorisationnonObject authorizationVoir 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

nonAN25Mobile 
subMerchantInformation du Payment FacilitatornonObject subMerchantVoir les éléments ci-dessousVersion 18 ou supérieure

Les éléments de référence

Object payment


Élément

Description

Prérequis

Format

Exemple

Condition

amount

Informations transmises lors de l’appel de la fonction doWebPayment

oui

N12

100

La valeur 100 correspond à 1 €

currency

Devise du paiement

oui

N3

978


action

Code action

oui

N3

100

code 100 et 101 = paiement
code 421 = remboursement

voir la table

mode

Mode du paiement

oui

AN3

CPT

voir la table

contractNumber

Numéro de contrat

oui

AN50

1234567

doWebPayment (défini le point de vente), doCapture/doRefund (contractNumber retourné par le getPaymentDetails/getWebPaymentDetails).

differedActionDate

Date à laquelle le paiement sera réalisé

non

AN8

07/04/2016

Format : dd/mm/yy

Si le champ mode = DIF, alors la date DifferedActionDate est obligatoire sinon ce champ doit être vide.

method

Nom de l’émetteur de la carte

non

AN20

CB

version 10 ou supérieure

Ex : CB, PAYSAFECARD

softDescriptor

Information affichée sur le relevé de compte de l'acheteur, limite avec certains moyens de paiement. Cette information sera affichée sur le ticket de paiement.
Les caractères spéciaux (non A..Z et 1..9) sont spécifiques à chaque acquéreur/moyen de paiement.

nonAN64www.boutique.frversion 13 ou supérieure
cardBrand

Indique la marque utilisée pour l'opération, voir les valeurs.
Il n’est pris en compte que si le moyen de paiement permet le choix de la marque.

nonAN15

version 15 ou supérieure

voir table

registrationToken

Jeton utilisé en réponse dans les services.
Il permet au partenaire de retourner un jeton afin d'identifier un consommateur et retrouve ces données lors d'une demande de paiement.
nonAN
version 18 ou supérieure RELEASE 4.53

 

Object card


Élément

Description

Requis

Format

Exemple

Condition

encryptionKeyId

Identifiant de la clé RSA Payline de chiffrement. Ne pas tenir compte de ce champ.

non

N4



encryptedData

Les données carte chiffrées. Ne pas tenir compte de ce champ.

non

AN400



number

Numéro de carte masqué, conforme à PCI DSS

non

 AN19

4970102121041646 en entrée de notre API.
En sortie, le numéro est masqué : 497010XXXXXX1646

Si le champ token est renseigné, le champ number doit être vide.

type

Type de la carte : CB, VISA, MASTERCARD, MAESTRO, AMEX.

oui

AN

CB


expirationDate

Date d’expiration de la carte

nonN4

0311


cvx

Cryptogramme visuel au dos de la carte de crédit

non

N10



ownerBirthdayDate

Date d’anniversaire du porteur

non

N6

Format à respecter :ddmmyy


password

Mot de passe crypté

non

AN16



cardPresent

Ce service est utilisée uniquement si vous faites du Mail Order ou Telephone Order ou alors dans le cas où l’internaute est présent physiquement

non

N1

0 ou 1 (présent)


cardholder

Titulaire de la carte

non

AN20

Pierre Dupont


token

Alias du numéro de carte.

La version doit être supérieure ou égale à 3

non

AN19

1111gPNzHtyu4444

Vous devez utilisez l’option de token PAN et la version doit être supérieure ou égale à 3.

paymentDataObject en entrée du service pour véhiculer les données du moyen de paiement ApplePaynonObject PaymentData

 

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

 

Object orderDetail


Element

Comment

Required

Format

Example

ref

Item reference

No

AN50

 

price

Item price, in the smallest currency unit

No

N12

 

quantity

Number of Items

No

N5

 

comment

Comment

No

AN255

 

category

Category of item

No

AN50

See table values

brand

Product brand

No

AN50

E.g.: HERMES

subcategory1

Rank 1 subcategory

No

AN50

E.g.: Watches & Jewellery

subcategory2

Rank 2 subcategory

No

AN50

E.g.: Jewellery

additionalData

List of specifications required for certain payment methods

No

AN255

E.g.: LegalAge=18&Discount=0105

taxRate

Item tax rate (expressed in hundredths)

No

N4

E.g.: 1580 for 15.8%

 

Object buyer


Élément

Description

Requis

Type

Exemple

Condition
titletitrenonAN1

 

Voir la table des valeurs

lastName

Nom de l’acheteur

non

AN100

 

 

firstName

Prénom de l’acheteur

non

AN100

 

 

email

Adresse email de l’acheteur

non

AN150

 

Ne pas mettre plus de 12 chiffres consécutifs (ex.:test-123456789101@test.test)

shippingAdress

Adresse de livraison. Le paramètre doit bien être orthographié shippingAdress dans la trame d'appel.

non

Object Address

 

 

billingAddress

Adresse de facturation

non

Object Address

 

 

accountCreateDate

La date de création du compte de l’acheteur

non

AN10

01/04/16

Format à respecter : dd/mm/yy 

accountAverageAmount

Le montant moyen des achats de cet acheteur

non

N10

 

 

accountOrderCount

Le nombre de commande passé par cet acheteur

non

N10

 

 

walletId

L’identifiant du portefeuille virtuel de votre client.

Non

AN50

 

Obligatoire pour les paiements par portefeuille

walletDisplayed

Gestion de l’affichage des moyens de paiement de votre client.

Pour ne pas afficher les données de paiement client, saisir la valeur « none ».

Pour afficher les données de paiement client, la balise doit être vide ou absente

non

AN5



walletSecured

Nature du contrôle ajouté à la cinématique de paiement WEB.

non

AN12


Voir la table des valeurs

walletCardInd

Spécifie l’index de la carte à utiliser.

non

AN2

1

L’index de la carte, valeur par défaut « 1 » 

ip

L’adresse IP de l’acheteur

non

AN50


Format à respecter : IPv4 ou IPv6 

mobilePhone

Le numéro de mobile de l’acheteur

non

N15

0033691666666

 

 

customerId

Identifiant client

non

AN50

894492568

Clearsale : Cette donnée peut être un identifiant ou un email
legalStatusType du status de l'acteur : personne ou entreprisenonN11Clearsale : voir la table de valeur.
legalDocumentNumero d'identification du document officielnonAN100X5446119U 
birthDateDate de naissancenonAN10

2016-04-27

Format: yyyy-mm-dd 
fingerprintIDID Device fingerprintnonAN50  
deviceFingerprintInformation du DeviceFingerPrint.nonAN à partir de la version 15
isBotInformation du DeviceFingerPrint. Valeur possible : Y ou NnonAN1 à partir de la version 15
isIncognitoInformation du DeviceFingerPrint. Valeur possible : Y ou NnonAN1 à partir de la version 15
isBehindProxyInformation du DeviceFingerPrint. Valeur possible : Y ou NnonAN1 à partir de la version 15
isFromTorInformation du DeviceFingerPrint. Valeur possible : Y ou NnonAN1 à partir de la version 15
isEmulatorInformation du DeviceFingerPrint. Valeur possible : Y ou NnonAN1 à partir de la version 15
isRootedInformation du DeviceFingerPrint. Valeur possible : Y ou NnonAN1 à partir de la version 15
hasTimezoneMismatchInformation du DeviceFingerPrint. Valeur possible : Y ou NnonAN1 à partir de la version 15

 

Object selectedContractList

Elément

Description

Requis

Type

Exemple

 

lastName

Nom du titulaire

non

AN30

Pierre

Applicable uniquement pour AMEX

firstName

Prénom du titulaire

non

AN15

Paul

Applicable uniquement pour AMEX

billingAddress

Adresse de facturation

non

Object addressOwner

 

Applicable uniquement pour AMEX

issueCardDate

Date d’émission de la carte

non

AN4

Format : mmyy

Applicable uniquement pour AMEX

 

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 authorization

Élément

Description

Requis

Format

Exemple

number

Numéro d’autorisation délivré par le serveur d’autorisation acquéreur. Ce champ est renseigné si la demande d’autorisation est accordée1.

oui

N6

123456

date

Date et heure de l’autorisation

oui

AN16

Format : dd/mm/yyyy HH24:MI

 

Object  subMerchant

Object disponible en version 18 ou supérieure des web services

Élément

Description

Requis

Type

Amex

CBMSCVISA

subMerchantId

Identifiant du sous marchant (bénéficiaire final) défini par le fournisseur de paiement (Payment Facilitator)

oui

ouioui

AN

subMerchantName

Nom du sous marchand

oui

non

AN

subMerchantMCC

Code MCC

oui

ouioui

AN

subMerchantSIRET

Numéro de SIRET

non

ouinonnon

AN

subMerchantTaxCode

Tax : Obligatoire pour les pays : USA et CAN . C'est au Payment Facilitator de déterminer si cette information doit être fournie ou non.

non

non

AN

subMerchantStreet

Nom de rue

oui

non

AN

subMerchantCity

Ville

oui

non

AN

subMerchantZipCode

Code postal

oui

non

AN

subMerchantCountry

Pays, voir la liste des valeurs.

oui

non

AN2

subMerchantState

État

non

non

AN

subMerchantEmailAddressEmailoui


ANS40
subMerchantPhoneNumber

Numéro de téléphone

oui


AN


Réponse en retour

Le message « doDebitResponse » est la réponse faite par Payline à une demande de débit. La réponse a la structure suivante :

Élément

Description

Requis

Format

Exemple

result

Information sur le résultat de la demande de débitoui

Object result

Voir les éléments ci-dessous

transactionInformation sur la transactionouiObject transactionVoir les éléments ci-dessous
cardInformation sur la cartenonObject cardOutVoir les éléments ci-dessous
extendedCardInformation complémentaire sur la cartenonObject extendedCardTypeVoir les éléments ci-dessous

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)AN50à partir de la version 14
partnerCodeLabelLibellé du partenaireAN255à partir de la version 14

 

Object transaction


ÉlémentDescriptionFormatExempleCondition
idIdentifiant unique de la transaction PaylineN50

dateDate et heure de la transaction PaylineAN16Format : dd/mm/yyyy HH24:MI
isDuplicated

Cet indicateur est retourné par Payline dans le cas de transaction en doublon :

1 = transaction en doublon
0 = pas de doublon détecté

AN11
isPossibleFraud

Cet indicateur est calculé en fonction des critères définis par le commerçant :

1 = Il existe un risque de fraude
0 = Aucun risque de fraude détecté

AN11
fraudResultCode de la fraudeAN50

fraudResultDetailsDetails de la fraudeObject fraudResultDetails

explanationMotif du refus en cas de fraudeAN50

threeDSecure

Cet indicateur permet de savoir si la transaction est 3DSecure ou non :

Y = Transaction 3DS
N = Transaction non 3DS
D = cas de rétrogradation (version 14 ou supérieur)

AN1

softDescriptor

Information affichée sur le relevé de compte de l'acheteur, limite avec certains moyens de paiement. Cette information sera affichée sur le ticket de paiement.

Les caractères spéciaux (non A..Z et 1..9) sont spécifiques à chaque acquéreur/moyen de paiement.

AN64*www.boutique.fr

version 13 ou supérieure.

version 16 ou supérieure pour Paypal.

scoreScoring de la possibilité de fraude : Score de 0 à 10N52
externalWalletTypeType de wallet utilisé lors de la transactionAN20Ex : V.Me, Masterpass
externalWalletContractNumberNuméro du contrat VAD associé au paiement par WalletAN50

PartnerAdditionalData

Informations retournées au commerçant et provenant des partenaires :

AN


version 16 ou supérieure


avs
Service de vérification des adresses AVS
object avs
version 17 ou supérieure

 

Object cardOut


Élément

Description

Requis

Format

Exemple

Condition

number

Carte marqué conforme à PCI DSS

non

AN

111122XXXXXX4444

Si le champ token est renseigné, le champ number doit être vide.

type

Type de la carte : CB, VISA, MASTERCARD, MAESTRO, AMEX

non

AN

CB

 

expirationDate

Date d’expiration de la carte

non

AN

0311

 

cardholder

Titulaire de la carte

non

AN20

Pierre Dupont

 

token

Alias du numéro de carte.

La version doit être supérieure ou égale à 3

non

AN19

1111gPNzHtyu4444

 

 

Object extendedCardType


Élément

Commentaire

Requis

Exemple

country

Pays d’emission de la carte

AN2

CODE ISO : exemple FR

isCvd

La carte est elle une e carte bleu

AN1

Y OR N

bank

La banque de la carte utilisée pour le paiement

AN

Crédit Lyonnais

type

Le type de carte de paiement

AN20

MASTERCARD

network

Désigne le rattachement de la carte à une entité gérant l’acceptation de la carte à un niveau national ou international

AN20

MASTERCARD

product

Indique la catégorie à laquelle appartient le type de la carte : voir les codes produit

AN

Gold/Premier pour une carte type VISA

Vous avez d’autres questions ? Envoyer une demande

Commentaires

Réalisé par Zendesk