Search documentation:
	Help  Advanced
Published 05/13/2002

Chapter 3

CSV Report Formats

This chapter describes the format of CyberSource comma-separated values (CSV) reports.

CSV Conventions

CyberSource CSV reports use the following conventions:

• The first and second records in the report describe the report format and indicate which dates are included in the report.
• If the value of a field contains a comma, the contents of the field are surrounded by double quotes ("). For example, the value A,B,C is represented as follows:

"A,B,C"

• If the value of a field contains a double quote ("), the contents of the field are surrounded by double quotes, and the double quote is represented as two double quotes. For example, the value Sample "value" is represented as follows:

"Sample ""value"""

• Records are separated with a carriage return followed by a line feed.

Data Types and Lengths

This chapter uses the following terms to refer to the data type of each field:

• Alphanumeric: String containing letters, numbers, and special characters (for example, @, #, and %). All text uses UTF-8 character encoding.
• Boolean: Single character; T for true or F for false.
• Currency: Amount, including a decimal point if necessary.
• Date: YYYY-MM-DD, where:
• YYYY is the four-digit year
• MM is the two-digit month
• DD is the two-digit day
• DateTime: YYYY-MM-DDTHH:MM:SS[+ | -]HH:MM, where:
• YYYY is the four-digit year.
• MM is the two-digit month.
• DD is the two-digit day.
• THH:MM:SS is the time , with HH representing hours, MM representing minutes, and SS representing seconds.
• [+ | -]HH:MM is the time zone's offset from Greenwich Mean Time (GMT), with HH representing hours and MM representing minutes. The number is prefixed by either a plus (+) or minus (-) to indicate whether the offset adds to or subtracts from GMT.

For example, the offset for Pacific Daylight Time is -07:00.

• Numeric: String containing numbers.

The data lengths indicate the maximum length of each field. If a field is shorter than the maximum length, it is not padded in any way.

Payment Batch Detail Report

The Payment Batch Detail Report contains transactions that include any of the following CyberSource applications:

• ics_bill
• ics_credit
• ics_ecp_debit
• ics_ecp_credit

The first two records in the report are header records. The rest of the records contain information about your payment transactions.

The report includes only transactions that CyberSource has sent to the payment processor.

Note  Transactions appear in the Payment Batch Detail Report before funds are transferred to or from your merchant bank account. To determine whether funds have been transferred, you must reconcile the Payment Batch Detail Report with your bank statements.

For more information about reconciling transactions, see the ICS2 Developer's Guide and the Payment Services Planning Guide. Both guides are available on the CyberSource Support Center.

First Header Record

The first header record describes the name and version of the report and indicates which dates are included in the report.

Example  First Header Record

Payment Batch Detail Report,1.0,2001-08-15 to 2001-08-15,,,,,,, 

Table 29 Fields in the First Header Record 

Position	Field Name	Description	Data Type and Length
1	report_name	Name of the report. This field always contains the text Payment Batch Detail Report.	Alphanumeric (100)
2	version_number	Version number of the report. The current version number is 1.0.	Numeric (10)
3	date_range	Dates that are included in the report. This field uses the format YYYY-MM-DD to YYYY-MM-DD. The first date is the start date; the second date is the end date.	Alphanumeric (100)
4-10	Empty	n/a	n/a

Second Header Record

The second header record indicates the name of each field in the report. The fields in the second header record follow these rules:

• The content of each field is the same as the field name.
• The data type and length of each field is alphanumeric (100).

For a list of field names in the second header record, see Table 30, "Fields in the Transaction Record".

Example  Second Header Record

batch_id,merchant_id,batch_date,request_id,merchant_ref_number,trans_ref_no,payment_method,currency,amount,transaction_type 

Transaction Record

Each transaction record includes information about a CyberSource payment transaction.

Example  Transaction Record

987654321,CyberSource,2001-08-15,9979040000003515181891,3C1B4BC412EB00561AE1C19D5,SZJPTM07Y8O5,Visa,USD,100.00,ics_bill 

Table 30 Fields in the Transaction Record 

Position	Field Name	Description	Data Type and Length
1	batch_id	CyberSource batch in which the transaction was sent.	Numeric (39)
2	merchant_id	CyberSource merchant ID used for the transaction.	Alphanumeric (30)
3	batch_date	Date when the batch was sent to the processor.	Date (10)
4	request_id	Identifier for the transaction.	Numeric (26)
5	merchant_ref_number	Merchant-generated order reference or tracking number, such as a purchase order number.	Alphanumeric (50)
6	trans_ref_no	Reference number that you use to reconcile your CyberSource reports with your processor reports.	Alphanumeric (60)
7	payment_method	Type of card or bank account used for the transaction. This field can contain one of the following values: American Express Carte Blanche Checking Corporate Checking Diners Club Discover EnRoute JAL JCB MasterCard MBNA-LOAN Savings Switch UNKNOWN card Visa If your company uses CyberSource to process a private label card, this field can also contain the name of your private label card.	Alphanumeric (50)
8	currency	ISO currency code used for the transaction. For a list of ISO currency codes, see the ICS2 Developer's Guide, available on the CyberSource Support Center.	Alphanumeric (5)
9	amount	Amount of the transaction. For ics_credit and ics_ecp_credit transactions, the amount is negative.	Currency (19)
10	transaction_type	CyberSource payment application processed for the transaction.	Alphanumeric (50)

Transaction Detail Report

This report contains summary information about your transactions. It also includes detailed information about your payment and Advanced Fraud Screen transactions.

Note  The CSV version of the Transaction Detail Report does not include information about the offers in a transaction. If you need this information, you must use the XML version of the report.

First Header Record

The first header record describes the name and version of the report and indicates which dates are included in the report.

Example  First Header Record

Transaction Detail Report,1.0,2001-08-16 to 2001-08-16,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, 

Table 31 Fields in the First Header Record 

Position	Field Name	Description	Data Type and Length
1	report_name	Name of the report. This field always contains the text Transaction Detail Report.	Alphanumeric (100)
2	version_number	Version number of the report. The current version number is 1.0.	Numeric (10)
3	date_range	Dates that are included in the report. This field uses the format YYYY-MM-DD to YYYY-MM-DD. The first date is the start date; the second date is the end date.	Alphanumeric (100)
4-124	Empty	n/a	n/a

Second Header Record

The second header record indicates the name of each field in the report. The fields in the second header record follow these rules:

• The content of each field is the same as the field name.
• The data type and length of each field is alphanumeric (100).

For a list of field names in the second header record, see Table 32, "Fields in the Transaction Record".

Example  Second Header Record

row_descriptor,request_id,transaction_date,merchant_ref_number,merchant_id,ics_applications,auth_rcode,auth_rflag,auth_rmsg,auth_reversal_rcode,auth_reversal_rflag,auth_reversal_rmsg,bill_rcode,bill_rflag,bill_rmsg,credit_rcode,credit_rflag,credit_rmsg,ecp_debit_rcode,ecp_debit_rflag,ecp_debit_rmsg,ecp_credit_rcode,ecp_credit_rflag,ecp_credit_rmsg,score_rcode,score_rflag,score_rmsg,tax_rcode,tax_rflag,tax_rmsg,dav_rcode,dav_rflag,dav_rmsg,export_rcode,export_rflag,export_rmsg,elc_rcode,elc_rflag,elc_rmsg,elc_revoke_rcode,elc_revoke_rflag,elc_revoke_rmsg,download_rcode,download_rflag,download_rmsg,create_isv_rcode,create_isv_rflag,create_isv_rmsg,add_value_to_isv_rcode,add_value_to_isv_rflag,add_value_to_isv_rmsg,get_isv_history_rcode,get_isv_history_rflag,get_isv_history_rmsg,get_isv_info_rcode,get_isv_info_rflag,get_isv_info_rmsg,get_isv_profiles_rcode,get_isv_profiles_rflag,get_isv_profiles_rmsg,modify_isv_rcode,modify_isv_rflag,modify_isv_rmsg,redeem_isv_rcode,redeem_isv_rflag,redeem_isv_rmsg,customer_firstname,customer_lastname,customer_middlename,bill_address1,bill_address2,bill_city,bill_state,bill_zip,bill_country,company_name,customer_email,customer_title,customer_phone,ship_to_address1,ship_to_address2,ship_to_city,ship_to_state,ship_to_zip,ship_to_country,ship_to_phone,customer_ipaddress,account_suffix,customer_cc_expmo,customer_cc_expyr,customer_cc_startmo,customer_cc_startyr,customer_cc_issue_number,payment_method,amount,currency,auth_auth_avs,auth_auth_code,auth_cv_result,shipping_method,score_factors,score_host_severity,score_score_result,score_time_local,customer_hostname,shipping_carrier,customer_password_provided,lost_password,repeat_customer,cookies_accepted,customer_loyalty,customer_promotions,gift_wrap,returns_accepted,customer_id,product_risk,applied_score_threshold,applied_time_hedge,applied_velocity_hedge,applied_host_hedge,applied_category_gift,applied_category_time,avs,cv 

Transaction Record

Each transaction record includes information about a CyberSource payment transaction.

For information about possible values for each field, see the ICS2 Developer's Guide, available on the CyberSource Support Center.

Example  Transaction Record

Request,0004223530000167905139,2001-08-16T07:42:03+08:00,3C515C71D48F631,CyberSource,"ics_auth,ics_dav,ics_score,ics_tax",1,SOK,ok,,,,,,,,,,,,,,,,1,SOK,score service was successful,1,SOK,Tax service was successful.,1,SOK,dav service was successful,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,John,Doe,A,1295 Charleston Rd.,,Mountain View,CA,94043,US,CyberSource,icsinfo@cybersource.com,,650-965-6000,1295 Charleston Rd.,,Mountain View,CA,94043,US,650-965-6000,127.0.0.1,1111,12,2009,,,,Visa,88.96,USD,X,123456,M,,U,1,7,2001-08-16T08:59:47+08:00,hostname.cybersource.com,,,,,,,,,,,,40,Normal,Low,Normal,N,Off,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, 

Table 32 Fields in the Transaction Record 

Position	Field Name	Description	Data Type and Length
1	row_descriptor	Description of the data in this record. This field always contains the value Request.	Alphanumeric (20)
2	request_id	Identifier for the transaction.	Numeric (26)
3	transaction_date	Date on which the transaction was processed.	DateTime (25)
4	merchant_ref_number	Merchant-generated order reference or tracking number, such as a purchase order number.	Alphanumeric (50)
5	merchant_id	CyberSource merchant ID used for the transaction.	Alphanumeric (30)
6	ics_applications	Comma-separated list of applications that were included in the request.	Alphanumeric (255)
7	auth_rcode	One-digit code that indicates whether the ics_auth request was successful.	Numeric (1)
8	auth_rflag	One-word description of the result of the ics_auth request.	Alphanumeric (50)
9	auth_rmsg	Message that explains the reply flag for ics_auth.	Alphanumeric (255)
10	auth_reversal_rcode	One-digit code that indicates whether the ics_auth_reversal request was successful.	Numeric (1)
11	auth_reversal_rflag	One-word description of the result of the ics_auth_reversal request.	Alphanumeric (50)
12	auth_reversal_rmsg	Message that explains the reply flag for ics_auth_reversal.	Alphanumeric (255)
13	bill_rcode	One-digit code that indicates whether the ics_bill request was successful.	Numeric (1)
14	bill_rflag	One-word description of the result of the ics_bill request.	Alphanumeric (50)
15	bill_rmsg	Message that explains the reply flag for ics_bill.	Alphanumeric (255)
16	credit_rcode	One-digit code that indicates whether the ics_credit request was successful.	Numeric (1)
17	credit_rflag	One-word description of the result of the ics_credit request.	Alphanumeric (50)
18	credit_rmsg	Message that explains the reply flag for ics_credit.	Alphanumeric (255)
19	ecp_debit_rcode	One-digit code that indicates whether the ics_ecp_debit request was successful.	Numeric (1)
20	ecp_debit_rflag	One-word description of the result of the ics_ecp_debit request.	Alphanumeric (50)
21	ecp_debit_rmsg	Message that explains the reply flag for ics_ecp_debit.	Alphanumeric (255)
22	ecp_credit_rcode	One-digit code that indicates whether the ics_ecp_credit request was successful.	Numeric (1)
23	ecp_credit_rflag	One-word description of the result of the ics_ecp_credit request.	Alphanumeric (50)
24	ecp_credit_rmsg	Message that explains the reply flag for ics_ecp_credit.	Alphanumeric (255)
25	score_rcode	One-digit code that indicates whether the ics_score request was successful.	Numeric (1)
26	score_rflag	One-word description of the result of the ics_score request.	Alphanumeric (50)
27	score_rmsg	Message that explains the reply flag for ics_score.	Alphanumeric (255)
28	tax_rcode	One-digit code that indicates whether the ics_tax request was successful.	Numeric (1)
29	tax_rflag	One-word description of the result of the ics_tax request.	Alphanumeric (50)
30	tax_rmsg	Message that explains the reply flag for ics_tax.	Alphanumeric (255)
31	dav_rcode	One-digit code that indicates whether the ics_dav request was successful.	Numeric (1)
32	dav_rflag	One-word description of the result of the ics_dav request.	Alphanumeric (50)
33	dav_rmsg	Message that explains the reply flag for ics_dav.	Alphanumeric (255)
34	export_rcode	One-digit code that indicates whether the ics_export request was successful.	Numeric (1)
35	export_rflag	One-word description of the result of the ics_export request.	Alphanumeric (50)
36	export_rmsg	Message that explains the reply flag for ics_export.	Alphanumeric (255)
37	elc_rcode	One-digit code that indicates whether the ics_elc request was successful.	Numeric (1)
38	elc_rflag	One-word description of the result of the ics_elc request.	Alphanumeric (50)
39	elc_rmsg	Message that explains the reply flag for ics_elc.	Alphanumeric (255)
40	elc_revoke_rcode	One-digit code that indicates whether the ics_elc_revoke request was successful.	Numeric (1)
41	elc_revoke_rflag	One-word description of the result of the ics_elc_revoke request.	Alphanumeric (50)
42	elc_revoke_rmsg	Message that explains the reply flag for ics_elc_revoke.	Alphanumeric (255)
43	download_rcode	One-digit code that indicates whether the ics_download request was successful.	Numeric (1)
44	download_rflag	One-word description of the result of the ics_download request.	Alphanumeric (50)
45	download_rmsg	Message that explains the reply flag for ics_download.	Alphanumeric (255)
46	create_isv_rcode	One-digit code that indicates whether the ics_create_isv request was successful.	Numeric (1)
47	create_isv_rflag	One-word description of the result of the ics_create_isv request.	Alphanumeric (50)
48	create_isv_rmsg	Message that explains the reply flag for ics_create_isv.	Alphanumeric (255)
49	add_value_to_isv_rcode	One-digit code that indicates whether the ics_add_value_to_isv request was successful.	Numeric (1)
50	add_value_to_isv_rflag	One-word description of the result of the ics_add_value_to_isv request.	Alphanumeric (50)
51	add_value_to_isv_rmsg	Message that explains the reply flag for ics_add_value_to_isv.	Alphanumeric (255)
52	get_isv_history_rcode	One-digit code that indicates whether the ics_get_isv_history request was successful.	Numeric (1)
53	get_isv_history_rflag	One-word description of the result of the ics_get_isv_history request.	Alphanumeric (50)
54	get_isv_history_rmsg	Message that explains the reply flag for ics_get_isv_history.	Alphanumeric (255)
55	get_isv_info_rcode	One-digit code that indicates whether the ics_get_isv_info request was successful.	Numeric (1)
56	get_isv_info_rflag	One-word description of the result of the ics_get_isv_info request.	Alphanumeric (50)
57	get_isv_info_rmsg	Message that explains the reply flag for ics_get_isv_info.	Alphanumeric (255)
58	get_isv_profiles_rcode	One-digit code that indicates whether the ics_get_isv_profiles request was successful.	Numeric (1)
59	get_isv_profiles_rflag	One-word description of the result of the ics_get_isv_profiles request.	Alphanumeric (50)
60	get_isv_profiles_rmsg	Message that explains the reply flag for ics_get_isv_profiles.	Alphanumeric (255)
61	modify_isv_rcode	One-digit code that indicates whether the ics_modify_isv request was successful.	Numeric (1)
62	modify_isv_rflag	One-word description of the result of the ics_modify_isv request.	Alphanumeric (50)
63	modify_isv_rmsg	Message that explains the reply flag for ics_modify_isv.	Alphanumeric (255)
64	redeem_isv_rcode	One-digit code that indicates whether the ics_redeem_isv request was successful.	Numeric (1)
65	redeem_isv_rflag	One-word description of the result of the ics_redeem_isv request.	Alphanumeric (50)
66	redeem_isv_rmsg	Message that explains the reply flag for ics_redeem_isv.	Alphanumeric (255)
67	customer_firstname	First name of the bill-to customer.	Alphanumeric (60)
68	customer_lastname	Last name of the bill-to customer.	Alphanumeric (60)
69	customer_middlename	Middle name of the bill-to customer.	Alphanumeric (60)
70	bill_address1	First line of the billing address.	Alphanumeric (60)
71	bill_address2	Second line of the billing address.	Alphanumeric (60)
72	bill_city	City of the billing address.	Alphanumeric (50)
73	bill_state	State, province, or territory of the billing address.	Alphanumeric (20)
74	bill_zip	Postal code of the billing address.	Alphanumeric (10)
75	bill_country	ISO country code of the billing address. For a list of ISO country codes, see the ICS2 Developer's Guide, available on the CyberSource Support Center.	Alphanumeric (2)
76	company_name	Company name of the billing address.	Alphanumeric (60)
77	customer_email	Email address of the bill-to customer.	Alphanumeric (255)
78	customer_title	Title of the bill-to customer.	Alphanumeric (30)
79	customer_phone	Phone number of the bill-to customer.	Alphanumeric (15)
80	ship_to_address1	First line of the shipping address.	Alphanumeric (60)
81	ship_to_address2	Second line of the shipping address.	Alphanumeric (60)
82	ship_to_city	City of the shipping address.	Alphanumeric (50)
83	ship_to_state	State, province, or territory of the shipping address.	Alphanumeric (20)
84	ship_to_zip	Postal code of the shipping address.	Alphanumeric (10)
85	ship_to_country	ISO country code of the shipping address. For a list of ISO country codes, see the ICS2 Developer's Guide, available on the CyberSource Support Center.	Alphanumeric (2)
86	ship_to_phone	Phone number of the ship-to customer.	Alphanumeric (15)
87	customer_ipaddress	IP address of the customer.	Alphanumeric (15)
88	account_suffix	Last four digits of the customer's credit card or bank account number.	Alphanumeric (4)
89	customer_cc_expmo	Expiration month (MM) of the credit card.	Alphanumeric (2)
90	customer_cc_expyr	Expiration year (YYYY) of the credit card.	Alphanumeric (4)
91	customer_cc_startmo	Start month (MM) of the credit card. Used for Switch cards.	Alphanumeric (2)
92	customer_cc_startyr	Start year (YYYY) of the credit card. Used for Switch cards.	Alphanumeric (4)
93	customer_cc_issue_number	Issue number of the credit card. Used for Switch cards.	Alphanumeric (5)
94	payment_method	Type of card or bank account used for the transaction. This field can contain one of the following values: American Express Carte Blanche Checking Corporate Checking Diners Club Discover EnRoute JAL JCB MasterCard MBNA-LOAN Savings Switch UNKNOWN card Visa If your company uses CyberSource to process a private label card, this field can also contain the name of your private label card.	Alphanumeric (50)
95	amount	Total amount of the transaction. For ics_credit and ics_ecp_credit transactions, the amount is negative.	Currency (19)
96	currency	ISO currency code used for the transaction. For a list of ISO currency codes, see the ICS2 Developer's Guide, available on the CyberSource Support Center.	Alphanumeric (5)
97	auth_auth_avs	Results of address verification. For a list of possible values, see the ICS2 Developer's Guide, available on the CyberSource Support Center.	Alphanumeric (5)
98	auth_auth_code	Authorization code.	Alphanumeric (15)
99	auth_cv_result	Results of processing the card verification number. For a list of possible values, see the ICS2 Developer's Guide, available on the CyberSource Support Center.	Alphanumeric (1)
100	shipping_method	Reserved for future use.	Alphanumeric (10)
101	score_factors	Comma-separated list of codes that indicate what factors affected the score of the order. For a list of factor codes, see the ICS2 Developer's Guide, available on the CyberSource Support Center. Note If you use Smart Authorization, the value of the reply field auth_factor_code is returned in this field.	Alphanumeric (100)
102	score_host_severity	Indicates the risk associated with the customer's email domain.	Numeric (5)
103	score_score_result	Total score calculated for the order.	Numeric (5)
104	score_time_local	The customer's local time, which is calculated from the transaction request time and the customer's billing address.	DateTime (25)
105	customer_hostname	DNS-resolved hostname of the customer.	Alphanumeric (255)
106	shipping_carrier	Reserved for future use.	Alphanumeric (12)
107	customer_password_provided	Reserved for future use.	Boolean (1)
108	lost_password	Reserved for future use.	Boolean (1)
109	repeat_customer	Reserved for future use.	Boolean (1)
110	cookies_accepted	Reserved for future use.	Boolean (1)
111	customer_loyalty	Reserved for future use.	Boolean (1)
112	customer_promotions	Reserved for future use.	Boolean (1)
113	gift_wrap	Reserved for future use.	Boolean (1)
114	returns_accepted	Reserved for future use.	Boolean (1)
115	customer_id	Reserved for future use.	Alphanumeric (50)
116	product_risk	Reserved for future use.	Alphanumeric (6)
117	applied_score_threshold	Score threshold applied to the order. Note For information about how ics_score selects a threshold, see the ICS2 Developer's Guide, available on the CyberSource Support Center.	Numeric (5)
118	applied_time_hedge	Importance of time of day in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.	Alphanumeric (6)
119	applied_velocity_hedge	Importance of the number of orders from the customer in a specific time period in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.	Alphanumeric (6)
120	applied_host_hedge	Importance of email and IP addresses of the customer in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.	Alphanumeric (6)
121	applied_category_gift	Importance of bill-to and ship-to addresses in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.	Alphanumeric (1)
122	applied_category_time	Importance of time of day in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.	Alphanumeric (6)
123	avs	Reserved for future use.	Alphanumeric (5)
124	cv	Reserved for future use.	Alphanumeric (1)