Changelog
Version 2 is available now. Version 1 is deprecated.
All notable changes to the current API will be documented here. To learn about API versioning, see API Lifecycle.
History
June 2024
GET:/settlement/v1/ledgers
now returns sales unit information as an array of objects. See Downloading reports for details.
May 2024
- Removed the deprecated
GET:/report/v1/ledgertransactions
endpoint. Requests to the endpoint will result inHTTP 410 Gone
.
February 2024
- Added the
GDPR data
parameter
includeGDPRSensitiveData
for Vippsnummer payments.
December 2023
- We removed
FirstPayout
andLastPayout
from the response ofGET:/settlement/v1/ledgers
. - Removed some internal data from the
GET:/report/v2/ledgers/{ledgerId}/{topic}/feed
. The data was never mentioned in the API specification, so we consider this a bug fix. The internal fields that were removed:name
,externalId
,settlementEmailRecipients
,settlementEmailFrequency
,enableGrossSettlements
,enableSettlementPayoutIfBlocked
,blockSettlementPayouts
,settlementFrequency
,salesUnits
,entityId
,changedBy
,changedAt
andcomment
.
November 2023
- Added the
hasMore
field toGET:/report/v2/ledgers/{ledgerId}/{topic}/dates/{ledgerDate}
to reduce the learning curve of API.
September 2023
- Launched the final non-Beta version of the Report API, which is named
report/v2
. Version 1 is deprecated. - November 2022: Launched the beta of the Report API,
report/v1
.
Version 2 compared to version 1
- The information in the
/ledgertransactions
endpoint has been split into different endpoints to list changes to balance (funds
) and per-transaction fees charged by Vipps MobilePay AS (fees
). This split is primarily done to make it more natural in the API to provide fee specifications also for merchants that receive gross settlements. - Instead of query parameters to
/ledgertransactions
implying different modes of using the endpoint, we provide different endpoints for different ways of fetching/synchronizing the data. - In total,
GET:/report/v1/ledgertransactions
is replaced by the following endpoints, where{topic}
can befunds
orfees
: - While all the above endpoints are very similar to the
v1/ledgertransactions
endpoint, there are some cosmetic changes:transactionId
has been renamedpspReference
to be consistent with the ePayment API.orderId
has been renamedreference
to be consistent with the ePayment API.ledgerAmount
is simplyamount
.transactionType
has been renamed toentryType
.- The
payout
type has been renamed topayout-scheduled
. Please consult the full list of entry types in the reference.
- The
- The
grossAmount
andfee
columns are removed from this endpoint and replaced with:- Detailed information about fees available on the
/fees
endpoint; both for cases where fees are retained ("net settlements") and not ("gross settlements") - For net settlements, an adjustment of the ledger balance is included as a sum row.
There is typically once such row per day, although details of this will vary according to when
Vipps MobilePay legally collects the fees (
entryType
offees-retained
).
- Detailed information about fees available on the
- The
inPayout
argument tov1/ledgertransactions
has no equivalent in the new API. We recommend to instead fetch data per date.- We may add the feature back if there is enough popular demand for it,
in that case as a separate
payouts
path alongsidefeed
anddates
.
- We may add the feature back if there is enough popular demand for it,
in that case as a separate
- The
sincePayout
argument to/ledgertransactions
has been removed and appears to be unused.