The Checkout API is composed of several Vipps MobilePay services, while transaction operations are to be performed on the ePayment API. For examples of requests and responses, see the Checkout API guide and ePayment API guide.
Checklist for full integration
Integrate all the Checkout API endpoints
Integrate applicable ePayment API endpoints
|Get payment details|
|Full and partial capture payment|
|Full and partial refund payment|
When the checklist is completed, notify Vipps MobilePay Integration Service at firstname.lastname@example.org. Include examples from the test environment, pilot customer info, and a description of the implemented solution.
We will verify the integration and contact you. After the checklist is approved, we'll send you the information you need to get started.
|Handle callbacks||Correctly handle callbacks from Vipps MobilePay, both for successful and unsuccessful payments. See the API documentation for how callback URLs are built, make test calls to make sure you handle the |
|Handle errors||Make sure to log and handle all errors. All integrations should display errors in a way that the users (customers and merchant employees/administrators) can see and understand them.|
|Include HTTP headers||Send the HTTP headers in all API requests for better tracking and troubleshooting (mandatory for partners and platforms, who must send these headers as part of the checklist approval).|
|Add information to the payment history||We recommend using the Order Management API to add receipts and/or images to the payment history. This is a great benefit for the end user experience. It is also mandatory for merchants using "Vipps Assisted Content Monitoring".|
Avoid integration pitfalls
|Send useful ||Follow our reference recommendations.|
|Poll for payment details||The Merchant must not rely on |
|Handle redirects||The merchant must handle that the |
|Follow design guidelines||The branding must be according to the design guidelines.|
|Educate customer support||Make sure your customer service, etc. has all the tools and information they need available in your system, through the APIs listed in the first item in this checklist, and that they do not need to visit portal.vipps.no for normal work.|