If you are using Android Components v5.0.0 or later:
This payment method requires no additional configuration.
Follow the Components integration guide and use the following module and Component names:
- To import the module: instant
- To launch and show the Component: InstantPaymentComponent
If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to the MobilePay app on their mobile device to complete the payment. As with other redirect payment methods, you need to handle the redirect result after the shopper returns to your app.
To give your shoppers a better experience, you can also send the shopper's telephone number when making the payment, so they no longer have to provide this later when they are redirected to MobilePay.
Requirements
Requirement | Description |
---|---|
Integration type | Make sure that you have built an Advanced flow Android Components integration. |
Webhooks | To make MobilePay payouts, you need to configure recurring lifecycle webhooks. |
Limitations | The MobilePay payout feature is experimental, and supported only with the /payments endpoint. See the full payout limitations. |
Setup steps | Before you begin, add MobilePay in your Customer Area. |
Show MobilePay in 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.
-
Make a POST /paymentMethods request specifying one of the following combinations:
Country/region countryCode amount.currency amount.value Denmark DK DKK The value of the payment, in minor units. Finland FI EUR The value of the payment, in minor units.
The response contains paymentMethod.type
: mobilepay.
We provide logos for MobilePay which you can use on your payment form. For more information, refer to Downloading logos.
Make a payment
-
From your server, make a POST /payments request, specifying:
paymentMethod.type
: mobilepaytelephoneNumber
: Optional. If you already have your shopper's phone number, send it in the request so they no longer have to provide this later when they are redirected to MobilePay.returnUrl
: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in theRedirectComponent.getReturnUrl(context)
.
-
In the /payments response, check the
action
object for the information that you must use to redirect the shopper.
Payment with payout token creation
To make a MobilePay payment and generate a token for future payouts to MobilePay wallets:
-
Make sure that you have set up the recurring lifecycle webhook.
-
Make a /payments request as usual, but include the parameters to create a token:
telephoneNumber
shopperReference
enablePayout
set to true
-
When you receive the recurring lifecycle webhook for the payment, save the
storedPaymentMethodId
(the token) for your customer, identified by theshopperReference
. -
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.
Handle the redirect
-
Use the Redirect Component to redirect the shopper to the MobilePay app.
-
After the shopper returns to your app, make a POST /payments/details request from your server, providing:
details
: TheactionComponentData.details
object from the Redirect Component.
You receive a response containing:
resultCode
: Use this to present the payment 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 MobilePay 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. | Inform the shopper that there was an error processing their payment. |
Refused | The payment was refused. | 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
MobilePay cannot be tested in the test environment. You must make penny test (low-amount) payments in the live environment.
-
Submit a request for MobilePay in your live Customer Area.
-
After MobilePay is added to your live Customer Area, do the following for each test payment:
- Make a MobilePay payment for a low amount.
- Get the AUTHORISATION webhook on your server. It includes the status of the payment.
- 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:
-
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
-
-
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.