Skip to main content

Get PayPal Transaction Summary

GET 

/api/paypal/integrations/:id/transactions/summary

Totals for imported PayPal transactions on one integration. Accepts the same filter[...] and filter_groups parameters as List PayPal Transactions, so the totals always match the filtered list.

Authentication: Requires Bearer token.

gross, fees and net count order-related activity only (payments, refunds, disputes): rows whose match status is not_applicable (bank transfers, balance top-ups, holds, currency conversions, standalone fees) are left out. Transfers to and from bank accounts are totalled in transfers; the other not_applicable activity is totalled in other, net of any PayPal fee (so a standalone fee with a zero gross still counts). fees is the signed sum of PayPal fees. match_status_counts counts rows per match status. import reports whether transaction import is enabled for this PayPal account (the merchant must have granted transaction-search access when connecting) and when it last ran. import.last_error is a plain-language reason with a next step. import.first_import and import.initial_days say whether the next import reads the last initial_days days; otherwise import.next_import_from is the moment it resumes from (at least 7 days behind the last import, further back to the oldest transaction still pending). import.unavailable_reason explains, for how the account is connected, why transactions can't be imported (null when they can).

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Permission: Integrations → List (integrations.index).

Currencies: amounts in different currencies are never added together. totals has one row per currency (currency, gross, fees, net, transfers, other, count), sorted by currency. The top-level gross, fees, net, transfers and other are filled only when the filtered transactions are in a single currency, named by currency; when they mix currencies those fields and currency are null — read totals instead. count is the total across currencies.

Request​

Responses​

OK

Response Headers
    Content-Type