ePayment PSP API checklist
Use this checklist to ensure your ePayment PSP API implementation is complete and production-ready. It covers the key endpoints, quality assurance steps and pitfalls — from payments to captures, refunds, and error handling.
From test to production​
-
Complete your testing of the ePayment PSP API. Use the list below to ensure you cover all areas of the integration before you submit the checklist.
-
Send your filled out checklist to us at developer@vippsmobilepay.com. Use this editable PDF to fill out and submit. Request examples in the checklist must be no more than 1 month old at the time you submit the checklist. Together with the checklist, please include a video of your payment flow and a short description of your solution.
-
We will verify your integration and get back to you as soon as possible, so you can continue with the process to go live.
Endpoints to integrate​
It is important that you integrate all the ePayment API endpoints.
Merchant​
| Purpose | Endpoint |
|---|---|
| Create merchant | POST /merchant-management/psp/v1/merchants |
| Delete merchant | PATCH /merchant-management/psp/v1/merchants/{merchantSerialNumber} |
Payment​
| Purpose | Endpoint |
|---|---|
| Initiate payment | POST /epayment/v1/payments |
| Create a payment with Express Optional feature | POST /epayment/v1/payments |
| Create a payment with Profile sharing Optional feature | POST /epayment/v1/payments |
| Create a payment with Minimum user age Optional feature | POST /epayment/v1/payments |
| Get payment status Fetch current status of a payment. | GET /epayment/v1/payments/{reference} |
| Fetch payment event log Fetch the history of a payment. Often used in support cases to see all events for a specific payment. | GET /epayment/v1/payments/{reference}/events |
| Respond to card data callback With RESERVE, FAIL and SOFT_DECLINE | POST /psp-makepayment |
| Update payment status with Capture | POST /epayment/v1/payments/{reference}/capture |
| Update payment status with Cancel | POST /epayment/v1/payments/{reference}/cancel |
| Update payment status with Refund | POST /epayment/v1/payments/{reference}/refund |
Quality assurance​
Ensure that your implementation complies with our requirements and recommendations.
Proper logging​All integrations should log error responses to be used for later reference in troubleshooting. Logs must include endpoint, headers, request body, error code and message. |
Include HTTP headers​Send the HTTP headers in all API requests for better tracking and troubleshooting (mandatory for partners and platforms). |
Specify customer interaction​For instore solutions it is required to specify the customer interaction by setting |
Payment status​All payments must be updated with capture or cancel status, as well as refund if this is performed. |
Merchant onboarding​All merchants must be onboarded as individual merchants and not super merchants, and they must be onboarded with valid MCC. All merchants must use their own merchant/webshop name and logo. See PSP merchant for more details. |
Send a useful |
Handle redirects​For mobile flows the implementation must handle that the |
Appswitch​If you offer your merchants to use apps, you must test a switch between MobilePay app and a merchant app. |
Sign up for operational updates​Subscribe to the Vipps MobilePay Operational Status Page for real-time updates on service availability, incidents, and maintenance. |
Follow design guidelines​The Vipps MobilePay branding must be according to the design guidelines. |
Go live​
After the checklist is approved, we will send you the information you need to get access to production.
In the production environment you must complete a series of production transactions to verify your solution. We recommend that you complete the production transactions with a pilot merchant. Please contact us at developer@vippsmobilepay.com with a transaction reference for each of the following:
| Purpose | Endpoint | Your reference |
|---|---|---|
Respond to card data callback with RESERVE | POST /psp-makepayment | |
Respond to card data callback with FAIL | POST /psp-makepayment | |
Respond to card data callback with SOFT_DECLINE | POST /psp-makepayment | |
Transaction with status Capture | POST /epayment/v1/payments/{reference}/capture | |
Transaction with status Refund | POST /epayment/v1/payments/{reference}/cancel | |
Transaction with status Cancel | POST /epayment/v1/payments/{reference}/refund |
We will inform you when we have verified your production test, and you can then go live with your merchants