Management and reporting APIs
These APIs are used by accounting partners and merchants to manage merchant configuration and retrieve financial data.
A typical accounting partner workflow:
- Onboard and configure — use the Management API to set up sales units and prefill product orders on behalf of merchants
- Retrieve financial data — use the Report API and Sales API to pull transaction data, settlement figures, and sales context for bookkeeping and reconciliation
The Donations API is also listed here as it shares the same access model, but it retrieves donation-specific records from the Donations product rather than general financial data.
Management API​
The Management API enables self-service operations for sales units and merchant onboarding. You can manage sales units, retrieve merchant information, and prefill product orders on behalf of merchants.
Report API​
The Report API answers what happened to the money — ledger balances, captures, refunds, fees, and payouts.
Available to merchants and to accounting partners using accounting keys.
Sales API​
The Sales API answers what was sold and to whom — order lines, VAT breakdowns, sales categories, and buyer identity when available.
Available to accounting partners using accounting keys.
Use together with the Report API: join on reference or pspReference to correlate sales data with money movements.
Donations API​
The Donations API retrieves donation records from the Donations product — donor data, amounts, and payment history. For settlement data from Donations, use the Report API.