Skip to main content

API platform overview

The API platform provides a shared framework for all APIs, using the same API keys, authentication methods, terminology, and error message formats. This makes it straightforward to integrate with multiple APIs.

Not sure which API you need?
Using Shopify, WooCommerce, or other platforms?

We have ready-made plugins that handle the API integration for you:

No need to integrate APIs manually if a plugin is available for your platform.

Main APIs​

Online payments icon

ePayment​

Add Vipps MobilePay to your checkout.

Recurring icon

Recurring​

Let returning customers pay automatically.

Login icon

Login​

Sign-up and login users online.

  • Login API - Confirm the identity of a customer through the login process.
Using multiple APIs together

Many supporting APIs like Webhooks, Userinfo, and Order Management can be used together with your main product integration without requiring separate product purchases.

Additional APIs​

Supporting APIs​

Enhance your integration with these supporting APIs, available with all main products:

  • Access Token API - Required for authentication. Obtain an access token to authorize API requests.
  • Check-in API (experimental) - Let customers check in at a physical location via the app (Point of Sale).
  • Order Management API - Attach order details, images, and information to transactions. Primarily used with eCom API; optional with ePayment.
  • QR API - Generate QR codes that can be scanned to start a payment or redirect to a URL.
  • Userinfo API - Get the user's consent and retrieve their address and other profile information.
  • Webhooks API - Register for event notifications. Required for ePayment and Recurring integrations.

Management API​

This API enables self-service operations for sales units and merchant onboarding:

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

Reporting APIs​

These APIs retrieve financial data from your products:

  • Report API - (For merchants and for accounting partners with accounting keys) Retrieve transaction and settlement data for Payment Integration, Cash register integration, and Recurring payments products.
  • Donations API - Retrieve donation-specific data from the Donations product. For settlement data, use the Report API.

Other APIs​

PSPs​

Payment Service Provider (PSP) APIs:

  • MobilePay Online - Integrate MobilePay payments for merchants in Denmark and Finland. For PSPs only.
  • Vipps PSP API - Integrate Vipps payments in Norway; initiate payments, get details, and update status. For PSPs only.
  • Vipps PSP Signup API - Onboard and manage merchants; create sales units and retrieve merchant information. For PSPs only.

Agentic commerce​

For AI and agent-driven shopping and checkout, we support the Universal Commerce Protocol (UCP) and the Vipps MobilePay payment handler. Use it to integrate WALLET and CARD payments in agentic and conversational flows.

Legacy APIs​

Last updated on