Glossary
Last updated: Feb 19th, 11:54pm
Record types
The record type field categorizes transactions based on accounting principles for reporting purposes. The record subtype provides more details about the subcategory the transaction belongs to. These fields help users to understand the different categories of transactions and account them in their books appropriately.
Record Type | Record Type Description | Record Subtypes and Descriptions |
Sale | Payment received from a buyer for sale of goods or services. |
|
Refund | Payment sent to a buyer when you refund them the money they paid you for a sale. |
|
Dispute | Money movement resulting from a dispute filed by you or the buyer. |
|
Other payments | Transactions that are not related to sales and include other types of payments using your account. Includes postage payments, purchases through gift certificates, third-party payments, PayPal virtual debit card transactions, donations, rebates, crypto transfers, and certain types of reversals. |
|
Currency conversion | Accounting transaction generated to capture currency conversion details and costs. |
|
Add money | Addition of funds in your balance by you or some business event. |
|
Withdraw money | Withdrawal of money from your balance to a bank or non-banking institution account by you or auto-generated business events. |
|
Bonus | Addition of funds to your PayPal balance as a bonus for services you've subscribed to. |
|
Reversal | None |
|
Failed disbursement | Failure of an automated transaction that was initiated by PayPal to disburse the money from your balance to your linked bank account. |
|
Adjustment | Debits or credits made by PayPal in order to make adjustments in your account. |
|
Hold | Holds placed on the amount of a sales transaction or on all the funds in your account. |
|
Hold release | Reversals of holds and incentive usages in your account. |
|
Funds transfer | Transfer of funds between two accounts, such as PayPal accounts owned by you, PayPal accounts of partners or marketplaces, and general ledger accounts. |
|
Fees | Transactions created to record fees charged or reversed by PayPal. |
|
Partner fees | Fees charged by a partner for processing a transaction. |
|
Payout | Payout transaction. |
|
Payout refund | Refund against a past payout transaction. |
|
Payout reversal | Reversal of a payout transaction. |
|
Scheme fees | None |
|
Tax | Tax Withholding to IRS. |
|
Digital currency trade | Crypto buy / sell transactions |
|
Payment instrument type and subtype
Here is the list of payment methods that PayPal accepts. Use the payment instrument type and payment instrument subtype fields to find details of which payment method the buyer used while transacting.
Payment instrument type gives the main family name. Payment instrument subtype gives the granular details of the payment method under each family used by the buyer.
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-Mastercard
Payment instrument type with subtypes |
Credit card
|
Debit card
|
PayPal
|
Venmo
|
Apple Pay
|
Google Pay
|
Network Token
|
Direct debit
|
Local payment method
|
* Important: Sofort will be sunset on April 18, 2024. PayPal will not support Sofort payments starting April 19, 2024. Offer your users PayPal wallet and other alternative payment methods. Learn more.
Report File Naming Convention
For Individual Account report file naming convention for a report generated for an individual merchant account is as follows:
${encryptedSubscriptionId}-{NodeIdentifier}-{subfamily}-{templateName}-{dateCadence}-{fileNumber}-{totalFile}-{genDateTime}.{extension}
Field | Length | Information | Example |
Encrypted Subscription ID | 7 | Subscription ID within PayPal | ADSF13S |
Node Identifier | 45 | For PayPal accounts, this corresponds to the merchant's encrypted account number (PayerID) | 9HBKUHNC34696 |
Sub Family | 20 | Sub family of Report |
BTR for Balance Transactional Report BSR for Balance Summary Report FTR for Fee Transactional Report |
Template Name | 50 | Managed or user-given template name |
BALANCE_TRANSACTIONAL_REPORT BALANCE_SUMMARY_REPORT FEE_TRANSACTIONAL_REPORT |
Date Cadence | 4-29 |
For daily report : Report date in YYYYMMDD (ISO-8601) format in the merchant's time zone For a Custom Date Range : {startDateTime}-{endDateTime} Both date and time are in YYYYMMddHHmmss (ISO-8601 without separators) in the merchant's time zone. Length 29 is including the delimiter for {startDateTime}-{endDateTime} |
For example, August 1st to August 31st 2022 is shown as: 20220801000000-20220831235959 |
File Number | 3 | Current file number or sequence from 1 to 999 | None |
Total File | 3 | Total number of files in this report from 1 to 999 | None |
Window | 2 |
Optional. 2-digit offset from the Coordinated Universal Time on which the report is generated. This is useful when generating multiple reports for the same entity, like MAM. |
None |
Gen DateTime | 14 | Unique generation ID. Generated in YYYYMMddHHmmss format. | None |
Extension | 3 | Filename extension | None |
Delimiters | 9 | '-', '.' | None |
Total length | 185 | Length to be limited to 200 | None |
format | None | One of the following:
|
None |