|
|
|
|
|
|
This chapter describes the format of these CyberSource comma-separated values (CSV) reports.
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.
Important The CSV version of the Payment Submission Detail Report uses quotation marks around each of the reports values unlike the CSV versions of the other reports.
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.
Amount: An 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 zones 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 (PDT) is -07:00.
Example 2006-07-31T16:31:18-07:00 represents July 31, 2006 at 4:31:18 PM PDT.
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.
Exported Search Results
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 alphanumeric (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 table below.
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. |
Alphanumeric (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. |
Alphanumeric (50) |
|
5 (E) |
Last Name |
Last name of the billed customer. |
Alphanumeric (60) |
|
6 (F) |
First Name |
First name of the billed customer. |
Alphanumeric (60) |
|
7 (G) |
Email Address |
Email address of the billed customer. |
Alphanumeric (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. |
Alphanumeric (5) |
|
10 (J) |
Account Suffix |
Last four digits of the customers payment account number |
Alphanumeric (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 transactions processed with these applications:
Bank transfer and bank transfer refund
Credit card capture and credit
Direct debit and direct debit refund
Electronic check debit and electronic check 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 Credit Card Services Implementation Guide and the Electronic Check Services Implementation Guide.
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. |
Alphanumeric (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. |
Alphanumeric (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 alphanumeric (100).
The list of field names in the second header record is in Table 73.
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. |
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. This field corresponds to the <service>_reconciliationID (Simple Order API) and to the <service>_trans_ref_no (SCMP API) reply fields. |
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 Bank Transfer Carta Si Carte Blanche Carte Bleue Checking Corporate Checking Dankort Delta Diners Club Direct Debit Discover EnRoute JAL |
Alphanumeric (50) |
|
|
|
JCB Laser Maestro (International) MasterCard MBNA-LOAN Paymentech Bill Me Later PayPal Savings Solo Maestro (UK Domestic) UATP UNKNOWN card Visa Visa Electron If your company uses CyberSource to process a private label card, this field can also contain the name of your private label card. |
|
|
8 |
currency |
ISO currency code used for the transaction. |
Alphanumeric (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. |
Alphanumeric (50) |
Payment Submission Detail Report
The Payment Submission Detail Report is identical to the Payment Batch Detail Report with the following exceptions:
The Payment Submission Detail Report includes China payment and refund transactions.
The Payment Submission Detail Report includes the payment_processor field in the second header record. See the field description in Table 74.
The Payment Submission Detail Report includes two additional values for the payment_method:
China bank transfer
China eWallet
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","FDMS Nashville" |
This report contains information about events that occur for these types of payment transactions:
Credit card transactions processed with the CyberSource Global Payment Service
Direct debits
Electronic check debits and credits with TeleCheck, AmeriNet, or Paymentech
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. You should ensure that 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, ensure that you can track the delayed reports.
When CyberSource needs to regenerate a report, the entire report is generated, not only selected transactions. You are notified as soon as the new version of the report is available. Ensure that 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, you should prepare your implementation to recognize these payment and refund exceptions. In some cases, you may 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 may indicate that a transaction was successful, the processor may 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 may be occasionally 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.
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.
You may also see duplicate payments and refunds in the same or different reports. You can ignore these events because they will match an existing request ID.
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) |
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 76. In the fields of the second header record, the content is the same as the field name, and the data type and length is alphanumeric (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 |
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. This field can contain one of these 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 more information, see processor_message. 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 more details about the decline, see processor_message. |
Alpha (20) |
|
|
|
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 more details about the refund, see processor_message. Reversal: A payment was reversed. For more details about the reversal, see processor_message. 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. |
|
|
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. |
Alpha (20) |
|
|
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. 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. The values that you receive vary with the processor. Successful events Immediately after a transaction is submitted, this field contains one of these values: Payment: Payment has been received. The value is always positive. Refund: A refund (credit) occurred. The value is always negative. For AmeriNet only. After six days, if the bank does not notify AmeriNet of problems in transferring the funds, AmeriNet considers the check cleared. However, CyberSource does not guarantee that the check has truly cleared. The initial value changes to this one: Completed: The transaction was completed. For AmeriNet only. After six days, if the bank does not notify AmeriNet of problems in transferring the funds, AmeriNet considers the check cleared. However, CyberSource does not guarantee that the check has truly cleared. The initial value changes to this one: Completed: The transaction was completed. |
Alpha (20) |
|
|
|
Failed Events If the check is returned by the processor, the report shows one of these values: Declined: The account was invalid or disabled. For more details about the decline, see processor_message. Error: An error occurred. For more details about the error, see processor_message. Final NSF: The final instance of insufficient funds occurred. NSF: The bank returned the check because of insufficient funds. Stop Payment: The customer stopped the payment. Failed: The account was invalid or disabled. For more details about the decline, see processor_message. For TeleCheck and AmeriNet, this value is Declined. Correction: A positive or negative correction occurred to a payment or refund; not for TeleCheck. Other: The processor reported an unanticipated event; not for TeleCheck. Void: The check was successfully voided. For Paymentech, you see only events that have failed: Declined, NSF, and Stop Payment. For definitions, see above. |
|
|
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. |
Alpha (20) |
|
|
|
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. |
|
|
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 D, Banking Reversal Codes in the Payment Events Report . For PayPal transactions, this field can contain one of these values: 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. |