Pricing Transaction Revision Report

DocsCurrent

Last updated: Jan 26th, 11:02pm

The pricing transaction revision report provides a detailed view of a revised or updated cost for a transaction that occurred before the current month for partners on interchange-plus pricing. You can use this report to review the updated transaction details.

Know before you begin

  • Ensure you are an approved partner to use this report.
  • This report is generated and placed on PayPal's secure file transfer protocol (SFTP) server by the second day of each month by 9:00 AM 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 shows up as 1000 on the report.
  • To maintain backward compatibility, read the report data by column header name instead of column index.
  • For any transaction in this report, the interchange details are the updated and revised details. If the transaction received any interchange data before this report, discard that value and apply the new details.
  • Blank values indicate that no interchange program is applicable as of now, and any details received prior to this report should be nullified.
  • This report is only available to partners who are on gross billing fees or a net settlement revenue share model and have interchange plus pricing.

Section 1: Report file name

The file name of the Pricing Transaction Revision Report for a single account follows this naming convention:

PRICING_TXN_REVISION.yyyymm.PartnerIdentifier.ReportingWindow.SequenceNumber.MajorVersion.MinorVersion.Format

Field Information
PRICING_TXN_REVISION An abbreviation for Pricing Transaction Revision Report.
yyyymm The month for the data in the report (formatted as year and month).
PartnerIdentifier The partner's button source code or the name of the partner's organization.
ReportingWindow The window of time during which the report was generated.
SequenceNumber The sequence number of the report file. It begins with 0 and continues until all parts of the report are recorded. The sequence number is always included, even if there is only one file.
MajorVersion The major version of the report.
MinorVersion The minor version of the report.
Format The report format, which is CSV (comma-separated values).

Section 2: Report format

Each row of the report begins with a two-letter row type, followed by details specific to that type. The table below outlines the valid row types and the corresponding sections that describe their data.

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 format YYYY/MM/DD HH:MM:SS offset, where the offset is the five-character signed offset from GMT (For example, +0800).
3 Reporting Window Varchar, (single character, one of: A, H, R, X). The time window during 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.
4 Report Period Start Date Date-time The start date and time for transactions included in the report, in the format YYYY/MM/DD HH:MM:SS offset, where the offset is the five-character signed offset from GMT (For example, +0800).
5 Report Period End Date Date-time The end date and time for transactions included in the report, in the format YYYY/MM/DD HH:MM:SS offset, where the offset is the five-character signed offset from GMT (For example, +0800).

Section header data

Position Column name Data type Description
1 Column Type Literal SH

Section body data

Position Column name Data type Description
1 Column Type Literal The column type (CH).
2 TRANSACTION_TYPE Varchar The type of transaction. One of:
  • PAYMENT: Forward money movement between buyer and seller for a given order.
  • AUTH: Auth type transactions for Auth or Auth void.
  • BONUS: Bonus type transactions.
  • CHARGEBACK: Chargeback type transactions for Chargeback fee or Chargeback fee reversal.
  • CORRECTION: Correction type transactions.
  • CURRENCY_CONVERSION: Currency conversion type transactions.
  • DEPOSIT: Deposit type transactions.
  • DISBURSEMENT: Disbursement type transactions.
  • DISPUTE: Dispute type transactions.
  • FEES: Fees type transactions (For example, Partner Fee, Payment Fee, or Fee Reversal).
  • HOLD: Hold type transactions.
  • HOLD_RELEASE: Hold release type transactions.
  • INCENTIVES: Incentive type transactions.
  • OTHERS: Other types of transactions.
  • PAYMENT: Payment type transactions.
  • RECOUP: Recoup type transactions (For example, from a Bank or Loss Account).
  • REFUND: Refund type transactions.
  • REVERSAL: Reversal type transactions.
  • WITHDRAWAL: Withdrawal type transactions.
  • PAYABLE: Funds payable, representing funds provided by PayPal that need to be paid back.
  • RECEIVABLE: Funds receivable, representing funds provided by PayPal that are being paid back.
  • TRANSFER: Funds transferred between a PayPal account and another payable account.
  • SETTLEMENT_CONSOLIDATION: Combines multiple transactions into a single entry for easier reconciliation.
  • ACH_REVERSAL: Reverses an incorrect or duplicate ACH transaction to correct errors.
  • PAYOUT_REFUND: Refund against a past payout transaction.
  • PAYOUT_REVERSAL:Reversal of a Payout transaction.
3 TRANSACTION_SUBTYPE Varchar The Subtype of Transaction. One of:
  • VOID: Void subtype transactions (applicable for transaction type AUTH).
  • FEE: Fee subtype transactions (applicable for transaction type CHARGEBACK).
  • REVERSAL: Reversal subtype transactions (applicable for transaction types CHARGEBACK, FEES, and WITHDRAWAL).
  • REFUND: Fee refunds.
  • PARTNER_FEE: Partner fee subtype transactions (applicable for transaction type FEES).
  • PAYMENT_FEE: Payment fee subtype transactions (applicable for transaction type FEES).
  • MASSPAY: MassPay subtype transactions (applicable for transaction type PAYMENT).
  • BANK: Bank subtype transactions (applicable for transaction type WITHDRAWAL).
  • LOSS_ACCOUNT: Loss account subtype transactions (applicable for transaction type RECOUP).
  • FROM: Currency Conversion from one currency.
  • TO: Currency Conversion to another currency.
  • FOREIGN_WITHDRAWAL: Foreign withdrawal fees (applicable for transaction type FEES).
  • BONUS: Applies to bonus transactions.
4 PRICING_FEE_TYPE Varchar One of the following fee types, based on transaction and forward or reverse money movement:
  • SALE: Sale-related fee type.
  • REFUND: Refund-related fee type.
  • CHARGEBACK: Chargeback-related fee type.
5 SELLER_ACCOUNT_ID Varchar The merchant's PayPal encrypted account number.
6 PAYPAL_REFERENCE_ID String The original PayPal transaction ID to which this event is related.
7 PAYPAL_TRANSACTION
_ID		 Varchar The PayPal transaction ID of the transaction.
8 INVOICE_ID Varchar The invoice ID of the transaction.
9 CUSTOM_FIELD Varchar A field for custom data.
10 TRANSACTION_DATE Date-time
The date and time the transaction was initiated in the format: YYYY/MM/DD HH:MM:SS offset.
  • YYYY:Four-digit year.
  • MM:Two-digit month.
  • DD:Two-digit day.
  • HH:Hour in 24-hour notation.
  • MM: Minutes.
  • SS: Seconds.
  • offset: The five-character signed offset from GMT (For example, +0800).
11 INTEGRATION_IDENTIFIER Varchar The button source code or organization name of the partner.
12 PAYMENT_INSTRUMENT
_TYPE		 Varchar A high-level classification of the financial instrument used to fund a payment. Examples include:
  • PAYPAL
  • CREDIT_CARD
  • DEBIT_CARD
  • Direct Debit
  • VENMO
  • Apple Pay
  • Google Pay
  • Network Token
  • Supported APMs
13 PAYMENT_INSTRUMENT
_SUBTYPE		 Varchar A detailed classification of the financial instrument used to fund a payment. Examples include:
  • AMEX: AMEX card transaction.
  • CARTE_BANCAIRE: CARTE_BANCAIRE 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.
  • DINERS: DINERS 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.
  • RUPAY: RUPAY card transaction.
  • SOLO: SOLO card transaction.
  • STAR: STAR card transaction.
  • SWITCH: SWITCH card transaction.
  • VISA: VISA card transaction.
For wallets and network tokens, the payment source subtype provides details of the card type and card brand used to fund the transaction. Examples include:
  • CREDIT_CARD-VISA
  • DEBIT_CARD-MASTER_CARD
14 TRANSACTION_AMOUNT Money The transaction amount.
15 TRANSACTION_CURRENCY Three character currency code The currency of the transaction.
16 TRANSACTION_DEBIT
_CREDIT_CODE		 Varchar Indicates whether money has been credited or debited from the account.
  • CR: – Denotes Credit.
  • DR: – Denotes Debit.
17 PRICING_MODEL Varchar Denotes whether there is a revenue share on the transaction or if fees are gross billed through invoices.
  • GROSS_BILLING: Gross billing of fees.
  • REVSHARE: Revenue share on fees.
18 INTERCHANGE_PROGRAM varchar The updated interchange program received for the transaction. If the transaction has received any interchange prior to this, that value should be discarded, and new details applied. A blank value means no interchange program is applicable, and prior interchange details should be nullified.
19 INTERCHANGE_COST
_PERCENTAGE		 varchar The percentage of the transaction amount charged as the revised interchange cost. If the transaction has received any interchange prior to this, that value should be discarded, and new details applied. Blank values should also be updated.
20 INTERCHANGE_COST
_FIXED_AMOUNT		 Money The fixed amount component of the revised interchange cost. If the transaction has received any interchange prior to this, that value should be discarded, and new details applied. Blank values should also be updated.
21 INTERCHANGE_COST Money The total revised interchange cost. If the transaction has received any interchange prior to this, that value should be discarded, and new details applied. Blank values should also be updated.
22 NETWORK_NAME varchar The pinless debit network name. Examples include:
  • VISA
  • AMEX
  • DISCOVER
  • MASTER_CARD
  • CARTE_BANCAIRE
ReferencePayPal.comPrivacyCookiesSupportLegalContact