eCom API

NOTICE

All new integrations should use the ePayment API. See the eCom to ePayment migration guide for help migrating older integrations.

Available for Vipps.

What is eCom API?

The eCom API allows merchants to create various online payment flows, including express checkout. Initiate payments, get payment details, capture payments, and refund payments.

The eCom API supports Payment Integration, Checkout, Cash Register Integration, native apps and other solutions.

Try eCom in the demo store (opens in a new tab)

Getting started

warning

New projects should use ePayment API instead. The eCom API is maintained for existing integrations only.

I have an existing eCom integration

1. Consider migration: Review the eCom to ePayment Migration guide
2. Understand benefits: Learn why ePayment API is recommended for new projects
3. Plan your timeline: Determine when to migrate to the newer API
4. Get support: Contact us for migration assistance

I need to maintain eCom integration

1. Start here: Follow the API quick start guide
2. Build your solution: Use the API guide for detailed implementation
3. Complete integration: Work through the API checklist
4. Reference: Check the API specification for all endpoints

How it works

• How the eCom API works online: Let your customers pay with Vipps online or in your app. All your customer needs to provide is their mobile number, then they pay in Vipps with one click
• How the eCom API works in the Store: How the eCom API can be integrated in your Point Of Sale (POS) system

Common use cases

• Online payment processing (legacy implementations)
• Express checkout flows (existing integrations)
• Point of sale integrations (maintained systems)
• Mobile app payment flows (current implementations)

Plugins for payment integration

We offer open-source plugins to provide the payment integration for the following platforms:

• Drupal
• Adobe Commerce
• Optimizely
• Shopify
• Wix
• WooCommerce

Technical documentation

• API quick start: Run the basic examples in curl or Postman
• API guide: Learn about the eCom API features
• API checklist: Complete the checklist for direct and POS integrations
• API FAQ: Look for your question among those people have asked before
• API specification: Go straight to the endpoint specifications

Need help?

Can't find what you're looking for?

• Check our Knowledge Base for common questions
• Visit our Contact page for developer support

Considering migration?

• See Getting started for information about API keys, product activation, and the test environment
• Review the ePayment API for modern payment integration