Data available for customization

In addition to using the labels of columns displayed in the pre-formatted transactions report, the merchant can also use the labels described in the table.

Label / Description
AUTH_DATE

Type: DATE | Length: 8

Description: Authorization date (YYYYMMDD).

Hosted Payment Page equivalent: N/A

REST API equivalent: transactionDetails.cardDetails.authorizationResponse.authorizationDate

E.g.: 20200114

CONTRIB

Type: VARCHAR | Length: 255

Description: eCommerce Solution used for the payment (Joomla, osCommerce, etc.). For proprietary implementations, this field can include the version number of the software developed by the merchant. The field is empty if it is not transmitted in the payment request.

Hosted Payment Page equivalent: vads_contrib

REST API equivalent: contrib.

E.g.: PrestaShop_1.5-1.7_1.12.0/1.7.6.2/7.1.32

CUSTOMER_ADDRESS

Type: VARCHAR | Length: 255

Description: Buyer's address.

Hosted Payment Page equivalent: vads_cust_address

REST API equivalent: customer.billingDetails.address

E.g.: Innovation Street

CUSTOMER_CITY

Type: VARCHAR | Length: 255

Description: Buyer’s city.

Hosted Payment Page equivalent: vads_cust_city

REST API equivalent: customer.billingDetails.city

E.g.: Dijon

CUSTOMER_COUNTRY

Type: VARCHAR | Length: 2

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

Hosted Payment Page equivalent: vads_cust_country

REST API equivalent: customer.billingDetails.country

E.g.: FR for France

CUSTOMER_FIRSTNAME

Type: VARCHAR | Length: 255

Description: Buyer’s first name.

Hosted Payment Page equivalent: vads_cust_first_name

REST API equivalent: customer.billingDetails.firstName

E.g.: Emile

CUSTOMER_MAIL

Type: VARCHAR | Length: 255

Description: Buyer's e-mail address.

Hosted Payment Page equivalent: vads_cust_email

REST API equivalent: customer.email

E.g.: sample@example.net

CUSTOMER_MOBILE_PHONE

Type: VARCHAR | Length: 255

Description: Buyer's mobile phone.

Hosted Payment Page equivalent: vads_cust_cell_phone

REST API equivalent: customer.billingDetails.cellPhoneNumber

E.g.: 06123456789

CUSTOMER_NAME

Type: VARCHAR | Length: 255

Description: Buyer's last name.

Hosted Payment Page equivalent: vads_cust_last_name

REST API equivalent: customer.billingDetails.lastName

E.g.: Gravier

CUSTOMER_NATIONAL_ID

Type: VARCHAR | Length: 255

Description: Buyer's national identifier (CPF/CNPF in Brazil).

Hosted Payment Page equivalent: vads_cust_national_id

REST API equivalent: customer.billingDetails.identityCode

E.g.: 12.345.678/0001-18

CUSTOMER_PHONE

Type: VARCHAR | Length: 255

Description: Buyer's phone.

Hosted Payment Page equivalent: vads_cust_phone

REST API equivalent: customer.billingDetails.phoneNumber

E.g.: 0123456789

CUSTOMER_STATE

Type: VARCHAR | Length: 255

Description: Buyer's state

Hosted Payment Page equivalent: vads_cust_state

REST API equivalent: customer.billingDetails.state

E.g.: Bourgogne-Franche-Comté

CUSTOMER_TITLE

Type: VARCHAR | Length: 255

Description: Buyer's title.

Hosted Payment Page equivalent: vads_cust_title

REST API equivalent: N/A

E.g.: Madame

CUSTOMER_ZIP_CODE

Type: VARCHAR | Length: 255

Description: Buyer's postal code.

Hosted Payment Page equivalent: vads_cust_zip

REST API equivalent: customer.billingDetails.zipCode

E.g.: 21000

ERROR_CODE

Type:NUMERIC | Length: 3

Description: Error details in case of declined payment.

Hosted Payment Page equivalent: vads_payment_error

REST API equivalent: N/A

E.g.: 149

LITIGES

Type: BOOLEAN | Length: 5

Description: Reconciliation of the chargeback.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

Values:
  • true

    The chargeback reconciliation option for non-payments is enabled and a lawsuit has been filed concerning the transaction regardless of the dispute outcome

  • false

    The Chargeback reconciliation option for non-payments is enabled and no lawsuits have been filed concerning the transaction

  • empty

    The Chargeback reconciliation option for non-payments is not enabled

E.g.: true

MATCH_STATUS

Type: VARCHAR | Length: 255

Description: Reconciliation status.

Hosted Payment Page equivalent: N/A

REST API equivalent: N/A

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

E.g.: MATCH_OK

NSU

Type: NUMERIC | Length: 255

Description: Unique sequence number (Latin America).

Hosted Payment Page equivalent: vads_authent_nsu

REST API equivalent: N/A

E.g.: 000000000000200

ORDER_INFO

Type: VARCHAR | Length: 255

Description: Context of buyer’s purchase.

Hosted Payment Page equivalent: vads_order_info

REST API equivalent: N/A

E.g.: info1

ORDER_INFO2

Type: VARCHAR | Length: 255

Description: Context of buyer’s purchase.

Hosted Payment Page equivalent: vads_order_info2

REST API equivalent: N/A

E.g.: info2

ORDER_INFO3

Type: VARCHAR | Length: 255

Description: Context of buyer’s purchase.

Hosted Payment Page equivalent: vads_order_info3

REST API equivalent: N/A

E.g.: info3

PAYMENT_MEANS_TOKEN

Type: VARCHAR | Length: 255

Description: Token of the payment method.

Hosted Payment Page equivalent: vads_identifier

REST API equivalent: paymentMethodToken

E.g.: 16ef4cd4872b48b7bd008bd41f242e3e

PAYMENT_OPTION

Type: VARCHAR | Length: 255

Description: Payment option selected during payment.

Hosted Payment Page equivalent: vads_payment_option_code

REST API equivalent: N/A

E.g.: W3063

REMITTANCE_DATE

Type: DATE | Length: 8

Description: Capture date (YYYYMMDD).

Hosted Payment Page equivalent: N/A

REST API equivalent: captureResponse.captureDate

E.g.: 20200116

REMITTANCE_NB

Type: NUMERIC | Length: 6

Description: Capture number

Hosted Payment Page equivalent: N/A

REST API equivalent: captureResponse.captureFileNumber

E.g.: 1234567

SEQUENCE_NUMBER

Type: NUMERIC | Length: 3

Description: Installment payment sequence number.

Hosted Payment Page equivalent: vads_sequence_number

REST API equivalent: transactionDetails.sequenceNumber

E.g.: 1

SHIPPING_ADDRESS

Type: VARCHAR | Length: 255

Description: Shipping address.

Hosted Payment Page equivalent: vads_ship_to_street

REST API equivalent: customer.shippingDetails.address

E.g.: Boulevard de la Croisette

SHIPPING_CITY

Type: VARCHAR | Length: 255

Description: Shipping city.

Hosted Payment Page equivalent: vads_ship_to_city

REST API equivalent: customer.shippingDetails.city

E.g.: Cannes

SHIPPING_COUNTRY

Type: VARCHAR | Length: 2

Description: Country shipping code (ISO 3166 alpha-2 standard).

Hosted Payment Page equivalent: vads_ship_to_country

REST API equivalent: customer.shippingDetails.country

E.g.: FR

SHIPPING_DISTRICT

Type: VARCHAR | Length: 255

Description: Shipping district/area.

Hosted Payment Page equivalent: vads_ship_to_district

REST API equivalent: customer.shippingDetails.district

E.g.: Croisette

SHIPPING_NAME

Type: VARCHAR | Length: 255

Description: Recipient's last name.

Hosted Payment Page equivalent: vads_ship_to_name

REST API equivalent: customer.shippingDetails.lastName

E.g.: Simon Jeremi

SHIPPING_PHONE

Type: VARCHAR | Length: 255

Description: Recipient's phone.

Hosted Payment Page equivalent: vads_ship_to_phone_num

REST API equivalent: customer.shippingDetails.phoneNumber

E.g.: 06123456789

SHIPPING_STATE

Type: VARCHAR | Length: 255

Description: Shipping state/region.

Hosted Payment Page equivalent: vads_ship_to_state

REST API equivalent: customer.shippingDetails.state

E.g.: Provence-Alpes-Côte d'Azur

SHIPPING_ZIP_CODE

Type: VARCHAR | Length: 255

Description: Shipping zip code.

Hosted Payment Page equivalent: vads_ship_to_zip

REST API equivalent: customer.shippingDetails.zipCode

E.g.: 06400

SHOP_KEY

Type: NUMERIC | Length: 8

Description: Shop ID

Hosted Payment Page equivalent: vads_site_id

REST API equivalent: shopId

E.g.: 12345678

SHOP_NAME

Type: VARCHAR | Length: 255

Description: Shop reference.

Hosted Payment Page equivalent: vads_shop_name

REST API equivalent: N/A

E.g.: Chez Laplo

TOTAL_AMOUNT

Type: NUMERIC | Length: 13

Description: Total amount of the transaction.

Hosted Payment Page equivalent:

REST API equivalent: orderDetails.orderTotalAmount

E.g.: E.g.: 3000 for 30,00 EUR

TRANSACTION_ID_EXT

Type: VARCHAR | Length: 255

Description: External transaction reference

Hosted Payment Page equivalent: vads_ext_trans_id

REST API equivalent: transactionDetails.externalTransactionId

E.g.: 1238885523

TRANSACTION_UUID

Type: VARCHAR | Length: 255

Description: UUID (Universally Unique IDentifier) - transaction identifier.

Hosted Payment Page equivalent: vads_transaction_uuid

REST API equivalent: uuid

E.g.: b7a6b9ec0a5546eebce0b0641aadf27b

USER_INFO

Type: VARCHAR | Length: 255

Description: Information about the user who made the payment. Corresponds to the user login in case od a manual payment.

Hosted Payment Page equivalent: vads_user_info

REST API equivalent: N/A

E.g.: jdupont