Skip to main content

ePayment API checklist


Download the ePayment API checklist as an editable PDF.

Partners only

Partners, please send your completed checklist to us at

Include a video of your payment flow, your Merchant Serial Number, a short description of your solution, and the reference used in your API requests, so we can verify your integration. We’ll get back with you as soon as possible.

We will verify your integration and get back to you as soon as possible.

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

Endpoints to integrateYour reference ID
Create payment - POST:/epayment/v1/payments
Get Payment - GET:/epayment/v1/payments/{reference}
Get Payment Event log - GET:/epayment/v1/payments/{reference}/events
Cancel payment - POST:/epayment/v1/payments/{reference}/cancel
Full and partial capture payment - POST:/epayment/v1/payments/{reference}/capture
Full and partial refund payment - POST:/epayment/v1/payments/{reference}/refund nullnull
General integration pointersYour comments
Quality assurancenull
Handle responses
Make sure to handle all responses and states from the payment: CREATED, AUTHORIZED, ABORTED, EXPIRED, TERMINATED and the event CANCELLED, CAPTURED and REFUNDED.
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 ID.
Follow our reference recommendations.
Handle redirects
The merchant must handle that the returnUrl 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. Follow our recommendations regarding handling redirects.
In the rare cases where webhooks may be delayed: Poll for payment detailsThe Merchant should not rely on webhooks alone, and should poll Get the payment. Follow our polling recommendations.
Follow design guidelines
The Vipps MobilePay 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 for normal work.

Download the ePayment API checklist as an editable PDF.

Flow to go live for direct integrations​

  1. Order Payment Integration.
  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 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 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: Vipps MobilePay partners.

Friends high five

Help us improve our documentation

Did you find what you were looking for?