Frequently asked questions
See the Management API Guide for all the technical details, and Partners for all partner information.
See also:
When will the Management API be available?
It's available now. We are continuously improving it, and have documented both existing functionality and upcoming functionality.
How can I get access?
See: Integrating with this API.
What are the benefits of the Management API over the Partner API?
- The Management API contains everything as the Partner API, and more.
- The Management API is actively developed, the Partner API will be phased out.
- Both APIs use the same API keys.
- The endpoints are practically identical, with the Management API endpoints offering better error handling, more detailed responses, etc.
- The Prefill a product order endpoint in the Management API will give an error if the partner sends incorrect or invalid data. In the Partner API the error will not be discovered until the merchant attempts to use the URL to the incorrectly submitted prefilled product order.
- The Management API supports international merchants, since the
businessIdentifieralso works for non-Norwegian merchants.
How can I test the prefill functionality in the Management API?
The Management API is only available in the production environment. See: Can I use the Management API in the test environment?
To see the product order form without anything prefilled: Log in on portal.vippsmobilepay.com and see the form there.
If you have API keys you can:
- Send a prefill request with
POST:/management/v1/products-orders](/api/management/#tag/Product-orders/operation/orderProduct) - Get a response with the prefill URL
- Open the URL and see the prefilled product order form
If you are not a Vipps MobilePay merchant you will have to fill out the Merchant Agreement form before step 3. That is a requirement to get to the product order form.
Since the product order form is frequently improved and (slightly) changed, we do not have screenshots, videos, etc. of it in the developer documentation. The best way to see it is live on portal.vippsmobilepay.com.
How can I make feature requests and give input for the Management API?
Contact your partner manager or key account manager.
Will there be a partner portal?
Yes. We aim to have the first version ready in Q4 2024. The first version will offer the functionality in the Management API.
Until then:
It is not yet possible for partners to sign in on portal.vippsmobilepay.com as partners, but merchants may give access to individual users as described here: How to add a portal user.
There is a Postman collection for the Management API that may be useful. See the Quick Start
Does the management API work for "VM number" sales units?
No, the Management API only works for sales unit that have their own API keys, such as sales units that are set up to sue the ePayment API and Recurring API.
"Vippsnummer" and "MyShop" sales unit do not have their own API keys, and cannot be managed with the Management API.
How can I check the status of a merchant's product order?
See:
- Get information about a product order
- How to check if a merchant is signed up with the partner as partner.
Where do I get the pricePackageId?
The pricePackageId is a UUID, and you get it by email when you are activated as partner.
A UUID has a format like this: 81b83246-5c19-7b94-875b-ea6d1114f099.
Use
GET:/management/v1/partners/{partner-id}/price-packages
to retrieve your price packages.
Can I use the Management API in the test environment?
Nope. We do not have all the required backend systems available in the test environment. See Limitations of the test environment.
Why is the URL for a prefilled product order not working?
It is probably because the prefill request was invalid.
If you send an invalid request to
POST:/management/v1/product-orders,
the prefill will in most cases fail with an error message.
Although we do as much input validation as possible, it is not possible to validate all data, so in some cases the prefill request will succeed, and the prefill URL will lead to an empty product order form.
Which fields in the product order form are editable in a prefill PO?
All of them except:
- Partner
- Price package (if provided)
Important: Please provide as much information as possible in the prefill request. See: Prefill a product order.
Why do I get HTTP 404 Not Found?
It depends on which request has been made. Partners will get this error if they attempt to retrieve data for a merchant that does not yet have an active sales unit connected with the partner.
When will it be possible to update an existing sales unit?
We know this is a very important feature, but can't give you a release date yet.
See Endpoints and availability. The documentation will be updated as soon as we have new information.
We recommend subscribing to the Technical updates.