Order Management API checklist

API version: 1.0.

Integrate all the API endpoints. For examples of requests and responses, see the quick start guide.

If you're new to the platform, see Getting started for information about API keys, product activation, and the test environment.

Order management checklist	Your comments
Endpoints to integrate
Add an image to an order POST:/order-management/v1/images
Add category to an order PUT:/order-management/v2/{paymentType}/categories/{orderId}
Add receipt to an order POST:/order-management/v2/{paymentType}/receipts/{orderId}
Get order with category and receipt GET:/order-management/v2/{paymentType}/{orderId}
Quality assurance
Handle errors Make sure to log and handle all errors. All integrations should display errors in a way that the users (customers and merchant employees/administrators) can see and understand them.
Include HTTP headers Send the HTTP headers in all API requests for better tracking and troubleshooting (mandatory for partners and platforms, who must send these headers as part of the checklist approval).
Avoid integration pitfalls
Follow design guidelines The Vipps MobilePay branding must be according to the design guidelines.
Educate customer support Make sure your customer support 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.vippsmobilepay.com for normal work.

As this API allows you to update transactions that have been created by using the eCom API or Recurring API, you may need to implement the associated checklist(s) from these.

Information for partners

Partners, there are additional checklist items for you, as described in Partner checklist.

Partner checklist

Partner checklist	Your comments
Accept partner terms and conditions As a partner, you accept the Partner terms and conditions
Provide technical documentation for merchants How to apply for products (a URL, plain text or PDF is preferred) How to configure and use the solution (a URL, plain text or PDF is preferred) Frequently Asked Questions (FAQs) for merchants (a URL, plain text or PDF is preferred)
Pilot customer Provide one pilot customer to verify the integration in the production environment (send organization number and name).
Description of integration Describe how your integration has been set up, with a link to a demo, or provide screenshots (PDF is preferred).

Send your completed checklist to us at developer@vippsmobilepay.com.

Include a video of your payment flow, your Merchant Serial Number, a short description of your solution, and the reference used in your API requests, so we can verify your integration.

We will verify your integration and get back to you as soon as possible. After the checklist is approved, we'll send you the information you need to go live.

Flow to go live for direct integrations

1. The merchant orders Payment Integration.
2. Vipps MobilePay completes customer control (KYC, PEP, AML, etc.).
3. The merchant receives an email saying that they can log in with BankID on portal.vippsmobilepay.com and retrieve API keys.
4. The merchant completes all checklist items above. Please double-check to avoid mistakes.
5. The merchant verifies the integration in the production environment:
   • Please note: We don't do any kind of activation or make any changes based on this checklist. The API keys for the production environment are made available on portal.vippsmobilepay.com as soon as the customer control (see step 2) is completed, independently of this checklist.
6. Partners only: Send your checklist to developer@vippsmobilepay.com. We don't do any kind of activation or make any changes based on this checklist, we just use it to verify that you have done the integration.
7. Go live 🎉

tip

Operational Status Page

We recommend that you subscribe to the Vipps MobilePay Operational Status Page for real-time updates on service availability, incidents, and maintenance.