Decline analysis report
Last updated: Sept 18th, 8:38am
This report provides a detailed view of card and bank transaction declines that happened during the reporting timeframe. Use this report to analyze why you had any processor and bank declines, and to take corrective action as required.
Download a sample report
To review what's available in this report, download a sample in CSV format. This sample may vary from your actual report, depending on your settings.
Know before you begin
- Ensure you are an approved partner to use this report.
- This report is generated and placed on SFTP by 9:00 AM daily in the leading time zone of the reporting window.
- This report includes alternative payment methods (APMs). See the list of supported APMs.
- The actual amounts in this report are multiplied by 100 to represent the amounts as cents. For instance, a $10 entry appears as 1000 on the report.
- Read the report data by column header name instead of column index to maintain backward compatibility.
Report file name
The file name of the Decline Analysis Report follows this naming convention:
1<DA>.<yyyymmdd>.<ReportIdentifier>.<ReportingWindow>.<SequenceNumber>.<MajorVersion>.<MinorVersion>.<Format>
Field | Information |
---|---|
DA |
An abbreviation for the Decline Analysis Report. |
yyyymmdd |
The date for the data in the report. It represents the latest, or ending date, of the data. |
ReportIdentifier |
This is the unique value set up during report generation to identify the report, such as the BN code or organization name. |
ReportingWindow |
The window of time when the report was generated as follows:
|
SequenceNumber |
The sequence number of the report file. It is two characters,
right-justified, and zero-filled. The sequence number begins with
0 and continues until all parts of the report are recorded
in files. The sequence number is always present in the report filename
even if there is only one file.
|
MajorVersion |
This indicates the main report version. The major version number increments when there are significant changes in the report. |
MinorVersion |
The minor version number increments with any change to the report. If there are no changes, it is set to 0. |
format |
The report format is CSV (comma-separated values). |
Report format
Each row of the report consists of a two-letter row type, followed by the details specific to that row type. The following table lists the valid row types, along with the sections that describe the data for that row type.
Code | Description |
---|---|
FH | File header |
SH | Section header |
CH | Column header |
SB | Section body |
SF | Section footer |
FF | File footer |
File header data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
The column type (FH ). |
2 | Report Generation Date | Date-time |
The date and time when the report file was generated, in the following
format: YYYY/MM/DD HH:MM:SS offset where:
|
3 | Reporting Time Zone |
One of the following Varchar single characters:
A , H , R , X .
|
The window of time in which the report was generated, as follows:
|
4 | Report Period Start Date | Date-time |
The beginning date and time for which to include transactions in the
report, in the following format:
YYYY/MM/DD HH:MM:SS offset , where offset is the five-character signed
offset from GMT. For example, +0800 .
|
5 | Report Period End Date | Date-time |
The final date and time for which to include transactions in the report,
in the following format: YYYY/MM/DD HH:MM:SS offset , where offset is the five-character signed
offset from GMT. For example, +0800 .
|
Section header data
1 | Column Type | Literal |
SH |
Section body data
1 | Column Type | Literal |
The column type (CH ). |
2 | TRANSACTION_TYPE | Varchar |
One of the following types of transaction:
|
3 | TRANSACTION_SUBTYPE | Varchar |
The value of the subtype of transaction depends on the value of the
TRANSACTION_TYPE . It can be blank in some use cases.
|
4 | SELLER_ACCOUNT_ID | Varchar |
The seller's PayPal encrypted account number. |
5 | PAYPAL_REFERENCE_ID | String |
The original PayPal transaction ID this event is related to. |
6 | PAYPAL_TRANSACTION_ID | Varchar |
The PayPal transaction ID. |
7 | INVOICE_ID | String |
The invoice ID of the transaction. |
8 | CUSTOM_FIELD | Varchar |
This indicates the custom_id that is passed in the Create
Order request.
|
9 | TRANSACTION_DATE | Date-time |
The date and time the case was filed, in the following format:
YYYY/MM/DD HH:MM:SS offset . YYYY is the
four-digit year.MM is two-digit month of the year.DD
is the two-digit day of the month. HH is the hour in
24-hour notation. MM is minutes. SS is
seconds. offset is the five-character signed offset from
GMT, such as +0800 .
|
10 | TRANSACTION_AMOUNT | Money |
The amount paid by or refunded to the buyer. This field contains the gross transaction value for all transactions. |
11 | TRANSACTION_CURRENCY | Three-character currency code | The currency of the transaction. |
12 | PAYMENT_INSTRUMENT_TYPE | Varchar |
A high-level classification of the type of financial instrument that was
used to fund a payment, such as the following:
|
13 | PAYMENT_INSTRUMENT_SUBTYPE | Varchar |
One of the following detailed classifications of the financial
instrument used to fund a payment:
For example:
|
14 | DECLINE_CODE | Varchar |
Normalized code that indicates the following:
|
15 | AVS_RESPONSE_CODE | Varchar |
Address verification service (AVS) response code. See the AVS response codes. |
16 | BILLING_ADDRESS_1 | String |
The number and street of the card's billing address on file. |
17 | BILLING_ADDRESS_2 | String |
The number and street of the card's billing address on file. |
18 | BILLING_CITY | String |
The city of the card's billing address on file. |
19 | BILLING_STATE | String |
The state of the card's billing address on file. |
20 | BILLING_ZIPCODE | String |
The zip code or pincode of the card's address on file. |
21 | BILLING_COUNTY_CODE | String |
The country code of the card's address on file. |
21 | INTEGRATION_IDENTIFIER | String |
The partner's button source code, either the BN code or organization name. |
Section footer Data
1 | Column Type | Literal |
The column type (SF ). |
File footer data
1 | Column Type | Literal |
The column type (FF ). |