No momento, esta página não está disponível em português
Payment-method icon

Vipps for API only

Add Vipps to an existing API-only integration.

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.

Before you begin

Before starting your Vipps integration:

  1. Make sure that you have set up your back end implementation.
  2. Add Vipps in your Customer Area.

Build your payment form for Vipps

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

We provide logos for Vipps which you can use on your payment form. For more information, refer to Downloading logos.

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

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 don't 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.

    When using the HTTP GET method:
    For security reasons, when displaying 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.

  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:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful, and proceed with the order.
You receive the funds after the payment has been captured.
Cancelled The shopper cancelled the payment. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. For more information, check the refusalReason field. Inform the shopper that there was an error processing their payment.
Refused The payment was refused. For more information, check the refusalReason field. Ask the shopper to try the payment again using a different payment method.

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

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful, and proceed with the order.

Test and go live

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

Phone number National Identity Number (NIN) PIN
94987289 09104226830 1236
99460821 23035007725 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.

See also