Checklist

The Checkout API should be considered an aggregation API of Vipps MobilePay services, while transaction operations is to be performed on the epayment API.

Checklist for full integration

• Integrate all the API endpoints:
  • Initiate POST:checkout/v3/session
  • Details GET:checkout/v3/session/{reference}
  • Full and partial Capture POST:epayment/v1/{reference}/capture
  • Cancel POST:epayment/v1/{reference}cancel
  • Full and partial Refund POST:epayment/v1/{reference}refund
  • Details GET:epayment/v1/{reference}
  • For examples of requests and responses, see the relevant API docs for checkout and epayment.
• Send the Vipps HTTP headers in all API requests for better tracking and troubleshooting (mandatory for partners and platforms):
  • Merchant-Serial-Number
  • Vipps-System-Name
  • Vipps-System-Version
  • Vipps-System-Plugin-Name
  • Vipps-System-Plugin-Version
• Follow the orderId recommendations.
• We recommend using Vipps Order management, as this is a massive benefit for the end user experience. It is mandatory for merchants using "Vipps Facilitated Content Monitoring".
• Correctly handle callbacks from Vipps, 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. Vipps does not have capacity to manually do this for you.
  • Callback POST:[callbackPrefix]/checkout/{version}/order/{orderId}
• Avoid Integration pitfalls
  • 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.
  • 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. See the API guide: Recommendations regarding handling redirects. See the FAQ: How can I open the fallback URL in a specific (embedded) browser?
  • The Vipps branding must be according to the Vipps design guidelines.
  • 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.