Decline analysis report

DocsCurrentLast updated: June 22nd 2021, @ 11:30:10 am


This report provides a detailed view of declines for card and bank transactions 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

  • You must be 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:

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:
  • 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 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:
  • YYYY is the four-digit year
  • MM is the 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. For example, +0800
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:
  • 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.
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:
  • PAYMENT: This type applies to money movement between a buyer and a seller for an order.
  • AUTH: This type applies to authorization and authorization void transactions.
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:
  • AMEX: AMEX card transaction
  • CB_NATIONALE: CB_NATIONALE card transaction
  • CETELEM: CETELEM card transaction
  • COFIDIS: COFIDIS card transaction
  • COFINOGA: COFINOGA card transaction
  • CHINA_UNION_PAY: CHINA_UNION_PAY card transaction
  • DELTA: DELTA card transaction
  • DISCOVER: DISCOVER card transaction
  • ELECTRON: ELECTRON card transaction
  • ELO: ELO card transaction
  • HIPER: HIPER card transaction
  • HIPERCARD: HIPERCARD card transaction
  • JCB: JCB card transaction
  • MAESTRO: MAESTRO card transaction
  • MASTER_CARD: MASTER_CARD card transaction
  • SOLO: SOLO card transaction
  • STAR: STAR card transaction
  • SWITCH: SWITCH card transaction
  • VISA: VISA card transaction
  • DINERS: DINERS card transaction
  • RUPAY: RUPAY card transaction
14 DECLINE_CODE Varchar Normalized code that indicates the following:
  • Reason of decline, when available
  • Processor decline codes for credit card transactions
  • Bank decline codes for bank transactions
  • See the processor decline codes.
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.
1 Column Type Literal The column type (SF).
1 Column Type Literal The column type (FF).