Format V1

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 date and time (YY/MM/DD_hh:mm:ss) 20/01/14_11:02:36
04 Version TABLE_V1

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

Description: Record code.

Value: MATCHING

02 MERCHANT_COUNTRY

Type: VARCHAR | Length: 2

Description: Country code of the company (ISO 3166-1 alpha-2 standard).

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: FR for France.

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 CONTRACT

Type: VARCHAR | Length: 255

Description: Merchant ID number.

Hosted Payment Page equivalent: vads_contract_used

REST API equivalent: transactionDetails.mid

E.g.: 0535875

05 PAYMENT_DATE

Type: DATE | Length: 8

Description: Date and time of the payment.

Hosted Payment Page equivalent: vads_effective_creation_date

REST API equivalent: creationDate

E.g.: 20200107

06 TRANSACTION_ID

Type: VARCHAR | Length: 6

Description: Transaction identifier.

Hosted Payment Page equivalent: vads_trans_id

REST API equivalent: cardDetails.legacyTransId

E.g.: xrT15p

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

09 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: Payment by CB card.
  • AMEX: Payment by American Express card.
  • PAYPAL: Payment via a PayPal account.
  • SDD: Payment by SEPA direct debit.
10 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

11 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.
12 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

13 OPERATION_TYPE

Type: VARCHAR | Length: 2

Description: Type of operation.

Hosted Payment Page equivalent: vads_operation_type

REST API equivalent: operationType

Values:
  • DT: Debit
  • CT: Credit

E.g.: DT

14 OPERATION_NUMBER

Type: VARCHAR | Length: 0

Description: Operation sequence number.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Value: Always empty.

15 REMITTANCE_DATE

Type: DATE | Length: 8

Description: Capture date.

Hosted Payment Page equivalent: N/A

REST API equivalent: transactionDetails.cardDetails.captureResponse.captureDate

E.g.: 20200107

16 REMITTANCE_TIME

Type: TIME | Length: 6

Description: Capture time.

Hosted Payment Page equivalent: N/A

REST API equivalent: transactionDetails.cardDetails.captureResponse.captureDate

E.g.: 034500

17 BRUT_AMOUNT

Type: NUMERIC | Length: 13

Description: Gross amount of a captured transaction (expressed in the smallest currency unit).

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 3000 for 30,00 EUR

18 MATCH_STATUS

Type: VARCHAR | Length: 8

Description: Reconciliation status.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Value: Always set to MATCH_OK.

19 REMITTANCE_NB

Type: NUMERIC | Length: 6

Description: Capture number.

Hosted Payment Page equivalent: N/A

REST API equivalent: transactionDetails.cardDetails.captureResponse.captureFileNumber

E.g.: 22

20 NET_AMOUNT

Type: NUMERIC | Length: 13

Description: Net amount (expressed in the smallest currency unit) credited to the merchant account.

Specified only if the reconciliation is performed automatically and if the acquirer transmits the information.

E.g.: 3000 for 30,00 EUR

21 COMMISSION_AMOUNT

Type: NUMERIC | Length: 13

Description: Commission fee amount (expressed in the smallest currency unit).

Specified only if the reconciliation is performed automatically and if the acquirer transmits the information.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 3000 for 30,00 EUR

22 COMMISSION_CURRENCY

Type: NUMERIC | Length: 3

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

Specified only if the reconciliation is performed automatically and if the acquirer transmits the information.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

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

The “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 JRB folder.