PayPal balance report for partner

DocsBeta

Last updated: Oct 30th, 12:29pm

The Balance report gives you detailed information about revenue collected as Partner commission as part of each transaction that affects the settlement of funds in your accounts. The report also summarises the beginning and ending balances for each currency held in your accounts. It helps you understand how your Balances are changing on daily basis in relation to your transactions. It also provides a view of how much would get settled to your Bank account the next day.

The Balance Report is available through the Secure FTP Server. For more information about using SFTP to access reports, see Access SFTP Reports .

How to use the PayPal balance report

Use Cases Report Type Delivery Method Recon Guide
  • Reconciling the Partner revenue charged as Partner commission for each transaction processed on behalf of the merchants.
  • Reconciling the day’s (or any specified period's) revenue generated for all payment activity including Sales, Refunds, Disputes, Fees, Withdrawals, etc., with the End of Day balances.
  • Reconcile your Opening and Closing balances.
  • Understand Payouts to your Bank accounts.
Download a sample report
  • SFTP
Reports Reconciliation Guide

How to get the report

  • Subscribe to the report to have it delivered to your SFTP folder. Reach out to your account team to subscribe to SFTP delivery.

Know before you begin

  • The report format is CSV (comma-separated value) only.
  • The character encoding of this report is UTF-8 (8-bit UCS/Unicode Transformation Format).
  • All amounts in this report are Expressed in major units of the currency (e.g. dollars for USD, yen for JPY) See PayPal-supported currencies for a list of all ISO-4217 currency codes that PayPal supports for use with payments and balances.
  • Money being reversed from your account would be shown with a Negative sign [ e.g. -1000 USD as refund amount ] to ease the reconciliation.
  • A single report file can contain a maximum of a million records. If the report contains more than a million records, the report is split across multiple files.
  • For reports that are split over multiple files, only the first file has a report header record. Only the last file has a report footer and a report record count.
  • Descriptions of Record Type and Record subtype and Payment instrument type and Payment instrument subtype are available here: glossary
  • The PayPal balance report is generated and put on the Secure FTP server by no later than 12:00 PM daily, in the leading timezone of the reporting window. The report is available on the Secure FTP Server in the /ppreports/outgoingdirectory. For help with SFTP reports, see Access SFTP reports.

Report file name

The sample filename for reports being delivered to your SFTP is as following: 0000ZIZ-YWSCZZCDSYKGA-BTR-BALANCE_TRANSACTIONAL-REPORT-20220601-1-1-20220602000000.CSV For more details about file naming convention, see the glossary

Report Specifications

Report template includes the following sections:

  • Report Header(RH)
  • Report Summary(RS)
  • Report Details(RD)
  • Report Footer(RF)

RH: Report Header

Position Column name Optional/Required Data type Description
1 RH Required Static, 2 characters Descriptor advising that this row of data contains report body data.
2 Report name Required Character varying (256) Name of the report. Values include: `BALANCE_TRANSACTIONAL_REPORT`.
3 Report status Required Success/Error Report generation status.
4 Report generated Required YYYY-MM-DD The date and time when the report file was generated, in the following format: YYYY/MM/DD where:
  • YYYY is the year.
  • MM is the month.
  • DD is the day.
5 Hierarchy Required Character varying (256) Encrypted account number for an account holding individual account in PayPal.
6 Time zone Required Character varying (256) Time zone of the report.

RS: Report Summary Section

Summary for Balance Report :
This section includes the Opening and Closing balance of the Partner Fee accounts.

Position Column name Optional/Required Data type Description
1 Account ID Required Character varying (256) Encrypted account number of the partner.
2 Balance Required Numeric (23, 2) The opening and closing balances for the day or the date range for which the report is generated.
Opening Balance for Day N+1 is usually the closing balance for Day N.
Closing balance is usually the Opening Balance plus the sum of Net amounts from transactions that happened on the day or a selected date range.
3 Currency Required Three-character currency code
Max length: 3 characters
Currency of fee. See PayPal-supported currencies for possible values.
4 Available Required Numeric (23, 2) This is the balance available for the specific currency. You can expect the closing available balance to be settled to your bank account the next day.
5 Withheld Required Numeric (23, 2) This is the balance that is kept on Hold due to Risk / Compliance policies.
6 Total Required Numeric (23, 2) This is the Total balance that's the sum of your Available and Withheld balances.

RD: Report Details

Position Column name Optional/Required Data type Description
1 Record ID Required Character varying (256) PayPal generated unique identifier for this transaction.
2 Related record ID Optional Character varying (256) Indicates the immediate parent transaction ID.
3 Original record ID Optional Character varying (256) This is a PayPal generated unique identifier for a pre-existing transaction that is referenced by this transaction. This is useful for users to trace the list of all transactions related to the Original Sale transaction.
4 Record type Required Character varying (256) Type of the transaction.
See the glossary for more information.
5 Record subtype Optional Character varying (256) Subtype of the transaction.
See the glossary for more information.
6 Related record type Optional Character varying (256) Record Type of the related transaction which is contributing to this transaction.
7 Related record subtype Optional Character varying (256) Record subtype of the related transaction which is contributing to this transaction.
8 Merchant account ID Required Character varying (256) Encrypted account number of the merchant.
9 Partner identifier Optional Character varying (256) Identifier of the Channel Partner who had initiated this transaction.
This is populated when the merchant has authorized a Channel partner to initiate transactions.
10 Invoice ID Optional Character varying (256) The invoice ID passed at the time of transaction.
11 Original invoice ID Optional Character varying (256) The invoice ID of the original sale transaction. Uses to link all transactions associated with the original invoice ID.
12 Custom Field Optional Character varying (256) Custom field.
13 Payment instrument type Optional Character varying (256) The method of payment used to process the transaction.
See the glossary for more information.
14 Payment instrument subtype Optional Character varying (256) The specific tender used to process the transaction.
See the glossary for more information.
15 Created at Required YYYY-MM-DD HH:MM:SS Date and time the transaction was initiated, 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.
16 Record currency Required Three-character currency code
Max length: 3 characters
Currency of the transaction. See PayPal-supported currencies for possible values.
17 Gross amount Required Numeric (23, 2) Total amount of the transaction before deducting fees.
18 Total fees net billed Optional Numeric (23, 2) This field contains the fee amount value for all transactions where a transactional fee is net billed against the transaction.
19 Net amount Required Numeric (23, 2) This is the net disbursed amount (Gross Amount + Total fees net billed).
Note: Total fees net billed is a signed amount , effective it would get negated from gross amount
20 Transfer ID Optional Character varying (256) Unique identifier passed at the time of withdrawal of funds to either BANK or HW or any external instrument that appears against the transaction in the bank statement/HW statement of the partner.
In the Disbursement Report, this enables the merchant to reference all the transactions that contributed to a particular Withdrawal.
21 External payout instrument Optional Character varying (256) Indicates instrument to which amount is withdrawn.
Examples : Bank , HW for Hyperwallet
22 Related record gross amount Required Numeric (23, 2) Total amount of the original transaction like Sale / Refund to which this fee transaction is associated to.
23 Variable fee rate Optional Numeric (23, 2) Variable part of the PayPal fees, represented in percentage Ex. 2.49% = .0249
24 Fixed fees Optional Numeric (23, 2) Fixed part of the PayPal fees.
25 PayPal fees Optional Numeric (23, 2) Total PayPal fee applicable as part of the transaction.
26 Fx variable rate Optional Numeric (23, 2) PayPal markup rate for FX Optimizer enabled currency conversion transactions.
27 Fx fixed fees Optional Numeric (23, 2) PayPal markup amount for FX Optimizer enabled currency conversion transactions.
28 Fees description Optional Character varying (256) Name of the Interchange program classification.
29 Interchange rate Optional Numeric (23, 2) Interchange rate applied to this transaction.
30 Interchange fixed fees Optional Character varying (256) Interchange fixed fee applied to this transaction.
31 Interchange fees Optional Numeric (23, 4) Total Interchange fee charged by the issuer.
32 Scheme fees Optional Numeric (23, 4 Total scheme fees applied to this transaction.
33 Total passthrough fees Optional Numeric (23, 2) Total Passthrough fees applied to this transaction (sum of Total Interchange Fees + Total Scheme Fees).
34 Fees count Optional Numeric (23, 2) Total transactions applicable for aggregated fees like gateway fees.
35 Total fees gross billed Optional Numeric (23, 2) Total fee that was applied to this transaction. This fees will be billed monthly to the merchant, hence gross-billed.
36 Invoicing currency Optional 3-character currency code
Max length: 3 characters
The currency of invoice account in which invoice is raised on.
See PayPal-supported currencies for possible values.
37 Total fees gross billed in invoice currency Optional Numeric (23, 2) This reflects the converted amount in invoice account's primary currency, rounded to 5 decimal places.
Sum up this amount across different rows and sections for each invoice account to reconcile with what you get in invoice.
38 Gross billing month Optional YYYY-MM Expected Month in which the amount would be gross billed and included in the Monthly invoice.
39 Network name Optional Character varying (256) Network through which the transactions were processed. This is specific to low-cost processing networks
40 Cross border transaction Optional One-character flag Indicates if the transaction is a cross border or not.
  • Y - Cross border transaction
  • N - Non cross border transaction
41 Case ID Optional Character varying (256) ID of the Dispute in-case this transaction event is tied to a dispute.
42 Store ID Optional Character varying (256) ID of the store where the transaction was Initiated.
43 Reader ID Optional Character varying (256) Terminal ID in the store where the Transaction was initiated.
44 Payment channel Optional Character varying (256) Indicates if transaction is an Online vs Offline txn. Here are the possible values.
  • Online transactions - Online
  • Offline transactions - POS
45 Reason code Optional Character varying (256) This code indicates the reason of decline, when available. For credit card transactions, the code is a processor decline code. For bank transactions, the code is a bank decline code. For more information, see processor decline codes. For more information on UDD Sepa declines, refer here.
46 Payout item ID Optional Character varying (256) The ID of the payout item.
47 Memo Optional Character varying (256) Custom information sent by user while calling Api to place transaction.

RF: Report Footer

Position Column name Optional/Required Data type Description
1 RF Required Static 2 characters Descriptor advising the merchant this row of data contains Report footer data.
2 File number Required Numeric (23, 2) Indicates the current file number. This can be part of the file naming convention.
3 Total records Required Numeric (23, 2) This will be file specific and will indicate number of transactions included in the detail section in a file. This field should be shown only in the report if there are transactional details.
4 Total files Required Numeric (23, 2) The number of files generated for the report.

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