On this page, you can find additional configuration for adding Vipps to your Components integration.
Before you begin
This page assumes you have already:
API reference
You don't need to send additional fields for Vipps. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:
- /sessions: This is the default with Components v5.0.0 or later.
- /payments: If you implemented an additional use case.
Component configuration
If your integration uses iOS Components v5.0.0 or later, configure and create an instance of the Vipps Component:
//Create a payment method object for Vipps.
let paymentMethod = paymentMethods.paymentMethod(ofType: vippsComponentPaymentMethod.self)
//Create a configuration object for the Vipps Component.
var vippsComponentConfiguration = vippsComponent.Configuration()
//Set additional parameters on the configuration object.
vippsComponentConfiguration.localizationParameters = //Optional custom localization parameters.
There is no required Vipps-specific integration for Components.
Recurring payments
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
vippsAgreementUrl
for your account.
vippsAgreementUrl
is 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:
storePaymentMethod
: true- shopperReference: Your unique identifier for the shopper.
When the payment has been authorised, you receive a webhook containing:
eventCode
: RECURRING_CONTRACToriginalReference
: ThepspReference
of 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:
paymentMethod.type
: vipps.paymentMethod.storedPaymentMethodId
: ThepspReference
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.