Vipps for API only

Accept Vipps payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Requirements

Build your payment form for Vipps

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

If you are using the /paymentMethods request to show available payment methods to the shopper, specify the following:

• countryCode: NO
• amount.currency: 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: vipps
• paymentMethod.telephoneNumber (optional): Used to prefill the shopper's phone number on the Vipps-hosted page.
• channel: Set this to either:
  • Web to receive a url to redirect the shopper to the Vipps-hosted page.
  • iOS or Android to receive a url that switches the shopper to the Vipps app.
• returnUrl: URL to where the shopper should be taken back to after a redirection.
• shopperStatement (optional): The description of this payment shown in the Vipps app. If you do not specify a shopperStatement, we'll use the value that you provided as the reference to populate this field.

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Handle the redirect

1. To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:

   • When using the HTTP GET method:
     For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

   • Redirection for mobile integrations:
     For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • details: object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

3. In the response note the following:

   • resultCode: use this to present the 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:

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

Test and go live

To test your integration, install a Vipps test app, and use the following credentials:

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