vipps-ecom-api-checklist.md

Vipps eCommerce API Checklist

API version: 2.0

Document version 1.3.0

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 or callback 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 (/refund request).
   • A complete order ending in VOID (/cancel request).
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 (/refund request).
   • A complete order ending in VOID (/cancel request).
8. The Merchant goes live 🎉

Flow to go live for direct integrations for partners

1. The partner becomes a partner by applying here
2. The partner completes the integration, with the API test keys
3. The partner 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 (/refund request).
   • A complete order ending in VOID (/cancel request).
4. The partner receives an email from Vipps saying that the implementation is OK.
5. Vipps adds the partner to vipps.no, including the signup forms for merchants.
6. The partner add its merchant to their solution, usually by configuring the POS with the merchant's API keys.
7. The Merchant goes live 🎉

Questions?

We're always happy to help with code or other questions you might have! Please create an issue, a pull request, or contact us.

Sign up for our Technical newsletter for developers.