• France
état des services
démonstrations
assistance
FAQContacter le support
Video tutorials
Rechercher
Catégories
Tags
France
France
Espagne
Europe (Anglais)
Inde
Accueil
Cas d'usage
Créer un paiement
Créer un paiement en plusieurs fois
Créer un paiement multicarte (fractionné)
Créer un paiement par alias (token)
Créer un lien de paiement
Créer un abonnement
Gérer vos abonnements
Gérer vos transactions (rembourser,...)
Analyser vos journaux
Docs API
Formulaire embarqué
API REST
Formulaire en redirection
SDK Mobile
Échange de fichiers
Mandats SEPA par API REST
Exemples de code
Moyens de paiement
Modules de paiement
Marketplace
Guides
Back Office Marchand
Back Office Expert
Guides fonctionnels

Format V1

L'enregistrement « TITRE »

Pos. Description
01 RECORD_CODE

Type : VARCHAR | Longueur : 5

Description : Code d'enregistrement.

Valeur : TITRE

02 RECORD_DATE

Type : TIMESTAMP | Longueur : 17

Description : Date et heure UTC de l'envoi au format ISO 8601.

Ex : 2020-01-15T16:53Z

03 Version

Type : VARCHAR | Longueur : 255

Description : Version du journal.

Ex : V1

04 ENTITY_CODE

Type : VARCHAR| Longueur : 255

Description : Code client Lyra Collect.

Ex : CLXXXXXX

05 ACTIVITY

Type : VARCHAR | Longueur : 255

Description : Le nom de la boutique en majuscule.

Les espaces éventuels sont remplacés par des "_"

Ex : DEMO_STORE

Les enregistrements « ENTETE » et « DETAILS »

Pos. Description
01 TRANSACTION_UUID

Type : VARCHAR | Longueur : 32

Description : Identifiant unique de la transaction.

Équivalent API Formulaire : vads_trans_uuid

Équivalent API REST : uuid

Ex : e078b7a6a01c494eae6afd52c4ea2bee

02 TRANSACTION_ID

Type : VARCHAR | Longueur : 6

Description : Identifiant de la transaction.

Équivalent API Formulaire : vads_trans_id

Équivalent API REST : cardDetails.legacyTransId

Ex : xrT15p

03 ORDER_ID

Type : VARCHAR | Longueur : 255

Description : Numéro de commande générée par le site marchand.

Équivalent API Formulaire : vads_order_id

Équivalent API REST : orderDetails.orderId

Ex : CX-1254

04 OPERATION_TYPE

Type : VARCHAR | Longueur : 255

Description : Type de transaction.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs :
  • SINGLE : pour le paiement comptant
  • INSTALLMENT : pour le paiement en plusieurs fois

Ex : SINGLE

05 OPERATION_DIRECTION

Type : VARCHAR | Longueur : 255

Description : Type d'opération

Équivalent API Formulaire : vads_operation_type

Équivalent API REST : operationType

Valeurs :
  • DEBIT : Débit
  • CREDIT : Crédit 

Ex : DEBIT

06 TRANSACTION_STATUS

Type : VARCHAR | Longueur : 255

Description : Statut de la transaction.

Équivalent API Formulaire : vads_trans_status

Équivalent API REST : detailedStatus

Valeurs :

  • ACCEPTED : Transaction de vérification acceptée
  • AUTHORISED : Transaction en attente de remise
  • AUTHORISED_TO_VALIDATE : Transaction à valider
  • CANCELLED : Transaction annulée
  • CAPTURED : Transaction remisée
  • CAPTURED_FAILED : La remise de la transaction a échoué
  • EXPIRED : Transaction expirée
  • REFUSED : Transaction refusée
  • UNDER_VERIFICATION : Vérification en cours
  • WAITING_AUTHORISATION : Transaction en attente de demande d’autorisation ou de pré-notification
  • WAITING_AUTHORISATION_TO_VALIDATE : Transaction à valider et autoriser

Ex : CAPTURED

07 MERCHANT_ID

Type : VARCHAR | Longueur : 255

Description : Identifiant légal de la société (SIRET ou legal ID).

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 045251785700028

08 SHOP_KEY

Type : NUMERIC | Longueur : 8

Description : Identifiant de la boutique.

Équivalent API Formulaire : vads_site_id

Équivalent API REST : shopId

Ex : 12345678

09 SHOP_EXT_ID

Type : NUMERIC | Longueur : 8

Description : Référence externe de la boutique. Correspond au code entité, sans les 2 premiers caractères.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 56987 pour le code client CL56987.

10 SHOP_NAME

Type : VARCHAR | Longueur : 255

Description : Libellé de la boutique.

Équivalent API Formulaire : vads_shop_name

Équivalent API REST : N/A

Ex : Chez Laplo

11 ACQUIRER

Type : VARCHAR | Longueur : 255

Description : Collecteur de fonds.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles :
  • Lyra Collect : service de paiement avec Lyra Collect comme collecteur des fonds.
  • External acquirer : autre collecteur avec lequel le marchand a contractualisé en direct.

Ex : External acquirer

12 CONTRACT

Type : VARCHAR | Longueur : 255

Description : Numéro de contrat du marchand.

Équivalent API Formulaire : vads_contract_used

Équivalent API REST : transactionDetails.mid

Ex : 0535875

13 PAYMENT_CHANNEL

Type : VARCHAR | Longueur : 255

Description : Canal de vente.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles :
  • PROXIMITY : paiement de proximité
  • E-COMMERCE : paiement e-commerce

Ex : E-COMMERCE

14 REMITTANCE_DATE

Type : TIMESTAMP | Longueur : 17

Description : Date et heure (norme ISO 8601) de la remise, dans le fuseau UTC.

Équivalent API Formulaire : N/A

Équivalent API REST : transactionDetails.cardDetails.captureResponse.captureDate

Ex : 2020-01-07T23:05+00Z

15 REMITTANCE_NB

Type : VARCHAR | Longueur : 6

Description : Numéro de remise.

Équivalent API Formulaire : N/A

Équivalent API REST : transactionDetails.cardDetails.captureResponse.captureFileNumber

Ex : 22

16 WIRE_REFERENCE

Type : VARCHAR | Longueur : 255

Description : Référence du virement.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : LYRA COLLECT 19100253200018

17 PAYMENT_MEANS

Type : VARCHAR | Longueur : 255

Description : Type de moyen de paiement.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles :
  • CARD
  • CREDIT_TRANSFER
  • ELECTRONIC_MONEY

Ex : CARD

18 ORIGIN_AMOUNT

Type : NUMERIC | Longueur : 13

Description : Montant de la transaction au moment du paiement exprimé dans la plus petite unité de la devise.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 4525 pour 45,25 EUR

19 AMOUNT

Type : NUMERIC | Longueur : 13

Description : Solde de la transaction exprimé dans la plus petite unité de la devise.

Équivalent API Formulaire : vads_amount

Équivalent API REST : amount

Ex : 4525 pour 45,25 EUR

20 CURRENCY_CODE

Type : VARCHAR | Longueur : 3

Description : Code de la devise (ISO 4217 alpha3).

Équivalent API Formulaire : vads_currency

Équivalent API REST : currency

Ex : EUR

21 FEES_EXCLUDING_VAT

Type : NUMERIC | Longueur : 13

Description : Montant de la commission Lyra Collect et des commissions de fin de mois si le marchand est paramétré pour payer les commissions Lyra Collect par facture de prestations.

Montant Hors Taxe exprimé dans la plus petite unité de la devise.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 4525 pour 45,25 EUR

22 FEES_VAT_AMOUNT

Type : NUMERIC | Longueur : 13

Description :Montant de la commission Lyra Collect et des commissions de fin de mois si le marchand est paramétré pour payer les commissions Lyra Collect par facture de prestations.

Montant TVA exprimé dans la plus petite unité de la devise.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 4525 pour 45,25 EUR

23 FEES_VAT_INCLUDED

Type : NUMERIC | Longueur : 13

Description: Montant de la commission Lyra Collect et des commissions de fin de mois si le marchand est paramétré pour payer les commissions Lyra Collect par facture de prestations.

Montant TTC exprimé dans la plus petite unité de la devise.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 4525 pour 45,25 EUR

24 NETWORK_FEES

Type : NUMERIC | Longueur : 13

Description : Montant estimé des frais réseau, exprimé dans la plus petite unité de la devise.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 4525 pour 45,25 EUR

25 INTERCHANGE_FEES

Type : NUMERIC | Longueur : 13

Description : Montant estimé des frais d'interchange, exprimé dans la plus petite unité de la devise.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 4525 pour 45,25 EUR

26 SEQUENCE_NUMBER

Type : NUMERIC | Longueur : 3

Description : Numéro de l’occurrence sur paiement en plusieurs fois.

Équivalent API Formulaire : vads_sequence_number

Équivalent API REST : transactionDetails.sequenceNumber

Ex : 1

27 SEQUENCE_COUNT

Type : NUMERIC | Longueur : 3

Description : Nombre total d'occurrences.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 1

28 PAYMENT_DATE

Type : TIMESTAMP | Longueur : 17

Description : Date et heure du paiement (norme ISO 8601), dans le fuseau UTC.

Équivalent API Formulaire : vads_effective_creation_date

Équivalent API REST : creationDate

Ex : 2020-01-07T13:33+00Z

29 CARD_VALIDITY

Type : NUMERIC | Longueur : 7

Description : Période de validité du moyen de paiement.

Équivalent API Formulaire : vads_expiry_month + "/" + vads_expiry_year

Équivalent API REST : transactionDetails.cardDetails.expiryMonth + "/" + transactionDetails.cardDetails.expiryYear

Ex : 06/2050

27 CARD_TYPE

Type : VARCHAR | Longueur : 255

Description : Moyen de paiement.

Équivalent API Formulaire : vads_card_brand

Équivalent API REST : transactionDetails.cardDetails.effectiveBrand

Ex : CB,VISA, MASTERCARD, etc.

31 CARD_NUMBER

Description : Numéro du moyen de paiement sous la forme 123456XXXXXX1234.

Équivalent API Formulaire : vads_card_number

Équivalent API REST : transactionDetails.cardDetails.pan

Ex : 123456XXXXXX1234

32 BUSINESS_CARD

Type : BOOLEAN | Longueur : 1

Description : Booléen permettant d'identifier les cartes commerciales.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles :
  • true : carte commerciale
  • false : carte de particulier

Ex : false

33 PAYMENT_METHOD_COUNTRY

Type : VARCHAR | Longueur : 2

Description : Code pays (norme ISO 3166 alpha-2) de la carte.

Équivalent API Formulaire : vads_card_country

Équivalent API REST : transactionDetails.cardDetails.country

Ex : FR pour France

34 BANK_CODE

Type : VARCHAR | Longueur : 255

Description : Code de la banque émettrice du moyen de paiement.

Équivalent API Formulaire : vads_bank_code

Équivalent API REST : transactionDetails.cardDetails.issuerCode

Ex : 30003

35 BANK_NAME

Type : VARCHAR | Longueur : 255

Description : Nom de la banque émettrice du moyen de paiement.

Équivalent API Formulaire : vads_bank_label

Équivalent API REST : transactionDetails.cardDetails.issuerName

Ex : 31c1d62734ef479f87cfd30bef8c7e01

36 PRODUCT_BANK_CODE

Type : VARCHAR | Longueur : 255

Description : Code produit de la carte.

Équivalent API Formulaire : vads_bank_product

Équivalent API REST : transactionDetails.cardDetails.effectiveProductCode

Ex :

37 RESPONSE_CODE

Type : NUMERIC | Longueur : 2

Description : Code retour de l'opération demandée.

Pour plus de détails, consultez le paramètre BANK_RESPONSE_CODE.

Valeurs :
  • 00 : Opération acceptée.
  • 05 : Opération refusée.
  • 34 : Opération refusée pour suspicion de fraude.
  • 75 : Opération refusée suite à un nombre de tentatives de saisie du numéro de carte dépassé.
  • 96 : Opération refusée suite à une erreur technique.

Ex : 00

38 CERTIFICATE

Type : VARCHAR | Longueur : 255

Description : Certificat de la transaction.

Équivalent API Formulaire : vads_payment_certificate

Équivalent API REST : N/A

Ex : 6ed7b71c023a20adbadf9a2e2c58cd4321f63123

39 AUTORISATION_ID

Type : VARCHAR | Longueur : 20

Description : Numéro d'autorisation de la transaction.

Équivalent API Formulaire : vads_auth_number

Équivalent API REST : transactionDetails.cardDetails.authorizationResponse.authorizationNumber

Ex : 3fc116

40 OUTCOME_STATUS

Type : VARCHAR | Longueur : 255

Description : Statut de la demande d'autorisation.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles:
  • AUTHENTICATION_REJECTED_AUTHENTICATION_IMPOSSIBLE
  • AUTHENTICATION_REJECTED_NOT_AUTHENTICATED
  • AUTHENTICATION_REJECTED_UNKNOWN_STATUS
  • OK
  • REJECTED
  • REJECTED_FRAUD_RISK
  • REJECTED_SUPPORT_NEEDED
  • REJECTED_TECHNICAL_PROBLEM

Ex : OK

41 CUSTOMER_IP_ADDRESS

Type : VARCHAR | Longueur : 255

Description : Adresse IP de l'acheteur.

Équivalent API Formulaire : N/A

Équivalent API REST : customer.extraDetails.ipAddress

Ex : 185.244.73.2

42 ACCOUNT_SERIAL

Description : Alias suivi du n° éventuel d'abonnement, séparés par un tiret "-".

Équivalent API Formulaire : vads_identifier "-" vads_subscription

Équivalent API REST : paymentMethodToken "-" subscriptionId

Ex : 5fa8d3dede8f4c219c4652dfabe2bf55-20191106ANav0o

43 OPERATOR_SALES_AMOUNT

Type : NUMERIC | Longueur : 13

Description : Montant des ventes en propre de l'opérateur Marketplace.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 4525 pour 45,25 EUR

44 OPERATOR_FEE_AMOUNT

Type : NUMERIC | Longueur : 13

Description : Montant des commissions Marketplace.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 4525 pour 45,25 EUR

45 ENTRY_MODE

Type : NUMERIC | Longueur : 1

Description : Mode de lecture de la carte.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles :
  • 0 : Non spécifié
  • 2 : Piste magnétique
  • 3 : Transaction microcircuit sans contact utilisant les données puce EMV
  • 4 : Transaction microcircuit sans contact utilisant les données piste
  • 5 : Microcircuit
  • 6 : Saisie Manuelle
  • 7 : Piste magnétique, après tentative de lecture du microcircuit
  • 8 : Issu d'un serveur
  • 9 : Réseau privé

Ex : 4

46 HOLDER_CHECK_METHOD

Type : NUMERIC | Longueur : 1

Description : Mode d'authentification du porteur.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles :
  • 0 : Pas d'authentification
  • 1 : Code confidentiel
  • 2 : Signature électronique
  • 5 : Signature manuelle
  • 6 : Autres authentifications manuelles
  • 7 : Vérification d'adresse
  • 8 : Code confidentiel + signature manuelle

Ex : 1

47 AID

Type : NUMERIC | Longueur : 13

Description : Application Identifier. Correspond au « logiciel » lié au réseau utilisé sur le TPE.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles :
  • A0000000031010 : réseau VISA
  • A0000000032010 : réseau VISA
  • A0000000041010 : réseau MC
  • A0000000043060 : réseau MC
  • A0000000421010 : réseau CB
  • A0000000424010 : réseau CB
  • A0000000424020 : réseau CB

Ex :A0000000031010

48 AUTHORISATION_REASON

Type : NUMERIC | Longueur : 4

Description : Raison de la demande d'autorisation.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

|Valeurs possibles :
  • 1503 : appel aléatoire (terminal)
  • 1506 : "on-line" forcé par l'accepteur de carte
  • 1507 : "on-line" forcé par le dispositif d'acceptation de carte pour mise à jour
  • 1508 : "on-line" forcé par le terminal
  • 1509 : "on-line" forcé par l'émetteur (Code service)
  • 1510 : Dépassement seuil d'appel
  • 1511 : Soupçons de l'accepteur
  • 1512 : BIN interdit
  • 1513 : Carte interdite
  • 1651 : Cumul / porteur / application / jour
  • 1652 : BIN surveillé
  • 1653 : BIN inconnu
  • 1654 : N° surveillé
  • 1655 : Demande de pré-autorisation
  • 1656 : Forcé par l'émetteur (Contrôle de flux)
  • 1657 : Monnaie ou devise étrangère
  • 1658 : Code monnaie ou devise de la transaction inconnu
  • 1659 : Carte refusée
  • 1660 : Appel suite à ARCQ émis par la carte
  • 1663 : BIN refusé
  • 1664 : Strictement on-line
  • 1665 : Off-line avec capacité on-line
  • 1666 : Centre d'appel
  • 1667 : Appel phonie demandé par l'émetteur
  • 1671 : Transaction puce sans contact utilisant les données piste
  • 1672 : Carte en mode SDA
  • 4000 : Annulation par le client
  • 4007 : Terminal accepteur incapable d'effectuer la transaction
  • 4200 : Décision porteur
  • 4201 : Décision terminal
  • 4203 : Décision porteur ou terminal
  • 4204 : Décision accepteur

Ex : 4204

49 AUTHORISATION_FORCING_CODE

Type : NUMERIC | Longueur : 1

Description : Code forçage.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles :
  • 1 : Forçage autorisation après réponse émetteur
  • 2 : Forçage avant demande d'autorisation
  • 3 : Saisie manuelle de l'autorisation
  • 4 : Pas de forçage
  • blanc : Transaction non autorisée

Ex : 1

50 CONTACTLESS_DEVICE

Type : NUMERIC | Longueur : 13

Description : Facteur de forme. Indique par quel type de support le paiement sans contact s’est réalisé, par carte ou par téléphone.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

51 IDSA

Type : NUMERIC | Longueur : 13

Description : Identifiant du système d'acceptation.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 21P0000E

52 ITP

Type : NUMERIC | Longueur : 12

Description : Identifiant du Terminal de Paiement.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Ex : 143521100587

53 ERT

Type : NUMERIC | Longueur : 2

Description : Environnement réglementaire et technique.

Équivalent API Formulaire : N/A

Équivalent API REST : N/A

Valeurs possibles :
  • 10 : Paiement de proximité
  • 20 : VAD non spécifié
  • 41 : Signature électronique
  • 42 : Paiement par automate de classe I - niveau 1 : ADM
  • 43 : Paiement par automate de classe II.1 - niveau 1 : ADM
  • 45 : Paiement sur automate à authentification porteur obligatoire
  • 46 : Paiement par automate de classe I - niveau 2: SST
  • 47 : Paiement par automate de classe II.1 - niveau 2: SST
  • 48 : Paiement par automate de classe II.2 - niveau 2: SST
  • 49 : Paiement par automate de classe I - niveau 3: LAT (hors contexte CB)
  • 50 : Paiement par automate de classe II.1 - niveau 3: LAT (hors contexte CB)
  • 51 : Paiement par automate de classe II.2 - niveau 3: LAT (hors contexte CB)
  • 54 : Paiement sur automate bancaire multiservices de classe I - ADM (hors contexte CB)
  • 55 : Paiement sur automate bancaire multiservices de classe II.1 - ADM (hors contexte CB)
  • 56 : Paiement sur automate bancaire multiservices de classe II.2 - ADM (hors contexte CB)
  • 57 : Paiement sur automate de location (hors contexte CB)
  • 60 : non spécifié (quasi-cash)
  • 63 : télévision (quasi-cash)
  • 64 : réseau ouvert (quasi-cash)
  • 65 : automate (quasi-cash)
  • 80 : Pré-autorisation

Ex : 10

54 DATA_COMP_1

Type : VARCHAR | Longueur : 4

Description : Code motif de l'impayé dans le cas d'une transaction impayée.

55 DATA_COMP_2

Type : VARCHAR | Longueur : 255

Description : Mode de facturation des commissions Lyra Collect :

  • CASHOUT : Prélèvement des commissions Lyra Collect à la source des ventes du marchand
  • MONTHLY : Paiement des commissions Lyra Collect dans la facturation des prestations mensuelles du marchand
56 DATA_COMP_3

Type : NUMERIC (21,5) |Longueur : 5

Description : Montant de toutes les commissions (fin de mois ou autres) en HT au format décimal (5 décimales)

57 DATA_COMP_4

Type : NUMERIC (21,5) |Longueur : 5

Description : Montant TVA de toutes les commissions (fin du mois ou autres) en HT au format décimal (5 décimales)

58 DATA_COMP_5

Type : VARCHAR | Longueur : 255

Description : Numéro logique du système d'acceptation (NLSA).

59 DATA_COMP_6

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

60 DATA_COMP_7

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

61 DATA_COMP_8

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

62 DATA_COMP_9

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

63 DATA_COMP_10

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

64 DATA_COMP_11

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

65 DATA_COMP_12

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

66 DATA_COMP_13

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

67 DATA_COMP_14

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

68 DATA_COMP_15

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

69 DATA_COMP_16

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

70 DATA_COMP_17

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

71 DATA_COMP_18

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

72 DATA_COMP_19

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

73 DATA_COMP_20

Type : VARCHAR | Longueur : 255

Description : Réservé pour une utilisation future

Exemple de fichier

Téléchargez le pack d'exemples : https://docs.lyra.com/files/samples/sample-files-collect.zip.

Vous trouverez un fichier d'exemple dans le dossier JAM.

Nous recrutons
Mentions légales
Charte de Protection des Données Personnelles
25.8-1.11