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 Sent on (YY/MM/DD) 20/01/14
04 Version V1
05 File description LES IMPAYÉS RAPPROCHÉS DU JOUR

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.

Pos. Description
01 ENTETE

Type: VARCHAR | Length: 6

Description: Record code.

Value: DETAIL

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 OPERATION_TYPE

Type: VARCHAR | Length: 1

Description: Type of operation.

Hosted Payment Page equivalent: vads_operation_type

REST API equivalent: operationType

Values:
  • D: Debit (purchase receipt)
  • C: Credit (credit receipt)

E.g.: D

08 SOURCE_AMOUNT

Type: NUMERIC | Length: 13

Description: Gross amount of the receipt.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 3000 for 30,00 EUR

09 SIRET

Type: VARCHAR | Length: 255

Description: Legal identifier of the company.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Value:

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

E.g.: 045251785700028

10 UNPAID_NB

Type: NUMERIC | Length: 11

Description: Number of the chargeback file.

Always empty for transactions made within the GATECONEX network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 00000645948

11 UNPAID_CODE

Description: Code of the chargeback reason.

Always empty for transactions made within the GATECONEX network.

Always set to 45 for transactions made within the CB network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 45 (See Table of reasons for chargeback

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

13 CONTRACT_TYPE

Description: MID type.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:
  • 3: payment made on one of the following networks: CB, SEPA, AMEX, PPRO, GATECONEX.
  • empty: payment made within the PAYPAL network

E.g.: 3

14 POS_NB

Type: NUMERIC | Length: 8

Description: Number of the point of sale.

Hosted Payment Page equivalent: vads_site_id

REST API equivalent: shopId

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

E.g.: 12345678

15 REMITTANCE_DATE

Description: Capture date.

Hosted Payment Page equivalent: N/A

REST API equivalent: transactionDetails.cardDetails.captureResponse.captureDate

E.g.: 20200107

16 EXCHANGE_AMOUNT

Type: NUMERIC | Length: 13

Description: Amount of the invoice in counter currency. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 3000 for 30,00 EUR

17 VALUE_DATE

Description: Value date. Empty field if not provided by acquirer.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 20200114

18 UNPAID_AMOUNT

Type: NUMERIC | Length: 13

Description: Chargeback amount.

Always empty for transactions made within the GATECONEX network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 3000 for 30,00 EUR

19 EXCHANGE_UNPAID_AMOUNT

Type: NUMERIC | Length: 13

Description: Amount of the non-payment in counter currency. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 3000 for 30,00 EUR

20 EXCHANGE_CURRENCY_CODE

Type: NUMERIC | Length: 3

Description: Numeric code of the counter currency (ISO 4217 standard). Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

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

21 CHARGED_BANK_CODE

Type: NUMERIC | Length: 5

Description: Bank code to apply. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 14707

22 CHARGED_COUNTER

Type: NUMERIC | Length: 5

Description: Original counter code. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 00070

23 CHARGED_ACCOUNT

Description: Account number. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 01234567890

24 CHARGED_ADMIN_ACCOUNT

Type: NUMERIC | Length: 5

Description: Administrator account. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 00070

25 PBA_REMIT_NB

Type: NUMERIC | Length: 6

Description: PBA capture number. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 123456

26 MATCH_STATUS

Description: Chargeback reconciliation status.

Values:
  • MATCH_OK: Reconciliation made
  • MATCH_ANALYSE: To be analyzed
  • R_CHARGEBACK: SEPA chargeback

Always set to MATCH_OK for transactions made within the AMEXGLOBAL network.

Always set to MATCH_OK for transactions made within the PAYPAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: MATCH_OK

27 CUSTOMER_ID

Description: Customer reference generated by the merchant website.

Hosted Payment Page equivalent: vads_cust_id

REST API equivalent: customer.reference

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

E.g.: C2383333540

28 ORDER_ID

Description: Order number generated by the merchant website.

Hosted Payment Page equivalent: vads_order_id

REST API equivalent: orderDetails.orderId

E.g.: CX-1254

29 RETURN_CONTEXT

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.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

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.
30 TRANSACTION_STATUS

Description: Transaction status.

Hosted Payment Page equivalent: vads_trans_status

REST API equivalent: detailedStatus

Values: See chapter vads_trans_status

E.g.: CAPTURED

31 CURRENT_AMOUNT

Type: NUMERIC | Length: 13

Description: Current transaction amount. Corresponds to the captured amount minus the refunded amount or the amount waiting for refund.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 3000 for 30,00 EUR

32 ORIGIN_AMOUNT

Type: NUMERIC | Length: 13

Description: Initial transaction amount

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 3000 for 30,00 EUR

33 CARD_TYPE

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.
34 CHARGED_CARD_TYPE

Description: Type of chargeback.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Value: always empty.

35 UNPAID_SETTLE_DATE

Description: Non-payment settlement date. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 20200114

36 UNPAID_DOC_REASON

Description: Motive of document request. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.:

37 UNPAID_DOC_DATE

Description: Date of the initial documentation request. Empty field if not provided by acquirer.

Always empty for PayPal transactions.

Always empty for transactions made within the GATECONEX network.

Always empty for transactions made within the AMEXGLOBAL network.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 20200114

The “FIN” record

Pos. Description Values
01 Record code FIN

File sample

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

You will find a sample file in the JRI folder.