Checkout API checklist

The Checkout API is composed of several Vipps MobilePay services, while transaction operations are to be performed on the ePayment API.

Integrate all the Checkout API endpoints For examples of requests and responses, see the Checkout API quick start guide and ePayment API guide.

If you're new to the platform, see Getting started for information about API keys, product activation, and the test environment.

Endpoints to integrate	Your comments
Checkout API endpoints
Initiate POST:/checkout/v3/session
Details GET:/checkout/v3/session/{reference}
Callback POST:[callbackPrefix]/checkout/{version}/order/{orderId}
ePayment API endpoints (see ePayment checklist)
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

General integration pointers	Your comments
Quality assurance
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
Send a useful reference Follow our reference recommendations.
Poll for payment details The Merchant must not rely on returnUrl or callback alone, and must poll Payments Details GET:/epayment/v1/{reference} or Session Details GET:/checkout/v3/{reference}. For pure payment status, polling the ePayment API is recommended. Follow our polling recommendations.
Handle redirects The merchant must handle that the returnUrl 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.

Partners only

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.

Flow to go live for direct integrations

1. Order Checkout.
2. We will complete customer control (KYC, PEP, AML, etc.). As soon as the customer control is completed, independently of this checklist, we will make the production API keys available on portal.vippsmobilepay.com and notify you that you can retrieve your keys.
3. Retrieve your API keys.
4. Complete all the checklist items.
5. Verify the integration in the test environment by checking that there are test IDs (reference) in the test environment, with the following states:
   • A complete order ending in CAPTURED (/capture request).
   • A complete order ending in REFUNDED (/refund request).
   • A complete order ending in CANCELLED (/cancel request).
   • In the test environment, this must be verified using the API itself.
6. Verify the integration in the production environment (similar to step 5):
   • A complete order ending in AUTHORIZED, CAPTURED, REFUNDED and CANCELLED request.
   • We recommend checking this using the API.
7. Partners only: Send your checklist to developer@vippsmobilepay.com. We don't do any kind of activation or make any changes based on this checklist, we just use it to verify that you have done the integration.
8. Go live 🎉

Partners, see: Integration and checklist.