vipps-ecom-api-checklist.md

Vipps eCommerce API Checklist

API version: 2.0

Document version 1.1.1

For examples of requests and responses, see the Postman collection in tools

Checklist

• Integrate all the API endpoints:
  • Initiate POST:/ecomm/v2/payments
  • Capture POST:/ecomm/v2/payments/{orderId}/capture
  • Cancel PUT:/ecomm/v2/payments/{orderId}/cancel
  • Refund POST:/ecomm/v2/payments/{orderId}/refund
  • Details GET:/ecomm/v2/payments/{orderId}/details
• The merchant correctly handles callbacks, both for successful and unsuccessful payments
  • Callback POST:[callbackPrefix]/v2/payments/{orderId}
  • For express checkout only: Shipping details POST:[shippingDetailsPrefix]/v2/payments/{orderId}/shippingDetails
  • For express checkout only: Remove consent DELETE:[consetRemovalPrefix]/v2/consents/{userId}
• Avoid Integration pitfalls
  • The Merchant must not rely on fallback alone
  • The Vipps branding must be according to the Vipps design guidelines

Flow to go live for direct integrations

1. The merchant orders Vipps på Nett.
2. Vipps completes customer control (KYC, PEP, AML, etc).
3. The merchant receives an email from Vipps saying that they can log in with bankID on portal.vipps.no and retrieve API keys.
4. The merchant completes all checklist items.
5. The merchant contacts Vipps with test IDs (orderId) in the Vipps test environment, showing that all checklist items have been fulfilled.
   • A complete order ending in Refund.
   • A complete order ending in Cancel.
6. The merchant receives an email from Vipps saying that the orders are OK.
7. The Merchant contacts Vipps to verify the integration in the production environment:
   • A complete order ending in Refund.
   • A complete order ending in Cancel.
8. The Merchant goes live 🎉