Activity Report

Document Version 1.1AnchorIcon

Changelog

Report DefinitionAnchorIcon

The Activity Report is a daily report that contains all transactions that were Submitted for Settlement or Settlement Declined from the previous processing day. The purpose of this report is to provide projected disbursement dates and total transaction fees for all transactions to aid in forecasting receivables from PayPal. By saving the projected disbursement dates for all transactions in your system of record, you will be able to more easily track transactions that will be disbursed in the future. For merchants who offer installments, this report will also capture any adjustments to future installment disbursement that may occur due to credit card disputes or refunds.

For merchants who process credit cards (with or without installments), this report will contain the Projected Disbursement Date for the following type of transactions:

  • Credit card sale and refund transactions
  • Debit card sale and refund transactions
  • Newly created installment transactions
  • Adjustments to installments

Obtaining projected disbursement datesAnchorIcon

In Brazil, card-based transactions can take anywhere from 2 to 30 days to be disbursed depending on the card type. The default disbursement is 30 days, however a feature called Predefined Funds Anticipation allows merchants to pay a premium to accelerate the funding of credit card based transactions. For more information about this feature visit this page.

Card TypeDisbursement Date
Credit Cards30 days
Debit Cards2 days

Whether you opt to pay for Predefined Funds Anticipation or not, it will be important to obtain and store the projected disbursement dates for all transactions and installments in your system of record so that you can track your receivables and forecast future disbursements.

Standard sale and refund transactionsAnchorIcon

To obtain the projected disbursement date for a standard sale or refund transaction, follow the below steps:

  1. Filter the report on Record Type = Sale or Refund
  2. Use the values in found in the Record ID column to match the IDs of transaction sales and refunds in your system of records
  3. Save the value found in the Projected Disbursement Data column along with the transaction in your system

Sale transactions with installmentsAnchorIcon

When a sale transaction is created and submitted for settlement with installments, the transaction response object will contain the following data for each installment:

  • Installment ID
  • Installment Amount

When the installments are initially created, the Projected Disbursement Date will be NULL and will be populated within twelve hours.

Installment records should be stored separately from standard sale transactions in your system of record because they will be paid out over time, so tracking them individually will be required in order to reconcile PayPal’s data with your system of record, and with your deposit bank account.

Steps to locate installment projected disbursement datesAnchorIcon

  1. Select all records where Record Type = Installment and Record Subtype is empty.
  2. Once the installment records are filtered to just those that represent newly created installments, iterate through the set using the Record ID column to identify the installment ID for which the record pertains to.
  3. Locate the Projected Disbursement Date field, add this date to your system of record, and save it with the installment record.

Installment adjustmentsAnchorIcon

The amount of an installment can be affected by two types of payment events:

  • Full and partial refunds
  • Full and partial disputes

Whenever a transaction with installments is refunded or has a dispute that has Lost associated with it, every installment will have its amount adjusted equally.

Additionally, adjustments can occur on both installments previously disbursed as well as installments that are to be disbursed in the future.

In the case an adjustment is made to an installment that has previously been disbursed, the adjustment amount will be netted out of the next disbursement, so it’s important to track the installment adjustments as they are created so that you can reconcile the installment disbursements with both your deposit account and your system of record.

Types of installment adjustmentsAnchorIcon

RefundsAnchorIcon

In the case of refunds, each installment will be reduced by the amount of the refund divided by the number of installments.

DisputesAnchorIcon

Dispute adjustments are typically negative adjustments and will reduce installment amounts. In some cases, disputes can be reversed, resulting in a positive adjustment.

Steps to locate information in the Activity ReportAnchorIcon

In order to maintain your system of records for installments, you will need to save installment adjustment records separately.

  1. To isolate the installment adjustment records, select all records with Record Type = Installment and Record Subtype = Adjustment from the Daily Activity Report
  2. Iterate through the installment adjustment records, using the Record ID field to identify the installment ID and save the following fields:
    • Settlement Amount – This will be used to obtain the amount of the adjustment. Add this value to the installment amount in your system of record to obtain the new amount for the installment.
    • Installment Disbursed
      • If TRUE then the installment’s adjustment amount will be netted from a future disbursement whose date can be obtained from the Projected Disbursement Date field. Installment adjustments for previously disbursed installments should be tracked as separate objects in your system of record because they will have their own money movement event, and will need to be reconciled using the Disbursement Report.
      • If FALSE then only future disbursed installments will be affected. In this case, the installment adjustment will have the same projected disbursement date as the installment.
    • Projected Disbursement Date – This is the date the adjustment amount will be netted from a future disbursement
    • Reason – This is the reason for the adjustment. The reason will either be a refund or dispute.
    • Adjuster ID – This is the ID of the object in your system that caused the installments to be adjusted.
      • When Reason = refund the Adjuster ID will be the ID of the refund in your system.
      • When Reason = dispute the Adjuster ID will be the ID of the dispute in your system.

Data dictionary of Activity ReportAnchorIcon

Field NameDescription
Merchant Account IDThe Merchant Account ID that was used to process the transaction
Record Type The type of object in the Braintree gateway. Either:
- Sale
- Refund
- Installment
Record Subtype The subtype of the object in the Braintree gateway:
- Adjustment (this is populated for installment objects where the row is describing an adjustment to an existing installment)
Record ID The ID of the object in the Braintree gateway.
- For Sale and Refund record types, the ID will be the Transaction ID for the sale or credit transaction.
- For Installment record types, the ID will be the Installment ID
StatusThe status of the transaction
Presentment CurrencyThe presentment currency of the transaction
Presentment AmountThe amount in presentment currency
Tax AmountThe amount passed by the merchant in the Tax Amount field of the API
Settlement CurrencyThe currency used to settle the transaction
Settlement Amount The amount of the Braintree object.
- For Sale and Refund records, the Settlement Amount will be the amount of the transaction.
- For Installment records (non-adjustments), this will be the initial amount of the installment
- For Installment records where the Record Subtype is Adjustment, the Settlement Amount will be the Adjustment Amount.
Effective Date The date scope of the report.
- For Sale and Refund record types, this will be the Submitted for Settlement date
- For Installment record types (non-adjustment) this will be the date the installment was created.
- For Installment record types with the Record Subtype of Adjustment, the date will be the creation date of the installment adjustment.
Order IDThe merchant populated order ID value
Purchase Order NumberA Level 2 data field that can be used to store a purchase order identification value.
Payment Instrument TypeThe payment instrument that was used to create the transaction
Payment Instrument Subtype The subtype of the payment instrument where applicable. For credit cards, this will be the brand of the credit card that was used to create the installment transaction.
Card TypeThe type of credit card used, either:
- Credit
- Debit
- Unknown
Customer IDThe ID of the customer in the Braintree gateway
Installment Disbursed A Boolean that indicates whether the installment that's being adjusted has been disbursed previously
Projected Disbursement Date The projected disbursement date of the installment adjustment. Only populated for installment adjustments where installments that have previously been disbursed.
Number of InstallmentsThe total number of installments in the installment plan.
Installment NumberThe sequence number of the installment
ReasonThe reason the adjustment occurred, either:
- Refund
- Dispute
Adjuster ID The ID of the adjusting object.
- When Reason is Refund the adjuster ID will be the refund ID.
- When Reason is Dispute the adjuster ID will be the dispute ID.
Total Fee AmountThe total fee that will be assessed on the transaction upon disbursement

Record types and subtypesAnchorIcon

Record TypeRecord Subtype
Sale​Installment​​
(null)
Refund​Referenced ​
Non-referenced​
Installment​Adjustment
(null)

Payment instrument types and subtypesAnchorIcon

Payment InstrumentPayment Instrument Subtype
Credit Card​ Visa
Mastercard​
American Express
Discover
Hipercard
Elo
Union Pay
Debit Card​ Visa
Mastercard​
American Express
Discover
Hipercard
Elo
Union Pay
PayPal​PayPal Wallet​
PayPal Credit
VenmoVenmo Wallet​
Apple Pay​Visa
Mastercard​
American Express
Discover
Google PayVisa
Mastercard​
American Express
Discover
Samsung PayVisa
Mastercard​
American Express
Discover
Bank AccountUS Personal Account
US Business Account
Others
Local Payment Methods OXXO
iDeal
Bancontact
Sofort
eps
Grabpay
MyBank
giropay
Przelewy24
Verkkopankki
Blik
OthersPartner Tax

ChangelogAnchorIcon

Document VersionDateNotes
1.002-18-2021Initial Version
1.104-27-2021Added "Total Fee Amount" Column