This interface enables webstore to retrieve reports of settlements.

Report Content

The response can be for example an JSON, XML, CSV or XLS (Excel) document. There might be some other formats available also, ask for more details if needed. JSON, XML and XLS file encoding is always UTF-8 whereas CSV file encoding is ISO-8859-15.

Details regarding Invoice, B2B Invoice and Part Payment responses

Response contains daily settlements to selected payment method from the selected time interval. The requested time interval must not contain current or future dates. Maximum allowed time interval is one month.

Responses can be requested in JSON or CSV format with payment method and format specific gc_action value.

JSON is machine readable hierarchical data format. CSV contains the same settlement data but in tabular ( excel ) form.

Details regarding XML response (applies only to GET_SETTLEMENTS_XML)

The exact definition of the XML response (gc_action=GET_SETTLEMENTS_XML) 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 can be settled daily, or once a 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 (- Marketplace commissions)

• the amount refunded back to payers

• Svea Payments commission sum

• the VAT amount sum of Svea Payments commission (since version 2)

• the VAT rate of Svea Payments commission (since version 2)

• the optional Marketplace commission sum (since version 3)

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 commission (- Marketplace commission)

• the amount refunded back to payer

• Svea Payments commission

• the VAT amount of Svea Payments commission (since version 2)

• the VAT rate of Svea Payments commission (since version 2)

• the payment method code (since version 3)

• the payment method group (since version 3)

• the optional marketplace commission (since version 3)

• the optional reference number of completed marketplace commission settlement (Version 3)

• the optional compensation date of completed marketplace commission settlement (Version 3)

About testing

To test this interface, you should acquire individual test credentials, make some payments using them, add delivery info if needed and then mark those payments as settled (feature available only in test environment) using Extranet. After this, the aforementioned payments should appear in the settlement report response. The same goes for testing the reports that can be downloaded from the Extranet.

Skip to contents in this page