Checkout API checklist

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

Endpoint	Comment
Initiate	POST:/checkout/v3/session
Details	GET:/checkout/v3/session/{reference}
Callback	POST:[callbackPrefix]/checkout/{version}/order/{orderId}

Integrate applicable ePayment API endpoints

Endpoint	Comment
Get payment details	GET:/epayment/v1/{reference}
Cancel payment	POST:/epayment/v1/{reference}cancel
Full and partial capture payment	POST:/epayment/v1/{reference}/capture
Full and partial refund payment	POST:/epayment/v1/{reference}refund

When the checklist is completed, notify Vipps MobilePay Integration Service at developer@vippsmobilepay.com. 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.

Quality assurance

Action	Comment
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 POST requests correctly. We do not have capacity to manually do this for you.
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 Content monitoring.

Avoid integration pitfalls

Action	Comment
Send useful reference	Follow our reference recommendations.
Poll for payment details	The Merchant must not rely on fallback or callback alone, and must poll Payments Details GET:/epayment/v1/{reference} or Session Details GET:/checkout/v3/{reference} as documented (this is part of the first item in this checklist, but it's still a common error). For pure payment status polling the ePayment API is recommended. Follow our polling recommendations.
Handle redirects	The merchant must handle that the fallback URL is opened in the default browser on the phone, and not in a specific browser, in a specific tab, in an embedded browser, requiring a session token, etc. Follow our recommendations regarding handling redirects.
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.vippsmobilepay.com for normal work.