• France
status page
demonstrations
assistance
FAQContact support
Search
Categories
Tags
English
French
English
Homepage
Use cases
Create a payment
Create an installment payment
Create a multi-card (split) payment
Create a payment by Alias (Token)
Create a payment link
Create a recurring payment
Manage subscriptions
Manage your transactions (refund, cancel...)
Analyze your reports
API docs
Embedded Form
REST API
Hosted payment
Mobile payment
File exchange
Snippets
Payment methods
Plugins
Guides
Merchant Back Office
Functional guides

V2 Format

The record« TITRE »

Pos. Description Values
01 Record code TITRE
02 The shop label, as defined in the Merchant Back Office. E.g.: DEMO Store
03 Dispatch date and time (YY/MM/DD_HH:MM:SS) 20/01/14_03:05:00
04 Version TABLE_V2

The record« ENTETE »and« DETAILS »

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.:FRfor 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: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:33Z

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.: 4525 for EUR 45.25

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

Values: List of supported currencies

E.g.: 978 for euro (EUR)

09 PAYMENT_METHOD

Type:VARCHAR| Length: 255

Description: Payment method.

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 “additional information”, separated by the | character”.

Additional information can be transmitted through the merchant website:

  • via the field vads_order_info, vads_order_info2, vads_order_info3 payment form,
  • via attributes orderInfo, orderInfo2, orderInfo3 of the object metadata of the REST API

Beyond 500 characters, the string is truncated.

Empty field if no additional information is transmitted.

Hosted Payment Page equivalent: vads_order_info | vads_order_info2 | vads_order_info3

|

REST API equivalent: orderInfo | orderInfo2 | orderInfo3

E.g.:
  • info1|info2|info3 if the 3 pieces of additional information are transmitted.
  • info1||info3: if only the 1st and 3rd pieces of additional information 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.: 4525 for EUR 45.25

18 MATCH_STATUS

Type:VARCHAR| Length: 8

Description: Reconciliation status.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Value: Always populated withMATCH_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.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 4525 for EUR 45.25

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.: 4525 for EUR 45.25

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 chapter List of supported currencies).

23 INTERCHANGE

Type:NUMERIC| Length: 13

Description: Amount of the exchange fees. Empty field if not provided by acquirer.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 4525 for EUR 45.25

24 SCHEME_CHARGE_AMOUNT

Type:NUMERIC| Length: 13

Description: Amount of the network commission. Empty field if not provided by acquirer.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 4525 for EUR 45.25

25 BANK_CHARGE_AMOUNT

Type:NUMERIC| Length: 13

Description: Amount of the bank commission. Empty field if not provided by acquirer.

E.g.: 4525 for EUR 45.25

26 CARD_NATURE

Type:VARCHAR| Length: 1

Description: Nature of the card. Empty field if not provided by acquirer.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:
  • P : Consumer Card
  • E : Commercial Card

E.g.: P

27 TRANSACTION_REGIONALITY

Type:VARCHAR| Length: 3

Description: Geographic area of the payment. Empty field if not provided by acquirer.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:
  • FRA : Domestic
  • UE : Inside EU
  • HUE : Outside EU

E.g.: FRA

28 CARD_HOLDER_COUNTRY_CODE

Type:VARCHAR| Length: 3

Description: Country code (ISO 3166 alpha-3 standard) of the card. Empty field if not provided by acquirer.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: FRA for France

29 CARD_SCHEME

Type:NUMERIC| Length: 1

Description: Card scheme. The field is empty if it is not transmitted by the acquirer.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:
  • 1 :CB
  • 2 :VISA
  • 3 :MCI
  • 4 :ECI
  • 9 : Undetermined (CB or VISA)

E.g.: 1

30 CARD_PRODUCT_CATEGORY

Type:VARCHAR| Length: 1

Description: Card product category.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:
  • C : CREDIT
  • D : DEBIT
  • P : PREPAID

E.g.: D

31 ACQ_INFOS

Type:VARCHAR| Length: 255

Description: Complementary information sent by the acquirer.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:

CardCategory=XX

XX can take one of the following values:

  • HE : Card outside EU
  • CO : Intra-EU commercial card
  • DT : Intra-EU debit card
  • CT : Intra-EU credit card
  • UV : Intra-EU universal card (CB only)
  • NR : Intra-EU unregulated credit card

E.g.: CardCategory=UV

The record «FIN”

Pos. Description Values
01 Record code FIN

File sample

Download the sample pack: https://sogecommerce.societegenerale.eu/doc/files/samples/sample-files.zip.

You will find a sample file in the folderReporting/JRB.

© 2024 {'|'} All rights reserved to Sogecommerce
2.91.0-doc-1.11