Glossary
DocsBetaLast updated: November 17th 2023, @ 6:51:27 pm
Record types
The record type field categorizes transactions based on accounting principles for reporting purposes. 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 | Description |
| Sale | Payment received from a buyer for sale of goods or services. | No subtype | All sales transactions, unless specified otherwise. |
| Accelerated Checkout | A sales transaction via your accelerated checkout integrations. | ||
| Refund | Payment sent to a buyer when you refund them the money they paid you for a sale. | Referenced | Refund related to a payment you had received earlier, via PayPal. This refund will be referenced to the original payment in your PayPal account. |
| Non-referenced | This refund won't have a reference to the original payment, which was made offline. | ||
| Dispute | Money movement resulting from a dispute filed by you or the buyer. | Chargeback | Money moved back to the buyer's PayPal account when a dispute is resolved in favor of the buyer. |
| Chargeback reversal | Reversal of a chargeback that was debited from your account earlier. | ||
| 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, and certain types of reversals. | Payment sent | Other payments that are not directly related to a sale. |
| Payment received | Other payments that are not directly related to a sale. | ||
| Donation | Payment sent or received as a donation. | ||
| Blocked payment | Money movement when a payment is blocked. | ||
| Other | Payments that cannot be put into any other existing categories. | ||
| Currency conversion | Accounting transaction generated to capture currency conversion details and costs. | Balance conversion from | Accounting transaction generated when your PayPal balance is converted from one currency to another. This shows the original currency. |
| Balance conversion to | Accounting transaction generated when your PayPal balance is converted from one currency to another. This shows the destination currency. | ||
| Conversion from | Accounting transaction generated when a sale or refund amount is converted from one currency to another. This shows the original currency. | ||
| Conversion to | Accounting transaction generated when a sale or refund amount is converted from one currency to another. This shows the destination currency. | ||
| Add money | Addition of funds in your balance by you or some business event. | No subtype | General money additions to your balance. |
| Credit card transfer | Money added to your balance using a credit card. | ||
| PayPal Credit transfer | Money added to your balance using any PayPal Credit scheme. | ||
| PayPal payables | Money added to the balance by PayPal, which you must pay back later. | ||
| Incentive redemption | Funds added to your balance for incentives, gift certificates, or rewards. | ||
| Withdraw money | Withdrawal of money from your balance to a bank or non-banking institution account by you or auto-generated business events. | No subtype | General money withdrawals from your balance. |
| Disbursed | General money withdrawals from your balance. | ||
| Non-bank withdrawal | Withdrawals that are not going to your linked bank account. | ||
| Credit card withdrawal | Withdrawals to a credit card account. | ||
| Manual withdrawal | Withdrawals initiated by the user manually. Not related to automated, scheduled withdrawals. | ||
| Bonus | Addition of funds to your PayPal balance as a bonus for services you've subscribed to. | No subtype | All general bonuses. |
| Cash bonus | None | ||
| Referral bonus | None | ||
| Warranty bonus | None | ||
| Protection bonus | None | ||
| Reversal | None | Payment reversal | Payment reversals due to disputes and risks checks. |
| Bank reversal | Reversal of a payment by a buyer through their bank account. The reversal is triggered because the bank has declined the payment. | ||
| Incentive reversal | Reversal of an incentive payment made to you in the past. After reversal, the incentive is available for use again. | ||
| Failed disbursement | Failure of an automated transaction that was initiated by PayPal to disburse the money from your balance to your linked bank account. | Bank reversal | 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. | No subtype | All general adjustments. |
| PayPal receivables | Adjustment made for money you owe to PayPal on account of a PayPal payables transaction. | ||
| PayPal Credit adjustment | Adjustments made for money you owe to PayPal on account of a PayPal Credit transfer. | ||
| Account correction | Adjustments due to account corrections. | ||
| Hold | Holds placed on the amount of a sales transaction or on all the funds in your account. | Account hold | Holds placed on your account due to a payment review. |
| Temporary hold | A temporary hold placed on your account due to a payment review. | ||
| Disbursement hold | Hold on the funds before being disbursed to your account | ||
| Account reserve | Amount reserved at your account level, based on your instructions to PayPal, to manage your risk. | ||
| Transactional reserve | Amount reserved at a transactional level, based on your instructions to PayPal, to manage your risk. | ||
| Dispute hold | Amount put on hold to manage risk when a dispute is filed against you. | ||
| Tax hold | Hold placed on the funds from a sale due to a missing Tax Identification Number (TIN). | ||
| Hold release | Reversals of holds and incentive usages in your account. | Account hold release | Reversal of an account hold. Also see description of record type Hold. |
| Temporary hold release | Reversal of a temporary hold. Also check descriptions under the Type Hold. | ||
| Disbursement hold release | Reversal of a disbursement hold. | ||
| Account reserve release | Reversal of the amount put on reserve at the account level. | ||
| Transactional reserve release | Reversal of the amount put on reserve at the transactional level. | ||
| Dispute hold release | Reversal of amount put on hold to manage risk when a dispute is filed against you. | ||
| Tax hold release | Hold is released on the funds from a sale. | ||
| 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. | No subtype | All general funds transfers. |
| Receivables financing | None | ||
| Recoupment | Transfer of funds from a PayPal account, bank account, or a partner account to another PayPal account for covering a negative balance in that PayPal account. | ||
| Transfer refund | Reversal of a fund transfer transaction. | ||
| Sent / Received | All general fund transfers. | ||
| Fees | Transactions created to record fees charged or reversed by PayPal. | No subtype | General PayPal fees, including both variable and fixed components. |
| Withdrawal fees | Fees charged on withdrawals from PayPal balance under special circumstances. | ||
| Chargeback fees | Fees charged on chargeback processing | ||
| Monthly fees | Monthly fees charged for your PayPal Payments Pro account or charged for special products such as VT and PRO. | ||
| Dispute fees | Fees charged on disputes that required PayPal's involvement for resolution. | ||
| Fee reversal | Reversal of a fee | ||
| Custody fees | A fee charged for holding more the allowed balance in your account. | ||
| Bank return fees | Recovery of fees charged by a bank on returns. Can be due to reasons such as insufficient funds or high risk. | ||
| Campaign fees | Fees associated to a campaign running in your PayPal account. | ||
| Fee refund | Refund of a fee charged to your account earlier. | ||
| Payout fees | Fees charged on payouts to multiple recipients | ||
| Transactional fees | Fees charged by PayPal on a transaction. | ||
| Authorization success | Activities that incur fees for using a PayPal premium product. Fees charged by PayPal for various events, such as authorization, and its various states, such as success, decline, and void. This represents a decline state. | ||
| Authorization declines | Same as previous entry. | ||
| Capture success | Same as previous entry. | ||
| Capture declines | Same as previous entry. | ||
| Void success | Same as previous entry. | ||
| Void declines | Same as previous entry. | ||
| Refund success | Same as previous entry. | ||
| Refund declines | Same as previous entry. | ||
| Monthly scheme fees | Scheme fees charged monthly. | ||
| Authorization scheme fee | Scheme fees associated with authorizations. | ||
| Verification scheme fee | Scheme fees associated with verifications. | ||
| Authorization misuse scheme fee | Scheme fees associated with authorization misuses. | ||
| Partner fees | Fees charged by a partner for processing a transaction. | No subtype | General fees charged by the partner. |
| Partner tax | Tax withheld by the partner. | ||
| Payout | Payout transaction. | Sent / Received | Amount paid out or received from a different account. |
| Payout refund | Refund against a past payout transaction. | No subtype | None |
| Payout reversal | Reversal of a payout transaction. | No subtype | None |
| Scheme fees | None | Monthly fees | Fees charged by your Interchange++ scheme. |
| Tax | Tax Withholding to IRS. | Tax withholding | None |
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-VisaDebit card-Mastercard
| Payment instrument type | Payment instrument subtype |
| Credit card | American Express |
| Cartes Bancaires | |
| Cetelem | |
| Cofidis | |
| Cofinoga | |
| UnionPay | |
| Delta | |
| Discover | |
| Electron | |
| Elo | |
| Hiper | |
| Hipercard | |
| JCB | |
| Maestro | |
| Mastercard | |
| Solo | |
| Star | |
| Switch | |
| Visa | |
| RuPay | |
| Diners Club | |
| Bancard | |
| Unknown | |
| Debit card | Visa |
| Mastercard | |
| Maestro | |
| Discover | |
| American Express | |
| PayPal | PayPal wallet |
| Venmo | Venmo wallet |
| Apple Pay | Debit card-Visa |
| Credit card-Mastercard | |
| Debit card-American Express | |
| Credit card-Discover | |
| Google Pay | Debit card-Visa |
| Credit card-Mastercard | |
| Debit card-American Express | |
| Credit card-Discover | |
| Network Token | Debit card-Visa |
| Credit card-Mastercard | |
| Debit card-American Express | |
| Credit card-Discover | |
| Direct debit | None |
| Local payment method | OXXO |
| iDEAL | |
| Bancontact | |
| Sofort (Legacy) * | |
| eps | |
| MyBank | |
| giropay (Legacy) * | |
| Przelewy24 | |
| Trustly | |
| Verkkopankki | |
| Pay upon invoice | |
| Blik |
* Important: giropay will be sunset on June 30, 2024. PayPal will not support giropay payments starting July 1, 2024. Offer your users PayPal wallet and other alternative payment methods.
* 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 |