Payment-method icon

MobilePay for API only

Add MobilePay to your API-only integration.

You can add MobilePay to your existing integration. The following instructions show only what you must add to your integration specifically for MobilePay.

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.

Requirements

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Action handling Make sure that your existing integration is set up to handle the additional action.
action.type: redirect.
Setup steps Before you begin, add MobilePay in your Customer Area.

How it works

  1. The shopper selects MobilePay as the payment method.
  2. The shopper enters their details in the payment form that you build.
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase.
  4. You fulfill the order by sending items to the shopper.

Build your payment form

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

You can download the logo for MobilePay to use in your form.

Get MobilePay as an available payment method

When you make the /paymentMethods to get available payment methods, specify the following so that MobilePay is included in the response.

Parameter Values
countryCode DK, FI
amount.currency DKK, EUR

Add additional parameters to your /payments request

You do not need to add any parameters when you make a payment, unless you make a payment to generate a token for future payouts to MobilePay wallets.

Payment with payout token creation

To make a MobilePay payment and generate a token for future payouts to MobilePay wallets:

  1. Make sure that you have set up the recurring lifecycle webhook.

  2. Make a /payments request as usual, but include the parameters to create a token:

    • telephoneNumber
    • shopperReference
    • enablePayout set to true

  3. When you receive the recurring lifecycle webhook for the payment, save the storedPaymentMethodId (the token) for your customer, identified by the shopperReference.

  4. When you want to make a payout to the shopper's MobilePay wallet, send a POST /transfers request specifying the payout token in the counterparty.card.cardIdentification field.

Test and go live

MobilePay cannot be tested in the test environment. You must make penny test (low-amount) payments in the live environment.

  1. Submit a request for MobilePay in your live Customer Area.

  2. After MobilePay is added to your live Customer Area, do the following for each test payment:

    1. Make a MobilePay payment for a low amount.
    2. Get the AUTHORISATION webhook on your server. It includes the status of the payment.
    3. In your live Customer Area, go to Transactions > Payments to see the status of the payment.

Test payouts to MobilePay wallets

The MobilePay payout feature is experimental, and supported only with the /payments endpoint.

Do the following to test MobilePay payouts:

  1. Get a test app following the instructions in the VippsMobilePay documentation. When prompted for a phone number and NIN (national identity number), use one of the following sets:

    • NIN 0407640091
      Phone +45 22105837

    • NIN 0702860109
      Phone +45 34817154

    • NIN 0111500196
      Phone +45 73920021

  2. Test your integration end-to-end:

    • Make a test payment that generates a payout token, using the Vipps MobilePay test app to simulate the customer side.
    • Check that you receive and process the recurring lifecycle webhook.
    • Make a Transfers API request using the token that you receive in the webhook.

See also