Skip to main content

Subscriptions to Recurring

Below, you can find comparison between the existing MobilePay Subscriptions facade API and the Recurring API. The two APIs are very similar catering to an easy switch between the two solutions.

Before you begin make sure to check out how to get started with the migration.

New features

Remember to check out the new features you can utilize to enhance your solution and create more value for your and your customers

Mapping between the APIs

Endpoints

Find the full list of MobilePay Subscriptions endpoints and how they map to the new Recurring endpoints.

List of endpoints

Agreement

See: Agreements

MobilePay Agreement ​Vipps MobilePay Agreement
Description ​productDescription​
Amount​pricing: { "type"("LEGACY" => amount ,"VARIABLE" => suggestedMaxAmount), "currency"("NOK") }
Frequency​interval: { "unit"("YEAR" "MONTH" "WEEK" "DAY"), "count"([1..31]) }
Links: [user-redirect, success-callback, cancel-callback, cancel-redirectmerchantRedirectUrl + merchantAgreementUrl​
Plan​productName​
mobile_phone_number​phoneNumber​
external_id​externalId​
currency​N/A
country_code​N/A
expiration_timeout_minutes​N/A
retention_period_hours​N/A
disable_notification_management​N/A
notifications_on​N/A
N/Ascope (Space-separated list of the user profile-data scope to require for the agreement)​
N/AisApp (If merchant is redirecting user from an app or a mobile device)​
N/AskipLandingPage (true = skip landing page by sending a push notification directly to the user)​

Charges

See: Charges

MobilePay one-off​Vipps MobilePay initial charge
Amount (kroner.øre) ​amount (øre)​
External_id​orderId (if NULL → autogenerated. See Recommendations for reference and orderId.)​
Description​description​
Expiration_timeout_minutes​N/A
N/AtransactionType (RESERVE_CAPTURE, DIRECT_CAPTURE)​
MOBILEPAY RESPONSE FROM AGREEMENTVIPPS MOBILEPAY RESPONSE FROM AGREEMENT
IdagreementId
links["rel", "href"]vippsConfirmationUrl
one_off_payment_idchargeId

Callbacks

When you switch to Recurring API you must also implement the new webhook solution. It is important to notice that after integrating towards new webhook solution you will be receiving both new and old webhooks. You have to notify us about integration to webhooks, in order for us to turn of old MobilePay callbacks for you. By default, even after reintegration you will receive webhooks in the old MobilePay format, but there is no possibility to change callback URL or authentication method.

Check out the webhook documentaion to see types of webhook.

New features

Now that you are moving to the Recurring solution you can take advantage of some new features to improve your solution and enhance user experience.

Campaigns

A campaign in Recurring is a period where the price is lower than usual, so you can easily shown discounts and price campaigns to your users.

Login

Need an easy way to login your users? You don't have to stick with the Recurring API, you are free to use all our APIs including Login that can be used to retrieve user data or as a login option.

Merchant and sales unit data trough the API

There is no need to go trough the portal to fetch you merchant-serial-number, you can just use the Management API. This is especially relevant for partners as it can also be used to onboard and fetch information about their merchants.

Help us improve our documentation

Did you find what you were looking for?