Subscriptions to Recurring
API documentation:
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-redirect] | merchantRedirectUrl + 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/A | scope (Space-separated list of the user profile-data scope to require for the agreement) |
| N/A | isApp (If merchant is redirecting user from an app or a mobile device) |
| N/A | skipLandingPage (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/A | transactionType (RESERVE_CAPTURE, DIRECT_CAPTURE) |
| MOBILEPAY RESPONSE FROM AGREEMENT | VIPPS MOBILEPAY RESPONSE FROM AGREEMENT |
Id | agreementId |
links["rel", "href"] | vippsConfirmationUrl |
one_off_payment_id | chargeId |
Test environment
The test environment is called Merchant Test (MT) and is now open for test. MT currently only allows Norwegian phone numbers and merchants, but you can test the API and payment flow. Please see the details of limitations of the test environment.
You need credentials to get access to MT. Just request it on the MobilePay merchant test page, and we'll e-mail you the information you need.