Partner documentation template
This document is an example that partners can use for documentation to their merchants of how to get started with Vipps MobilePay.
The paragraphs prefixed with "ℹ️" is for the partners, and must not be in the finished documentation for the partner's merchants. See Partners for more information.
How to order Vipps MobilePay products
ℹ️ Partners should use the Partner API to pre-fill product orders for merchants, and document how the merchant sign up in the partner's interface. If the Partner API is not used, the merchants must order products on portal.vipps.no, as described below:
- Log in with BankID (everyone with BankID can log in).
- Search for your company's name or organization number.
- Fill in the required information. If you need help, please contact customer service.
- Sign the application with BankID.
- Order "Vipps på nett" 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.vipps.no at any time.
API keys
ℹ️ Select one of the alternatives below, depending on whether you use partner keys or not.
Explain that (since you use the Partner API and partner keys) the merchant does not have to do anything after ordering Vipps MobilePay in the partner's interface:
"When the application is complete, you will get an email. We, your partner, receive the same email. The email contains the "Merchant Serial Number" (MSN), a six-digit number identifying your new sales unit. There is nothing more you need to do, we then have everything we need."
Explain how to use the API keys in the partner's solution, complete with screenshots with added arrows, text, etc. Link to Developer resources: Vipps portal: How to find the API keys, if relevant.
For information about API keys, see Common topics: API keys.
Configuration of Vipps MobilePay on our (the partner) side
ℹ️ Describe in detail how to configure Vipps MobilePay, with screenshots, etc. Link to Getting Started if relevant.
Topics to cover:
- Installation
- Configuration
- Authorization
- Short codes
- Webhooks
- Additional info (support)
Consider linking to the Vipps MobilePay FAQs.
Frequently asked questions
ℹ️ All partners must offer a FAQ for their merchants. Link to the Vipps FAQs, if relevant.
Order handling
ℹ️ Document everything required for the merchant to manage their orders. All order management must be done in the partner's interface, using the Vipps MobilePay API platform, and not on portal.vipps.no.
From the integration checklist:
Make sure your customer service, etc. has all the tools and information they need available in your system, through the APIs listed in the first item in this checklist, and that they do not need to visit portal.vipps.no 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
ℹ️ All partners must offer all required support for their merchants. Explain how to get help, how to use the partner's support system, etc. Document very clearly that the partner's merchants should never contact Vipps MobilePay directly.
Questions
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.