This chapter describes the format of these CyberSource CSV reports:
Payment Submission Detail Report
Transaction Exception Detail Report
This section describes the exported search results:
The first line of the report describes the column headings with the name of each field. The data type and length of each field is string (100).
Example Second line of the report
Merchant ID,Date and Time,Request ID,Merchant Reference Number,Last Name,First Name,Email Address,Amount,Currency,Account Suffix,Applications |
Each transaction record includes information about a CyberSource payment transaction. For information about possible values for each field, see the implementation guide for the services that you use.
Example Transaction record. Each line of the report is described in the following table.
ubcvp1_3,Dec 01 2006 06:26:15 PM,1650191751800167904064,1165019175129, YOUNG,SARAH,sample@sample.com,10.00,USD,1111,"Credit Card Authorization (Accept),Decision Manager(Accept)"
Position |
Field Name |
Description |
Data Type and Length |
---|---|---|---|
1 (A) |
merchantID |
CyberSource merchant ID used for the transaction. |
String (30) |
2 (B) |
Date and Time |
Complete date and time of the transaction, for example: Aug 30 2006 11:15:17 AM |
DateTime (25) |
3 (C) |
requestID |
CyberSources identifier for the transaction. |
Numeric (26) |
4 (D) |
Merchant Reference Number |
Merchant-generated order reference or tracking number, such as a purchase order number. |
String (50) |
5 (E) |
Last Name |
Last name of the billed customer. |
String (60) |
6 (F) |
First Name |
First name of the billed customer. |
String (60) |
7 (G) |
Email Address |
Email address of the billed customer. |
String (255) |
8 (H) |
Amount |
Amount of the transaction. For ics_credit and ics_ecp_credit transactions, the amount is negative. |
Amount (19) |
9 (I) |
Currency |
ISO currency code used for the transaction. |
String (5) |
10 (J) |
Account Suffix |
Last four digits of the customers payment account number |
String (4) |
11 (K) |
Applications |
Comma-separated list of the services that you requested with the result for each service, for example: Credit Card Authorization(Accept),Credit Card Settlement(Accept) Tax Calculation(Accept),Credit Card Authorization(Accept),Credit Card Settlement(Accept),Advanced Fraud Screen(Accept) |
|
Sample Record
Each record includes information about an order.
ubcvp1_3,Nov 27 2006 12:27:04 PM,1646520241230167904065,ubcvp1_3272706102704,,, jane.doe@example.com,,,3333,Customer List Modification(Accept) ubcvp1_3,Nov 10 2006 05:24:05 PM,1632013444870167904065,fraud_cleanup_tool_remove_1163201344486,,,,,,,IFS Update(Accept) ubcvp1_3,Sep 27 2006 04:56:55 PM,1593944457280167904064,1159394445727,Doe,John,null@cybersource.com,1.00,USD,0299,"Credit Card Authorization(Accept),Decision Manager(Accept)" ubcvp1_3,Sep 08 2006 10:52:45 AM,1577307655110167904065,1157730593326,,,,,,, Subscription Creation(Reject) |
The Payment Batch Detail Report contains these types of transactions:
Bank transfer and bank transfer refund
Credit card capture and credit
Direct debit and direct debit refund
Electronic check debit and electronic check credit
PayPal transactions
Bill Me Later transactions
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 implementation guides for the services you are using.
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,,,,,,,
Position |
Field Name |
Description |
Data Type and Length |
---|---|---|---|
1 (A) |
report_name |
Name of the report. This field always contains the text Payment Batch Detail Report. |
String (100) |
2 (B) |
version_number |
Version number of the report. The current version number is 1.0. |
Numeric (10) |
3 (C) |
date_range |
Dates included in the report in the format YYYY-MM-DD to YYYY-MM-DD. The first date is the start date; the second date is the end date. For the Payment Batch Detail Report, both dates are identical. |
String (100) |
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 String (100).
The list of field names in the second header record is in Table 80.
Example Second Header Record
batch_id,merchant_id,batch_date,request_id,merchant_ref_number,trans_ref_no,payment_method,currency,amount,transaction_type |
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 |
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. |
String (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. |
String (50) |
6 |
trans_ref_no |
Reference number that you use to reconcile your CyberSource reports with your processor reports. This field corresponds to the <service>_reconciliationID (Simple Order API) and to the <service>_trans_ref_no (SCMP API) reply fields. |
String (60) |
7 |
payment_method |
Type of card or bank account. For the possible values, see Appendix E, Types of Cards and Bank Accounts. |
String (50) |
8 |
currency |
ISO currency code used for the transaction. |
String (5) |
9 |
amount |
Amount of the transaction. For ics_credit and ics_ecp_credit transactions, the amount is negative. |
Amount (19) |
10 |
transaction_type |
CyberSource payment application processed for the transaction. |
String (50) |
This report contains information about events that occur for:
Bank transfers
China payments and refunds
Credit card transactions processed with the CyberSource Global Payment Service
Direct debits
Electronic check debits and credits
PayPal transactions
Report Generation for the Global Payment Service
The report is generated daily Monday through Friday unless CyberSource does not receive a data file from the processor, receives the data file after the cut-off time, or receives an empty data file. Because the report is not generated on weekends, the report that you download on Mondays contains all your weekend transactions. Make sure your implementation can handle reports that contain transactions spanning multiple processing days.
The report is generated for the date when CyberSource processes the file, not for the date when the processor submits the file. Because of cut-off and processing times, transactions that you process on Day 1 will most likely appear on the report on Day 3.
If the generation of the report is delayed, you are notified. Because the report generated after a delay may span more than one day, make sure you can track the delayed reports.
When CyberSource needs to regenerate a report, the entire report is generated, not selected transactions. You are notified as soon as the new version of the report is available. Make sure your implementation can recognize and process only the transactions that were modified or added to the report.
Transaction Exceptions for the Global Payment Service
Although most reports contain transactions that you can match, your implementation also needs to recognize payment and refund exceptions. In some cases, you might need to search your system manually for the original request ID, which remains in the CyberSource system for six months.
Rejected payments and refunds
Although the reply that you receive from CyberSource might indicate that a transaction was successful, the processor can occasionally reject a transaction. Rejected transactions do not appear on the Payment Events Report. However, Customer Support will notify you by email if rejections occur.
Delayed payments
You need to be aware that payments can occasionally be delayed.
Unmatched payments and refunds
Unmatched events occur when the processor generates an event that cannot be matched or when the event is older than six months. If CyberSource cannot match the payment or refund to a specific transaction, CyberSource generates a new request ID for the unmatched event. You may need to search manually for the original request in your system.
Corrections to payments and refunds
When the amount of the original event is changed or the event is reversed, you need to update the original payment or refund.
Duplicate payments and refunds can appear in the same or different reports. You can ignore these events because they will match an existing request ID.
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 Events Report,1,2004-02-28,merchant_id,,,, |
P
Position |
Field Name |
Description |
Data Type and Length |
---|---|---|---|
1 |
report_name |
Name of the report. This field always contains the text Payment Events Report. |
String (100) |
2 |
version_number |
Version number of the report. The current version number is 1.0, which is shown in the Excel spreadsheet as 1. |
Numeric (10) |
3 |
report_date |
Date included in the report. This field uses the format YYYY-MM-DD. |
Date & time (10) |
4 |
merchant_id |
CyberSource merchant ID |
String (30) |
Second Header Record
The second header record indicates the name of each field in the report. For a list of field names in the second header record, see Table 82. In the fields of the second header record, the content is the same as the field name, and the data type and length is String (100).
Example Second Header Record
request_id,merchant_id,merchant_ref_number,payment_type,event_type,event_date,trans_ref_no,merchant_currency_code,merchant_amount,consumer_currency_code,consumer_amount,fee_currency_code,fee_amount,processor_message |
Transaction Record
Each transaction record includes information about a CyberSource or PayPal payment transaction. For information about possible values for each field, see the Implementation Guide for the services you use. These guides are available in the Support Center.
Example Transaction Record
1004223530000167905139,CyberSource,4828225690-3098813497360087,credit card,Payment,2/28/2004,54415,JPY,20000,JPY,20000,,,[DC] |
Position |
Field Name |
Description |
Data Type and Length |
---|---|---|---|
1 |
request_id |
Unique identifier generated by CyberSource for the transaction. If your payment processor is Global Collect, the value in this field may be 1 followed by 21 zeros in these cases: Transaction older than six months: request ID no longer stored. Transaction information sent by processor: no valid request ID. |
Numeric (26) |
2 |
merchant_id |
CyberSource merchant ID used for the transaction. |
String (30) |
3 |
merchant_ref_number |
Merchant-generated order reference or tracking number, such as a purchase order number. |
String (50) |
4 |
payment_type |
Method of payment used for the order. Possible values: bank transfer: Bank transfer. For China payments and refunds, the bank transfer value indicates a Chinese bank card or PayEase eWallet transaction. credit card: Personal credit card. For China payments and refunds, the credit card value indicates an international credit card transaction. corporate: Corporate credit card debit: Debit card, such as a Maestro (UK Domestic) or Solo card check: Electronic check PayPal Credit: PayPal transaction PayPal Debit: PayPal transaction If your processor is TeleCheck, the payment types are: Debit: Debit card Claim: Bill or settlement Credit: Credit card Void: Voided transaction |
String (10) |
5 |
event_type (credit card, bank transfer, or direct debit transactions) |
Type of event that occurred for the transaction: Chargeback: The customer did not authorize the transaction. For details about the chargeback, see the processor_message value in the report. Correction: The payment or refund was corrected, or the bank was unable to credit the customer's account; the value is either positive or negative. Failed: The account was invalid or disabled. For details about the failure, see the processor_message value in the report. Other: The processor reported an unanticipated event. Payment: The payment was received by the processors bank; the value is always positive. Refund: The payment was returned; the value is always negative. For details about the refund, see the processor_message value in the report. Reversal: A payment was reversed. For details about the reversal, see the processor_message value in the report. Settled: The transaction has been settled: the payment has been received, or the refund has been given to the customer. Settled Unmatched: A bank transfer payment has been received but cannot be matched to the original request. |
Alpha (20) |
5 |
event_type (PayEase China Processing transactions) |
Type of event that occurred for the transaction. Possible values: Chargeback: The original payment transaction is being disputed by the cardholder or the cardholders bank. Payment Abnormal: The payment has been held up for regulatory or legal reasons. Payment Declined: The processor has refused the payment request. Payment Failed: The payment request failed. The reason is not specified. Payment Funded: The processor has submitted a transfer to the merchant's bank account as a result of a settled payment. |
Alpha (20) |
|
|
Payment Initiated: The payment request was received from the merchant. Payment Lost: The processor does not acknowledge receiving the payment request. Payment Pending Proc: The payment has not been completed. It is awaiting settlement by the processor. Payment Settled: The payment has been confirmed by the processor and is expected to be funded. Refund Abnormal: The refund has been held up for regulatory or legal reasons. Refund Declined: The processor has refused the refund request. Refund Failed: The refund request failed. The reason is not specified. Refund Funded: The processor has submitted a transfer to the merchant's bank account as a result of a settled refund. Refund Pending Cyb: The refund has not been completed. It is awaiting transmission by CyberSource. Refund Pending Proc: The refund has not been completed. It is awaiting settlement by the processor. Refund Settled: The refund has been confirmed by the processor and is expected to be funded. Unknown: The processor does not acknowledge receiving the request. |
|
5 |
event_type (check transactions) |
Type of event that occurred for the check transaction. These values vary with the processor. Successful Events Payment: Payment has been received. The value is always positive. Refund: A refund (credit) occurred. The value is always negative. Completed: The transaction was completed: CyberSource ACH ServiceThe event type is Payment after a debit request is received by the bank. CyberSource waits for three days. If the bank does not inform CyberSource about any problems with the funds transfer, the bank considers the check cleared. The event type listed in the report is Completed when the check clears. CyberSource does not guarantee that the check has truly cleared. Failed Events Correction: A positive or negative correction occurred to a payment or refund. Declined: The account was invalid or disabled. For details about the decline, see the processor_message value in the report. Error: An error occurred. For details about the error, see the processor_message value in the report. Failed: The account was invalid or disabled. For details about the failure, see the processor_message value in the report. Final NSF: The final instance of insufficient funds occurred. First NSF: The bank will attempt to re-deposit the funds. NSF: The bank returned the check because of insufficient funds.Other: The processor reported an unanticipated event. Second NSF: The bank will attempt to re-deposit the funds for the second time. Stop Payment: The customer stopped the payment. Void: The check was successfully voided. |
Alpha (20) |
5 |
event_type (PayPal transactions) |
Type of event that occurred for the PayPal transaction. This field contains one of the following values: Batched: The PayPal transaction was completed, but the funds have not been transferred to your account. Canceled_reversal: You requested that the reversal requested by the customer be cancelled. Completed: The PayPal transaction (standard or pre-approved payment was completed, and the funds have been transferred to your account. Denied: You denied the request. The reason is not specified. Failed: The request failed. The reason is not specified. MIPS: A billing agreement was created or modified. Pending: The PayPal transaction is not completed. The value will eventually change to Completed, Failed, or Denied. Refunded: You initiated a refund of the PayPal payment. Reversed: A payment was reversed due to a chargeback or other type of reversal. |
Alpha (20) |
6 |
event_date |
Date in GMT format that the event occurred. This field is empty for some event types, such as Declined. For PayPal transactions, the date is always present. |
Date Time (25) |
7 |
trans_ref_no |
Reference number that you use to reconcile your CyberSource reports with your processor reports. This field corresponds to the <service>_reconciliationID (Simple Order API) and <service>_trans_ref_no (SCMP API) reply fields. |
String (60) |
8 |
merchant_currency_code |
ISO currency code of the merchants currency. For PayPal transactions, reported only if merchant_amount is greater than zero. |
String (5) |
9 |
merchant_amount |
The amount deposited or withdrawn from the merchants account for the event. For PayPal transactions, reported only if the Paypal account is set to automatically convert payment. |
Amount (19) |
10 |
consumer_currency_code |
ISO currency code of the customers currency. |
String (5) |
11 |
consumer_amount |
The amount deposited or withdrawn from the customers account for the event. |
Amount (19) |
12 |
fee_currency_code |
ISO currency code of the assessed fee. For PayPal transactions, this fee does not apply, and the field is always empty. |
String (5) |
13 |
fee_amount |
The processors fee for the transaction. |
Amount (19) |
14 |
Additional information that may appear from the processor about the event, such as an error message or reason. For Global Collect direct debit reversals, this field contains a banking reversal code. See Appendix G, Banking Codes in the Payment Events Report . Possible values for PayPal transactions: pending: The payment status is pending. For a PayPal credit or a PayPal reversal, this field contains one of these values: buyer_complaint: The customer has placed a reversal about this transaction. chargeback: The customer has initiated a chargeback. guarantee: The customer triggered a money back guarantee. refund: You have given the customer a refund. address: The customer did not include a confirmed shipping address. You must manually accept or deny this payment. echeck: The check has not yet cleared. intl: You hold a non-U.S. account and do not have a withdrawal method. You must manually accept or deny this payment. multi_currency: You do not have a balance in the currency sent. You must manually accept or deny this payment. other: A reversal has occurred for a reason other than buyer_complaint, chargeback, guarantee, or refund. Alternately, the payment is pending for a reason other than address, echeck, intl, multi_currency, unilateral, upgrade, or verify. |
String (255) |
|
|
|
unilateral: The payment was made to an email address that is not yet registered or confirmed. upgrade: You have reached the monthly limit for transactions on your account, or the payment was made via credit card, and you do not have a Business or Premier PayPal account. verify: The payment is pending. You must verify your account before accepting this payment. |
|
Payment Submission Detail Report
The CSV version of the Payment Submission Detail Report is identical to the CSV version of the Payment Batch Detail Report with the following exceptions:
The Payment Submission Detail Report includes China payments and China refunds.
The Payment Submission Detail Report includes the payment_processor field.
Important The CSV version of the Payment Submission Detail Report uses quotation marks around each of the reports values. The CSV versions of other reports do not use quotation marks around each value.
Example Second Header Record
batch_id,merchant_id,batch_date,request_id,merchant_ref_number,trans_ref_no,payment_method,currency,amount,transaction_type,payment_processor |
Example Transaction Record
"987654321","CyberSource","2001-08-15","9979040000003515181891","3C1B4BC412EB00561AE1C19D5","SZJPTM07Y8O5","Visa","USD","100.00","ics_bill","smartfdc" |
Position |
Field Name |
Description |
Data Type and Length |
---|---|---|---|
11 |
payment_processor |
String (40) |
Transaction Exception Detail Report
This report provides detailed information about transactions that were flagged by CyberSource or by the processor because of errors that were sent in the request of your follow-on transactions, such as captures and credits. When errors occur, you are notified in the Message Center with a message that remains for seven days. For example, you might see errors such as a capture amount greater than the authorized amount and missing or invalid fields.
After reviewing and correcting the errors, you can resend the requests and then update your system to avoid these errors in the future.
Important Error notifications received from card processors during authorization attempts will continue to be reported immediately.
With the Global Payment Services, all errors associated with the primary and follow-on requests associated will be included in this report. For more information, see the Global Payment Services Planning and Users Guide.
First Header Record
The first line of the report describes the name and version of the report and indicates the dates included in the report.
Example First Header Record
Transaction Exception Detail Report,1.0,2006-05-01 to 2003-05-01,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, |
Position |
Field Name |
Description |
Data Type and Length |
---|---|---|---|
1 |
report_name |
Name of the report. This field always contains the text Transaction Exception Detail Report. |
String (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. |
String (100) |
4-124 |
Empty |
n/a |
n/a |
Second Header Record
The second line of the report indicates the name of each field in the report. The fields in follow these rules:
The content of each field is the same as the field name.
The data type and length of each field is String (100).
Example Second Header Record
row_descriptor,request_id,transaction_date,merchant_id,merchant_ref_number,transaction_ref_number,transaction_type,payment_method, amount,currency_code,payment_processor,original_request_id,action, reason_code,error_category,error_message,account_suffix,customer_cc_expmo,customer_cc_expyr,bank_code,bank_account_name,customer_firstname,customer_lastname,bill_address1,bill_address2,bill_city,bill_state,bill_zip,bill_country,company_name,customer_email, customer_phone,ship_to_first_name,ship_to_last_name,ship_to_address1, ship_to_address2,ship_to_city,ship_to_state,ship_to_zip,ship_to_country |
Transaction Record
Each transaction record includes information about a CyberSource payment transaction. For information about possible values for each field, see the Implementation Guide for the services that you use. These guides are available in the Support Center.
Example Transaction Record
Request,0004223530000167905139,2006-05-01T07:42:03-07:00,exampleMerchant,3C515C71D48F631,1140625304845,Direct Debit,,,30.00,GBP,sample processor, 1406235110599167904565,No action needed.,311,,,,,4234,10,2010,20-00-00, John Smith,John,Doe,1295 Charleston,Mountain View,CA,94043,US,,, jdoe@example.com,999-999-9999,,,,,,,,,,,,,,,,, |
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. |
String (20) |
2 |
request_id |
Identifier for the transaction. |
Numeric (26) |
3 |
transaction_date |
Date on which the transaction was processed. |
DateTime (25) |
4 |
merchant_id |
CyberSource merchant ID used for the transaction. |
String (30) |
5 |
merchant_ref_number |
Merchant-generated order reference or tracking number, such as a purchase order number. |
String (50) |
6 |
transaction_ref_number |
Reference number that you use to reconcile your CyberSource reports with your processor reports. This field corresponds to the (Simple Order API) <service>_reconciliationID and to the (SCMP API) <service>_trans_ref_no reply fields. |
String (60) |
7 |
transaction_type |
Type of transaction, such as credit card capture, credit, or bank transfer. |
String (30) |
8 |
payment_method |
Type of card or bank account. For the possible values, see Appendix E, Types of Cards and Bank Accounts. |
String (50) |
9 |
amount |
Amount specified in the request. |
String (19) |
10 |
currency_code |
Optional ISO currency code used for the transaction. |
String (5) |
11 |
payment_processor |
String (40) |
|
12 |
original_request_id |
Request ID of the original transaction. For example, if the request that has an error is a refund, this field contains the request ID of the original payment. |
String (26) |
13 |
action |
Brief description of the action. Possible values: ERROR FAILED CANCELLED |
String (15) |
14 |
reason_code |
Reason code for the error that occurred. This reason code is the same one that you receive in the reply or transaction receipt. See Appendix F, Reason Codes in the Transaction Exception Detail Report. |
Numeric (3) |
15 |
processor_response_code |
Code returned directly from the processor for the error that occured. |
String (60) |
16 |
error_category |
Type of error. Possible values: Data Error Failure Processor Error Settlement Error |
String (20) |
17 |
error_message |
Description of the error. |
String (255) |
18 |
account_suffix |
Last four characters of the account number. |
String (4) |
19 |
customer_cc_expmo |
If a credit card was used for the transaction, expiration month of the card (MM). |
Numeric (2) |
20 |
customer_cc_expyr |
If a credit card was used for the transaction, expiration year of the card (YYYY). |
Numeric (4) |
21 |
bank_code |
If a bank account was used for the transaction, the bank code or sort code for the account. |
String (15) |
22 |
bank_account_name |
Name of account holder. |
String (60) |
23 |
customer_firstname |
First name of the billed customer. |
String (60) |
24 |
customer_lastname |
Last name of the billed customer. |
String (60) |
25 |
bill_address1 |
First line of the billing address. |
String (60) |
26 |
bill_address2 |
Second line of the billing address. |
String (60) |
27 |
bill_city |
City of the billing address. |
String (50) |
28 |
bill_state |
State, province, or territory of the billing address. |
String (20) |
29 |
bill_zip |
Postal code of the billing address. |
String (10) |
30 |
bill_country |
ISO country code of the billing address. |
String (2) |
31 |
company_name |
Company name of the billing address. |
String (60) |
32 |
customer_email |
Email address of the billed customer. |
String (255) |
33 |
customer_phone |
Phone number of the billed customer. |
String (15) |
34 |
ship_to_first_name |
First name of the customer receiving the shipment. |
String (60) |
35 |
ship_to_last_name |
Last name of the customer receiving the shipment. |
String (60) |
36 |
ship_to_address1 |
First line of the shipping address. |
String (60) |
37 |
ship_to_address2 |
Second line of the shipping address. |
String (60) |
38 |
ship_to_city |
City of the shipping address. |
String (60) |
39 |
ship_to_state |
State, province, or territory of the shipping address. |
String (50) |
40 |
ship_to_zip |
Postal code of the shipping address. |
String (10) |
41 |
ship_to_country |
ISO country code of the shipping address. |
String (2) |
This report provides information about the permissions and roles granted to users. To use the CSV format of this report, you need to have a program that processes pipe-delimited ( | ) data.
First Line of the Report
The first line of the report describes the name and version of the report and indicates which dates are included in the report.
Example Each part of this example (separated by commas) is described in the following table.
User Listing Report,Version 1.0,2007-09-14 |
Position |
Field Name |
Description |
Data Type (Length) |
---|---|---|---|
1 (A) |
report_name |
Name of the report. This field always contains the text User Listing Report. |
String (100) |
2 (B) |
version_number |
Version number of the report. The current version number is 1.0. |
Numeric (10) |
3 (C) |
date |
Date and time when the report was run. |
DateTime (25) |
Second Line of the Report
The second line of the report shows the column headings with the name of each field. The data type and length of each field is String (100).
Example Second line of the report
Username,Merchant ID,First Name,Last Name,Email,Date Created,LastAccess,Status,Role, Permissions |
Position |
Field Name |
Description |
Data Type and Length |
---|---|---|---|
1 (A) |
Username |
Unique identifier for the user. |
String |
2 (B) |
Merchant ID |
CyberSource merchant ID used for the transaction. |
String (30) |
3 (C) |
First Name |
User's first name. |
String (60) |
4 (D) |
Last Name |
User's last name. |
String (60) |
5 (E) |
|
Optional email address of the user |
String (255) |
6 (F) |
Date Created |
Date when the user was created. |
DateTime (25) |
7 (G) |
LastAccess |
Date when the user most recently logged in the Business Center. |
DateTime (25) |
8 (H) |
Status |
Activity status of the user: enabled: user can perform tasks according to permissions granted. disabled: user cannot log in the Business Center. |
String |
9 (I) |
Role |
Named collection of single permissions that describe the tasks assigned to a user, such as admin or custom. |
String |
10 (J) |
Permissions |
Pipe-separated list of all permissions granted to the user, for example: Customer Profile View|Customer Profile Management|One Time Payment|Subscription View|Subscription Management|Virtual Terminal Settings View|... |
String |
Sample Record
Each record includes information about a user.
User Listing Report,Version 1.0,2007-09-14 Username,Merchant ID,First Name,Last Name,Email,Date Created,LastAccess,Status,Role, Permissions infodev_user,infodev,Jane,Doe,,2007-03-29 07:47 GMT,2007-09-21 11:44 GMT,Enabled, Custom,Virtual Terminal Transaction|Payment Authorization infodev_user_2,infodev,John,Doe,,2007-03-29 07:47 GMT,2007-09-21 08:00 GMT,Enabled, Report Download,Report Download |