Vipps Component

Our Vipps Component renders Vipps in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns to your website.

When paying with Vipps, the shopper is first redirected to a Vipps-hosted page to confirm or enter their phone number. They then complete the payment in the Vipps app on their mobile device.

Before you begin

This page explains how to add Vipps to your existing Web Components integration. The Web 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, and created an instance of AdyenCheckout.
2. Add Vipps in your test Customer Area.

Show Vipps in your payment form

To present the Vipps Component in your payment form:

1. From your server, make a POST /paymentMethods request specifying:

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

2. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

3. Add the Vipps Component:
   a. Create a DOM element for Vipps, placing it where you want the form to be rendered:

   <div id="vipps-container"></div>

   b. Create and mount an instance of the Vipps Component using its component name, vipps. This renders a button on your payment form.

   function handleOnSubmit(state, component) {
       // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
       state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
       state.data // Provides the data that you need to pass in the `/payments` call.
       component // Provides the active component instance that called this event.
   }
   const vippsComponent =  checkout.create('vipps', {
       onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
   }).mount('#vipps-container');

   When the shopper selects the payment method, the Component calls the onSubmit event, which contains a state.data object including the shopper's selected payment method. If your integration is set up correctly, the state.data is passed on to your server.

Make a payment

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

• paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
• paymentMethod.telephoneNumber (optional): Used to prefill the shopper's phone number on the Vipps-hosted page.
• channel: Web
• returnUrl: URL to where the shopper should be taken back to after a redirection. The URL can contain a maximum of 1024 characters and should include the protocol: http:// or https://. You can also include your own additional query parameters, for example, shopper ID or order reference number.
• 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.

Here is how you would make a payment request for 10 NOK.

curl https://checkout-test.adyen.com/v53/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"NOK",
    "value":1000
  },
  "paymentMethod":{
    "type":"vipps"
  },
  "channel":"Web",
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'

# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "NOK",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "vipps"
  },
  :channel => "Web",
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})

// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("NOK");
    amount.setValue(1000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("vipps");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

    paymentsRequest.setChannel(PaymentsRequest.ChannelEnum.Web);

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "NOK",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "vipps"
  ),
  "channel" => "Web",
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);

#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'NOK'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'vipps'
   },
   'channel': 'Web',
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})

// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("NOK", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "vipps"
};
var paymentsRequest = new Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details,
  Channel = Model.Checkout.PaymentRequest.ChannelEnum.Web
};

var paymentResponse = checkout.Payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "NOK", value: 1000 },
    paymentMethod: {
        type: 'vipps'
    },
    channel: "Web",
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

The /payments response contains an action object with type:redirect.

{
  "resultCode": "RedirectShopper",
  "action": {
   "method": "GET",
   "paymentData": "Ab02b4c0!BQABAgCSZT7t...",
   "paymentMethodType": "vipps",
   "type": "redirect",
   "url": "https://test.adyen.com/hpp/redirect.shtml?brandCode=.."
  },
  "details": [
    {
      "key": "payload",
      "type": "text"
    }
  ],
...
}

If your integration is set up correctly, the action object is passed from your server to the client, and the action.paymentData temporarily stored on your server.

Handle the redirect

Handling the redirect works the same way for all redirect payment methods:

1. Call createFromAction, passing the action object from the previous step. This will return a new Component that you need to mount:

   checkout.createFromAction(action).mount('#my-container');

   The Component redirects the shopper to Vipps to complete the payment.
2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
   • paymentData: The value from the /payments response.
   • details: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your site. For example, payload.
   The parameters can vary based on the payment method configuration. To check which parameters you should submit, always check the details array from the /payments response.
   https://docs.adyen.com/payment-methods/vietnamese-online-banking/web-component#-payments-details-request

   /payments/details request

   {
         "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
         "details":{
           "{hint:Verify the parameters from /payments response}payload{/hint}":"Ab02b4c0!BQABAgCW5sxB4e/=="
         }
   }

   The /payments/details response contains:
   • resultCode: Use this to present the payment result to your shopper.
   • pspReference: Our unique identifier for the transaction.
   https://docs.adyen.com/payment-methods/vietnamese-online-banking/web-component#-payments-details-response

   /payments/details response

   {
         "resultCode": "Authorised",
         "pspReference": "88154795347618C"
   }

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:

If the shopper failed to return to your website or app, wait for the AUTHORISATION notification to receive the outcome of the payment:

Recurring payments

To make recurring payments for Vipps, you need to:

1. Create a shopper token when the shopper is making a Vipps payment.
2. 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 notification 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.

{
   "live":"false",
   "notificationItems":[
      {
         "NotificationRequestItem":{
            "additionalData":{
               "vipps.userToken":"eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJodHRwczpcL1wvdmlwcHMubm8iLCJzdWIiOiIxNjQiLCJzY29wZSI6InBzcF9zdWJzY3JpcHRpb24iLCJpc3MiOiJWaXBwcyIsImlhdCI6MTU4ODg1NzgyNH0.P2RsrsdtHXqTeJRzkyilWRae-inqL3Go5iLYMaNCV_o",
               "vipps.variant" : "vipps",
               "recurring.shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
               "paymentMethodVariant":"vipps",
               "acquirerAccountCode":"VippsAcquirerAccount"
            },
            "amount":{
               "currency":"NOK",
               "value":1000
            },
            "eventCode":"RECURRING_CONTRACT",
            "eventDate":"2020-05-07T15:23:56+02:00",
            "merchantAccountCode":"YOUR_MERCHANT_ACCOUNT",
            "merchantReference":"YOUR_ORDER_NUMBER",
            "originalReference" : "88154795347618C",
            "paymentMethod":"vipps",
            "pspReference":"8315888578361992",
            "reason":"",
            "success":"true"
         }
      }
   ]
}

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 notification. Alternatively, you can get this value by using the /listRecurringDetails endpoint.
• 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.
  Payments with recurringProcessingModel: UnscheduledCardOnFile are currently not supported for Vipps.
  https://docs.adyen.com/payment-methods/vipps/api-only#recurring-vipps

  • curl
  • Ruby
  • Java
  • PHP
  • Python
  • C#
  • NodeJS

  curl Ruby Java PHP Python C# NodeJS

  curl https://checkout-test.adyen.com/v53/payments \
  -H "x-API-key: YOUR_X-API-KEY" \
  -H "content-type: application/json" \
  -d '{
         "amount":{
            "value":1000,
            "currency":"NOK"
         },
         "paymentMethod":{
            "type":"vipps",
            "recurringDetailReference":"8315888578361992"
         },
         "reference":"YOUR_ORDER_NUMBER",
         "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
         "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
         "shopperInteraction":"ContAuth",
         "recurringProcessingModel": "Subscription"
  }'

  # Set your X-API-KEY with the API key from the Customer Area.
  adyen = Adyen::Client.new
  adyen.api_key = "YOUR_X-API-KEY"
   
  response = adyen.checkout.payments({
    :amount => {
      :currency => "NOK",
      :value => 1000
    },
    :reference => "YOUR_ORDER_NUMBER",
    :paymentMethod => {
      :type => "vipps",
      :recurringDetailReference => "8315888578361992"
    },
    :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
    :shopperReference => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
    :shopperInteraction => "ContAuth",
    :recurringProcessingModel => "Subscription"
  })

  // Set YOUR_X-API-KEY with the API key from the Customer Area.
  // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
  Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
  Checkout checkout = new Checkout(client);
  
  PaymentsRequest paymentsRequest = new PaymentsRequest();
  
  String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
  paymentsRequest.setMerchantAccount(merchantAccount);
  
  Amount amount = new Amount();
  amount.setCurrency("NOK");
  amount.setValue(1000L);
  paymentsRequest.setAmount(amount);
  
  DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
  paymentMethodDetails.setRecurringDetailReference("8315888578361992");
  paymentMethodDetails.setType("vipps");
  paymentsRequest.setPaymentMethod(paymentMethodDetails);
  
  paymentsRequest.setReference("YOUR_ORDER_NUMBER");
  paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
  paymentsRequest.setShopperInteraction("ContAuth");
  paymentsRequest.setRecurringProcessingModel("Subscription");
  
  PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

  // Set your X-API-KEY with the API key from the Customer Area.
  $client = new \Adyen\Client();
  $client->setXApiKey("YOUR_X-API-KEY");
  $service = new \Adyen\Service\Checkout($client);
  
  $params = array(
    "amount" => array(
      "currency" => "NOK",
      "value" => 1000
    ),
    "reference" => "YOUR_ORDER_NUMBER",
    "paymentMethod" => array(
      "type" => "vipps",
      "recurringDetailReference" => "8315888578361992"
    ),
    "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
    "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    "recurringProcessingModel" => "Subscription",
    "shopperInteraction" => "ContAuth",
    "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
  );
  $result = $service->payments($params);

  #Set your X-API-KEY with the API key from the Customer Area.
  adyen = Adyen.Adyen()
  adyen.client.xapikey = 'YOUR_X-API-KEY'
  
  result = adyen.checkout.payments({
     'amount': {
        'value': 1000,
        'currency': 'NOK'
     },
     'reference': 'YOUR_ORDER_NUMBER',
     'paymentMethod': {
        'type': 'vipps',
        'recurringDetailReference': '8315888578361992'
     },
     'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
     'shopperReference': 'YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j'
     'merchantAccount': 'YOUR_MERCHANT_ACCOUNT',
     'shopperInteraction':'ContAuth',
     'recurringProcessingModel': 'Subscription'
  })

  // Set your X-API-KEY with the API key from the Customer Area.
  var client = new Client ("YOUR_X-API-KEY", Environment.Test);
  var checkout = new Checkout(client);
  
  var amount = new Model.Checkout.Amount("NOK", 1000);
  var details = new Model.Checkout.DefaultPaymentMethodDetails{
    Type = "vipps",
    RecurringDetailReference = "8315888578361992"
  };
  var paymentsRequest = new Model.Checkout.PaymentRequest
  {
    Reference = "YOUR_ORDER_NUMBER",
    Amount = amount,
    ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
    MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
    ShopperReference = "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    RecurringProcessingModel = "Subscription",
    ShopperInteraction = "ContAuth",
    PaymentMethod = details
  };
  
  var paymentResponse = checkout.Payments(paymentsRequest);

  // Set your X-API-KEY with the API key from the Customer Area.
  const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
  const config = new Config();
  // Set your X-API-KEY with the API key from the Customer Area.
  config.apiKey = '[API_KEY]';
  config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
  const client = new Client({ config });
  client.setEnvironment("TEST");
  const checkout = new CheckoutAPI(client);
  checkout.payments({
      amount: { currency: "NOK", value: 1000 },
      paymentMethod: {
          type: 'vipps',
          recurringDetailReference: "8315888578361992"
      },
      reference: "YOUR_ORDER_NUMBER",
      merchantAccount: config.merchantAccount,
      shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
      returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
      shopperInteraction: "ContAuth",
      recurringProcessingModel: "Subscription"
  }).then(res => res);

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

Your test payments are processed using the following card, which is already included in the test app:

Vipps payments in your Customer Area

Check the status of Vipps test payments in your Customer Area > Transactions > Payments.

Authorised Vipps payments

Because the Adyen payments platform stores authorised payments under the card acquirer, authorised Vipps payments will show up in your Customer Area as Visa or Mastercard payments, with Shopper name: Vipps Placeholder. For example, payments that you make using the Vipps test app are shown as Visa payments.

To find all authorised Vipps payments in the payments list:

• Enter accountHolderName: vipps in the search bar on top of the payments list.

Refused Vipps payments

Refused Vipps payment are stored by the Adyen payments platform under the Vipps acquirer.

To find all refused Vipps payments in the payments list:

• Filter by Payment method: Vipps.

Go live

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

See also