Vipps Drop-in integration

Our iOS 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 handle the redirect result after the shopper returns to your app.

Before you begin

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

Before starting your Vipps integration:

1. Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
2. 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 invokes the didSubmit method which contains data.paymentMethod. Pass the data.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 data.paymentMethod from the didSubmit event from your client app.
• channel: iOS
• returnUrl: The URL where the shopper will be redirected back to after completing the payment. Use the custom URL for your app, for example, my-app://. For more information on setting custom URL schemes, refer to the Apple Developer documentation.
• 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.

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":"iOS",
  "returnUrl":"my-app://"
}'

# 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 => "iOS",
  :returnUrl => "my-app://",
  :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("my-app://");

    paymentsRequest.setChannel(PaymentsRequest.ChannelEnum.iOS);

    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" => "iOS",
  "returnUrl" => "my-app://",
  "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': 'iOS',
   'returnUrl': 'my-app://',
   '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 = @"my-app://",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details,
  Channel = Model.Checkout.PaymentRequest.ChannelEnum.iOS
};

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: "iOS",
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "my-app://"
}).then(res => res);

The /payments response contains:

• action: Object containing information about the 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"
     }
  ],
  ...
}

Handle the redirect result

Drop-in uses dropInComponent.handle(action) to redirect the shopper to the Vipps app.  

1. To inform Drop-in when the shopper returns to your app, implement the following in your UIApplicationDelegate:

   func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey: Any] = [:]) -> Bool {
      RedirectComponent.applicationDidOpen(from: url)
   
      return true
   }

   After Drop-in completes the action, it invokes the didProvide method.
2. From your server, make a POST /payments/details request providing the data from the didProvide method from your client app.
   https://docs.adyen.com/payment-methods/vietnamese-online-banking/ios-drop-in#-payments-details-request

   /payments/details request

   {
      "{hint:data.paymentData from didProvide}paymentData{/hint}":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
      "{hint:data.details from didProvide}details{/hint}":{
        "payload":"Ab02b4c0!BQABAgCW5sxB4e/=="
      }
   }

   You receive a response containing:
   • resultCode: Use this to present the result to your shopper.
   • pspReference: Our unique identifier for the transaction.
   https://docs.adyen.com/payment-methods/vietnamese-online-banking/ios-drop-in#-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