Agreements
1. Initiation
A user chooses Vipps MobilePay as payment method for a subscription on a merchant’s website or app.
2. The landing page
If the agreement was started on a desktop device, the user will be sent to the Vipps MobilePay landing page. The user confirms their number and is prompted to log in to Vipps MobilePay.
If the agreement was started from a mobile device, the app will automatically switch over to Vipps MobilePay.
3. Accept agreement
The user receives a push notification on their phone. They log in to Vipps MobilePay and accept the agreement. The agreement has multiple parameters that you can use to customize it to your business needs:
- The agreement can be with or without initial charge. Read more at How Recurring works with initial charge.
- The agreement can be with a campaign. Read more at How Recurring works with campaign.
- The agreement can have fixed or variable amount.
- The agreement can have flexible or fixed frequency: daily, weekly, monthly, etc.
In the example you can see the agreement with initial charge, without a campaign, with fixed amount and fixed monthly frequency.
- Vipps
- MobilePay
4. Confirmation of subscription
The user is redirected back to the merchant’s website or app, and the subscription is confirmed on the merchant’s page.
Please note: Activation of the agreement is not guaranteed to be finished by the time the user is redirected back to the merchantRedirectUrl
. The agreement could still have the status PENDING, so it is important to continue to poll the status of the agreement until a final status is returned by the API or use webhooks.
5. Overview of agreements and charges
The user can see their active subscriptions, as well as stopped subscriptions, and get an overview of previous charges in Vipps MobilePay.
6. Manage agreement
When the user clicks on Manage agreement, they will be presented the manage agreement view with different options specific to that agreement. On all agreements irrespective of their type, the users can:
-
Change the payment source
-
Toggle notifications upon payment
-
Stop payment agreement
-
Easily access "My page" on the merchant's site using
See at Merchant AS
link, if this link is provided by the merchant. This merchant agreement URL is mandatory for Norwegian merchants and optional for Finnish and Danish merchants. We recommend the merchants to use the Login API to make logging in to the merchant’s site easy.The merchant's "My page" must provide an easy way for users to cancel their subscription, as shown below.
-
On variable amount agreements, the users can also update the maximum amount.
Merchants can opt out of showing Stop payment agreement in the app. See Recurring API FAQ.
7. Stop payment agreement
Users can stop the agreement in the app.
Make sure you have webhooks implemented to listen for the recurring.agreement-stopped.v1
webhook event
and update the subscription status on your systems accordingly.
The actor field in the payload will indicate whether the agreement was stopped by the merchant or the user.
Great! Now you know how the Recurring agreement process works.
Take a look at the technical documentation in the Recurring API Guide.