ePayment API guide

View as Markdown (opens in a new tab)

Install AI tools

Our plugin gives your assistant up-to-date guidance for payments and login. Full instructions

Claude Code

Run both commands, in order.

claude plugin marketplace add vippsas/agent-toolkit
claude plugin install vipps@agent-toolkit

Cursor

Open Settings, then Plugins.

Add vippsas/agent-toolkit as a plugin marketplace, then install the "vipps" plugin.

Codex

See the Codex plugin docs at developers.openai.com/codex.

Add vippsas/agent-toolkit as a plugin marketplace, then install the "vipps" plugin.

Any editor

No plugin needed. Paste this into your assistant.

Read https://developer.vippsmobilepay.com/llms.txt for the Vipps MobilePay developer documentation.

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

Features

Payment flows

• Online - The standard flow: the customer checks out in your web shop and approves the payment in the app.
• 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.
• Accept freestanding card payments - Accept card payments from the user without requiring a linked Vipps or MobilePay account.

Payment options

• Profile sharing - Request access to user profile information as part of the payment flow.
• Verify minimum user age - Limit payments to users above a specified minimum age for compliance or business rules.
• 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.