Plugin development
Ready to build your own Vipps MobilePay plugin? This guide provides everything you need to create professional, well-documented plugins that meet our quality standards.
Requirements
Learn what documentation and features your plugin must include
Development
Technical guidelines for building robust, secure plugins
Examples
Browse existing plugin repositories for inspiration
Getting started
New to our APIs? Start with the Getting started guide to understand the basics of Vipps MobilePay integration.
For partner-specific requirements, see Finishing the integration and going live.
Plugin requirements checklist
Use this comprehensive checklist to ensure your plugin meets all requirements for quality, usability, and support.
Product checklists
An integration is considered complete when all the elements of the relevant API checklists are done. Please make sure to read and understand the checklists.
Important: You only need to complete the checklist for the product you're integrating. To avoid delays, provide all the information requested in the product checklist.
ePayment checklist
For an ePayment solution, complete the ePayment API checklist.
Provide the required information, such as
reference,
paymentDescription
and
HTTP headers.
Recurring checklist
For a Recurring Payments solution, complete the Recurring checklist.
Provide the required information, such as
orderid,
paymentDescription
and
HTTP headers.
Checkout checklist
For a Checkout solution, complete the Checkout checklist.
This involves implementing some ePayment endpoints. Provide all the required information.
Login checklist
For a Login solution, complete the Login checklist.
Include a test access, examples, pilot customer info, and other requirements.
Technical implementation requirements
Your plugin must implement these essential features and follow our development standards:
| Required content | Comment |
|---|---|
| Error Logging | Include the option to activate debugging mode with enhanced logging and tracking of all Vipps MobilePay calls and responses. Track and make sure to handle all errors. Present the results in a separate page of the module configuration, with the complete Vipps MobilePay error message displayed. |
| Error Handling | Ensure that users, both administrators and customers, receive an unambiguous notification when anything goes wrong. For POS integration, present the information to both the cashier and the customers. |
| Follow up on GitHub security/Dependabot alerts | Ensure that security alerts are added to pull requests and that there is a monthly routine in place for handling these. |
| Order Management | Add order details to orders using the Order Management API. |
| On-site messaging configuration | Add a configurable On-site messaging feature to ease the On-site messaging. |
| Follow design guidelines | The Vipps MobilePay branding must be according to the design guidelines. |
Documentation requirements
Your plugin must include comprehensive documentation covering all aspects of installation, configuration, and usage:
| Required content | Comment |
|---|---|
| List of features | A list of available features and information about how to configure, enable, and disable them. |
| Install plugin | Description of how to install the module. |
| Prerequisites | A list of prerequisites for using the module. |
| Configuration | Information about all the configurable features. |
| Get API keys | Detailed 1-2-3-type list with reference how to get API keys. |
| Info about on-site-messaging | Specify how to configure in module or add a link to On-site messaging. |
| Notification on available updates | If it's not default by platform, show a notification banner when an update is available for the module. |
| Changelog | Detailed release notes for new releases. Do not add cryptic comments about updates, but describe what is new. |
| FAQ | A list of frequently asked questions and information about other typical issues related to the platform and module. |
Support & help resources
Ensure users can get help and understand how to use additional Vipps MobilePay services:
| Required content | Comment |
|---|---|
| Support | Provide information about how to get help with the plugin or module. Link to the plugin's support system. Do not link to Vipps contact page. |
| Link to portal | Inform the merchant that they can manage their sales units on the business portal. For example: "You can manage your sales unit (e.g., change name and logo), see reports of all payments, etc. on portal.vippsmobilepay.com." |
| Link to knowledge base | Provide a link to the Vipps MobilePay Knowledge base. For example: "For typical questions and answers about payments and APIs, see the Knowledge base." |
| Info about contributing on GitHub | If applicable, add to the issues tab on your plugin's GitHub repository. |
| Link to help pages | https://help.vippsmobilepay.com |
| Link to customer center for merchants | For example, "If you need help with your customer relationship with Vipps, Contact customer service." |
| Link to technical updates | "Vipps MobilePay has a technical updates with news about APIs, etc. We recommend subscribing to it." |
Finishing the integration and going live
Once you've completed your checklist, it's time to get your integration verified and approved.
Submit for review
Send your completed checklist to us at developer@vippsmobilepay.com.
Include: Examples from the test environment, pilot customer info, and a description of the implemented solution.
We will verify the integration and contact you with next steps.
Reference implementations
Study our existing open-source plugins for implementation examples and best practices. All repositories follow the standards outlined above.
Pro tip: Browse these repositories to see how other developers have implemented features, handled errors, and structured their documentation.
Next steps
Ready to start?
Get your API credentials and start building
Get API keys →
Need help?
Questions about plugin development?
Contact our team →
Contribution guidelines: We welcome contributions to existing plugins! Check each repository's contribution guidelines and feel free to submit issues or pull requests.