Vipps Redirect Component

If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to complete the payment. As with other redirect payment methods, you need to handle the redirect after the shopper returns to your app.

Before you begin

This page explains how to add Vipps to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your Vipps integration:

1. Make sure that you have set up your back end implementation for making API requests.
2. Add Vipps in your Customer Area.

Show Vipps in your payment form

Include Vipps in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.

1. Specify in your /paymentMethods request:
   • countryCode: Any supported country. For example, NO
   • amount.currency: Any supported currency. For example, NOK.
   • amount.value: The value of the payment, in minor units.

The response contains paymentMethod.type: vipps.

Make a payment

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

• paymentMethod.type: vipps
• 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 don't specify a shopperStatement, we'll use the value that you provided as the reference to populate this field.

The /payments response contains an action object with the information needed to redirect the shopper.

Handle the redirect

1. Use the Redirect Component to redirect the shopper to the Vipps app.

2. After the shopper returns to your app, make a POST /payments/details request from your server, providing:

   • details: The actionComponentData.details object from the Redirect Component.

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.

Recurring payments

Complete the following to make recurring payments for Vipps:

1. Contact our Support Team and ask them to configure vippsAgreementUrl for your account.
   vippsAgreementUrl is a URL that you provide, where the shopper can manage their recurring agreement.
2. Create a shopper token when the shopper is making a Vipps payment.
3. Use the token to make future payments for the shopper.

Create a token

To create a token, include in your /payments request:

• storePaymentMethod: true
• shopperReference: Your unique identifier for the shopper.

When the payment has been authorised, you receive a webhook containing:

• eventCode: RECURRING_CONTRACT
• originalReference: The pspReference of the initial payment.
• pspReference: The token that you need to make recurring payments for this shopper.

Make a payment with a token

To make a payment with saved payment details, include in your /payments request:

• paymentMethod.type: vipps.
• paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT webhook.
• shopperReference: The unique shopper identifier that you specified when creating the token.
• shopperInteraction: ContAuth.

• 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.

Go live

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

See also