Revenue Share Transactions Report
Last updated: Jan 9th, 2:12am
The Revenue Share Transactions Report provides details about the revenue share earned from each transaction and the corresponding payout settled to your PayPal or bank account. The report supports reconciliation and enables you to validate each transaction’s contribution to your total revenue share payout for a specific period.
You can access the report through PayPal’s Secure File Transfer Protocol (SFTP) server. For more information about using SFTP to access reports, see Access SFTP reports.
Prerequisites and requirements
- Available to partners who have enabled revenue share payouts with PayPal.
- Access to the SFTP server. Reports are automatically delivered to your designated SFTP location after each revenue share payout cycle.
Report access and delivery
| Method | Description | Reports Setup | Delivery Details | Availability |
|---|---|---|---|---|
| Scheduled delivery | The report is generated automatically and is delivered to the user's SFTP dropbox after initiating revenue share payout. | Prerequisites:
|
Delivered to your SFTP location after each payout.
|
Available |
Report samples according to the revenue share model
| Revenue share model | Description | Sample report |
|---|---|---|
| Net TPV model | PayPal shares a portion of Total Payments Volume (TPV) with the partner. | |
| Net Revenue model | PayPal shares a portion of the net revenue earned with the partner after deducting costs (for example, interchange, network fees) and losses (for example, chargebacks, negative balances). | |
| Buy-Sell model | PayPal collects the transaction fee (sell rate) from the merchant and retains the platform fee (buy rate). For Interchange plus plus (IC++) use cases, processing costs (interchange, assessment) are also passed on to the partner. |
File format specifications
- Format: Comma-separated values (.csv).
- Encoding: UTF-8 (8-bit UCS/Unicode Transformation Format).
- Currency representation: Major currency units (For example, dollars for USD, yen for JPY).
- Negative amounts: Indicated with a minus sign (For example, -1000.00 for refunds).
- File size limit: Maximum 1 million records per file. Larger reports are split across multiple files.
File naming convention
Reports follow this standardised naming pattern:
${encryptedSubscriptionId}-{NodeIdentifier}-{subfamily}-{templateName}-{dateCadence}-{fileNumber}-{totalFile}-{genDateTime}.{extension}
Example:
- Net TPV model
0000001-E7Q5P8YQHH5ZA-RST-REVSHARE_TXN_REPORT_nTPV-20250101-20250131-1-1-20250101000000.CSV
- Net Revenue model
0000001-8549P8GMXS3X2-RST-REVSHARE_TXN_REPORT_NREV-20250919-20250921-1-1-2025110600000.CSV
- Buy-Sell model
0000001-E7Q5P8YQHH5ZA-RST-REVSHARE_TXN_REPORT_BuySell-20250101-20250131-1-1-20250101000000.CSV
For more details about the file naming convention, see the glossary.
Reconciliation guide
| Reconciliation use case | How to reconcile |
|---|---|
| Trace revenue share payout in bank statement or PayPal account | Use the PAYOUT_REFERENCE_ID column in the report summary section to match the payout in your bank or PayPal account. |
|
Reconcile payouts and contributing transactions |
For every PAYOUT_REFERENCE_ID, total payout amount in report summary section under column PAYOUT_AMOUNT in PAYOUT_CURRENCY == Sum of amounts in PAYOUT_CURRENCY in REVSHARE_PAYOUT column for all transactions in the report details section. |
|
Revenue share per transaction (by model) |
Revenue is shared with partners primarily through these 3 models:
|
Report specifications
The report template includes the following sections:
Report header (RH)
Contains metadata about the report, such as report name, status, date range, generation time, account hierarchy, and timezone.
| Position | Column name | Optional/Required | Data type | Description |
|---|---|---|---|---|
| 1 | RH | Required | Static, 2 characters | Indicates that this row contains report header data. |
| 2 | Report name | Required | Character varying (256) | Name of the report. Values include:
|
| 3 | Report status | Required | Success/Error | Report generation status. |
| 4 | Report start date and time | Required | YYYY/MM/DD HH:MM:SS offset | The start date and time for which the data is captured in the report, where:
|
| 5 | Report end date and time | Required | YYYY/MM/DD HH:MM:SS offset | The start date and time for which the data is captured in the report, where:
|
| 6 | Report generation date and time | Required | YYYY/MM/DD HH:MM:SS offset | The date and time when the report file was generated, in the following format: YYYY/MM/DD where:
|
| 7 | Hierarchy | Required | Character varying (256) | Encrypted PayPal account number for an account holding individual account in PayPal. |
| 8 | Timezone | Optional | Character varying (256) | Timezone of the report. |
Report summary (RS)
Provides a summary of the revenue share payout, including payout IDs, period, amount, currency, payment instrument, and program details.
| Position | Column name | Optional/Required | Data type | Description |
|---|---|---|---|---|
| 1 | RS | Required | Static, 2 characters | Indicates that this row contains report summary data. |
| 2 | Record ID | Optional | Character varying (256) | Unique identifier generated by PayPal for the payout transaction. |
| 3 | Transfer ID | Optional | Character varying (256) | Unique external reference number assigned to the payout transaction. |
| 4 | Payout period start date | Optional | YYYY-MM-DD HH:MM:SS offset | Start date of the period for which the revenue share payout is calculated, where:
|
| 5 | Payout period end date | Optional | YYYY-MM-DD HH:MM:SS offset | End date of the period for which the revenue share payout is calculated, where:
|
| 6 | Timezone | Optional | Character varying (256) | Timezone of the user. Transactions included in the payout are based on this time zone. |
| 7 | Payout amount | Optional | Numeric (23, 2) | Total amount disbursed to your account for this payout. |
| 8 | Payout currency | Optional | 3-character currency code Max length: 3 characters |
Currency in which the payout is processed. See PayPal-supported currencies for possible values. |
| 9 | Payout instrument | Optional | Character varying (256) | Payment instrument to which the payout has been made. |
| 10 | Account number | Optional | Character varying (256) | Account number associated with the payment instrument. |
| 11 | Revenue share program | Optional | Character varying (256) | The Revenue share program name defined in PayPal for configuring the revenue share arrangement. |
Report details (RD)
Provides transaction-level details, including merchant account, region, type, integration product, transaction IDs, amounts, currencies, payment methods, fee breakdowns, and revenue share calculations.
| Position | Column name | Optional/Required | Data type | Description |
|---|---|---|---|---|
| 1 | RD | Required | Static 2 characters | Indicates that this row contains report details data. |
| 2 | Merchant account ID | Required | Character varying (256) | Encrypted account number of the merchant. |
| 3 | Merchant region | Required | Character varying (256) | Merchant's country code of residence. See the Market Code Table. |
| 4 | Merchant type | Optional | Character varying (256) |
|
| 5 | Integration product | Optional | Character varying (256) |
|
| 6 | Integration sub product | Optional | Character varying (256) |
|
| 7 | Integration identifier | Optional | Character varying (256) | BN code associated with the transaction. |
| 8 | Record id | Required | Character varying (256) | PayPal generated unique identifier for this transaction. |
| 9 | Related record id | Required | Character varying (256) | Immediate parent transaction ID. |
| 10 | Record type | Required | Character varying (256) | Type of transaction. See glossary for more information. |
| 11 | Record subtype | Optional | Character varying (256) | Subtype of the transaction. See glossary for more information. |
| 12 | Created at | Required | YYYY-MM-DD HH:MM:SS offset | Date and time the transaction was initiated, in the following format: YYYY/MM/DD HH:MM:SS offset. Where:
|
| 13 | Gross transaction amount | Required | Numeric (23, 2) | Total amount of transaction before deducting fees. |
| 14 | Transaction currency | Required | 3-character currency code Max length: 3 characters |
Currency of the transaction. See PayPal-supported currencies for possible values. |
| 15 | Payment method | Optional | Character varying (256) | Method of payment used to process the transaction. See glossary for more information. |
| 16 | Payment method type | Optional | Character varying (256) | Specific tender used to process the transaction. See glossary for more information. |
| 17 | Invoice id | Optional | Character varying (256) | Invoice ID passed at the time of transaction. |
| 18 | Custom field | Optional | Character varying (256) | Custom field. |
| 19 | Merchant pricing model | Optional | Character varying (256) | Net TPV model: This field is not applicable. Buy-Sell model: Specifies the pricing structure applied when charging the merchant.
|
| 20 | Transaction meta data | Optional | Character varying (256) | Primarily applicable for users on Buy-Sell rate model. Additional transaction details, if applicable, in JSON format. Refer to Attribute reference for details. |
| 21 | Revshare eligible | Required | Character varying (256) | Indicates whether the transaction qualifies for revenue share (YES/NO). |
| 22 | Revshare model | Optional | Character varying (256) | Primary revenue share model applied to the transaction.
|
| 23 | Total processing fee | Optional | Character varying (256) |
|
| 24 | Total processing cost | Optional | Character varying (256) |
|
| 25 | Processing losses | Optional | Character varying (256) |
|
| 26 | Platform fee | Optional | Character varying (256) |
|
| 27 | Partner revshare | Optional | Numeric (23, 2) | Revenue share earned from the transaction in record currency (precision up to two decimal places). |
| 28 | Fee details | Optional | Character varying (256) | JSON object breaking down revenue share from eligible transaction and value-added service components, with detailed fee and cost sub-components. Refer to Attribute reference for detailed specifications. |
| 29 | Payout currency | Required | Character varying (256) | Currency of the Revenue share Payout. See PayPal-supported currencies for possible values. |
| 30 | Revshare payout | Required | Numeric (23, 2) | Revenue share earned from the transaction in payout currency (precision up to six decimal places). |
| 31 | Transfer ID | Required | Character varying (256) | Unique external reference number assigned to the payout transaction. |
| 32 | Revshare remarks | Optional | Character varying (256) | Remarks |
Attribute reference
| S.No | Revenue share model | Column details | Description | Sample object details |
|---|---|---|---|---|
| 1 | Net TPV | FEE_DETAILS | For transactions under the Net TPV model, the FEE_DETAILS JSON parameter provides the applied revenue share rate in accordance with the revenue share agreement, along with the revenue share model and the revenue share amount in the record currency. |
|
| 2 | Net Revenue | FEE_DETAILS | For transactions under the nRev model, the FEE_DETAILS JSON parameter provides the split of various fees and applied revenue share rate in accordance with the revenue share agreement, along with the revenue share model and the revenue share amount in the record currency. |
|
| 3 | Buy-Sell model | FEE_DETAILS | For transactions under the Buy-Sell model, the FEE_DETAILS JSON parameter provides the split of Buy rate and Sell rate applied at transaction level and the partner revenue share amount in the record currency. |
|
| 4 | Buy-Sell model | TRANSACTION_META_DATA |
|
Fee details
| S.No | Parameter | Data type | Description |
|---|---|---|---|
| 1 | revshare_model | Character varying (256) | Primary revenue share model applied to the transaction. For example, the revshare_model for Net Revenue model is net_revenue. |
| 2 | revshare_rate | Numeric (23, 2) | Revenue share rate applied to net revenue per transaction, expressed as a decimal. |
| 3 | partner_revshare | Numeric (23, 2) | Revenue share earned from the transaction in the record currency rounded off to 2 decimal places. |
| 4 | platform_fee | Numeric (23, 2) | Fees charged by PayPal to meet the costs associated to process the transaction, amount is rounded to 2 decimal places. |
| 5 | processing_losses | Numeric (23, 2) | Any losses incurred due to chargebacks or bank returns etc rounded to 2 decimal places. |
| 6 | processing_fee | Character varying (256) JSON object |
JSON object that provides the split of various fees components charged to process the transactions. For example, processing_fee includes standard fee charged by PayPal. In case of IC++ card transactions, it also includes fees charged by processors like interchange and assessment. |
| 7 | processing_cost | Character varying (256) JSON object |
JSON object that provides split of various costs associated with the transaction. For example, processing_cost includes charges by processors like interchange assessment. For each kind of fee or cost, view the detailed split in terms of total amount, fixed and variable fees applicable. |
| 8 | processing_losses | Character varying (256) JSON object |
JSON object that provides split of various losses incurred by PayPal. For example, processing_losses includes chargebacks or bank returns. For each kind of fee or cost, view the detailed split in terms of total amount, fixed and variable fees applicable. |
| 9 | value_added_services | Character varying (256) JSON object |
Any fees charged as a part of value added services opted by merchant. For example, Foreign Exchange as a Service, Fraud protection. For each kind of fee or cost, view the detailed split in terms of total amount, fixed and variable fees applicable. |
Transaction meta data
Parameter description
| S.No | Parameter | Description |
|---|---|---|
| 1 | base_transaction_amount | Base amount on which buy and sell rates or markups are applied. |
| 2 | transaction_currency | Currency of the base transaction amount in which Buy and sell rates or markups are applied. |