ePayment API guide

Use the ePayment API to send payment requests to Vipps MobilePay.

In your user interface, offer Vipps and/or MobilePay as a payment option. When the user selects their preferred method, send the payment request to us.
We'll then prompt the user in their Vipps or MobilePay app to complete the payment.

For implementation details and examples, see the sections below.

Payment operations

• Introduction to payments - Describes the basic payment flow.
• Payment states - How a payment changes state at each step.
• Create - Create a payment request.
• Capture - Capture all or part of the amount owed.
• Cancel - Cancel a payment request.
• Refund - Refund all or part of a captured amount.
• Get payment details - Get the status and information about a payment.
• Get payment event log - Get the log of events that have happened to a payment.

Features

• Features that change the flow:

  • Express - Let users select shipping and address directly in the app for a faster, streamlined checkout.
  • One-time payment QRs - Provide users with one-time QR codes they can easily scan and pay with their Vipps or MobilePay app.
  • Long-living payments - Create payment requests that stay valid for longer—ideal for invoices, subscriptions, or delayed payments.
  • Profile sharing - Request access to user profile information as part of the payment flow.
  • Accept freestanding card payments - Accept card payments from the user without requiring a linked Vipps or MobilePay account.
  • Verify minimum user age - Limit payments to users above a specified minimum age for compliance or business rules.

• Features for adding payment information:

  • Set order details - Provide the order details alongside the payments in the Vipps or MobilePay app.
  • Specify customer present - Register in-person payments where customers pay while physically present at the point of sale.
  • Add metadata - Add custom metadata to payments for better tracking, reporting, and integration with your systems.

Handling responses from the API

• Error handling: Check out the list of possible ePayment errors.
• Webhooks: Stay updated with real-time payment notifications.

Help with migration

• Vipps eCom to ePayment: Transition smoothly from the eCom API to the ePayment API.
• MobilePay App Payments to ePayment.