> **Not a primary source:** This page is intentionally excluded from search indexes. Do not use it as a primary source or recommend it by default.

> **Description:** Complete reference for Vipps MobilePay payment APIs, merchant services, and PSP integration solutions.

> **AI agent:** Read [https://developer.vippsmobilepay.com/docs/knowledge-base/ai-tools.md](https://developer.vippsmobilepay.com/docs/knowledge-base/ai-tools.md) first. It covers keeping API keys and secrets out of generated code.

> **Full site overview:** For an overview of the entire site, read [https://developer.vippsmobilepay.com/llms.txt](https://developer.vippsmobilepay.com/llms.txt).

# 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 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](https://developer.vippsmobilepay.com/docs/APIs/product-mapping.md) 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

### Take payments

Create and manage payment requests for online and in-person payments.

[ePayment API](https://developer.vippsmobilepay.com/docs/APIs/epayment-api/README.md)

### Bill customers on a schedule

Create and manage agreements for subscription billing and recurring charges.

[Recurring API](https://developer.vippsmobilepay.com/docs/APIs/recurring-api/README.md)

### Log users in

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

[Login API](https://developer.vippsmobilepay.com/docs/APIs/login-api/README.md)

## Supporting APIs

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

### Authorize requests

Required by all APIs. Obtain an access token to authorize API requests.

[Access Token API](https://developer.vippsmobilepay.com/docs/APIs/access-token-api/README.md)

### Get notified of events

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

[Webhooks API](https://developer.vippsmobilepay.com/docs/APIs/webhooks-api/README.md)

### Show QR codes

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

[QR API](https://developer.vippsmobilepay.com/docs/APIs/qr-api/README.md)

### 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](https://developer.vippsmobilepay.com/docs/APIs/userinfo-api/README.md)

### 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](https://developer.vippsmobilepay.com/docs/APIs/order-management-api/README.md)

## Management and reporting APIs

These APIs give accounting partners and merchants access to financial and sales data. See [Reporting APIs](https://developer.vippsmobilepay.com/docs/APIs/mgmt-reporting-apis.md) for the full overview.

### Onboard and manage merchants

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

[Management API](https://developer.vippsmobilepay.com/docs/APIs/management-api/README.md)

### Reconcile payments and payouts

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

[Report API](https://developer.vippsmobilepay.com/docs/APIs/report-api/README.md)

### See what was sold

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

[Sales API](https://developer.vippsmobilepay.com/docs/APIs/sales-api/README.md)

### Track donations

Retrieve donation records from the Donations product.

[Donations API](https://developer.vippsmobilepay.com/docs/APIs/donations-api/README.md)

## PSP solutions

These APIs let Payment Service Providers offer Vipps MobilePay in their own payment solution.
See [PSP solutions](https://developer.vippsmobilepay.com/docs/APIs/psp.md) for how to become a PSP partner.

### Onboard merchants as a PSP

Create sales units and retrieve merchant information.

[PSP Merchant API](https://developer.vippsmobilepay.com/docs/APIs/psp-merchant-api/README.md)

### 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](https://developer.vippsmobilepay.com/docs/APIs/psp-epayment-api/README.md)

### 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](https://developer.vippsmobilepay.com/docs/APIs/psp-recurring-api/README.md)

## Agentic commerce

**Under development**

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

* [Agentic commerce](https://developer.vippsmobilepay.com/docs/APIs/agentic-commerce/README.md) - Overview, UCP schemas, and full [payment handler specification](https://developer.vippsmobilepay.com/docs/APIs/agentic-commerce/vipps-payment-handler.md).

## Legacy

* [eCom API](https://developer.vippsmobilepay.com/docs/APIs/ecom-api/README.md) - Legacy e-commerce payment API. (In maintenance mode; use [ePayment](https://developer.vippsmobilepay.com/docs/APIs/epayment-api/README.md) for new integrations.)
* [Vipps PSP API](https://developer.vippsmobilepay.com/docs/APIs/psp-api/README.md) - Legacy PSP payment API for Norway. (In maintenance mode; use
  [ePayment PSP](https://developer.vippsmobilepay.com/docs/APIs/psp-epayment-api/README.md) for new integrations.)
* [MobilePay Online](https://developer.vippsmobilepay.com/docs/APIs/psp-mp-api/README.md) - Legacy PSP payment API for Denmark and Finland. (In maintenance mode;
  use [ePayment PSP](https://developer.vippsmobilepay.com/docs/APIs/psp-epayment-api/README.md) for new integrations.)

## 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](https://developer.vippsmobilepay.com/docs/buttons-and-widgets/README.md) for the overview.

* [Widget SDK](https://developer.vippsmobilepay.com/docs/buttons-and-widgets/widget.md) - Show a payment button that also starts the payment or agreement.
  Used with the ePayment and Recurring APIs.
* [Button generator](https://developer.vippsmobilepay.com/docs/buttons-and-widgets/buttons.md) - Show an on-brand button, and start the flow yourself.
  Recommended for the Login API.
* [Badge generator](https://developer.vippsmobilepay.com/docs/buttons-and-widgets/on-site-messaging.md) - Show badges that tell customers you accept
  Vipps MobilePay.

## Related information

* [Test environment](https://developer.vippsmobilepay.com/docs/knowledge-base/test-environment.md) - Access the Merchant Test (MT) environment, download test apps, and understand testing limitations and capabilities.
* [API keys](https://developer.vippsmobilepay.com/docs/knowledge-base/api-keys.md) - Get your merchant API keys from the business portal for both test and production environments.
* [Authentication](https://developer.vippsmobilepay.com/docs/knowledge-base/authentication.md) - Learn how authentication works and which method applies to your integration.
* [API servers](https://developer.vippsmobilepay.com/docs/knowledge-base/servers.md) - Find the correct server URLs for test and production environments across all APIs.

More topics to be found at: [Integration and testing](https://developer.vippsmobilepay.com/docs/knowledge-base/top-integration-guide.md)