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)
Field | input name | value | Format | min lenght | C/O |
---|---|---|---|---|---|
Action code | gc_action | GET_SETTLEMENTS_XML GET_SETTLEMENTS_CSV GET_SETTLEMENTS_XLS | AN50 | 4 | C |
Message version | gc_version | 0001 | AN4 | 4 | C |
Seller ID | gc_sellerid | AN15 | C | ||
Begin date | gc_begindate | dd.MM.yyyy | AN10 | 10 | C |
End date | gc_enddate | dd.MM.yyyy | AN10 | 10 | C |
Hash algorithm | gc_hashversion | e.g. SHA-256 | AN10 | C | |
Secret key generation | gc_keygeneration | Default: 001 | N3 | C | |
Hash | gc_hash | AN128 | 32 | C |
info
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.
About testing
Currently, testing of this interface is possible only when Svea Payments manually updates some test payment status to settled. Also, testing must be done using webstore specific testing credentials. That is, sandbox testing is currently not available. In any case, you should contact us for more information about testing this interface since it always requires Svea Payments participation.
Response example
XML contents are best described through an example
<?xml version="1.0" encoding="UTF-8"?>
<getCompensationsResponse>
<version>0001</version>
<timestamp>2010-05-30T09:30:10+02:00</timestamp>
<sellerId>ABCD1234</sellerId>
<resultCode>00</resultCode>
<resultText>OK</resultText>
<hashVersion>SHA-256</hashVersion>
<keyGeneration>001</keyGeneration>
<hash>e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855</hash>
<compensations>
<compensation>
<compensationCode>
contains the compensation code, IF this is an actual bundle (compensationType = BUNDLE), and not
a compensation of a single payment.
</compensationCode>
<compensationType>
SINGLE = this “bundle” is a compensation of a single order, BUNDLE = many orders are included in
this bundle.
</compensationType>
<compensationDate>2010-05-30T00:00:00+02:00</compensationDate>
<reference>12345123451234512345</reference>
<grossAmount>
the gross amount of all orders included in the bundle. This is the value originally expected by
the web store
</grossAmount>
<netAmount>the actual compensated amount </netAmount >
<refundedAmount>the actual amount refunded to payers </refundedAmount>
<commission>commission sum for Maksuturva</commission>
<orders>
... if this is not a bundle, there will be just one order below...
<order>
<bundleCode>
optional field. Included, if this order is part of a bundle compensation
</bundleCode>
<orderNumber> order number from the web store (pmt_orderid)</orderNumber>
<originalReference>
the original reference number for the order, provided by the web store
(pmt_reference)
</originalReference>
<paymentId>
the unique id originally provided by the web store (pmt_id)
</paymentId>
<sellerGrossAmount>
the gross amount of the order originally expected by the web store
(pmt_amount + pmt_sellercosts)
</sellerGrossAmount>
<sellerNetAmount>
the actual compensated net amount, which is:
gross amount – refunds – Maksuturva’s commissions
</sellerNetAmount>
<refundedAmount>
the amount refunded back to payer
</refundedAmount>
<commission>
Maksuturva’s commission sum
</commission>
<buyerPaymentDatetime>2010-05-30T09:30:10+02:00</buyerPaymentDatetime>
</order>
</orders>
</compensation>
<compensation>
another compensation...
</compensation>
</compensations>
</getCompensationsResponse>