DOCSEARCHbyAlgolia
Submit Docs

Vipps MobilePay Developer Documentation

website·Indexed 36 days ago

https://developer.vippsmobilepay.com

Developer resources for integrating Vipps MobilePay payment and authentication services. Includes documentation for the ePayment, Recurring, Login, Checkout, Order Management, and QR APIs, as well as guides on OAuth 2.0 authentication, business setup, settlement processes, and the Merchant Test (MT) environment.

Tokens
262.5K
Snippets
678
Records
1.9K
Agent score
66%

What's inside Vipps MobilePay

  1. Overview of Vipps Login for ASP.NET and Optimizely

    The Vipps Login plugin provides OpenIdConnect (OIDC) Authentication middleware for ASP.NET applications using OWIN. It is specifically designed to allow customers to log in to Optimizely (formerly Episerver) using the Vipps app. Note: This plugin is currently deprecated and no longer actively maintained.

  2. Overview of Vipps MobilePay Drupal plugins

    Vipps MobilePay provides three community-supported plugins for Drupal Commerce stores operating in the Norwegian market. These plugins enable mobile app payments, subscription management, and user authentication.

  3. Overview of the Vipps MobilePay Donations API

    The Donations API is an optional tool for organizations using the Vipps MobilePay Donations product. It is specifically designed to streamline charitable giving by providing automated reporting on all received donation payments. This includes data from current donation flows as well as legacy solutions like VM-number fundraising reports and Recurring Donations. Note that this API is exclusively for donation data; for settlement information, the Report API must be used instead.

  4. Overview of the Vipps MobilePay Management API

    The Management API is designed for partners who onboard merchants and large merchants who need to manage multiple sales units programmatically. It provides self-service operations for administrative tasks that are also available via the business portal. Key capabilities include:

    • Retrieving sales unit (MSN) and merchant information.
    • Prefilling product order forms to streamline merchant onboarding.
    • Tracking the status of submitted product orders.
    • Accessing and applying partner-specific price packages for merchant accounts.

  5. Overview of Vipps and MobilePay QR API capabilities

    The QR API allows businesses to interact with customers using Vipps or MobilePay QR codes. Key capabilities include:

    • Generating QR codes that redirect users to a website or directly to the Vipps/MobilePay app with a payment suggestion for approval.
    • Retrieving information from personal QR codes, such as the associated user's phone number.
    • Implementing tracking and analytics for QR-driven interactions.

  6. Overview of ePayment API webhook events

    Webhooks provide real-time notifications for payment events initiated via the ePayment API. It is important to distinguish between customer-driven and merchant-driven cancellations:

    • epayments.payment.created.v1: Payment initiated; customer has not yet acted.
    • epayments.payment.authorized.v1: Customer accepted the payment in the app.
    • epayments.payment.aborted.v1: Customer actively stopped the payment before authorization (tapped cancel).
    • epayments.payment.expired.v1: Customer did nothing within the expiration time (default 10 minutes).
    • epayments.payment.terminated.v1: Merchant stopped the payment before authorization using the cancel endpoint.
    • epayments.payment.cancelled.v1: Merchant cancelled the uncaptured amount of a payment already authorized by the customer.
    • epayments.payment.captured.v1: Merchant captured part or all of an authorized payment.
    • epayments.payment.refunded.v1: Merchant refunded part or all of a captured payment.

  8. Overview of merchant signup methods

    To use a partner, a merchant must first apply for services with Vipps MobilePay and order a product to obtain a sales unit. Partners can facilitate this onboarding via three methods:

    1. Management API (Prefill): Best for partners with API keys who want to automate the process by providing a prefilled product order URL to the merchant.
    2. Product Order Templates: Recommended for partners without API keys. These are pre-configured links created in the partner portal that pre-set fields like partner and price.
    3. Manual Signup: The merchant fills out the product order form from scratch.

    General Flow: All methods check if the merchant already exists. New merchants must sign a Merchant Agreement (MA) before proceeding to the Product Order (PO) form. Once the PO is submitted and approved (after KYC/AML checks), both the merchant and partner are notified via email.

  9. Overview of the Sales API for accounting partners

    The Sales API provides order-centric entries representing financial transactions (captures or refunds) enriched with sales context. It is intended for accounting partners using accounting keys. Each entry includes a stable order identifier (reference), a transaction identifier (pspReference), and sales amounts (gross, net, VAT) in minor units. It provides order lines, VAT, and categories, but does not expose payment state or settlement correctness.

  10. Overview of Vipps MobilePay business setup

    To begin accepting payments with Vipps MobilePay, businesses must navigate several setup phases: verifying eligibility across Nordic regions (Denmark, Finland, Norway, and Sweden), applying for services to obtain a merchant agreement, and configuring account structures such as sales units for multi-store or complex organizational needs.

  11. Overview of the Merchant Test (MT) environment

    The Merchant Test (MT) environment allows developers to verify API implementations before going live. It mirrors production apps across all available APIs but connects to a separate test environment. Key constraints include:

    • Only test users with randomly generated phone numbers are supported; real user accounts cannot be used.
    • Test users must be in the same market and currency as the sales unit.
    • Test users are not available in production; production testing requires full merchant onboarding and compliance checks.

  12. Overview of Vipps MobilePay Webhooks API

    The Webhooks API allows your system to receive real-time notifications about payment events, order updates, and status changes. Instead of repeatedly polling an API, you register specific event types and verify incoming webhooks to react to changes in real-time.