Knowledge base
Welcome! You have reached the developer documentation.
If you need help with your account or with the app, please see the Help page.
Welcome to the Vipps MobilePay knowledge base!
Here you will find a collection of information for setting up Vipps and MobilePay as a payment or login provider for your store or website.
Introductory information
- Who can pay - Requirements for Vipps MobilePay users.
- Operating across borders - Use Vipps MobilePay in other countries.
- Applying for services - The process and requirements for applying for Vipps MobilePay services.
- Maintenance window - When is Vipps MobilePay offline for maintenance?
- Terminology - Vipps MobilePay terminology, including special terms from Danish, Finnish, and Norwegian.
👉 You might also check out the step-by-step guide to getting started.
Developer resources
- Test environment - How to set up for testing the Vipps MobilePay APIs.
- Merchant portal - Git tips about logging into the portal for getting API keys and managing sales units.
- Status pages - Get notifications about disruptions in Vipps MobilePay services.
- Servers - Get server addresses for making Vipps MobilePay API calls.
- Demo store - Test out the different payment flows with a real Vipps or MobilePay app.
Brand guidelines and assets
- Buttons - Vipps and MobilePay buttons.
- Logos and marks - Vipps and MobilePay logos and marks.
- Brand in text - Guidelines for using the brand in text.
- On-site messaging - Library for displaying Vipps MobilePay on-site messages, or badges.
API basics
- API keys - Find out what API keys are and how to get your API keys.
- Authentication and authorization - How authentication works in the API platform.
- HTTP headers - Headers to use in all your API requests.
- HTTP response codes and errors - HTTP statuses returned in API responses and the standard response body format for our error messages.
- QR codes - Different types of Vipps MobilePay QR codes.
- API lifecycle - General advice about API versioning and deprecation.
Payment concepts
- Payment overview - The payment request screen and receipt details in the Vipps MobilePay app. Payment use cases, success rates, card payments.
- Reserve and capture - The difference between reserving and capturing a payment.
- Cancel payment - Ways to cancel a payment.
- Refund payment - About payment refunds.
- Payment FAQ - Frequently asked questions and common problems with payments.
- Payment rules - Rules about payment time limits.
- Settlements - How settlements are processed by Vipps MobilePay.
Integrations
- Landing page - The landing page which opens in a browser and prompts the user to enter their phone number.
- Merchant questions - Typical questions asked by merchants.
- Direct integration and PSP integration - Differences between integrating the Vipps MobilePay APIs directly or implementing the PSP API.
- Point of Sale integrations - About setting up a PoS integration.
Detailed technical recommendations
- Payment description and transaction text - Recommendations for payment description and transaction text.
- orderId / reference - Recommendations for payment identifiers (
orderId
,chargeId
,reference
) used in the API requests. - Polling guidelines - How to poll for payment details.
- Redirects - Guidelines for how to redirect users to your website after a purchase.
- Timeouts - Standard timeouts for payment requests.
- URL validation - Details surrounding URL validation.
- User flows - Types of user flows, including web redirect and native redirect.
Other topics
- Partner information - For members of the partner program, find all partner-related information.
- Plugins - See the options for using a Vipps MobilePay plugin for your webshop.
If you aren't sure what to do next, see the Getting started page.