Report Request
Webstore delivers the request parameters in a <form>
using POST method as hidden input fields (<input type=hidden>
) to address https://www.maksuturva.fi/GetCompensationsByTimeInterval.pmt (or https://test1.maksuturva.fi/GetCompensationsByTimeInterval.pmt in test environment)
Note! All Svea Payments server-to-server APIs require HTTP Basic Authentication.
Skip to contents in this page
- 1 Response ( GET_SETTLEMENTS_XML )
- 2 Response example ( GET_BALANCE_SETTLEMENTS_CSV )
- 3 Response example ( GET_INVOICE_SETTLEMENTS_JSON, GET_B2B_INVOICE_SETTLEMENTS_JSON )
- 4 Response example ( GET_INVOICE_SETTLEMENTS_CSV, GET_B2B_INVOICE_SETTLEMENTS_CSV)
- 5 Response example ( GET_PART_PAYMENT_SETTLEMENTS_JSON )
- 6 Response example ( GET_PART_PAYMENT_SETTLEMENTS_JSON )
Input name | Value | Format | Min length | C/O | Description |
---|---|---|---|---|---|
| Bundled or Individual Settlements: Balance Settlements: Invoice, B2B Invoice or Part Payment Settlements: | AN50 | 4 | C | Action name that determines response’s
and
|
|
| AN4 | 4 | C | Version of interface content or message |
|
| AN15 |
| C | Technical seller id given to the webstore by Svea Payments. |
| dd.MM.yyyy | AN10 | 10 | C | Begin date |
| dd.MM.yyyy | AN10 | 10 | C | End date |
| Default: | N3 |
| C | Secret key generation or version related to the technical seller id. |
The note ANxx means that the field contains a maximum of xx alphanumeric characters. N means numeric. C means that the field is compulsory and O means it is optional.
The interval between begin date and end date can be one month at maximum.
Response ( GET_SETTLEMENTS_XML )
XML contents are best described through an example
<?xml version="1.0" encoding="UTF-8"?>
<getCompensationsResponse>
<!--Available versions: 0001-0003-->
<version>0003</version>
<timestamp>2024-01-09T09:16:00+02:00</timestamp>
<sellerId>ABCD1234</sellerId>
<resultCode>00</resultCode>
<resultText>OK</resultText>
<keyGeneration>001</keyGeneration>
<compensations>
<!--BUNDLE EXAMPLE-->
<!--One or more repetitions:-->
<compensation>
<!--Optional: Contains the compensation (bundle) code. Exists only if this is an actual bundle (compensationType = BUNDLE).-->
<compensationCode>10000000000000700000</compensationCode>
<!--BUNDLE = many orders are included in this bundle-->
<compensationType>BUNDLE</compensationType>
<compensationDate>2023-11-15T00:00:00+02:00</compensationDate>
<reference>99990000000000191247</reference>
<!--The gross amount of all orders included in the bundle. This is the value originally expected by the web store.-->
<grossAmount>529.35</grossAmount>
<!--The actual compensated amount of all orders included in the bundle-->
<netAmount>410.95</netAmount>
<!--The actual amount refunded to payers of all orders included in the bundle-->
<refundedAmount>108.95</refundedAmount>
<!--Svea Payments commissions of all orders included in the bundle (Version 2)-->
<commission>9.45</commission>
<!--The VAT amounts of Svea Payments commissions of all orders included in the bundle (Version 2)-->
<commissionVat>1.54</commissionVat>
<orders>
<!--One or more repetitions: If this is not a bundle, there will be just one order below-->
<order>
<!--Optional: Value, if this order is part of a bundle compensation-->
<bundleCode>10000000000000700000</bundleCode>
<!--Order number from the web store (pmt_orderid)-->
<orderNumber>2006</orderNumber>
<!--The original reference number for the order, provided by the web store (pmt_reference)-->
<originalReference>00000002365691421113</originalReference>
<!--The unique id originally provided by the web store (pmt_id)-->
<paymentId>1006</paymentId>
<!--The gross amount of the order originally expected by the web store (pmt_amount + pmt_sellercosts)-->
<sellerGrossAmount>199</sellerGrossAmount>
<!--The actual compensated net amount, which is: gross amount – refunds – commissions-->
<sellerNetAmount>138.5</sellerNetAmount>
<!--The amount refunded back to payer-->
<refundedAmount>59</refundedAmount>
<!--Svea Payments commission-->
<commission>1.5</commission>
<!--The VAT amount of Svea Payments commission (Version 2)-->
<commissionVat>0.00</commissionVat>
<!--The VAT rate of Svea Payments commission (Version 2)-->
<commissionVatRate>0</commissionVatRate>
<buyerPaymentDateTime>2023-11-11T00:00:00+02:00</buyerPaymentDateTime>
<!--The payment method code (Version 3)-->
<paymentMethod>FIOB</paymentMethod>
<!--The payment method group (Version 3)-->
<paymentMethodGroup>BANK_PAYMENTS</paymentMethodGroup>
</order>
<order>
<bundleCode>10000000000000700000</bundleCode>
<orderNumber>2007</orderNumber>
<originalReference>02310281352439178221</originalReference>
<paymentId>1007</paymentId>
<sellerGrossAmount>330.35</sellerGrossAmount>
<sellerNetAmount>272.45</sellerNetAmount>
<refundedAmount>49.95</refundedAmount>
<commission>7.95</commission>
<commissionVat>1.54</commissionVat>
<commissionVatRate>24</commissionVatRate>
<buyerPaymentDateTime>2023-11-11T00:00:00+02:00</buyerPaymentDateTime>
<paymentMethod>FIBI</paymentMethod>
<paymentMethodGroup>SVEA_B2B_INVOICE</paymentMethodGroup>
</order>
</orders>
</compensation>
<!--SINGLE EXAMPLE-->
<compensation>
<!--SINGLE = this “bundle” is a compensation of a single order -->
<compensationType>SINGLE</compensationType>
<compensationDate>2023-11-15T00:00:00+02:00</compensationDate>
<reference>99990000000000191247</reference>
<grossAmount>330.35</grossAmount>
<netAmount>272.45</netAmount>
<refundedAmount>49.95</refundedAmount>
<commission>7.95</commission>
<commissionVat>1.54</commissionVat>
<!--Optional: If Contains the compensation (bundle) code. Exists only if this is an actual bundle (compensationType = BUNDLE).
<commissionVatRate>24</commissionVatRate>
<orders>
<order>
<orderNumber>2007</orderNumber>
<originalReference>02310281352439178221</originalReference>
<paymentId>1007</paymentId>
<sellerGrossAmount>330.35</sellerGrossAmount>
<sellerNetAmount>272.45</sellerNetAmount>
<refundedAmount>49.95</refundedAmount>
<commission>7.95</commission>
<commissionVat>1.54</commissionVat>
<commissionVatRate>24</commissionVatRate>
<buyerPaymentDateTime>2023-11-11T00:00:00+02:00</buyerPaymentDateTime>
<paymentMethod>FIBI</paymentMethod>
<paymentMethodGroup>SVEA_B2B_INVOICE</paymentMethodGroup>
</order>
</orders>
</compensation>
<!--MARKETPLACE COMMISSION EXAMPLE-->
<compensation>
<compensationCode>10000000000000800000</compensationCode>
<compensationType>BUNDLE</compensationType>
<compensationDate>2023-11-16T00:00:00+02:00</compensationDate>
<reference>99990000000000191247</reference>
<grossAmount>680</grossAmount>
<netAmount>678.41</netAmount>
<refundedAmount>0.00</refundedAmount>
<commission>0.35</commission>
<commissionVat>0.00</commissionVat>
<!--Optional: Marketplace commissions sum (Version 3)-->
<marketplaceCommission>1.24</marketplaceCommission>
<orders>
<order>
<bundleCode>10000000000000800000</bundleCode>
<orderNumber>2008</orderNumber>
<originalReference>00000000000009028465</originalReference>
<paymentId>1008</paymentId>
<sellerGrossAmount>680</sellerGrossAmount>
<sellerNetAmount>678.41</sellerNetAmount>
<refundedAmount>0.00</refundedAmount>
<commission>0.35</commission>
<commissionVat>0.00</commissionVat>
<commissionVatRate>0</commissionVatRate>
<buyerPaymentDateTime>2023-11-12T00:00:00+02:00</buyerPaymentDateTime>
<paymentMethod>FIOB</paymentMethod>
<paymentMethodGroup>BANK_PAYMENTS</paymentMethodGroup>
<!--Optional: Marketplace commission (Version 3)-->
<marketplaceCommission>1.24</marketplaceCommission>
<!--Optional: Reference number of completed marketplace commission settlement (Version 3)-->
<marketplaceCommissionReference>99990000000000191247</marketplaceCommissionReference>
<!--Optional: Compensation date of completed marketplace commission settlement (Version 3)-->
<marketplaceCommissionCompensationDate>2023-11-16T00:00:00+02:00</marketplaceCommissionCompensationDate>
</order>
</orders>
</compensation>
</compensations>
</getCompensationsResponse>
Response example ( GET_BALANCE_SETTLEMENTS_CSV )
Response example ( GET_INVOICE_SETTLEMENTS_JSON, GET_B2B_INVOICE_SETTLEMENTS_JSON )
Both are same but on B2B Invoice the
customerName
element has company's name as value ( in InvoicecustomerName
is allways empty ).
{
"totalNrOfRows": 8,
"clientReports": [
{
"clientId": 10001,
"recipientTaxId": "20000008",
"recipientBankAccountNo": "FI8600000000000094 / NDEAFIHH",
"recipientBankAccountType": "IBAN",
"paymentReport": {
"sveaPaidAmountExcludingWithholding": 95098,
"sveaPaidAmountIncludingWithholding": 95098,
"openingBalanceDebt": 0,
"closingBalanceDebt": 0,
"nominalAmount": 96556,
"feeAmountExcludingVat": 1362,
"feeVatAmount": 96,
"numberOfRows": 8,
"currency": "EUR",
"vatGroups": [
{
"vatPercent": 2400,
"vatAmount": 96
}
]
},
"rows": [
{
"sveaCustomerId": 10000003,
"customerName": "",
"externalOrderNo": "100000000000000088",
"orderDate": "2022-09-01T00:00:00",
"sveaInvoiceNo": 1000009,
"sveaOrderNo": 20000008,
"nominalAmount": 11341119,
"sveaPaidAmount": 11174,
"totalFeeAmountExcludingVat": 163,
"totalFeeVatAmount": 12,
"paymentType": "Invoice",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 100000000009,
"rowType": "Order",
"fees": [
{
"sveaPaidAmount": -62,
"amountExcludingVat": 50,
"type": "Admin",
"vatAmount": 12,
"vatPercent": 2400
},
{
"sveaPaidAmount": -113,
"amountExcludingVat": 113,
"type": "Credit",
"vatAmount": 0,
"vatPercent": 0
}
],
"reconciliationDate": "2022-09-02T00:00:00"
},
{
"sveaCustomerId": 10000004,
"customerName": "",
"externalOrderNo": "100000000000000048",
"orderDate": "2022-09-01T00:00:00",
"sveaInvoiceNo": 1000070,
"sveaOrderNo": 20000003,
"nominalAmount": 7537,
"sveaPaidAmount": 7400,
"totalFeeAmountExcludingVat": 125,
"totalFeeVatAmount": 12,
"paymentType": "Invoice",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 100000000070,
"rowType": "Order",
"fees": [
{
"sveaPaidAmount": -62,
"amountExcludingVat": 50,
"type": "Admin",
"vatAmount": 12,
"vatPercent": 2400
},
{
"sveaPaidAmount": -75,
"amountExcludingVat": 75,
"type": "Credit",
"vatAmount": 0,
"vatPercent": 0
}
],
"reconciliationDate": "2022-09-02T00:00:00"
},
{
"sveaCustomerId": 10000005,
"customerName": "",
"externalOrderNo": "100000000000000094",
"orderDate": "2022-09-01T00:00:00",
"sveaInvoiceNo": 1000001,
"sveaOrderNo": 20000008,
"nominalAmount": 5839,
"sveaPaidAmount": 5719,
"totalFeeAmountExcludingVat": 108,
"totalFeeVatAmount": 12,
"paymentType": "Invoice",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 100000000071,
"rowType": "Order",
"fees": [
{
"sveaPaidAmount": -62,
"amountExcludingVat": 50,
"type": "Admin",
"vatAmount": 12,
"vatPercent": 2400
},
{
"sveaPaidAmount": -58,
"amountExcludingVat": 58,
"type": "Credit",
"vatAmount": 0,
"vatPercent": 0
}
],
"reconciliationDate": "2022-09-02T00:00:00"
},
{
"sveaCustomerId": 10000009,
"customerName": "",
"externalOrderNo": "100000000000000024",
"orderDate": "2022-09-01T00:00:00",
"sveaInvoiceNo": 1000072,
"sveaOrderNo": 20000096,
"nominalAmount": 13542229,
"sveaPaidAmount": 13352,
"totalFeeAmountExcludingVat": 185,
"totalFeeVatAmount": 12,
"paymentType": "Invoice",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 100000000072,
"rowType": "Order",
"fees": [
{
"sveaPaidAmount": -62,
"amountExcludingVat": 50,
"type": "Admin",
"vatAmount": 12,
"vatPercent": 2400
},
{
"sveaPaidAmount": -135,
"amountExcludingVat": 135,
"type": "Credit",
"vatAmount": 0,
"vatPercent": 0
}
],
"reconciliationDate": "2022-09-02T00:00:00"
},
{
"sveaCustomerId": 10000021,
"customerName": "",
"externalOrderNo": "100000000000000009",
"orderDate": "2022-09-02T00:00:00",
"sveaInvoiceNo": 1000073,
"sveaOrderNo": 20000044,
"nominalAmount": 14548,
"sveaPaidAmount": 14341,
"totalFeeAmountExcludingVat": 195,
"totalFeeVatAmount": 12,
"paymentType": "Invoice",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 100000000073,
"rowType": "Order",
"fees": [
{
"sveaPaidAmount": -62,
"amountExcludingVat": 50,
"type": "Admin",
"vatAmount": 12,
"vatPercent": 2400
},
{
"sveaPaidAmount": -145,
"amountExcludingVat": 145,
"type": "Credit",
"vatAmount": 0,
"vatPercent": 0
}
],
"reconciliationDate": "2022-09-02T00:00:00"
},
{
"sveaCustomerId": 10000044,
"customerName": "",
"externalOrderNo": "100000000000000057",
"orderDate": "2022-09-02T00:00:00",
"sveaInvoiceNo": 1000074,
"sveaOrderNo": 20000080,
"nominalAmount": 16343339,
"sveaPaidAmount": 16124,
"totalFeeAmountExcludingVat": 213,
"totalFeeVatAmount": 12,
"paymentType": "Invoice",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 100000000074,
"rowType": "Order",
"fees": [
{
"sveaPaidAmount": -62,
"amountExcludingVat": 50,
"type": "Admin",
"vatAmount": 12,
"vatPercent": 2400
},
{
"sveaPaidAmount": -163,
"amountExcludingVat": 163,
"type": "Credit",
"vatAmount": 0,
"vatPercent": 0
}
],
"reconciliationDate": "2022-09-02T00:00:00"
},
{
"sveaCustomerId": 10000088,
"customerName": "",
"externalOrderNo": "100000000000000051",
"orderDate": "2022-09-02T00:00:00",
"sveaInvoiceNo": 1000075,
"sveaOrderNo": 20000035,
"nominalAmount": 4038,
"sveaPaidAmount": 3936,
"totalFeeAmountExcludingVat": 90,
"totalFeeVatAmount": 12,
"paymentType": "Invoice",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 100000000075,
"rowType": "Order",
"fees": [
{
"sveaPaidAmount": -62,
"amountExcludingVat": 50,
"type": "Admin",
"vatAmount": 12,
"vatPercent": 2400
},
{
"sveaPaidAmount": -40,
"amountExcludingVat": 40,
"type": "Credit",
"vatAmount": 0,
"vatPercent": 0
}
],
"reconciliationDate": "2022-09-02T00:00:00"
},
{
"sveaCustomerId": 10000006,
"customerName": "",
"externalOrderNo": "100000000000000032",
"orderDate": "2022-09-02T00:00:00",
"sveaInvoiceNo": 1000076,
"sveaOrderNo": 20000091,
"nominalAmount": 23347,
"sveaPaidAmount": 23052,
"totalFeeAmountExcludingVat": 283,
"totalFeeVatAmount": 12,
"paymentType": "Invoice",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 100000000076,
"rowType": "Order",
"fees": [
{
"sveaPaidAmount": -62,
"amountExcludingVat": 50,
"type": "Admin",
"vatAmount": 12,
"vatPercent": 2400
},
{
"sveaPaidAmount": -233,
"amountExcludingVat": 233,
"type": "Credit",
"vatAmount": 0,
"vatPercent": 0
}
],
"reconciliationDate": "2022-09-02T00:00:00"
},
{
"nominalAmount": 0,
"sveaPaidAmount": 19500,
"totalFeeAmountExcludingVat": 0,
"totalFeeVatAmount": 0,
"paymentType": "Invoice",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"comment": "ClosingBalanceDebt",
"rowType": "ClosingBalanceDebt",
"reconciliationDate": "2023-03-31T00:00:00"
}
],
"reconciliationDate": "2022-09-02T00:00:00"
}
]
}
Response example ( GET_INVOICE_SETTLEMENTS_CSV, GET_B2B_INVOICE_SETTLEMENTS_CSV)
Both are same but on B2B Invoice the
customerName
element has company's name as value ( in InvoicecustomerName
is allways empty ).
Response example ( GET_PART_PAYMENT_SETTLEMENTS_JSON )
{
"totalNrOfRows": 179,
"clientReports": [
{
"clientId": 10002,
"recipientTaxId": "2000009",
"recipientBankAccountNo": "",
"recipientBankAccountType": "None",
"paymentReport": {
"sveaPaidAmountExcludingWithholding": 917094,
"sveaPaidAmountIncludingWithholding": 917094,
"openingBalanceDebt": 0,
"closingBalanceDebt": 0,
"nominalAmount": 917094,
"feeAmountExcludingVat": 0,
"feeVatAmount": 0,
"numberOfRows": 39,
"currency": "EUR",
"vatGroups": []
},
"rows": [
{
"sveaCustomerId": 50006,
"customerName": "",
"externalOrderNo": "10000000000029",
"orderDate": "2022-09-26T00:00:00",
"sveaOrderNo": 20000099,
"nominalAmount": 15149,
"sveaPaidAmount": 15149,
"totalFeeAmountExcludingVat": 0,
"totalFeeVatAmount": 0,
"paymentType": "PaymentPlan",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 1000000016,
"rowType": "Order",
"fees": [],
"reconciliationDate": "2022-10-04T00:00:00"
},
{
"sveaCustomerId": 50007,
"customerName": "",
"externalOrderNo": "10000000000032",
"orderDate": "2022-09-26T00:00:00",
"sveaOrderNo": 20000058,
"nominalAmount": 4380,
"sveaPaidAmount": 4380,
"totalFeeAmountExcludingVat": 0,
"totalFeeVatAmount": 0,
"paymentType": "PaymentPlan",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 1000000017,
"rowType": "Order",
"fees": [],
"reconciliationDate": "2022-10-04T00:00:00"
},
{
"sveaCustomerId": 40009,
"customerName": "",
"externalOrderNo": "10000000000069",
"orderDate": "2022-09-17T00:00:00",
"sveaOrderNo": 20000045,
"nominalAmount": -16900,
"sveaPaidAmount": -16900,
"totalFeeAmountExcludingVat": 0,
"totalFeeVatAmount": 0,
"paymentType": "PaymentPlan",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 1000000059,
"rowType": "Credit",
"fees": [],
"reconciliationDate": "2022-10-04T00:00:00"
},
{
"sveaCustomerId": 40008,
"customerName": "",
"externalOrderNo": "10000000000063",
"orderDate": "2022-09-20T00:00:00",
"sveaOrderNo": 20000011,
"nominalAmount": -129000,
"sveaPaidAmount": -129000,
"totalFeeAmountExcludingVat": 0,
"totalFeeVatAmount": 0,
"paymentType": "PaymentPlan",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 1000000068,
"rowType": "Credit",
"fees": [],
"reconciliationDate": "2022-10-04T00:00:00"
},
{
"sveaCustomerId": 50001,
"customerName": "",
"externalOrderNo": "10000000000065",
"orderDate": "2022-09-21T00:00:00",
"sveaOrderNo": 20000021,
"nominalAmount": -8900,
"sveaPaidAmount": -8900,
"totalFeeAmountExcludingVat": 0,
"totalFeeVatAmount": 0,
"paymentType": "PaymentPlan",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 1000000011,
"rowType": "Credit",
"fees": [],
"reconciliationDate": "2022-10-04T00:00:00"
},
{
"sveaCustomerId": 50002,
"customerName": "",
"externalOrderNo": "10000000000037",
"orderDate": "2022-09-22T00:00:00",
"sveaOrderNo": 20000092,
"nominalAmount": -37280,
"sveaPaidAmount": -37280,
"totalFeeAmountExcludingVat": 0,
"totalFeeVatAmount": 0,
"paymentType": "PaymentPlan",
"currency": "EUR",
"destinationCurrency": "EUR",
"exchangeRate": 1.0,
"deliveryId": 1000000040,
"rowType": "Credit",
"fees": [],
"reconciliationDate": "2022-10-04T00:00:00"
}
],
"reconciliationDate": "2022-10-04T00:00:00"
}
]
}
Response example ( GET_PART_PAYMENT_SETTLEMENTS_JSON )
Svea Payments Oy
info.payments@svea.fi
+358 9 4241 7050 (weekdays 8:00 - 16:00)
Saavutettavuusseloste