Skip to main content


API version: 1.0.

Endpoints to integrate

Integrate all the API endpoints. For examples of requests and responses, see the Postman collection and environment.

Add an image to an orderPOST:/order-management/v1/images
Add category to an orderPUT:/order-management/v2/{paymentType}/categories/{orderId}
Add receipt to an orderPOST:/order-management/v2/{paymentType}/receipts/{orderId}
Get order with category and receiptGET:/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 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

Handle errorsMake 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 headersSend 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 guidelinesThe Vipps MobilePay branding must be according to the design guidelines.
Educate customer supportMake 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 for normal work.

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 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 as soon as the customer control (see step 2) is completed, independently of this checklist.
  6. The merchant goes live 🎉

Flow to go live for direct integrations for partners

See: partners.

Help us improve our documentation

Did you find what you were looking for?