Skip to main content

Quick start guides

This is a guide for using Postman to test the Vipps MobilePay APIs with the Vipps app.

What you need for getting started with the API​

You will need to set up a few things before you can break loose in testing the API.

You need:

  1. A test user.

    All merchants automatically get a test user. See test users for more information.

  2. A test sales unit.

    You create this yourself by logging in to the Vipps Portal at https://portal.vipps.no. This requires BankId. See instructions for creating the test sales unit.

  3. A Vipps test app for your mobile phone.

    See instructions for installing the Vipps test app, Vipps MT.

  4. A Postman application on your computer.

    Download Postman and install it. Don't use the web version, because we should never save our keys on the web.

Getting started with Postman​

Postman is a common tool for working with REST APIs. It allows you to make calls to the API endpoints and see the full request and response for each call, including headers.

Import collections and environments​

We provide a Postman collections and environments to make development easier. Our Postman collections contain example API calls that you can run in the test environment.

Our Postman environments include all the variables needed to run the examples in the collection. You will need to update some of the variables, so that the example works with your test user and test sales unit.

Once you have installed Postman, you can import an environment from one our our APIs and then customize it for your own use.

  1. To import the collection and environment files, save them to your desktop. Then, click the Import button in the Postman interface.

  2. Select the file(s) and click Open.

The following is a global environment file that can be used with all the APIs:

Update the environment values​

The Postman environments comes pre-filled with some values, but there are still some required values which have to be manually entered. These are described in the quick start guide for each API.

You must normally update the variables to use your API keys: client_id, client_secret, Ocp-Apim-Subscription-Key, and merchantSerialNumber.

Run API calls​

After you have imported and updated the collections and environments, you can begin to run the calls.

In general, there is a sequence to running these, so check in the applicable quick start guide for that API to see what to run first.

Some methods require a body with information that is sent with the request. Vipps provides pre-populated test data, but this can be modified.

You might want to make the same request from your own application. You can generate snippets of code in various languages that will help you do this. Click the Code link to open the "Generate code snippets" modal.

Developer Postman: Tabs

Try it out!​

Your next step is to test out the examples!

Choose one of the API quick start guides listed below. This will lead you through a sequence of steps where you can experiment with every endpoint in the API.

By following the steps, you will make calls to all the endpoints and see the full request and response for each call.