Decline Analysis report

The Decline Analysis report is being deprecated. For new integrations, use the Attempts and Declines report. If you currently use this report, migrate to the new report for more comprehensive transaction insights.

This report provides a detailed view of card and bank transaction declines during the reporting period. Use it to analyze processor and bank declines and take corrective action as needed.

To see what's in this report, download a sample in CSV format. The sample may vary from your actual report, depending on your configuration.

Before you begin

Before using this report, review the following requirements and considerations:

Ensure you are an approved partner to use this report.
PayPal generates this report and places it in the SFTP folder by 9:00 AM daily in the leading time zone of the reporting window.
The report includes alternative payment methods (APMs).
Amounts in this report are in cents (multiplied by 100). For example, a $10 entry is 1000 in the report.

We improve reports on an ongoing basis, which could include adding attributes. Use column names when you integrate with these reports, so that your integrations do not break when we add new columns.

Report file name

The file name of the Decline Analysis report follows this convention:

<DA>.<yyyymmdd>.<ReportIdentifier>.<ReportingWindow>.<SequenceNumber>.<MajorVersion>.<MinorVersion>.<Format>

The following table describes each component of the file name.

Field, Description
Field	Description
`<DA>`	Report type. For this report, the value is `DA`.
`<yyyymmdd>`	Date of the report generation. It represents the latest, or ending date, of the data.
`<ReportIdentifier>`	This is the unique value that you set up during report generation to identify the report, such as the `BN` code or organization name.
`ReportingWindow`	The time window in which the report was generated: - `A`: America/New York to America/Los Angeles - `H`: America/Los Angeles to Asia/Hong Kong - `R`: Asia/Hong Kong to Europe/London - `X`: Europe/London to America/New York
`SequenceNumber`	The sequence number of the report file. It is 2 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 file name, even if there is only 1 file.
`MajorVersion`	The major version of the report. This number increments when there are significant changes to the report.
`MinorVersion`	The minor version of the report. The minor version number increments with any change to the report. If there are no changes, it is `0`.
`format`	The report format is CSV (comma-separated values).

Report format

Each row of the report consists of a 2-letter row type, followed by the details that are specific to that row type. The following table lists the valid row types.

Code, Description
Code	Description
`FH`	File header
`SH`	Section header
`CH`	Column header
`SB`	Section body
`SF`	Section footer
`FF`	File footer

File header data

The file header contains metadata about the report file, including generation timestamp, account information, and time zone.

Position, Column name, Data type, Description
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 format: `YYYY/MM/DD HH:MM:SS offset`. `offset` is the 5-character signed offset from GMT, for example `+0800`.
3	`Reporting Time Zone`	`Varchar`	The time window in which the report was generated: `A` = America/New York to America/Los Angeles, `H` = America/Los Angeles to Asia/Hong Kong, `R` = Asia/Hong Kong to Europe/London, or `X` = Europe/London to America/New York
4	`Report Period Start Date`	`Date-time`	The beginning date and time for which to include transactions in the report, in the format: `YYYY/MM/DD HH:MM:SS offset`. `offset` is the 5-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 format: `YYYY/MM/DD HH:MM:SS offset`. `offset` is the 5-character signed offset from GMT, for example `+0800`.

Section header data

The section header identifies the start of a new data section in the report.

Position, Column name, Data type, Description
Position	Column name	Data type	Description
1	`Column Type`	`Literal`	The column type (section header, `SH`)

Section body data

The section body contains the detailed decline transaction data for each record in the report.

Position, Column name, Data type, Description
Position	Column name	Data type	Description
1	`Column Type`	`Literal`	The column type (section body, `SB`)
2	`TRANSACTION_TYPE`	`Varchar`	One of the following transaction types: `PAYMENT` (money movement between a buyer and a seller for an order) `AUTH` (authorization and authorization void transactions)
3	`TRANSACTION_SUBTYPE`	`Varchar`	The subtype of transaction. The value depends on `TRANSACTION_TYPE`. It can be blank in some use cases.
4	`SELLER_ACCOUNT_ID`	`Varchar`	The seller's encrypted PayPal account number
5	`PAYPAL_REFERENCE_ID`	`String`	The original PayPal transaction ID for this event
6	`PAYPAL_TRANSACTION_ID`	`Varchar`	The PayPal transaction ID
7	`INVOICE_ID`	`String`	The invoice ID of the transaction
8	`CUSTOM_FIELD`	`Varchar`	The `custom_id` in the Create Order request
9	`TRANSACTION_DATE`	`Date-time`	The date and time when the case was filed, in this format: `YYYY/MM/DD HH:MM:SS offset`. `offset` is the 5-character signed offset from GMT, for example `+0800`.
10	`TRANSACTION_AMOUNT`	`Money`	The amount paid by or refunded to the buyer. This amount is the gross transaction value for all transactions.
11	`TRANSACTION_CURRENCY`	3-character currency code	The currency of the transaction.
12	`PAYMENT_INSTRUMENT_TYPE`	`Varchar`	A high-level classification of the financial instrument that the buyer used to fund a payment, such as `CREDIT_CARD`, `DEBIT_CARD`, `DIRECT DEBIT`, `VENMO`, `Apple Pay`, `Google Pay`, a `Network Token`, or a supported APM
13	`PAYMENT_INSTRUMENT_SUBTYPE`	`Varchar`	A detailed classification of the financial instrument, including card brands, such as `AMEX` (American Express), `CARTE_BANCAIRE`, `CETELEM`, `COFIDIS`, `COFINOGA`, `CHINA_UNION_PAY`, `DELTA`, `DISCOVER`, `ELECTRON`, `ELO`, `HIPER`, `HIPERCARD`, `JCB`, `MAESTRO`, `MASTER_CARD`, `SOLO`, `STAR`, `SWITCH`, `VISA`, `DINERS` (Diners Club), and `RUPAY`. For wallets and network tokens, this value is the card type and brand, for example `CREDIT_CARD-VISA` or `DEBIT_CARD-MASTER_CARD`.
14	`DECLINE_CODE`	`Varchar`	Normalized code that indicates the reason for declining a transaction, including processor decline codes for credit card transactions and bank decline codes for bank transactions
15	`AVS_RESPONSE_CODE`	`Varchar`	Address verification service (AVS) response code
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 (continued)
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
22	`INTEGRATION_IDENTIFIER`	`String`	The partner's button source code, either the BN code or organization name.

Section footer data

The section footer marks the end of a data section in the report.

Position, Column name, Data type, Description
Position	Column name	Data type	Description
1	`Column Type`	`Literal`	The column type (section footer, `SF`)

File footer data

The file footer indicates the end of the report file.

Position, Column name, Data type, Description
Position	Column name	Data type	Description
1	`Column Type`	`Literal`	The column type (file footer, `FF`)

This report provides a detailed view of card and bank transaction declines during the reporting period. Use it to analyze processor and bank declines and take corrective action as needed.

To see what's in this report, download a sample in CSV format. The sample may vary from your actual report, depending on your configuration.

Before you begin

Before using this report, review the following requirements and considerations:

Ensure you are an approved partner to use this report.
PayPal generates this report and places it in the SFTP folder by 9:00 AM daily in the leading time zone of the reporting window.
The report includes alternative payment methods (APMs).
Amounts in this report are in cents (multiplied by 100). For example, a $10 entry is 1000 in the report.

We improve reports on an ongoing basis, which could include adding attributes. Use column names when you integrate with these reports, so that your integrations do not break when we add new columns.

Report file name

The file name of the Decline Analysis report follows this convention:

<DA>.<yyyymmdd>.<ReportIdentifier>.<ReportingWindow>.<SequenceNumber>.<MajorVersion>.<MinorVersion>.<Format>

The following table describes each component of the file name.

Field, Description
Field	Description
`<DA>`	Report type. For this report, the value is `DA`.
`<yyyymmdd>`	Date of the report generation. It represents the latest, or ending date, of the data.
`<ReportIdentifier>`	This is the unique value that you set up during report generation to identify the report, such as the `BN` code or organization name.
`ReportingWindow`	The time window in which the report was generated: - `A`: America/New York to America/Los Angeles - `H`: America/Los Angeles to Asia/Hong Kong - `R`: Asia/Hong Kong to Europe/London - `X`: Europe/London to America/New York
`SequenceNumber`	The sequence number of the report file. It is 2 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 file name, even if there is only 1 file.
`MajorVersion`	The major version of the report. This number increments when there are significant changes to the report.
`MinorVersion`	The minor version of the report. The minor version number increments with any change to the report. If there are no changes, it is `0`.
`format`	The report format is CSV (comma-separated values).

Report format

Each row of the report consists of a 2-letter row type, followed by the details that are specific to that row type. The following table lists the valid row types.

Code, Description
Code	Description
`FH`	File header
`SH`	Section header
`CH`	Column header
`SB`	Section body
`SF`	Section footer
`FF`	File footer

File header data

The file header contains metadata about the report file, including generation timestamp, account information, and time zone.

Position, Column name, Data type, Description
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 format: `YYYY/MM/DD HH:MM:SS offset`. `offset` is the 5-character signed offset from GMT, for example `+0800`.
3	`Reporting Time Zone`	`Varchar`	The time window in which the report was generated: `A` = America/New York to America/Los Angeles, `H` = America/Los Angeles to Asia/Hong Kong, `R` = Asia/Hong Kong to Europe/London, or `X` = Europe/London to America/New York
4	`Report Period Start Date`	`Date-time`	The beginning date and time for which to include transactions in the report, in the format: `YYYY/MM/DD HH:MM:SS offset`. `offset` is the 5-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 format: `YYYY/MM/DD HH:MM:SS offset`. `offset` is the 5-character signed offset from GMT, for example `+0800`.

Section header data

The section header identifies the start of a new data section in the report.

Position, Column name, Data type, Description
Position	Column name	Data type	Description
1	`Column Type`	`Literal`	The column type (section header, `SH`)

Section body data

The section body contains the detailed decline transaction data for each record in the report.

Position, Column name, Data type, Description
Position	Column name	Data type	Description
1	`Column Type`	`Literal`	The column type (section body, `SB`)
2	`TRANSACTION_TYPE`	`Varchar`	One of the following transaction types: `PAYMENT` (money movement between a buyer and a seller for an order) `AUTH` (authorization and authorization void transactions)
3	`TRANSACTION_SUBTYPE`	`Varchar`	The subtype of transaction. The value depends on `TRANSACTION_TYPE`. It can be blank in some use cases.
4	`SELLER_ACCOUNT_ID`	`Varchar`	The seller's encrypted PayPal account number
5	`PAYPAL_REFERENCE_ID`	`String`	The original PayPal transaction ID for this event
6	`PAYPAL_TRANSACTION_ID`	`Varchar`	The PayPal transaction ID
7	`INVOICE_ID`	`String`	The invoice ID of the transaction
8	`CUSTOM_FIELD`	`Varchar`	The `custom_id` in the Create Order request
9	`TRANSACTION_DATE`	`Date-time`	The date and time when the case was filed, in this format: `YYYY/MM/DD HH:MM:SS offset`. `offset` is the 5-character signed offset from GMT, for example `+0800`.
10	`TRANSACTION_AMOUNT`	`Money`	The amount paid by or refunded to the buyer. This amount is the gross transaction value for all transactions.
11	`TRANSACTION_CURRENCY`	3-character currency code	The currency of the transaction.
12	`PAYMENT_INSTRUMENT_TYPE`	`Varchar`	A high-level classification of the financial instrument that the buyer used to fund a payment, such as `CREDIT_CARD`, `DEBIT_CARD`, `DIRECT DEBIT`, `VENMO`, `Apple Pay`, `Google Pay`, a `Network Token`, or a supported APM
13	`PAYMENT_INSTRUMENT_SUBTYPE`	`Varchar`	A detailed classification of the financial instrument, including card brands, such as `AMEX` (American Express), `CARTE_BANCAIRE`, `CETELEM`, `COFIDIS`, `COFINOGA`, `CHINA_UNION_PAY`, `DELTA`, `DISCOVER`, `ELECTRON`, `ELO`, `HIPER`, `HIPERCARD`, `JCB`, `MAESTRO`, `MASTER_CARD`, `SOLO`, `STAR`, `SWITCH`, `VISA`, `DINERS` (Diners Club), and `RUPAY`. For wallets and network tokens, this value is the card type and brand, for example `CREDIT_CARD-VISA` or `DEBIT_CARD-MASTER_CARD`.
14	`DECLINE_CODE`	`Varchar`	Normalized code that indicates the reason for declining a transaction, including processor decline codes for credit card transactions and bank decline codes for bank transactions
15	`AVS_RESPONSE_CODE`	`Varchar`	Address verification service (AVS) response code
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 (continued)
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
22	`INTEGRATION_IDENTIFIER`	`String`	The partner's button source code, either the BN code or organization name.

Section footer data

The section footer marks the end of a data section in the report.

Position, Column name, Data type, Description
Position	Column name	Data type	Description
1	`Column Type`	`Literal`	The column type (section footer, `SF`)

File footer data

The file footer indicates the end of the report file.

Position, Column name, Data type, Description
Position	Column name	Data type	Description
1	`Column Type`	`Literal`	The column type (file footer, `FF`)

Decline Analysis report

Before you begin

Report file name

Report format

File header data

Section header data

Section body data

Section footer data

File footer data

On this page

On this page

On this page

Decline Analysis report

Before you begin

Report file name

Report format

File header data

Section header data

Section body data

Section footer data

File footer data

On this page

On this page

Decline Analysis report

On this page

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Decline Analysis report

On this page

On this page