Skip to main content

Checklist

Endpoints to integrate

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

EndpointComment
Create paymentPOST:/epayment/v1/payments
Get PaymentGET:/epayment/v1/payments/{reference}
Get Payment Event logGET:/epayment/v1/payments/{reference}/events
Cancel paymentPOST:/epayment/v1/payments/{reference}/cancel
Full and Partial capture paymentPOST:/epayment/v1/payments/{reference}/capture
Full and partial refund paymentPOST:/epayment/v1/payments/{reference}/refund

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

ActionComment
Handle responsesMake sure to handle all responses and states from the payment: CREATED, AUTHORIZED, ABORTED, EXPIRED, TERMINATED and the event CANCELLED, CAPTURED and REFUNDED.
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 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).
Add information to the payment historyWe recommend using the Order Management API to add receipts and/or images to the payment history. This is a great benefit for the end user experience. It is also mandatory for merchants using Content monitoring.

Avoid integration pitfalls

ActionComment
Send useful referenceFollow our reference recommendations.
Handle redirectsThe merchant must handle that the returnUrl URL is opened in the default browser on the phone, and not in a specific browser, in a specific tab, in an embedded browser, requiring a session token, etc. Follow our recommendations regarding handling redirects.
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 portal.vippsmobilepay.com for normal work.

Flow to go live for direct integrations

  1. The merchant orders Payment Integration.
  2. We complete customer control (KYC, PEP, AML, etc.).
  3. The merchant receives an email from us saying that they can log in with BankID on the merchant portal 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 test environment by checking that there are test IDs (reference) in the test environment, with the following states:
    • A complete order ending in CAPTURED (/capture request).
    • A complete order ending in REFUNDED (/refund request).
    • A complete order ending in CANCELLED (/cancel request).
    • In the test environment, this must be verified using the API itself.
  6. The merchant verifies the integration in the production environment (similar to step 5):
    • A complete order ending in AUTHORIZED, CAPTURED, REFUNDED and CANCELLED request.
    • We recommend checking this using the API.
    • 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 the merchant portal as soon as the customer control (see step 2) is completed, independently of this checklist.
  7. The merchant goes live 🎉

Flow to go live for direct integrations for partners

See: Vipps MobilePay partners.

Help us improve our documentation

Did you find what you were looking for?