Changelog

All notable changes to the current API will be documented in this file. See: API Lifecycle.

June 2023

A new field is returned by the GET:/agreements/{agreementId} endpoint:
- vippsConfirmationUrl: used to redirect the user to the landing page in a desktop flow (with https://), or to the Vipps app in a mobile flow (with vipps://), where the user can then approve the agreement

New fields returned by the GET:/agreements/{agreementId} endpoint:
- merchantAgreementUrl: URL where Vipps can send the customer to view/manage their subscription
- merchantRedirectUrl: URL where customer should be redirected after the agreement has been approved/rejected in the Vipps mobile application
- created: Date when agreement was created in ISO 8601 format
New fields returned by the GET:/agreements/{agreementId}/charges/{chargeId} endpoint:
- retryDays: The service will attempt to charge the customer for the number of days specified in retryDays after the due date
- externalAgreementId: Can be used by the merchant to map the agreementId to an ID in a subscription system or similar

New optional field externalId for agreements introduced. This field can be used to store an external ID for the agreement. Can be set in the request body of the POST:/agreements request. externalId will be returned by the GET:/agreements/{agreementId} endpoint. It is also possible to update it using the PATCH:/agreements/{agreementId} endpoint.
New optional field countryCode for agreements introduced. Can be set in the request body of the POST:/agreements request. countryCode will also be returned by the GET:/agreements/{agreementId} endpoint.
New field uuid (UUID representation of agreement ID) returned by the GET:/agreements/{agreementId} response.
New optional field externalId for charges introduced. This field can be used to store an external ID for the charge. Can be set in the POST:/agreements/{agreementId}/charges request.

The new endpoint GET:/charges/{chargeId} makes it possible to retrieve a charge specified by chargeId, without knowing the agreementId (unlike GET:/agreements/{agreementId}/charges/{chargeId}). The resulting charge now contains the agreementId. Its purpose is to simplify investigations when the merchant lost track of which charge belongs to which agreement.

v3 is now available. v3 includes new and improved functionality for campaigns, the ability to reserve and capture charges, and several technical improvements. The migration guide and quick start provide more details for upgrading to v3. v2 will be phased out and will no longer be available from November 1, 2023.