ePayment API guide

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

Basic operations

• Core concepts
• Payment operations
  • 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.
• Error handling
• Webhooks

Special features

Changing the flow

• Express - Let users select shipping and address directly in the app for a faster, streamlined checkout.
• Personal QR - identify your customer by scanning their Vipps/MobilePay personal QR.
• 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.

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.

Special cases

• Long-living payments - (Limited availability) Set an expiration time for a payment.
• Block payment sources - In the Danish and Finnish markets, it is possible to block commercial cards.