Understanding the structure of an operations report


From November , 2019, the date format is changing.

The value of the OPERATION_DATE, OPERATION_TIME and CAPTURE_DATE fields as well as the sending date displayed in the file header will be expressed in the UTC time zone.

The "Titre" (Title) record

The Title record provides information about the file characteristics for a better 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)
04 Version TABLE_V3

The "Entête" (Header) and "Details" records

The Header lists the various labels to be populated in the report. The information in Details populates the labels of the Header record for each transaction. The possible labels and values are presented in the following table:

Pos. "Entête" (Header) record "Details" record
Label Description Possible value Meaning
01 ENTETE Record code OPERATION  
02 MERCHANT_ID Merchant ID   Examples:

0+SIRET (Business Directory Identification System) in France.

0+CRN (Company Registration Number) in United-Kingdom

0+NIF (Numero de Identificación Fiscal) in Spain

03 PAYMENT_DATE Payment date YYYYMMDD format
04 TRANSACTION_ID Transaction identifier equivalent to vads_trans_id  
05 OPERATION_SEQUENCE Operation number    
06 OPERATION_NAME Type of the performed action MERCHANT_BO_CHECK_URL Invocation of the notification URL check:
  • during a payment, a modification or a duplication
  • during authorization via tasks
  • during a recurring payment
  • during a payment by ID file
  • during a payment
MANUAL_CHECK_URL Manual invocation of the notification URL check for an existing transaction
ADVICE The principle of forcing a transaction
AUTHOR Transaction authorization (in case the authorization is not performed in real time)
CANCEL Transaction cancellation
CREDIT_CAPTURE Capture in the bank:
  • of a refund
  • of a payment
DUPLICATE Transaction duplication
CREDIT Transaction refund
EXPIRED Transaction expiration
MODIFICATION Transaction modification
TRANSACTION Manual payment entry
VALIDATE Transaction validation
WAIT Transaction queuing
REACTIVATION Transaction reactivation
07 OPERATION_AMOUNT Transaction amount expressed in the smallest currency unit    
08 OPERATION_CURRENCY Operation currency  

See table vads_currency for more examples.

09 OPERATION_DATE Operation date    
10 OPERATION_TIME Operation time    
11 OPERATION_ORIGIN ID of the user who performed the action.   Set to "Batch" if the operation was processed automatically
12 RESPONSE_CODE Response code to the authorization request

See chapter vads_auth_result

13 NEW_STATUS New operation status REFUSED The transaction has been declined
AUTHORISED_TO_VALIDATE The transaction must be validated
AUTHORISED The transaction is waiting for capture
CANCELLED The transaction has been canceled
CAPTURED The transaction has been captured
EXPIRED The transaction has not been validated and has expire
WAITING_AUTHORISATION_TO_VALIDATE The transaction is waiting for an authorization request and must be validated
WAITING_AUTHORISATION The transaction is waiting for an authorization request
UNDER_VERIFICATION The transaction is waiting for PayPal verification
CAPTURE_FAILED Capture failed
14 RETURN_CONTEXT Context of a buyer's purchase   One or several details (order_info, order_info2, order_info3, etc.) separated by the "|" character

The "Fin" (End) record

Pos. Description Values
01 Record code FIN

Example of a file

This extract from the operations report (JO) shows:

  • a line of the Title record,
  • a line of the Header record,
  • two lines from the Details record each beginning with OPERATION,
  • a Fin (End) record line that marks the end of the document.
TITRE;Lyra Collect;16/04/08_14:53:25;TABLE_V3;