Skip to main content

API Quick start guide

Ready to integrate with Vipps MobilePay? This guide gets you testing in minutes.

note

Before you can use our APIs, you need:

  1. Business approval - Complete merchant application and get approved
  2. Product ordering - Order the specific API products you need

If you haven't completed business setup yet, start with Getting started.

1. 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.

warning

API keys should be kept secret. 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 at portal.vippsmobilepay.com.

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 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

  1. Go to For developers in the sidebar. (If you don’t see this, tell your Administrator that you need Developer access).

  2. In the API keys tab, select either Production or Test, depending on your sales unit type.

  3. Find the sales unit in the table.

    {TEST_KEYS}

  4. Click the corresponding Show keys button. A panel will open where you can copy the values of each key.

    {TEST_KEYS}
Use caution with storing and transferring API keys

API keys are sensitive information, so handle them carefully:

  • Vipps MobilePay will never ask for your API keys, and you must keep them secret.
  • Always send API keys by encrypted email.
  • Merchants: If you accidentally share your API keys, you must generate new ones by clicking the regenerate button on your portal.vippsmobilepay.com page.
  • Partners: For keys other than merchant API keys, contact the partner team. For merchant keys, the merchant needs to generate new ones on the portal.
  • Update your integrations, so they will continue working.

If you need to transfer the API keys to someone, be sure to do it securely. If they can't be moved securely, you can create a portal user for that person and give them basic access to the sales unit.

For partners

A Vipps MobilePay partner should use Partner keys, and not the merchant keys. If a partner can't get partner keys, there are two solutions:

  1. The merchant can download the API keys and send them to the partner securely.
  2. If the merchant is unable to provide the API keys to the partner securely, they can add a production user for the partner and give them Assistant access. Then, the partner can log in to the portal and download the API keys.

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.

2. Set up test environment​

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.

Cartoon graphic for sending and receiving

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: https://apitest.vipps.no

💡 Need more details? See the complete Test environment guide for advanced setup, troubleshooting, and additional test scenarios.

3. Try your first API call​

Choose your integration approach:

Most popular choice - Accept payments online or in-store

  1. Quick start: ePayment API quick start
  2. Test ePayment: Create a payment and complete it in the test app
  3. Next: ePayment API guide for full implementation

Ready to build? Start your API quick start​

Choose your integration path and jump right in:

ePayment API icon
ePayment quick start
Recurring API icon
Recurring quick start
Login API icon
Login quick start
Checkout API icon
Checkout quick start

Testing and validation​

Going to production​

When you are ready to work in production, you can make real customer transactions with the official Vipps or MobilePay app.

  • API checklist: Complete for your chosen API(s)
  • Production keys: Switch from test to production credentials
  • Production server: Switch to https://api.vipps.no

Need help?​

info

If this all seems a bit overwhelming, know that you may be able to use a partner or a plugin.

  • A partner can help you create and manage your Vipps or MobilePay integration. See Find a partner 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., WooCommerce, Shopify, Adobe Commerce). For an overview of all the plugins, see the plugins section.

Resources​

Quick answers​

Technical support​

Last updated on

Help us improve our documentation

Did you find what you were looking for?