V1 Format
The record « TITRE »
Pos. | Description |
---|---|
01 | RECORD_CODE Type: VARCHAR | Length: 5 Description: Record code. Value: TITRE |
02 | RECORD_DATE Type: TIMESTAMP | Length: 17 Description: UTC date and time of dispatch in the ISO 8601 format. E.g.: 2020-01-15T16:53Z |
03 | Version Type: VARCHAR | Length: 255 Description: Version of the log. E.g.: V1 |
04 | ENTITY_CODE Type: VARCHAR | Length: 255 Description: Lyra Collect Customer Code. E.g.: CLXXXXXX |
05 | ACTIVITY Type: VARCHAR | Length: 255 Description: The shop name in capital letters. Potential space characters are replaced by the “_” character E.g.: DEMO_STORE |
The records « ENTETE » (HEADER) and « DETAILS »
Pos. | Description |
---|---|
01 | TRANSACTION_UUID Type: VARCHAR | Length: 32 Description: Unique transaction ID. Hosted Payment Page equivalent: vads_trans_uuid REST API equivalent: uuid E.g.: e078b7a6a01c494eae6afd52c4ea2bee |
02 | TRANSACTION_ID Type: VARCHAR| Length: 6 Description: Transaction identifier. Hosted Payment Page equivalent: vads_trans_id REST API equivalent: cardDetails.legacyTransId E.g.: xrT15p |
03 | ORDER_ID Type: VARCHAR| Length: 255 Description: Order number generated by the merchant website. Hosted Payment Page equivalent: vads_order_id REST API equivalent: orderDetails.orderId E.g.: CX-1254 |
04 | OPERATION_TYPE Type: VARCHAR | Length: 255 Description: Transaction type Hosted Payment Page equivalent: N/A REST API equivalent: N/A Values:
E.g.: SINGLE |
05 | OPERATION_DIRECTION Type: VARCHAR | Length: 255 Description: Type of operation Hosted Payment Page equivalent: vads_operation_type REST API equivalent: operationType Values:
E.g.: DEBIT |
06 | TRANSACTION_STATUS Type: VARCHAR | Length: 255 Description: Status of the transaction. Hosted Payment Form equivalent: vads_trans_status REST API equivalent: detailedStatus Values:
E.g.: CAPTURED |
07 | MERCHANT_ID Type: VARCHAR | Length: 255 Description: Legal identifier of the company (SIRET or legal ID). Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 045251785700028 |
08 | SHOP_KEY Type: NUMERIC | Length: 8 Description: Shop ID Hosted Payment Page equivalent: vads_site_id REST API equivalent: shopId E.g.: 12345678 |
09 | SHOP_EXT_ID Type: NUMERIC | Length: 8 Description: External shop reference. Corresponds to the entity code, without the 2 first characters. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 56987 for client code CL56987. |
10 | SHOP_NAME Type: VARCHAR | Length: 255 Description: Shop reference Hosted Payment Page equivalent: vads_shop_name REST API equivalent: N/A E.g.: At Laplo |
11 | ACQUIRER Type: VARCHAR | Length: 255 Description: Fund collector. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: External acquirer |
12 | CONTRACT Type: VARCHAR | Length: 255 Description: Merchant ID number. Hosted Payment Page equivalent: vads_contract_used REST API equivalent: transactionDetails.mid E.g.: 0535875 |
13 | PAYMENT_CHANNEL Type: VARCHAR | Length: 255 Description: Sales channel. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: E-COMMERCE |
14 | REMITTANCE_DATE Type: TIMESTAMP | Length: 17 Description: Date and time (ISO 8601 standard) of the capture, in UTC time zone. Hosted Payment Page equivalent: N/A REST API equivalent: transactionDetails.cardDetails.captureResponse.captureDate E.g.: 2020-01-07T23: 05:00Z |
15 | REMITTANCE_NB Type: VARCHAR | Length: 6 Description: Capture number. Hosted Payment Page equivalent: N/A REST API equivalent: transactionDetails.cardDetails.captureResponse.captureFileNumber E.g.: 22 |
16 | WIRE_REFERENCE Type: VARCHAR | Length: 255 Description: Wire transfer reference. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: LYRA COLLECT 19100253200018 |
17 | PAYMENT_MEANS Type: VARCHAR | Length: 255 Description: Payment method type. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: CARD |
18 | ORIGIN_AMOUNT Type: NUMERIC| Length: 13 Description: Transaction amount at the moment of payment expressed in the smallest currency unit. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 4525 for EUR 45.25 |
19 | AMOUNT Type: NUMERIC| Length: 13 Description: Transaction balance expressed in the smallest currency unit. Hosted Payment Page equivalent: vads_amount REST API equivalent: amount E.g.: 4525 for EUR 45.25 |
20 | CURRENCY_CODE Type: VARCHAR | Length: 3 Description: Currency code (ISO 4217 alpha-3). Hosted Payment Page equivalent: vads_currency REST API equivalent: currency E.g.: EUR |
21 | FEES_EXCLUDING_VAT Type: NUMERIC | Length: 13 Description: Amount of Lyra Collect commission and end-of-month commissions if the merchant is set up to pay Lyra Collect commissions per service invoice. Pre-tax 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 |
22 | FEES_VAT_AMOUNT Type: NUMERIC | Length: 13 Description: Amount of Lyra Collect commission and end-of-month commissions if the merchant is set up to pay Lyra Collect commissions per service invoice. VAT 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 |
23 | FEES_VAT_INCLUDED Type: NUMERIC | Length: 13 Description: Amount of Lyra Collect commission and end-of-month commissions if the merchant is set up to pay Lyra Collect commissions per service invoice. Amount with taxes expressed in the smallest currency unit. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 4525 for EUR 45.25 |
24 | NETWORK_FEES Type: NUMERIC | Length: 13 Description: Estimated amount of network fees, expressed in the smallest unit of the currency. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 4525 for EUR 45.25 |
25 | INTERCHANGE_FEES Type: NUMERIC | Length: 13 Description: Estimated amount of the interchange fee, expressed in the smallest unit of the currency. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 4525 for EUR 45.25 |
26 | SEQUENCE_NUMBER Type: NUMERIC | Length: 3 Description: Installment payment sequence number. Hosted Payment Page equivalent: vads_sequence_number REST API equivalent: transactionDetails.sequenceNumber E.g.: 1 |
27 | SEQUENCE_COUNT Type: NUMERIC | Length: 3 Description: Total number of occurrences. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 1 |
28 | PAYMENT_DATE Type: TIMESTAMP | Length: 17 Description: Date and time of the payment (ISO 8601 standard), in UTC time zone. Hosted Payment Page equivalent: vads_effective_creation_date REST API equivalent: creationDate E.g.: 2020-01-07T13:33+00Z |
29 | CARD_VALIDITY Type: NUMERIC | Length: 7 Description: Payment method validity period. Hosted Payment Page equivalent: vads_expiry_month + "/" + vads_expiry_year REST API equivalent: transactionDetails.cardDetails.expiryMonth + "/" + transactionDetails.cardDetails.expiryYear E.g.: 06/2050 |
27 | CARD_TYPE Type: VARCHAR | Length: 255 Description: Payment method. Hosted Payment Page equivalent: vads_card_brand REST API equivalent: transactionDetails.cardDetails.effectiveBrand E.g.: CB,VISA, MASTERCARD, etc. |
31 | CARD_NUMBER Description: Payment method number in 123456XXXXXX1234 format. Hosted Payment Page equivalent: vads_card_number REST API equivalent: transactionDetails.cardDetails.pan E.g.: 123456XXXXXX1234 |
32 | BUSINESS_CARD Type: BOOLEAN | Length: 1 Description: Boolean allowing to identify commercial cards. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: false |
33 | PAYMENT_METHOD_COUNTRY Type: VARCHAR | Length: 2 Description: Country code (ISO 3166 alpha-2 standard) of the card. Hosted Payment Form equivalent: vads_card_country REST API equivalent: transactionDetails.cardDetails.country E.g.: FR for France |
34 | BANK_CODE Type: VARCHAR | Length: 255 Description: Code of the bank that issued the payment method. Hosted Payment Form equivalent: vads_bank_code REST API equivalent: transactionDetails.cardDetails.issuerCode E.g.: 30003 |
35 | BANK_NAME Type: VARCHAR | Length: 255 Description: Name of the bank that issued the payment method. Hosted Payment Form equivalent: vads_bank_label REST API equivalent: transactionDetails.cardDetails.issuerName E.g.: 31c1d62734ef479f87cfd30bef8c7e01 |
36 | PRODUCT_BANK_CODE Type: VARCHAR | Length: 255 Description: Card product code. Hosted Payment Form equivalent: vads_bank_product REST API equivalent: transactionDetails.cardDetails.effectiveProductCode E.g.: |
37 | RESPONSE_CODE Type: NUMERIC| Length: 2 Description: Return code of the requested operation. For more information, please see parameter BANK_RESPONSE_CODE. Values:
E.g.: 00 |
38 | CERTIFICATE Type: VARCHAR| Length: 255 Description: Transaction certificate. Hosted Payment Page equivalent: vads_payment_certificate REST API equivalent: N/A E.g.: 6ed7b71c023a20adbadf9a2e2c58cd4321f63123 |
39 | AUTORISATION_ID Type: VARCHAR| Length: 20 Description: Transaction authorization number. Hosted Payment Page equivalent: vads_auth_number REST API equivalent: transactionDetails.cardDetails.authorizationResponse.authorizationNumber E.g.: 3fc116 |
40 | OUTCOME_STATUS Type: VARCHAR | Length: 255 Description: Status of the authorization request. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: OK |
41 | CUSTOMER_IP_ADDRESS Type: VARCHAR | Length: 255 Description: Buyer IP address. Hosted Payment Page equivalent: N/A REST API equivalent: customer.extraDetails.ipAddress E.g.: 185.244.73.2 |
42 | ACCOUNT_SERIAL Description: Token followed by the potential subscription number, separated by a hyphen “-”. Hosted Payment Page equivalent: vads_identifier“ - ” vads_subscription REST API equivalent: paymentMethodToken "-" subscriptionId E.g.: 5fa8d3dede8f4c219c4652dfabe2bf55-20191106ANav0o |
43 | OPERATOR_SALES_AMOUNT Type: NUMERIC | Length: 13 Description: Amount of the Marketplace operator's own sales. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 4525 for EUR 45.25 |
44 | OPERATOR_FEE_AMOUNT Type: NUMERIC | Length: 13 Description: Marketplace commission amount. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 4525 for EUR 45.25 |
45 | ENTRY_MODE Type: NUMERIC | Length: 1 Description: Card reading mode. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: 4 |
46 | HOLDER_CHECK_METHOD Type: NUMERIC | Length: 1 Description: Cardholder authentication mode. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: 1 |
47 | AID Type: NUMERIC | Length: 13 Description: Application Identifier. Corresponds to the “software” linked to the network used on the POS. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: A0000000031010 |
48 | AUTHORISATION_REASON Type: NUMERIC | Length: 4 Description: Reason of the authorization request. Hosted Payment Page equivalent: N/A REST API equivalent: N/A | Possible values:
E.g.: 4204 |
49 | AUTHORISATION_FORCING_CODE Type: NUMERIC | Length: 1 Description: Override code. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: 1 |
50 | CONTACTLESS_DEVICE Type: NUMERIC | Length: 13 Description: Form factor. Indicates which type of medium was used for the contactless payment: card or phone. Hosted Payment Page equivalent: N/A REST API equivalent: N/A |
51 | IDSA Type: NUMERIC | Length: 13 Description: Acceptance system identifier. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 21P0000E |
52 | ITP Type: NUMERIC | Length: 12 Description: Payment Terminal ID. Hosted Payment Page equivalent: N/A REST API equivalent: N/A E.g.: 143521100587 |
53 | ERT Type: NUMERIC | Length: 2 Description: Regulatory and technical environment. Hosted Payment Page equivalent: N/A REST API equivalent: N/A Possible values:
E.g.: 10 |
54 | DATA_COMP_1 Type: VARCHAR | Length: 4 Description: Chargeback reason code for a chargeback transaction. |
55 | DATA_COMP_2 Type: VARCHAR | Length: 255 Description: Lyra Collect commission billing method :
|
56 | DATA_COMP_3 Type: NUMERIC (21,5) | Length: 5 Description: Amount of all commissions (month-end or other) in VAT in decimal format (5 decimal places) |
57 | DATA_COMP_4 Type: NUMERIC (21,5) | Length: 5 Description: VAT amount of all commissions (month-end or other) in VAT in decimal format (5 decimal places) |
58 | DATA_COMP_5 Type: VARCHAR | Length: 255 Description: Acceptance system logical number (NLSA). |
59 | DATA_COMP_6 Type: VARCHAR | Length: 255 Description: Reserved for future use |
60 | DATA_COMP_7 Type: VARCHAR | Length: 255 Description: Reserved for future use |
61 | DATA_COMP_8 Type: VARCHAR | Length: 255 Description: Reserved for future use |
62 | DATA_COMP_9 Type: VARCHAR | Length: 255 Description: Reserved for future use |
63 | DATA_COMP_10 Type: VARCHAR | Length: 255 Description: Reserved for future use |
64 | DATA_COMP_11 Type: VARCHAR | Length: 255 Description: Reserved for future use |
65 | DATA_COMP_12 Type: VARCHAR | Length: 255 Description: Reserved for future use |
66 | DATA_COMP_13 Type: VARCHAR | Length: 255 Description: Reserved for future use |
67 | DATA_COMP_14 Type: VARCHAR | Length: 255 Description: Reserved for future use |
68 | DATA_COMP_15 Type: VARCHAR | Length: 255 Description: Reserved for future use |
69 | DATA_COMP_16 Type: VARCHAR | Length: 255 Description: Reserved for future use |
70 | DATA_COMP_17 Type: VARCHAR | Length: 255 Description: Reserved for future use |
71 | DATA_COMP_18 Type: VARCHAR | Length: 255 Description: Reserved for future use |
72 | DATA_COMP_19 Type: VARCHAR | Length: 255 Description: Reserved for future use |
73 | DATA_COMP_20 Type: VARCHAR | Length: 255 Description: Reserved for future use |
File sample
Download the sample pack: https://docs.lyra.com/files/samples/sample-files-collect.zip.
You will find a sample file in the JAM folder.