Getting started
Welcome! You have reached the developer documentation.
If you need help with your account or with the app, please see the Help page.
Apply for services
As a merchant or partner, you can apply for access to Vipps MobilePay services. You'll need separate merchant agreements for operation in Norway, Denmark, and Finland. See Using Vipps MobilePay across borders to learn about the use in different countries.
The software you build for one country can be reused for another, but you'll need to use the different sales units and brands for different countries.
For example, you will need a Finnish sales unit to use MobilePay in Finland, a Danish sales unit to use MobilePay in Denmark, and a Norwegian sales unit to use Vipps in Norway. You can only use the MobilePay brand in Denmark and Finland, and you can only use the Vipps brand in Norway.
You can manage your merchant profile, order products, and apply for additional sales units on the merchant portal.
Register as a Vipps MobilePay merchant
The merchant agreement is a legal agreement between you and Vipps MobilePay.
Requirements
Merchants in Norway, Finland, and Denmark must have the following information in order to use Vipps MobilePay as a payment provider and to receive payments:
- A Norwegian, Danish, or Finnish organization number.
- A Norwegian, Danish, or Finnish bank account.
- A contact person with a Norwegian, Danish, or Finnish phone number and National identity number who can sign on behalf of the company.
Your application must be signed with Norwegian BankID, Danish MitID, Finnish FTN, or username and password.
If a foreign business hasn't yet been formally established, we can manually send the agreement for digital signing. If you need this, please contact customer service or, for partners, please contact your partner manager.
If the above is impossible, the business can use Vipps MobilePay through a Payment Service Provider (PSP). When using a Payment Service Provider, you will need to contact them for access.
Apply for a Merchant Agreement on the merchant portal. Provide details for your business, including real rights holders, politically exposed people, etc.
A person with signatory rights for the business must digitally sign the application. It is possible for the partner, or simply a person helping the merchant, to fill out the form, but the signing of the form must be done by a person with signing rights for the merchant.
Once the Merchant Agreement has been submitted, you can place an order for products. This will be processed immediately once your Merchant Agreement is approved.
It might take a few days, because we are required to perform background checks on all merchants and partners who want to use our services.
You can check the status of your application on portal.vippsmobilepay.com.
Order a product
You can order a product while your merchant agreement is still being processed. You can also add products later, but note that there might be a small delay if additional risk evaluations are required.
What kind of product do you need?
Online services - Sell more with easier ways to log in and pay online.
- Checkout - Provide an all-in-one online checkout with shipping options.
- Payment integration - Add Vipps or MobilePay to your online payment setup.
- Billing and recurring payments - Let returning customers pay automatically.
- Login - Easily sign up and log in users online.
In-person payments - Get paid in-person with through the app (e.g., Vippsnummer and MyShop) .
- Shopping Basket - Let users select the items they buy from a list.
- Open Amount - Let customers type how much they will pay.
- Cash register systems - Connect Vipps MobilePay directly to your existing cash register system and use it to register users into your customer club.
Learn about these products on vippsmobilepay.com.
If you have ordered In-person payments: you don't need to do anything else on this page. We'll contact you as soon as your order is processed and your Merchant Agreement is approved. Contact us at Vipps MobilePay customer support if you need help.
If you have ordered an Online service: As soon as your order is processed and your Merchant Agreement is approved, we'll email you the following, and you can start testing.
- Sales unit name
- Merchant serial number
- Credentials for logging into the test app
You can also check the status on portal.vippsmobilepay.com.
Start testing
If you ordered an online service, you'll be using the API platform to integrate Vipps/MobilePay into your website or system.
Once your sales unit is ready, you can start testing the applicable API endpoints and complete the corresponding checklists (e.g., ePayment checklist). For partners, there are additional steps.
You can get help to create your Vipps MobilePay integration from partners and plugins.
- A partner is a company that can manage your webshop or cash register integration. See Easy onboarding via our partners and the filter checkboxes to find a list that closely meets your needs.
- A plugin is a third-party software library that can be used in webshops (e.g., Adobe Commerce, Shopify, WooCommerce). See plugins overview.
Get your API keys
API keys are used for authentication with the API platform. These are credentials that confirm your identity and that your API request is valid.
You'll need API keys for sending requests on behalf of your sales unit.
Each sales unit has a unique set of API keys, so if you have many sales units, you will use different keys for each one.
Be very careful how you share your API keys. Use encrypted mail or provide other users with minimum access to see the keys for a sales unit in the portal.
- Merchants
- Partners
All merchants with API access have access to the test environment.
A test sales unit is automatically created when a merchant submits an order for a Vipps MobilePay product that includes an API. The details and API keys can then be found in the Developer section on portal.vippsmobilepay.com. See the Merchant portal section for details about logging in.
The sales unit will have the same country code as the merchant it is created for. A Norwegian merchant can only create Norwegian sales units, a Danish merchant can only create Danish sales units, and Finnish merchants can only create Finnish merchants.
How to find the API keys
You can find the API keys for your test or production sales unit in the merchant portal, portal.vippsmobilepay.com. (Need help logging in?)
-
Select For developers in the left menu. With the API keys tab selected, you should see a table with sales units.
-
Select either Production or Test, depending on the type of sales unit you are looking for.
-
Find the sales unit in the table and click the corresponding Show keys button. A panel will open where you can copy the values of each key.
For example:
If you need to get/give the API keys from/to someone, be sure to do it securely. If you can't do that, then create a new portal user for that person, and give them basic access to the sales unit.
All Vipps MobilePay customers can create as many sales units as they need in the test environment. Sale units in the test environment cannot be changed. See: How to create a test sales unit.
Once your partner application has been approved, you'll receive a welcome email with a test sales unit and API keys. If you have lost this or need a new test sales unit, please contact partner@vippsmobilepay.com. Sales units are specific for either Norway, Denmark, or Finland. Remember to state which country the sales unit should be created for.
Note that partner functionality is not available in test. Instead, you will receive merchant API keys, as mentioned in the limitations section. All payment and login flows can be tested using the merchant API keys.
Partners can also get access to the test environment by ordering the Login API. See Partner: How to get access to your sales units on the merchant portal.
Get the test app
See Merchant Test (MT) app to find out how to download the app.
See the Test environment page for test environment limitations, test servers, test apps, and much more.
Get your test user
If you were not sent a test user, you should read about how to create one from the test environment page.
Use the test server address
To send API requests to the test app, you'll need to use this server address:
apitest.vipps.no
Understand the test environment
Please read about the test environment before going further.
Try a quick start guide
There are several quick start guides that you can run through to get started. Find the one that is most relevant for you. For example:
Working in production
When you are ready to work in production, you can make real customer transactions with the official Vipps or MobilePay app.
To work in production, you first need the API keys for your production sales unit. Find the API keys for your production sales units in the same was as described above.
Then, update the server address to the production server:
api.vipps.no
Finding relevant information
The knowledge base information and resources to help you create your integration. You'll find troubleshooting tips, best practices, and FAQs, as well as design guidelines and assets (e.g., buttons).
If you are coming from MobilePay, see the Migration guide.
When you're ready to send API requests, see:
Each API type provides a step-by-step guide to using the API (e.g., ePayment Quick start).