Get data from APIs¶
Recommended for regular accounting. Let your accounting system receive payment data continuously, close to when payments happen. Your registered Vipps MobilePay accounting partner sets up and operates the integration; you stay in control of which data they can access.
What your accounting partner can retrieve¶
Your accounting partner uses two APIs together:
| The question | API | What the data includes |
|---|---|---|
| What was sold? | Sales API | Sales amount and category, plus order lines, quantities, and VAT when that information was added to the sale. |
| What happened to the money? | Report API | Captures, refunds, fees, balances, and payouts. |
The APIs link sales and settlement data using reference and pspReference. This gives your accounting partner the context to follow a sale through to settlement.
The Sales API documentation shows the two complementary data sets: sales context and money movement.
Sales details for bookkeeping¶
The Sales API covers Open Amount, Shopping Basket, and mPOS sales. Shopping Basket data can include item names, quantities, and VAT per line when your business has added it. Open Amount does not have order lines, and VAT data can be missing or partial.
The Sales API does not include customer information.
Settlement details for reconciliation¶
The Report API provides settlement data, transaction reports, and payment event history. Together with sales context, it helps an accounting system account for the amount paid, refunds, fees, and payouts.
For Vipps number / MobilePay number sales units, a registered accounting partner retrieves API data on your behalf.
Give an accounting partner access¶
Before you start, ask your accountant or accounting system provider whether they are a registered Vipps MobilePay accounting partner.
- Log in to the Vipps MobilePay business portal.
- Select Reports in the sidebar, then open the Accounting partners tab.
- Select Edit partner access.
- Choose the accounting partner.
- Select the sales unit and ledgers the partner can access, then confirm.
You give explicit access per sales unit and choose which ledgers a partner can access. You can give access to more than one accounting partner when needed.
What happens next¶
Your accounting partner uses its accounting keys to retrieve the data. They can synchronize continuously, retrieve data for a specific accounting date, or look up an individual sale or transaction when investigating a difference.
Send your accounting partner to the technical documentation if they need implementation details:
Prefer reports only when an integration is not needed¶
If you only need an occasional report, use the business portal instead. Download reports from the business portal