• 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

V3 Format

The « TITRE » record

Pos. Description Values
01 Record code TITRE
02 The shop label, as defined in the Merchant Back Office. E.g.: DEMO Store
03 UTC date and time of dispatch in the ISO 8601 format E.g.: 2017-12-15T16:53Z
04 Version TABLE_V3

The « ENTETE » (HEADER) and « DETAILS » records

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 Form 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 Form 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 Form 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 Form equivalent: vads_currency

REST API equivalent: currency

E.g.: 978 for euro (EUR) (See chapter List of supported currencies).

09 PAYMENT_METHOD

Type: VARCHAR | Length: 255

Description: Payment method.

Hosted Payment Form 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 Form 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 vads_order_info, vads_order_info2, vads_order_info3 fields of the payment form.
  • Via the attributes orderInfo, orderInfo2, orderInfo3 of the REST API metadata object.

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 Form 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 Form 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: TIMESTAMP | Length: 17

Description: Date and time (ISO 8601 standard) of the capture in UTC time zone.

Hosted Payment Page equivalent: N/A

REST API equivalent: transactionDetails.cardDetails.captureResponse.captureDate

E.g.: 2020-01-07T23:05Z

16 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

17 MATCH_STATUS

Type: VARCHAR | Length: 255

Description: Reconciliation status.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Value: Always set to MATCH_OK.

18 REMITTANCE_NB

Type: NUMERIC | Max length: 6

Description: Capture number.

Hosted Payment Page equivalent: N/A

REST API equivalent: transactionDetails.cardDetails.captureResponse.captureFileNumber

E.g.: 22

19 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

20 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

21 COMMISSION_CURRENCY

Type: NUMERIC | Length: 6

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

22 INTERCHANGE

Type: NUMERIC | Length: 13

Description: Amount of the exchange fees.

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

23 SCHEME_CHARGE_AMOUNT

Type: NUMERIC | Length: 13

Description: Amount of the network commission.

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

24 BANK_CHARGE_AMOUNT

Type: NUMERIC | Length: 13

Description: Amount of the bank commission.

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

25 CARD_NATURE

Type: VARCHAR | Length: 1

Description: Nature of the card.

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

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

E.g.: P

26 TRANSACTION_REGIONALITY

Type: VARCHAR | Length: 3

Description: Geographic area of the payment.

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

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

E.g.: FRA

27 CARD_HOLDER_COUNTRY_CODE

Type: VARCHAR | Length: 3

Description: Country code (ISO 3166 alpha-3 standard) of the card.

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.: FRA for France

28 CARD_SCHEME

Type: NUMERIC | Length: 1

Description: Card scheme.

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

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

E.g.: 1

29 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

30 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

31 TRANSACTION_UUID

Type: VARCHAR | Length: 255

Description: Unique transaction ID.

Hosted Payment Page equivalent: vads_trans_uuid

REST API equivalent: uuid

E.g.: e078b7a6a01c494eae6afd52c4ea2bee

32 DATA_COMP_1

Type: VARCHAR | Length: 255

Description: Unique Identifier (UUID) of the original transaction in case of refund or duplication.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 31c1d62734ef479f87cfd30bef8c7e01

33 DATA_COMP_2

Type: TIMESTAMP | Length: 17

Description: Value date (ISO 8601 standard), in UTC time zone.

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

Hosted Payment Page equivalent: vads_effective_creation_date

REST API equivalent: creationDate

E.g.: 2020-01-10T23:00Z

34 DATA_COMP_3

Type: NUMERIC | Length: 15

Description: Unique capture reference.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: 000000002200001

35 DATA_COMP_4

Type: VARCHAR | Length: 255

Description: Token or Unique Mandate Reference in case of a SEPA payment.

Hosted Payment Page equivalent: vads_identifier

REST API equivalent: paymentMethodToken

E.g.: d413bdbf0071390ce332d0acd977f270

36 DATA_COMP_5

Type: VARCHAR | Length: 255

Description: End-to-End Identification.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: L00893307901

37 DATA_COMP_6

Type: VARCHAR | Length: 255

Description: Buyer’s legal name or last name.

Set to the value of the vads_cust_legal_name field associated with the token.

Otherwise, set to the value of the vads_cust_first_name and vads_cust_last_name fields associated with the token, separated by a space character.

Hosted Payment Page equivalent: vads_cust_legal_name if applicable, otherwise vads_cust_first_name + vads_cust_last_name.

REST API equivalent: customer.billingDetails.firstName + customer.billingDetails.lastName

E.g.:
  • The Company
  • Jean Dupont
38 DATA_COMP_7

Type: TIMESTAMP | Length: 17

Description:
  • Date and time (ISO 8601 standard) in UTC time zone of the capture requested by the merchant for a payment by card.
  • Date and time (ISO 8601 standard) in UTC time zone of the funds transfer for a SEPA payment.

Hosted Payment Page equivalent: vads_presentation_date

REST API equivalent: transactionDetails.cardDetails.expectedCaptureDate

E.g.: 2020-01-10T23:00Z

39 DATA_COMP_8

Type: VARCHAR | Length: 255

Description: SEPA Creditor Identifier of the company. Always populated in case of a SEPA payment.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

E.g.: FR12ZZZ123456

40 DATA_COMP_9

Type: VARCHAR | Length: 255

Description: Reserved for future use

41 DATA_COMP_10

Type: VARCHAR | Length: 255

Description: Reserved for future use

42 DATA_COMP_11

Type: VARCHAR | Length: 255

Description: Reserved for future use

43 DATA_COMP_12

Type: VARCHAR | Length: 255

Description: Reserved for future use

44 DATA_COMP_13

Type: VARCHAR | Length: 255

Description: Reserved for future use

45 DATA_COMP_14

Type: VARCHAR | Length: 255

Description: Reserved for future use

46 DATA_COMP_15

Type: VARCHAR | Length: 255

Description: Reserved for future use

47 DATA_COMP_16

Type: VARCHAR | Length: 255

Description: Reserved for future use

48 DATA_COMP_17

Type: VARCHAR | Length: 255

Description: Reserved for future use

49 DATA_COMP_18

Type: VARCHAR | Length: 255

Description: Reserved for future use

50 DATA_COMP_19

Type: VARCHAR | Length: 255

Description: Reserved for future use

51 DATA_COMP_20

Type: VARCHAR | Length: 255

Description: Reserved for future use

The “FIN” record

Pos. Description Values
01 Record code FIN

File sample

Download the sample pack: https://scelliuspaiement.labanquepostale.fr/doc/files/samples/sample-files.zip.

You will find a sample file in the JRB folder.

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