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?

• See Find the right API

Using Shopify, WooCommerce, or other platforms?

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

• Shopify plugins - Payment, checkout, companion app, and login plugins
• See all plugins - Pre-built integrations for popular platforms

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

Main APIs

ePayment

Add Vipps MobilePay to your checkout.

• ePayment API - Create and manage payment requests.

Login

Sign up and log in users online.

• Login API - Confirm the identity of a customer through the login process.

Recurring

Let returning customers pay automatically.

• Recurring API - Create and manage agreements.

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.

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.
• 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 and reporting APIs

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

• Management API - Manage sales units, retrieve merchant information, and prefill product orders on behalf of merchants.
• Report API - Retrieve transaction and settlement data (funds, fees, payouts) for accounting and reconciliation.
• Sales API - Retrieve order lines, VAT breakdowns, and sales context. For accounting partners.
• Donations API - Retrieve donation records from the Donations product.

PSP solutions

See Payment Service Provider solutions for the full list of PSP APIs, including signup, card passthrough, and legacy payment APIs.

Agentic commerce

• Agentic commerce - Overview, UCP schemas, and full payment handler specification.

Legacy

• Check-in API - Let customers check in at a physical location via the app (Point of Sale).
• Checkout API - Legacy checkout API.
• eCom API - Legacy e-commerce payment API. (In maintenance mode; use ePayment for new integrations.)

Related information

• 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