{"title":"Vipps for API only","category":"default","creationDate":1776961628,"content":"

You can add Vipps to your existing integration. The following instructions show only what you must add to your integration specifically for Vipps.<\/p>\n

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to that corresponding step of the main integration guide.<\/p>\n

Requirements<\/h2>\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nMake sure that you have an existing API-only integration<\/a>.<\/td>\n <\/td>\n<\/tr>\n
Redirect handling<\/strong><\/td>\nMake sure that your existing integration is set up to handle the redirect<\/a>.
action.type<\/code>: redirect<\/strong>.<\/td>\n		<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\n Before you begin, add Vipps in your Customer Area<\/a>. <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

How it works<\/h2>\n
    \n
  1. The shopper selects Vipps as the payment method.<\/li>\n
  2. The shopper enters their details in the payment form that you build<\/a>.<\/li>\n
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase<\/a>.<\/li>\n
  4. Your existing integration setup will handle the redirect<\/a>.<\/li>\n<\/ol>\n

    Build your payment form<\/h2>\n

    Include Vipps in the list of available payment methods. You do not need to collect any information from the shopper in your payment form.<\/p>\n

    \n

    You can download the logo for Vipps<\/a> to use in your form.<\/p>\n<\/div>\n

    Get Vipps as an available payment method<\/h2>\n

    When you make the \/paymentMethods<\/a> to get available payment methods<\/a>, specify the following so that Vipps is included in the response.<\/p>\n\n\n\n\n\n\n\n
    Parameter<\/th>\nValues<\/th>\n<\/tr>\n<\/thead>\n
    countryCode<\/a><\/td>\nNO<\/strong><\/td>\n<\/tr>\n
    amount.currency<\/a><\/td>\nNOK<\/strong><\/td>\n<\/tr>\n
    amount.value<\/a><\/td>\nThe value of the payment, in minor units<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n
    \n <\/code-sample>\n<\/div>\n

    Add additional parameters to your \/payments request<\/h2>\n

    When you make a payment<\/a>, add the following parameters:<\/p>\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    paymentMethod.telephoneNumber<\/a><\/td>\n<\/td>\nUsed to prefill the shopper's phone number on the Vipps-hosted page.<\/td>\n<\/tr>\n
    shopperStatement<\/a><\/td>\n<\/td>\nThe description of this payment shown in the Vipps app. If you do not specify a shopperStatement<\/code>, we'll use the value that you provided as the reference<\/code> to populate this field.<\/td>\n<\/tr>\n
    channel<\/a><\/td>\n<\/td>\nSpecify the relevant channel, for example Web<\/strong>, iOS<\/strong>, or Android<\/strong>.<\/td>\n<\/tr>\n
    amount.value<\/a><\/td>\n<\/td>\nThe value of the payment, in minor units<\/a>. For Vipps, the minimum amount allowed is 100<\/strong>, which is 1.00 NOK.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n

    The response includes the action.type<\/code>: redirect<\/strong>.<\/p>\n

    \n <\/code-sample>\n<\/div>\n

    Test and go live<\/h2>\n

    Vipps cannot be tested in the test environment. You must make penny test (low-amount) payments in the live environment.<\/p>\n

    Request for Vipps in the live environment<\/h3>\n

    Before you can accept live Vipps payments, you need to submit a request for Vipps in your live Customer Area<\/a>.<\/p>\n

    After Vipps is added to your live Customer Area, do the following for each test payment:<\/p>\n

      \n
    1. Make a Vipps payment for a low amount.<\/li>\n
    2. Get the AUTHORISATION<\/strong> webhook<\/a> on your server. It includes the status of the payment.<\/li>\n
    3. In your live Customer Area, go to Transactions<\/strong>\u00a0>\u00a0Payments<\/strong> to see the status of the payment.<\/li>\n<\/ol>\n

      See also<\/h2>\n