Management and reporting APIs

View as Markdown (opens in a new tab)

Install AI tools

Give your assistant up-to-date guidance for our APIs, with our plugin or without it.

The plugin is still under development. See the AI tools page for details.

Claude Code

Run both commands, in order.

claude plugin marketplace add vippsas/agent-toolkit
claude plugin install vipps-developer@agent-toolkit

Cursor

Open Settings, then Plugins.

Add vippsas/agent-toolkit as a plugin marketplace, then install the "vipps-developer" plugin.

Codex

For the app, add the marketplace "vippsas/agent-toolkit" and then install "vipps-developer". For the CLI, run the following commands.

codex plugin marketplace add vippsas/agent-toolkit
codex plugin add vipps-developer@agent-toolkit

Without installing

Paste this into any assistant.

Read https://github.com/vippsas/agent-toolkit/blob/main/plugins/vipps-developer/README.md for Vipps MobilePay integration guidance.

For troubleshooting, see the full instructions.

These APIs are used by accounting partners and merchants to manage merchant configuration and retrieve financial data.

A typical accounting partner workflow:

1. Onboard and configure — use the Management API to set up sales units and prefill product orders on behalf of merchants
2. 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 vs Sales API

Use these APIs when you need automatic reporting, reconciliation, or bookkeeping. They answer two different questions, and an accounting integration often needs both:

📝 What happened to the money

The Report API returns ledger balances, captures, refunds, fees, and payouts.

Available to merchants and to accounting partners using accounting keys.

Report API

🛒 What was sold

The Sales API returns order lines, VAT breakdowns, sales categories, and amounts for Vippsnummer (Open Amount and Shopping Basket) and mPOS payments.

Available to the accounting partner the merchant has designated, using accounting keys.

Sales API

To see what was sold and what happened to the money for the same payment, join the two on reference or pspReference.

See the Sales API introduction for the full breakdown of available data, historical data availability, and environment limitations.

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.