Pricing transaction report

DOCS

Last updated: Aug 15th, 6:09am

This report provides a detailed view of different types of costs incurred on the transactions occurring on your platform.

Know before you begin

  • You must be an approved partner to use this report.
  • Reports for partners on IC++ are generated and placed on PayPal's secure file transfer protocol (SFTP) server by the seventh day of every month by 9:00 AM in the leading time zone of the reporting window.
  • Reports for all other partners are generated and placed on PayPal's secure file transfer protocol (SFTP) server by the second day of every 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 appears as 1000 on the report.
  • To maintain backward compatibility, read the report data by column header name instead of column index.
  • This report is only available to partners who are on gross billing fees or a net settlement revenue share model.

Section 1: Report file name

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

PRICING_TXN.yyyymm.PartnerIdentifier.ReportingWindow.SequenceNumber.MajorVersion.MinorVersion.Format
Field Information
PRICING_TXN An abbreviation for Pricing Transaction Report.
yyyymm The month for the data in the report.
PartnerIdentifier The partner's button source code or the name of the partner's organization.
ReportingWindow The window of time when the report was generated.
SequenceNumber The sequence number of the report file. 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 The major version of the report.
MinorVersion The minor version of the report.
Format The report format is CSV (comma-separated values).

Section 2: 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 and 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 at which the report file was generated, in the following format: YYYY/MM/DDHH:MM:SS offset, where 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 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/DDHH: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/DDHH:MM:SS offset, where 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 Partner Fee, Payment Fee, or Fee Reversal.
  • HOLD: Hold type transactions.
  • HOLD_RELEASE: Hold release type transactions.
  • INCENTIVES: Incentives type transactions.
  • OTHERS: Others type transactions.
  • PAYMENT: Payment type transactions.
  • RECOUP: Recoup type transactions done either from Bank or Loss Accounts.
  • REFUND: Refund type transactions.
  • REVERSAL: Reversal type transactions.
  • WITHDRAWAL: Withdrawal type transactions.
  • PAYABLE: Funds payable are funds provided by PayPal that need to be paid back.
  • RECEIVABLE: Funds receivable are funds provided by PayPal that are being paid back.
  • TRANSFER: Transfers are funds transferred either from or to a PayPal account and another payable account
  • SETTLEMENT_CONSOLIDATION
  • ACH_REVERSAL
  • PAYOUT_REFUNDRefund against a past payout transaction.
  • PAYOUT_REVERSALReversal 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: Fees refund.
  • 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 currency.
  • TO: Currency Conversion to currency.
  • FOREIGN_WITHDRAWAL: Indicates foreign withdrawal fees, applicable for transaction type FEES.
  • BONUS: This subtype 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
  • REFUND
  • CHARGEBACK
  • CURRENCY_CONVERSION
5 SELLER_ACCOUNT_ID Varchar Merchant's PayPal encrypted account number.
6 PAYPAL_REFERENCE_ID String Original PayPal transaction ID to which this event is related.
7 PAYPAL_TRANSACTION_ID Varchar PayPal transaction ID of the transaction.
8 INVOICE_ID Varchar 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 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.
11 INTEGRATION_IDENTIFIER Varchar Button Source code or Organization name of partner
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:
  • PAYPAL
  • CREDIT_CARD
  • DEBIT_CARD
  • Direct Debit
  • VENMO
  • Apple Pay
  • Google Pay
  • Network Token
  • Supported APMs
13 PAYMENT_INSTRUMENT_SUBTYPE Varchar One of the following detailed classifications of the financial instrument used to fund a payment:
  • 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 token, Payment Source Subtype would show details of card type and card brand used to fund the transaction.
For example:
  • 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 if money has been credited or debited from the account.
  • CR: – Denotes Credit.
  • DR: – Denotes Debit.
17 PRICING_MODEL Varchar Denotes if there is a revenue share on the transaction or if the fees are gross billed through invoices.
  • GROSS_BILLING: gross billing of fees
  • REVSHARE: revenue share on fees
18 PP_FEES_BASE_PERCENTAGE varchar Percentage of transaction amount charged as PayPal Base Fees at the time of transaction.
19 PP_FEES_BASE_FIXED_AMOUNT Money Fixed PayPal fee amount component of PayPal Base Fees charged at the time of transaction.
20 PP_FEES_XB_PERCENTAGE varchar Percentage of transaction amount charged as PayPal Cross Border Fees at the time of transaction.
21 PP_FEES_XB_FIXED_AMOUNT Money Fixed PayPal fee amount component of PayPal Cross Border Fees charged at the time of transaction.
22 PP_FEES Money Total PayPal Fees charged at the time of transaction.
23 PROCESSING_COST_BASE_PERCENTAGE varchar Percentage of transaction amount charged as PayPal Base Markup.
24 PROCESSING_COST_BASE_FIXED_AMOUNT Money Fixed amount component of PayPal Base Markup.
25 PROCESSING_COST_XB_PERCENTAGE varchar Percentage of transaction amount charged as PayPal Cross Border Markup.
26 PROCESSING_COST_XB_FIXED_AMOUNT Money Fixed amount component of PayPal Cross Border Markup.
27 PROCESSING_COST Money Total PayPal Markup.
28 INTERCHANGE_PROGRAM varchar Interchange program name applicable for the transaction.
29 INTERCHANGE_COST_PERCENTAGE varchar Percentage of transaction amount charged as Interchange cost.
30 INTERCHANGE_COST_FIXED_AMOUNT Money Fixed amount component of Interchange cost.
31 INTERCHANGE_COST Money Total Interchange cost.
32 PP_FX_MARKUP Number PayPal markup rate for FX Optimizer enabled currency conversion transactions.
33 PP_FX_MARKUP_AMOUNT Money PayPal markup amount for FX Optimizer enabled currency conversion transactions.
34 PARTNER_FX_MARKUP Number Partner's markup rate for FX Optimizer enabled currency conversion transaction.
35 PARTNER_FX_MARKUP_AMOUNT Money Partner's markup amount for FX Optimizer enabled currency conversion transaction.
36 INVOICE_FX_AMT_IN_TXN_CURRENCY Money This is the calculated invoice amount in transaction currency for a FX Optimizer enabled currency conversion transaction. If the invoice account's primary currency is different, it will get converted to invoice account currency. Refer to INVOICE_FX_AMT_IN_INVOICE_CURRENCY column.
37 INVOICE_FX_AMT_IN_INVOICE_CURRENCY Money This is the currency conversion converted amount in the invoice account's primary currency.
38 INVOICE_CURRENCY Three character currency code The currency of the invoice account in which invoice is raised on.
39 PAYOUT_FX_AMT_IN_TXN_CURRENCY Money This is the calculated revenue share payout amount in the transaction currency for a FX Optimizer enabled currency conversion transaction. If the payout account's primary currency is different, it will get converted to the payout account currency. Refer to PAYOUT_FX_AMT_IN_PAYOUT_CURRENCY column.
40 PAYOUT_FX_AMT_IN_PAYOUT_CURRENCY Money This is the currency conversion converted amount in the payout account's primary currency.
41 PAYOUT_CURRENCY Three character currency code The currency of payout account in which revenue share amount is payed out.
42 NETWORK_NAME varchar Pinless debit network name such as the following:
  • VISA
  • AMEX
  • DISCOVER
  • MASTER_CARD
  • CARTE_BANCAIRE
43 FASTLANE_CHECKOUT_TRANSACTION Y/N Indicates whether the transaction was checked out using fastlane accelerated checkout.
Position Column name Data type Description
1 Column Type Literal The column type (SF).
Position Column name Data type Description
1 Column Type Literal The column type (FF).

ReferencePayPal.comPrivacyCookiesSupportLegalContact

We use cookies to improve your experience on our site. May we use marketing cookies to show you personalized ads? Manage all cookies