API platform

With the API platform, you benefit from a shared API framework for all the APIs. This means that all APIs use the same API keys, authentication methods, terminology, and error message formats. Integrating with our APIs is straightforward and combining functionalities from multiple APIs is easy.

Main APIs

Payment integration

Add Vipps and MobilePay to your online payment selection.

• ePayment API
• eCom API (deprecated)

Recurring payments

Let returning customers pay automatically.

• Recurring API - Create and manage recurring agreements.

Login

Sign-up and login users online.

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

Checkout

Sell more with an all-in-one online checkout.

• Checkout API - Create a checkout session that handles payments, shipping, and user information.

Hot topic: 🔥

• Webhooks API - Get real-time updates for events happening to your sales unit.

Supporting products

Domain APIs

When you order one of the main products, you get access to the following APIs:

• Access token API - Obtain an access token to authorize all other API requests.
• Check-in API (experimental) - Communicate with your customer through the mobile app at the Point of Sale.
• Order Management API - Enrich your transactions by attaching images and information.
• QR API - Generate and administer QR codes that redirect the user to a URL.
• Userinfo API - Get the user's consent for access to their personal information.
• Webhooks API - Register for event notifications through webhooks.

Management and Report APIs

These APIs are helpful for managing your sales unit:

• Management API - Manage sales units, get information about merchants, or place orders on behalf of merchants.
• Report API - (For merchants and for accounting partners with accounting keys) Retrieve data about orders and settlements.

PSP APIs

Payment Service Provider (PSP) APIs:

• MobilePay Online
• Vipps PSP API
• Vipps PSP Signup API

SDKs

We are developing SDKs that will help you to implement the API platform in a faster way. Read more about these in the SDKs section.

Extensible platform

The API platform is extensible: If you have an integration with one API on the API platform, it is easy to use functionality from other APIs on the platform. Whenever a new API is released, existing integrations can easily take advantage of it.

For example, the Order Management API enables integrations to seamlessly incorporate digital receipt functionality, and the new Management API allows merchants and partners to manage their sales units, among other things.

note

Integrating with multiple APIs is no more complex than using a single API. The Vipps MobilePay API platform can be treated as a unified API, where each API's endpoints contribute to the overall platform strength.

Best practices

It is very important that you check the return response of each API call. You will get information about potential problems that could cause the customers problems or might cause you to lose money.

Include all the HTTP headers, so that we can help with debugging any problems.

Complete the API checklist to ensure that you have covered all the important functionality.

• Payment Integration: ePayment API checklist
• Recurring Payments: Recurring checklist
• Checkout: Checkout checklist
• Login: Login checklist