Reporting API to Report API

API Documentation

Both the Vipps MobilePay Report API and the MobilePay Reporting API allow for the retrieval of data related to payments, reconciliation, and more. The data offered by these APIs is quite similar. The transition from the Reporting API to the Report API is straightforward, involving no advanced logic. It's primarily about retrieving data in a read-only manner.

API transition timeline

Details:

• Until Finland launch: The MobilePay Reporting API will work as before for Finnish merchants.
• Until Denmark launch: The MobilePay Reporting API will work as before for Danish merchants.
• 2024.01.01: The Vipps MobilePay Report API will include data for the MobilePay Reporting API from 2024.01.01.
• Finland launch (mid-January 2024): From this date, the MobilePay Reporting API will not get new data for Finnish merchants, but historical data for payments up until this date will be available until summer 2024.
• Denmark launch (Q2 2024): From this date, the MobilePay Reporting API will not get new data for Danish merchants, but historical data for payments up until this date will be available until summer 2024.
• Summer 2024: The MobilePay Reporting API will be phased out and no longer available. The Vipps MobilePay Report API will contain all historical data, both data from the MobilePay Report API and the Vipps MobilePay Report API. Please note: The data format will be as documented for the Report API only.

Transition to facades

1. When we transition merchants to façades (which will happen first for the Finnish launch and the for the Denmark launch), settlement data from that date will not be available in the old MobilePay Reporting API. It will be exclusively available in the new Vipps MobilePay Report API.

2. Merchants are required to retrieve their historical data using the MobilePay Reporting API and obtain new data using the Vipps MobilePay Report API. MobilePay data from 2024.01.01 and forward will be available through the Vipps MobilePay Report API.

3. Merchants will need to combine data from both APIs on their end. This task is not overly complex as both APIs provide read-only JSON with similar data fields.

4. In the future, merchants will be able to access all settlement data, both old and new, through the Vipps MobilePay Report API once the migration is complete.

5. At some point, the MobilePay Reporting API will be deprecated and discontinued since all data will be accessible through the Report API. We may discontinue it before data migration, as there will be no new data available, and we encourage merchants to retrieve their data while it's still accessible.

Both the Vipps MobilePay Report API and the MobilePay Reporting API allow for the retrieval of data related to payments, reconciliation, and more. The data offered by these APIs is quite similar. The transition from the Reporting API to the Report API is straightforward, involving no advanced logic. It's primarily about retrieving data in a read-only manner.

Notable Differences

It's important to note that the MobilePay Reporting API offered some functionalities, such as retrieving payment points, which are readily available for you in the Management API. Please note that Report and Management APIs are only available in production.

Input formats

MobilePay Reporting API	Vipps MobilePay Report API
paymentId	pspReference
type: "Payment"	entryType
amount	amount
currencyCode	currency
message	Upcoming feature
merchantReference	reference
merchantPaymentLabel	N/A
transferReference	reference
transferDate	ledgerDate
timestamp	time
userPhoneNumber	N/A
userName	N/A
loyaltyId	N/A
myShopNumber	recipientHandle
brandName	N/A
brandId	N/A
locationId	N/A
posName	N/A
beaconId	N/A
agreementExternalId	N/A
agreementId	N/A
refundId	N/A
N/A	balanceBefore
N/A	balanceAfter

Endpoints

Operation	MobilePay Reporting API	Vipps MobilePay Report API	Vipps MobilePay Management API
Fetch list of payment points	GET /v3/reporting/paymentpoints	N/A	GET /management/v1/merchants/{scheme}/{id}/sales-units
List of transactions	GET /v3/reporting/transactions	GET /report/v2/ledgers/{ledgerId}/{topic}/feed	N/A
List of transfers	GET /v3/reporting/transfers	N/A	N/A
Fetch single transfer	GET /v3/reporting/transfers/{transferid}	GET /report/v2/ledgers/{ledgerId}/{topic}/dates/{ledgerDate}	N/A
Get ledgers	N/A	GET /report/v2/ledgers/{ledgerId}/{topic}/dates/{ledgerDate}	N/A

Webhook

Webhook events through the MobilePay Webhook API will no longer be sent for transfer.succeeded.