Documentation guidelines
The partner must provide the following types of documentation for their merchants.
These guidelines are for you (the partner), and must be rephrased before you put them in the finished documentation for the partner's merchants.
How to order products​
Document how the merchant orders products.
Partners should use the Management API to prefill product orders for merchants, and document how the merchant sign up in the partner's interface. If the Management API is not used, the merchants must order products on portal.vippsmobilepay.com, as described below:
- Log in to portal.vippsmobilepay.com, as described in the portal section.
- Search for your business' name or organization number.
- Fill in the required information. If you need help, please contact customer service.
- Sign the application.
- Order Payment Integration with the settings required by the partner. Try to avoid the typical reasons for delays.
You may get follow-up questions from us. Please check your email, including the "spam" folder, and search for "vipps".
You can check the status of your order on portal.vippsmobilepay.com at any time.
API keys​
Document how the merchant gets their API keys.
Option 1: You take care of the keys​
As a partner, explain that you are using the Management API and partner keys, so the merchant doesn't have to do anything after ordering products in your interface:
Once your application is complete, you’ll receive an email—your partner (that’s us!) gets the same email too. Inside, you'll find your "Merchant Serial Number" (MSN), a unique five, six, or seven-digit code identifying your new sales unit. That's it—no further action needed from your side. We have everything we need to get you started!
Option 2: Tell them how to get the keys​
Explain how to use the API keys in your solution, complete with screenshots with added arrows, text, etc. Link to Knowledge base: API keys, if relevant.
API keys let your system securely connect with Vipps MobilePay. Each sales unit has its own unique keys for both test and production environments.
To get your keys:
Log in to the Vipps MobilePay Business Portal. Go to For developers → API keys. Select the production environment and find your sales unit. Click Show keys to view or copy them. Keep your keys safe—never share them in unsecured channels. If you need more info, check the official guide.
Configuration of Vipps or MobilePay on your site​
Document how the Vipps/MobilePay is configured.
Describe in detail how to configure Vipps 
or MobilePay 
with screenshots and details.
Topics to cover:
- Installation
- Configuration
- Authorization
- Short codes
- Webhooks
- Additional info (support)
Consider linking to the Getting Started and Knowledge base sections.
Frequently asked questions​
Provide a list of relevant questions.
All partners must offer a FAQ for their merchants. Link to the Knowledge base, if relevant.
Order handling​
Document everything required for the merchant to manage their orders.
All order management must be done in your interface, using our API platform, rather than using portal.vippsmobilepay.com.
Make sure your customer service has all the tools and information they need available in your system and that they do not need to visit portal.vippsmobilepay.com for normal work.
Topics to cover:
- Order handling
- How do I capture an order?
- How do I partially capture an order?
- How do I cancel an order?
- How do I refund an order?
- How do I partially refund an order?
- How to I find all the details about an order?
- How do I debug a failed order?
- Additional info (support)
Support​
Document how the merchant can get support.
Offer all required support for your merchants. Explain how to get help, how to use your support system, and any other necessary details. Document very clearly that your merchants should contact you instead of Vipps MobilePay.
For example:
Please contact us, your partner, and we will help as soon as possible. We will contact Vipps MobilePay if needed, so you should not contact Vipps MobilePay directly. Please note: Add partner name, address, website, phone, email, etc. here.