You can add Vipps to your existing integration. The following instructions show only what you must add to your integration specifically for Vipps.
If an instruction on this page corresponds with a step in the main integration guide, it includes a link to that corresponding step of the main integration guide.
Requirements
| Requirement | Description | |
|---|---|---|
| Integration type | Make sure that you have an existing API-only integration. | |
| Redirect handling | Make sure that your existing integration is set up to handle the redirect. action.type: redirect. |
|
| Setup steps | Before you begin, add Vipps in your Customer Area. |
How it works
- The shopper selects Vipps as the payment method.
- The shopper enters their details in the payment form that you build.
- When you make the payment request, you include additional information about the items that the shopper intends to purchase.
- Your existing integration setup will handle the redirect.
Build your payment form
Include Vipps in the list of available payment methods. You do not need to collect any information from the shopper in your payment form.
You can download the logo for Vipps to use in your form.
Get Vipps as an available payment method
When you make the /paymentMethods to get available payment methods, specify the following so that Vipps is included in the response.
| Parameter | Values |
|---|---|
| countryCode | NO |
| amount.currency | NOK |
| amount.value | The value of the payment, in minor units. |
Add additional parameters to your /payments request
When you make a payment, add the following parameters:
| Parameter | Required | Description |
|---|---|---|
| paymentMethod.telephoneNumber | Used to prefill the shopper's phone number on the Vipps-hosted page. | |
| shopperStatement | The description of this payment shown in the Vipps app. If you do not specify a shopperStatement, we'll use the value that you provided as the reference to populate this field. |
|
| channel | Specify the relevant channel, for example Web, iOS, or Android. |
The response includes the action.type: redirect.
Test and go live
Vipps cannot be tested in the test environment. You must make penny test (low-amount) payments in the live environment.
Request for Vipps in the live environment
Before you can accept live Vipps payments, you need to submit a request for Vipps in your live Customer Area.
After Vipps is added to your live Customer Area, do the following for each test payment:
- Make a Vipps payment for a low amount.
- Get the AUTHORISATION webhook on your server. It includes the status of the payment.
- In your live Customer Area, go to Transactions > Payments to see the status of the payment.