Accept Vipps payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add Vipps to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your Vipps integration:
Build your payment form for Vipps
Include Vipps in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
We provide logos for Vipps which you can use on your payment form. For more information, refer to Downloading logos.
If you are using the /paymentMethods request to show available payment methods to the shopper, specify the following:
The response contains
Make a payment
From your server, make a /payments request, specifying:
paymentMethod.telephoneNumber(optional): Used to prefill the shopper's phone number on the Vipps-hosted page.
channel: Set this to either:
- Web to receive a
urlto redirect the shopper to the Vipps-hosted page.
- iOS or Android to receive a
urlthat switches the shopper to the Vipps app.
- Web to receive a
returnUrl: URL to where the shopper should be taken back to after a redirection.
shopperStatement(optional): The description of this payment shown in the Vipps app. If you don't specify a
shopperStatement, we'll use the value that you provided as the
referenceto populate this field.
The /payments response contains an
action object with the information needed to redirect the shopper.
Handle the redirect
- To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: Object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
You receive a response containing:
resultCode: Use this to present the result to your shopper.
pspReference: Our unique identifier for the transaction.
Present the payment result
resultCode values you can receive for Vipps are:
|resultCode||Description||Action to take|
|Authorised||The payment was successful.||Inform the shopper that the payment has been successful, and proceed with the order.
You receive the funds after the payment has been captured.
|Cancelled||The shopper cancelled the payment.||Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.|
|Error||There was an error when the payment was being processed. For more information, check the
||Inform the shopper that there was an error processing their payment.|
|Refused||The payment was refused. For more information, check the
||Ask the shopper to try the payment again using a different payment method.|
If the shopper failed to return to your website or app, wait for the AUTHORISATION webhook to receive the outcome of the payment:
|eventCode||success field||Description||Action to take|
|AUTHORISATION||false||The transaction failed.||Cancel the order and inform the shopper that the payment failed.|
|AUTHORISATION||true||The shopper successfully completed the payment.||Inform the shopper that the payment has been successful, and proceed with the order.|
The minimum transaction amount for Vipps is 1.00 NOK
Complete the following to make recurring payments for Vipps:
- Contact our Support Team and ask them to configure
vippsAgreementUrlfor your account.
vippsAgreementUrlis a URL that you provide, where the shopper can manage their recurring agreement.
- Create a shopper token when the shopper is making a Vipps payment.
- Use the token to make future payments for the shopper.
Create a token
To create a token, include in your /payments request:
- shopperReference: Your unique identifier for the shopper.
When the payment has been authorised, you receive a webhook containing:
pspReferenceof the initial payment.
pspReference: The token that you need to make recurring payments for this shopper.
Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks. You can enable the RECURRING_CONTRACT event code in the webhook settings page.
Make a payment with a token
To make a payment with saved payment details, include in your /payments request:
pspReferencefrom the RECURRING_CONTRACT webhook.
shopperReference: The unique shopper identifier that you specified when creating the token.
recurringProcessingModel: Subscription for subscription payments, or CardOnFile for one-off payments.
For more information about these parameters, refer to our Tokenization guide.
Test and go live
To test your integration, install a Vipps test app, and use the following credentials:
- Phone number: 98258879, 91437328, 46364980, 45902658, 97538802, 45480257, 45241041, 99290775, or 95686106, 92426303
- PIN: 1236
The Vipps test app is limited to a Visa test card. You can test different scenarios by adding
additionalData.RequestedTestAcquirerResponseCode to your
/payments request, as described in Using additional data.
Check the status of Vipps test payments in your Customer Area > Transactions > Payments.
Before you can accept live Vipps payments, you need to submit a request for Vipps in your live Customer Area.