• France
status page
Demo shops
assistance
FAQContact support
Search
Categories
Tags
Europe (English)
France
Spain
Europe (English)
India
Homepage
Use cases
Create a payment
Create an installment payment
Create a multi-card (split) payment
Create a payment by Alias (Token)
Create a payment link
Create a recurring payment
Manage subscriptions
Manage your transactions (refund, cancel...)
Analyze your reports
API docs
Embedded Form
REST API
Hosted payment
Mobile payment
File exchange
SDD mandates by REST API
Snippets
Payment methods
Plugins
Marketplace
Guides
Merchant Back Office
Back Office Expert
Functional guides

V3 Format

The record« TITRE »

Pos. Description Values
01 Record code TITRE
02 The shop label, as defined in the Expert Back Office. E.g.: DEMO Store
03 UTC date and time of dispatch (YYMMDD_HH:MM:SS) 200113_02:05:00
04 Version TABLE_V3

The record« ENTETE »and« DETAILS »

Pos. Description
01 ENTETE

Type:VARCHAR| Length: 9

Description: Record code.

Value: always populated with OPERATION

02 MERCHANT_ID

Type: VARCHAR | Length: 255

Description: Legal identifier of the company.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:

0+ Legal Identifier

(Legal Identifier = SIRET (Système d'Identification du Répertoire des Etablissements))

E.g.: 045251785700028

03 PAYMENT_DATE

Type: DATE | Length: 8

Description: Date of payment in UTC time zone.

Hosted Payment Page equivalent: vads_effective_creation_date

REST API equivalent: creationDate

E.g.: 20200110

04 TRANSACTION_ID

Type: VARCHAR | Length: 255

Description: Transaction identifier.

Hosted Payment Page equivalent: vads_trans_id

REST API equivalent: cardDetails.legacyTransId

E.g.: xrT15p

05 OPERATION_SEQUENCE

Type: NUMERIC | Length: 1

Description: Operation number. This field is always set to “1”.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Value: 1

06 OPERATION_NAME

Type: VARCHAR | Length: 255

Description: Type of the performed action.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:
  • AUTHOR : Transaction authorization (in case of deferred payments)
  • CANCEL : Transaction cancellation
  • CREDIT_CAPTURE : Capture of a refund transaction at the bank
  • DEBIT_CAPTURE : Capture of a debit transaction at the bank
  • DUPLICATE : Transaction duplication
  • CREDIT : Transaction refund
  • EXPIRED : Transaction expiration
  • MODIFICATION : Transaction update
  • TRANSACTION : Registration of a manual payment
  • TRANSACTION_WITH_MANUAL_VALIDATION : Registration of a manual payment with manual validation
  • VALIDATE : Transaction validation
  • RAPPROCHEMENT : Transaction reconciliation
  • VERIFICATION_REQUEST : Request to verify the payment method

E.g.: CREDIT

07 OPERATION_AMOUNT

Type: NUMERIC | Length: 13

Description: Transaction amount expressed in the smallest currency unit.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 4525 for EUR 45.25

08 OPERATION_CURRENCY

Type: NUMERIC | Length: 3

Description: Operation currency.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values: List of supported currencies

E.g.: 978

09 OPERATION_DATE

Type: DATE | Length: 6

Description: UTC date of the operation in the YYMMDD format.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 200112

10 OPERATION_TIME

Type: TIME | Length: 6

Description: Time of the operation in UTC format.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 121327

11 OPERATION_ORIGIN

Type: VARCHAR | Length: 255

Description: ID of the user who performed the action.

Set to “BATCH” if the operation was processed automatically.

E.g.: BATCH

12 RESPONSE_CODE

Type: NUMERIC | Length: 2

Description: Return code of the requested operation.

Values:
  • 00 : Operation accepted
  • 05 : Operation refused.
  • 34 : Operation refused on suspicion of fraud.
  • 75 : Transaction refused because number of attempts has been exceeded.
  • 96 : Operation refused due to technical error.

E.g.: 00

13 NEW_STATUS

Type: VARCHAR | Length: 255

Description: New transaction status. This field can be empty if the transaction status does not match one of the statuses below.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:
  • REFUSED : The transaction has been refused.
  • TO_VALIDATE : The transaction must be validated
  • TO_CAPTURE : The transaction is waiting for capture
  • TO_CREDIT : Credit transaction (refund) waiting for capture
  • CANCELLED : The transaction has been canceled
  • CAPTURED : The transaction has been captured
  • EXPIRED : The transaction has not been validated and has expired
  • TO_VALIDATE_AND_AUTHORIZE : The transaction is waiting for an authorization request and must be validated
  • TO_AUTHORIZE : The transaction is waiting for an authorization request
  • TO_PRENOTIFY : Transaction awaiting pre-notification
  • ACCEPTED : Verification transaction accepted
  • REFUSED_CAPTURED : Capture failed

E.g.: TO_CAPTURE

14 RETURN_CONTEXT

Type: VARCHAR| Length: 500

Description: Context of buyer’s purchase.

Concatenation of “additional information”, separated by the | character”.

Additional information can be transmitted through the merchant website:

  • via the field vads_order_info, vads_order_info2, vads_order_info3 payment form,
  • via attributes orderInfo, orderInfo2, orderInfo3 of the object metadata of the REST API

Beyond 500 characters, the string is truncated.

Empty field if no additional information is transmitted.

Hosted Payment Page equivalent: vads_order_info | vads_order_info2 | vads_order_info3

|

REST API equivalent: orderInfo | orderInfo2 | orderInfo3

E.g.:
  • info1|info2|info3 if the 3 pieces of additional information are transmitted.
  • info1||info3: if only the 1st and 3rd pieces of additional information are transmitted.

The “END” (FIN) record

Pos. Description Values
01 Record code FIN

File sample

Download the sample pack: https://docs.lyra.com/files/samples/sample-files-collect.zip.

You will find a sample file in the folderReporting/JO.

Jobs
Legal
GDPR
25.19-1.11