Skip to main content

Report API guide

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.

Run both commands, in order.

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

For troubleshooting, see the full instructions.

The Report API gives accounting partners and merchants programmatic access to payment transactions and settlement data across all Vipps MobilePay products, for use in accounting and financial reconciliation.

Note

Report API data is asynchronous and slightly behind the other APIs — usually by a second or so, but potentially by several hours if there are operational issues. Always use other Vipps MobilePay APIs as the source of truth for the status of a specific operation.

Contents​

  • Report API access — Authentication, API key types, and how to grant an accounting partner access to your sales unit data.
  • Overview of the settlement process — How ledgers, payouts, fees, and balances work, with example data and an account diagram.
  • Fetching report data — How to look up ledger IDs and retrieve settlement entries by date or continuous feed, including paging and GDPR fields.
  • Entry type reference — Descriptions of every entry type that can appear in the funds and fees ledgers.
  • Errors — Report API error codes and what they mean.
  • Sample scripts — Python scripts for fetching live settlement data and generating synthetic test data.
Last updated on