Settlements
This settlement information applies to Vipps.
Settlement flow
Settlements are done as quickly as possible and are dependent on banks.
The settlement flow is as follows:
-
Day 1: A customer makes a purchase and the transaction is completed. The merchant ships the product to the customer, if applicable. Then, the merchant captures the money and the customer's account is charged.
Note: Day 1 is normally the day that the product is shipped and the customer's account is charged.
-
Day 2: Settlement files are available (see How to get settlement files).
-
Day 3: Payments are made from the Vipps MobilePay bank account to the merchant's bank account. Money is normally available in the account before noon.
The settlement process will always adhere to our terms and conditions.
Days are bank days, Monday - Friday, excluding banking holidays. In other words, a capture made on Monday will be on the merchant's account on Wednesday, while a capture made on Friday will be on the merchant's account on Tuesday.
A day starts and ends at midnight, Oslo time: Start 00:00:00
, end 23:59:59
(subseconds not specified).
Please make sure your servers' clocks are correct, e.g. by using NTP.
Settlement files are generated every day including bank days and weekends (one file every day). Payout for Friday, Saturday, and Sunday arrives on Tuesday (three separate transactions). There is one settlement file per payout.
There is only one payment per settlement period: Even if there have been thousands of payments in one week, there will still only be one payment (e.g., lump sum) from us to the merchant. The settlement reports have all the details for each of the thousands of payments. Additionally, there is one payment per sales unit and this includes a corresponding settlement file.
Reconciliation
A simple illustration showing where each ID is set, and how it all fits together.
Frequency
Vipps MobilePay merchants can log in on portal.vippsmobilepay.com and select daily, weekly, or monthly settlement frequency.
Vipps MobilePay pays merchants every Monday for weekly settlements, and on the first day of the month for monthly settlements.
Net and gross settlements
There are two types of settlements:
- Net settlement: Merchants will receive the users' payments excluding the Vipps MobilePay fees. In other words: The Vipps MobilePay fees are deducted from the settlement amount.
- Gross settlement: Merchants receive the full amount of the users' payments including the Vipps MobilePay fees. The merchant is then invoiced for the fees.
Net settlement is the default and is, in practice, the only settlement method offered. Gross settlements are only offered in very rare cases. With gross settlements, Vipps MobilePay essentially provides a loan to the merchant, and this involves both additional cost and risk and also requires additional checks.
For gross settlements, if the merchant's organization number is registered as an EHF recipient, Vipps MobilePay sends invoices as EHF. If not, the invoices are sent by email. To change the invoice recipient, please contact customer service.
See Availability for information about settlement files when the balance is negative.
File formats
Settlement reports are provided in:
XML
Here are schemas and example files for XML settlement reports.
Both the current settlement report schema v3.0 and the old v2.0 version are available.
Example files are available for:
Changes to the settlement report XML schema from v2.0 to v3.0
NB! New settlements will contain a mix of captures and refunds. To make the numbers unambiguous we have introduced new fields for capture and refund, but kept gross and net fields as before.
-
Schema changes from v2.0 to v3.0:
- Old schema URL for v2.0 was SettlementReport-2.0.xsd
- New schema URL is SettlementReport-3.0.xsd
- New schema validates all amount fields with new types
money
,positiveMoney
, andnegativeMoney
- Other changes organized by parent element below
-
Changes to PaymentsInfo:
ReportDateFrom
andReportDateTo
fields:- Drop time part, keep only date (in YYYY-MM-DD format)
- Change schema type from
xs:string
toxs:date
- Remove control sums (
TotalSettledGrossAmount
,TotalSettledNetAmount
,TotalSettledFeeAmount
, andTotalSettledRefundAmount
) - Move
NumOfSettlements
afterSettlementInfo
blocks to facilitate future streaming optimizations for large files
-
Changes to TransactionInfo:
- Rename
TransactionDate
toTransactionTime
and:- Change type from
xs:string
toxs:dateTime
- Fix time zone bug from previous report system where time UTC formatting was applied to Oslo time.
- Now always Oslo time zone, consistent with dates
- Change type from
- Change type of
TransactionID
fromxs:string
toxs:long
- Add field
TransactionCaptureAmount
(always positive) - Add field
TransactionRefundAmount
(always negative) - Note that
TransactionGrossAmount = TransactionCaptureAmount + TransactionRefundAmount
- Rename
-
Changes to
SettlementInfo
:- Rename
SettlementBatchDate
toSettlementDate
and:- Drop time part and change type from
xs:string
toxs:date
- For new settlements, this date is within the inclusive range
[ReportDateFrom, ReportDateTo]
and is equal to or later than the date of the last transaction within the settlement - Note that the bank transfer will typically occur at a later date
- Drop time part and change type from
- Change type of
SettlementID
fromxs:string
toxs:long
- Move
NumOfTransactions
and all amounts to belowTransactionInfo
fields, to facilitate future streaming optimizations for large files - Add field
SettlementType
(Net
orGross
) - Add field
SettledAmount
, which is the amount paid out or invoiced (net or gross depending on settlement type) - Add field
CaptureSettlementAmount
, sum ofTransactionCaptureAmount
fields - Add field
RefundSettlementAmount
, sum ofTransactionRefundAmount
fields - Note that
GrossSettlementAmount
is still the sum ofTransactionGrossAmount
fields - Note that
GrossSettlementAmount = CaptureSettlementAmount + RefundSettlementAmount
- Rename
-
Changes to
FeeInfo
:FeeInfo
will only be included for old reports with gross settlement type- Change type of
FeeDate
fromxs:string
toxs:date
- Change type of
FeeAccount
fromxs:long
toxs:string
-
Changes to
SettlementDetailsInfo
:- Change type of
MainAddressCity
fromxs:NCName
toxs:string
- Change type of
-
Changes to
VippsInfo
:- Change type of
WebSite
fromxs:NCName
toxs:anyURI
- Change type of
Country
fromxs:NCName
toxs:string
- Change type of
CSV
The following is an example of a CSV settlement file:
CSV settlement file contents
The CSV settlement file contains the following info:
Column title | Description | Comment |
---|---|---|
Salgsdato | Date of sale | |
Salgssted | Sales unit name | |
Vippsnummer | Merchant serial number | |
Produkt | Vipps product name | E.G. "Vipps Netthandel" |
Transaksjons-ID | Transaction ID | Differs for Reserved, Captured and Refunded transaction |
Ordre-ID | Ordre ID | |
Brutto | Total amount | |
Gebyr | Fees | |
Netto | Total amount minus fees | |
Transaksjonstype | Transaction type | E.G. Salg (Sale), Refundering (Refund) |
Oppgjørs-ID | Settlement ID | |
Oppgjørsdato | Settlement date | |
Oppgjørssum | Settlement total amount | |
Oppgjørskonto | Settlement bank account number | |
Fornavn | First name | Only applicable for Vipps number |
Etternavn | Last name | Only applicable for Vipps number |
Melding | Message/Transaction text |
PDF
The following is an example of a PDF settlement file:
XLSX
The following is an example of a CSV settlement file:
Identifying payments
If you need to use the payment's ID to identify a payment, then use an online solution, such as the ePayment API.
Additional info for recurring payments
For recurring payments, the orderID
is an optional field.
If orderID
is not specified by the merchant when making a charge,
the settlement report shows the automatically generated chargeID
in the orderID
field.
If orderID
is in use, this is also used in the settlement report.
See the Recurring API for more details.
GDPR
We need the customer's consent before sharing personal information.
Settlement reports generally don't contain personal information; however, payments made with Vippsnummer (now referred to as: Shopping Basket and Open Amount) may have personal information and must be treated with care.
See the FAQ: Why are the customer names not shown on the transaction overview?
How to get settlement files
Report API
Use the Report API to get your settlement files programmatically. With this API, you can get daily or continuous-feed reports for your accounts. See the Report API guide for details.
Merchant portal
You can download reports from the merchant portal in the Reports section. Reports are available in the formats mentioned under File formats.
Reports with personal details of the customers are also available. Please consider GDPR.
Email
Through the merchant portal, you can specify the email addresses to receive settlement reports.
We are not allowed to send reports with personal customer details. See GDPR for more information.
SFTP
The SFTP service is deprecated and will be unavailable from 1 July 2024. This was announced in the Technical update 2023-10.
Please use the Report API to get your settlement information.
Availability
Settlements are created every day, as long as the balance is positive.
If the balance for a day is zero (e.g. due to lack of transaction) or negative (e.g. due to refunds), a settlement will not be created until the balance becomes positive. This means that in some cases, a settlement report may include transactions spanning several days back in time.
Settlement reports are available by 12:00 noon. The reports are generated around 01:00-03:00 at night, but may be delayed due to technical changes, maintenance in various systems, or other unforeseen events.
There will be no settlement reports for dates without completed payments. In these cases, neither the settlement files nor the directories that should have contained settlement files will exist.
If a merchant has refunded more money than the sum of payments, so that the balance is negative, we will not create settlement reports. We cover the negative balance for a short while, but if it persists, we will send an invoice to the merchant to settle the balance.
There are no settlement reports for the test environment.
Daily reports
The settlement reports are available by 12:00 noon.
Weekly reports
The settlement report is generated on Mondays, by 12:00 noon.
Monthly reports
The settlement report is generated on the 1st of the month, by 12:00 noon.