Order Management API checklist
API version: 1.0.
Endpoints to integrate
Integrate all the API endpoints. For examples of requests and responses, see the Postman collection and environment.
| Endpoint | Comment |
|---|---|
| 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} |
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.
When the checklist is completed, notify Vipps MobilePay Integration Service 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. After the checklist is approved, we'll send you the information you need to get started.
Quality assurance
| Action | Comment |
|---|---|
| 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 standard 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
| Action | Comment |
|---|---|
| Follow design guidelines | The Vipps MobilePay branding must be according to the design guidelines. |
| Educate customer support | 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.vippsmobilepay.com for normal work. |
Flow to go live for direct integrations
- The merchant orders Payment Integration.
- Vipps MobilePay completes customer control (KYC, PEP, AML, etc.).
- The merchant receives an email saying that they can log in with BankID on portal.vippsmobilepay.com and retrieve API keys.
- The merchant completes all checklist items above. Please double-check to avoid mistakes.
- 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.
- The merchant goes live 🎉
Flow to go live for direct integrations for partners
See: partners.