Retrieve Settlement Reports

This interface enables webstore to retrieve reports of settlements.

Report Content

The response message is an XML, CSV or XLS (Excel) document. XML and XLS file encoding is UTF-8 whereas CSV file encoding is ISO-8859-15.

The exact definition of the XML response is available as an XML Schema: https://www.maksuturva.fi/smtschema/GetCompensationsResponse.xsd

If the response is an error message, it will NOT include all compulsory fields, as they are not available in case of errors. The field resultCode is always available. Other fields may be expected only if resultCode has the value 00.

Logical Explanations of The Response Elements

Svea Payments can settle payments to the webstore in following ways:

  • separately one by one using webstore's original reference number (superior for accounting purposes)
  • in bundles containing several payments and usually with a fixed reference number. Bundles are settled once a day, week or month.

In either case, the XML report contains payments as bundles. If the payments were settled one by one, each bundle in the XML report contains only one payment/order.

The report has the following elements for each settlement bundle:

  • bundle code
  • the settlement date of the bundle
  • the reference number of the bundle (the actual reference seen on the bank account of the recipient)
  • the gross amount of all orders included in the bundle. This is the value originally expected by the webstore.
  • the actual settled net amount, which is: gross amount – refunds – Svea Payments commissions
  • Svea Payments commission sum
  • the amount refunded back to payers

The report has the following elements for each order / payment:

  • order id from the webstore (pmt_orderid)
  • the original reference number for the order, provided by the webstore (pmt_reference)
  • the unique id originally provided by the webstore (pmt_id)
  • the gross amount of the order originally expected by the webstore (pmt_amount + pmt_sellercosts)
  • the actual settled net amount, which is: gross amount – refunds – Svea Payments commissions
  • Svea Payments commission sum
  • the amount refunded back to payer

Report hash

The hash for checking the integrity of the XML report is calculated from the following fields:

  • version
  • timestamp
  • sellerId
  • resultCode
  • hashVersion
  • keyGeneration
  • secret key (which is not included in the XML report itself)

For further details, see section Hash Calculation.