Vipps Drop-in integration

Add Vipps to an existing Drop-in integration.

If you are using Android Drop-in v5.0.0 or later:

This payment method requires no additional configuration.

Our Android Drop-in renders Vipps in your payment form, and redirects the shopper to complete the payment. As with other redirect payment methods, you need to check the payment result after the shopper returns to your app.

Requirements

Requirement	Description
Integration type	Make sure that you have an existing Advanced flow Android Drop-in integration.
Setup steps	Before you begin, add Vipps in your Customer Area.

Show Vipps in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

To show Vipps in your payment form, specify in your /paymentMethods request:

countryCode: NO
amount.currency: NOK.
amount.value: The value of the payment, in minor units.

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod. Pass the paymentComponentData.paymentMethod to your server — these are the shopper details that you need to make the payment.

Make a payment

From your server, make a /payments request, specifying:

paymentMethod: The paymentComponentData.paymentMethod from your client app.
channel: Android
returnUrl: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).
shopperStatement (optional): 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.

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

If your integration is set up correctly, the action object is passed from your server to the client.

Check the payment result

Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData object.

From your server, make a POST /payments/details request providing:

details: The actionComponentData.details object from Drop-in.

You receive a response containing:

resultCode: Use this to present the payment result to your shopper.
pspReference: Our unique identifier for the transaction.

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The 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 `refusalReason` field.	Inform the shopper that there was an error processing their payment.
Refused	The payment was refused. For more information, check the `refusalReason` field.	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.

Test and go live

To test your integration, install a Vipps test app, and use the following credentials:

Phone number	National Identity Number (NIN)	PIN
94987289	09104226830	1236
99460821	23035007725	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.

Go live

Before you can accept live Vipps payments, you need to submit a request for Vipps in your live Customer Area.