Format V3

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 Date and time of dispatch (YYMMDD_hh:mm:ss) 200113_02:05:00
04 Version TABLE_V3

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.

The possible labels and values are presented in the following table:

Pos. Description
01 ENTETE

Type: VARCHAR | Length: 9

Description: Record code.

Value: always set to 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 at the bank of a refund transaction
  • DEBIT_CAPTURE: Capture at the bank of a debit transaction
  • 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.: 3000 for 30,00 EUR

08 OPERATION_CURRENCY

Type: NUMERIC | Length: 3

Description: Operation currency

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 978 (See table vads_currency in the annexes)

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.

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

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 declined
  • 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 the vads_order_info,vads_order_info2, and vads_order_info3 fields values 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.

The “END” (FIN) record

Pos. Description Values
01 Record code FIN

Example of a file

Download the pack of examples: https://payzen.io/files/samples/fr/sample-files.zip.

You will find a sample file in the JO folder.