Format

The « TITRE » record

The TITRE record provides information about file characteristics for its identification. It is populated as follows:

Pos. Description Values
01 Record code TITRE
02 Shop name
03 Delivery UTC date and time (YY/MM/DD_hh:mm:ss) 20/01/13_01:55:00
04 Version TABLE_V_CUSTOM

The « ENTETE » and « DETAILS » records

The ENTETE line lists the various labels to be populated in the report. The information in the DETAILS line populates the labels of the ENTETE record for each transaction.

By default, the data listed below are included in the transactions report file:

Pos. Description
01 ENTETE

Type: VARCHAR | Length: 11

Description: Record code.

Value: Always set to TRANSACTION

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

04 PAYMENT_MEANS

Type: VARCHAR | Length: 4

Description: Payment method. (Obsolete)

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Value: Always set to CARD.

05 CONTRACT

Type: VARCHAR | Length: 255

Description: Merchant ID number.

Hosted Payment Page equivalent: vads_contract_used

REST API equivalent: transactionDetails.mid

E.g.: 0535875

06 TRANSACTION_TYPE

Type: VARCHAR | Length: 255

Description: Transaction type

Hosted Payment Page equivalent: vads_operation_type

REST API equivalent: operationType

Values:
  • CREDIT for a refund transaction
  • DEBIT for a debit transaction
  • VERIFICATION for a transaction of payment method verification

E.g.: DEBIT

07 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.: 3000 for 30,00 EUR

08 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.: 3000 for 30,00 EUR

09 CURRENCY_CODE

Type: NUMERIC | Length: 3

Description: Numeric code of the currency (ISO 4217 standard).

Hosted Payment Page equivalent: vads_currency

REST API equivalent: currency

E.g.: 978 for euro (EUR) (See table vads_currency in annexes)

10 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

11 PAYMENT_TIME

Type: TIME | Length: 6

Description: Time of payment in UTC time zone.

Hosted Payment Page equivalent: vads_effective_creation_date

REST API equivalent: creationDate

E.g.: 142512

12 CARD_VALIDITY

Type: NUMERIC | Length: 6

Description: Payment method validity period.

Hosted Payment Page equivalent: vads_expiry_year + vads_expiry_month

REST API equivalent: transactionDetails.cardDetails.expiryYear + transactionDetails.cardDetails.expiryMonth

E.g.: 202306

13 CARD_TYPE

Type: VARCHAR | Length: 255

Description: Card type.

Hosted Payment Page equivalent: vads_card_brand

REST API equivalent: transactionDetails.cardDetails.effectiveBrand

E.g.: CB, VISA, MASTERCARD, etc.

14 CARD_NUMBER

Description: The 6 first digits of the payment method.

Hosted Payment Page equivalent: vads_card_number

REST API equivalent: transactionDetails.cardDetails.pan

E.g.: 497014

15 RESPONSE_CODE

Type: NUMERIC | Length: 2

Description: Return code of the requested operation.

Hosted Payment Page equivalent: vads_result

REST API equivalent: N/A

Values:
  • 00: Accepted authorization.
  • 05: Authorization refused.
  • 34: Suspected fraud.
  • 75: The maximum number of card number entry attempts has been exceeded.
  • 96: Service temporarily unavailable.

E.g.: 00

16 COMPLEMENTARY_CODE

Type: NUMERIC | Length: 2

Description: Risk assessment result (specific to shops that have enabled the module). The field is empty if no verifications have been completed.

Hosted Payment Page equivalent: vads_extra_result

REST API equivalent: N/A

Values:
  • 00: Verifications successfully performed.
  • 02: Credit card velocity exceeded.
  • 03: The card is on the merchant’s greylist.
  • 04: The issuing country of the card is on the greylist or is not on the merchant’s whitelist.
  • 05: The IP address is on the merchant's greylist.
  • 06: The card is on the merchant's BIN greylist.
  • 07: E-carte bleue control.
  • 08: Transaction not 3DS guaranteed.
  • 14: Control of a card with unconditional authorization.
  • 20: Verification of the country consistency between the card issuing country, the IP address and country of the customer's address.
  • 99: Technical issue encountered by the server during a local verification process.

E.g.: 00

17 CERTIFICATE

Type: VARCHAR | Length: 255

Description: Transaction certificate.

Hosted Payment Page equivalent: vads_payment_certificate

REST API equivalent: N/A

E.g.: 6ed7b71c023a20adbadf9a2e2c58cd4321f63123

18 AUTORISATION_ID

Type: VARCHAR | Length: 6

Description: Transaction authorization number.

Hosted Payment Page equivalent: vads_auth_number

REST API equivalent: transactionDetails.cardDetails.authorizationResponse.authorizationNumber

E.g.: 3fc116

19 CAPTURE_DATE

Type: DATE | Length: 8

Description: Date of sending to the requested bank.

Hosted Payment Page equivalent: vads_presentation_date

REST API equivalent: transactionDetails.cardDetails.expectedCaptureDate

E.g.: 20200107

20 TRANSACTION_STATUS

Type: VARCHAR | Length: 255

Description: Transaction status.

Hosted Payment Page equivalent: vads_trans_status

REST API equivalent: detailedStatus

Values: See chapter vads_trans_status

E.g.: CAPTURED

21 RETURN_CONTEXT

Type: VARCHAR | Length: 500

Description: Context of buyer’s purchase.

Concatenation of the values of vads_order_info, vads_order_info2, vads_order_info3 of the payment form, separated by the "|” character. Beyond 500 characters, the string is truncated. The field is empty if no vads_order_info is transmitted.

Hosted Payment Page equivalent: vads_order_info | vads_order_info2 | vads_order_info3

REST API equivalent: N/A

E.g.:
  • info1|info2|info3 if the 3 fields are transmitted,
  • info1||info3: if only vads_order_info 1 and 3 are transmitted.
22 AUTORESPONSE_STATUS

Type: VARCHAR | Length: 255

Description: Delivery status of the IPN.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:
  • FAILED: Failure of notification to the merchant server.
  • SENT: Notification sent to the merchant server.
  • UNDEFINED: An event has triggered the notification rule for end of payment but the URL is not configured.
E.g.: SENT
23 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

24 CUSTOMER_ID

Type: VARCHAR | Length: 255

Description: Customer reference generated by the merchant website.

Hosted Payment Page equivalent: vads_cust_id

REST API equivalent: customer.reference

E.g.: C2383333540

25 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

26 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

27 TRANSACTION_CONDITION

Type: VARCHAR | Length: 255

Description: 3D Secure authentication result.

Hosted Payment Page equivalent: N/A

REST API equivalent: transactionDetails.cardDetails.threeDSResponse.authenticationResultData.transactionCondition

Values:
  • 3D_SUCCESS: The merchant and the cardholder have enabled3D Secure and the card has been successfully authenticated.
  • 3D_FAILURE: The merchant and the buyer have enabled 3D Secure but the authentication has failed.
  • 3D_ERROR: The merchant has enabled 3D Secure but a technical issue has occurred.
  • 3D_NOTENROLLED: The merchant has enabled 3D Secure but the buyer is not enrolled.
  • 3D_ATTEMPT: The merchant and the cardholder have enabled 3D Secure but the cardholder was unable to authenticate.
  • SSL: The cardholder has not authenticated:
    • either the card type is not supported by 3D Secure,
    • or the merchant/cardholder has not enabled 3D Secure

E.g.: 3D_SUCCESS

28 CAVV_UCAF

Type: VARCHAR | Length: 255

Description: 3D Secure transaction certificate.

Hosted Payment Page equivalent: vads_threeds_cavv

REST API equivalent: transactionDetails.cardDetails.threeDSResponse.authenticationResultData.cavv

E.g.: Q2F2dkNhdnZDYXZ2Q2F2dkNhdnY=

29 COMPLEMENTARY_INFO

Type: VARCHAR | Length: 255

Description: Details of the risk assessment result.

Option reserved to the merchants who have enabled the Risk management module.

Hosted Payment Page equivalent: vads_risk_control

REST API equivalent: transactionDetails.fraudManagement.riskControl

Values:
  • CARD_COUNTRY=XXX: XXX corresponds to the country code in the Iso 3166 alpha-3 3166 format.
  • MAESTRO=YES|NO: indicates if the used payment method is a Maestro card.
  • CAS=YES|NO: indicates if the used payment method is a card with unconditional authorization.
  • ECBL=YES|NO: indicates if the used payment method is an eCarte-Bleue card.
  • CCC=YES|NO: indicates if an inconsistency between the country of the buyer, the payment method and the buyer’s IP address has been detected.
  • BDOM: Label of the bank that issued the payment method.
  • PRODUCTCODE: Card product.
  • BANKCODE: Bank code.

E.g.: MAESTRO=NO|ECBL=NO|PRODUCTCODE=MDS

30 BANK_RESPONSE_CODE

Type: NUMERIC | Length: 2

Description: Response code of the authorization request returned by the issuing bank.

Hosted Payment Page equivalent: vads_auth_result

REST API equivalent: transactionDetails.cardDetails.authorizationResponse.authorizationResult

Values: See chapter vads_auth_result.

E.g.: 00

31 3D_LS

Type: VARCHAR | Length: 255

Description: 3D Secure payment guarantee.

Hosted Payment Page equivalent: vads_warranty_result

REST API equivalent: transactionDetails.liabilityShift

Values:
  • YES: Payment guaranteed 3D Secure.
  • NO: Payment not guaranteed 3D Secure.
  • UNKNOWN: Payment guarantee cannot be determined following a technical error.

E.g.: YES

32 INFO_EXTRA

Type: VARCHAR | Length: 255

Description: Populated with customizable fields allowing to add details to the confirmation e-mail sent to the merchant and in the IPN URL (vads_ext_info_).

Hosted Payment Page equivalent: vads_ext_info

REST API equivalent: N/A

E.g.:

If vads_ext_info_key1=value1 and vads_ext_info_key2=value2,INFO_EXTRA is populated as follows:

key1=value1|key2 = value2

Example of a file

Download the pack of examples: https://paiement.systempay.fr/doc/files/samples/sample-files.zip.

You will find a sample file in the JT folder.