Skip to main content

API platform overview

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 API platform provides a shared framework for all APIs, using the same API keys, authentication methods, terminology, and error message formats.

This page lists the APIs by what they do: main APIs for payments and login, supporting APIs used alongside them, and reporting APIs for financial and sales data.

Not sure which API you need?

Start from your goal instead of the list below. On Find the right API you pick what you want to do — accept payments, let customers log in, or retrieve reporting data — and get the API and the product that go with it.

Main APIs​

Bill customers on a schedule​

Create and manage agreements for subscription billing and recurring charges.

Recurring API

Log users in​

Confirm the identity of a customer and retrieve profile information through the login process.

Login API

Supporting APIs​

These APIs enhance your integration and are used alongside the main product APIs:

Get notified of events​

Register for event notifications. Used with ePayment, Login, QR, Recurring, and Donations APIs.

Webhooks API

Show QR codes​

Generate QR codes for payments and redirects. Also supports personal QR codes.

QR API

Get customer profile data​

Request user consent and retrieve profile information during a payment or agreement flow. Used with ePayment and Recurring APIs.

Userinfo API

Show order details in the app​

Enrich payments with order details visible in the app. Primarily for the legacy eCom API; ePayment includes basic order details by default.

Order Management API

Management and reporting APIs​

These APIs give accounting partners and merchants access to financial and sales data. See Reporting APIs for the full overview.

Onboard and manage merchants​

Manage sales units, retrieve merchant information, and prefill product orders on behalf of merchants.

Management API

Reconcile payments and payouts​

Retrieve transaction and settlement data (funds, fees, payouts) for accounting and reconciliation.

Report API

See what was sold​

Retrieve order lines, VAT breakdowns, and sales context. For accounting partners.

Sales API

PSP solutions​

These APIs let Payment Service Providers offer Vipps MobilePay in their own payment solution. See PSP solutions for how to become a PSP partner.

Take payments as a PSP​

Create one-time payments, and receive the card details in a callback so you can acquire the payment yourself.

ePayment PSP API

Bill customers on a schedule as a PSP​

Create agreements and charges, and receive the card details in a callback so you can acquire each charge yourself.

Recurring PSP API

Agentic commerce​

Under development

Agentic commerce is under development. Content and integration details may change as we continue working.

Legacy​

Buttons and widgets​

These JavaScript libraries add Vipps MobilePay buttons and badges to your website. You use them together with the APIs, not instead of them. See Buttons and widgets for the overview.

  • Widget SDK - Show a payment button that also starts the payment or agreement. Used with the ePayment and Recurring APIs.
  • Button generator - Show an on-brand button, and start the flow yourself. Recommended for the Login API.
  • Badge generator - Show badges that tell customers you accept Vipps MobilePay.
  • Test environment - Access the Merchant Test (MT) environment, download test apps, and understand testing limitations and capabilities.
  • API keys - Get your merchant API keys from the business portal for both test and production environments.
  • Authentication - Learn how authentication works and which method applies to your integration.
  • API servers - Find the correct server URLs for test and production environments across all APIs.

More topics to be found at: Integration and testing

Last updated on