This documentation is deprecated and only available for supporting old/legacy integrations using for example hashes.">This documentation is deprecated and only available for supporting old/legacy integrations using for example hashes.

New documentation can be found here: [DOCS:Home]">New documentation can be found here: [DOCS:Home]



Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Current »

In cases where payer chooses specific payment method in the webstore, the available payment methods must be queried online for each order. This is essential, since the available payment methods depend on the total amount of the order. Some payment methods include restrictions regarding the total amount (min and max). To tackle this, the API contains a parameter total amount which dictates what payment methods are to be included in the response. In other words, in case of small (e.g. below 70 €) and large (e.g. over 2000 €) orders some of the payment methods are not available for the buyer to choose from. At the moment, only bank, card and mobile payment methods are always available regardless the total amount of the order. However, if web store has net settlements in use, each order's total amount must exceed the minimum transaction fee. This is not applicable when web store uses gross settlements where transaction fees are billed afterwards by invoice.

The payment method codes (<code>) values of the response are then used in Payment interface call as the value of parameter pmt_paymentmethod.

Skip to contents in this page

Get Payment Methods

The available payment methods can be retrieved (using either GET or POST) from address https://www.maksuturva.fi/GetPaymentMethods.pmt (or https://test1.maksuturva.fi/GetPaymentMethods.pmt in the testing environment).

REQUEST

Field

Input name

Value

Format

min length

C/O

Seller ID

sellerid

AN15

4

C

Language of the payment method display name

request_locale

fi, sv, en, de, pl
Default: fi

A2

2

O

The total amount of the order that the buyer is about to pay, including all the costs.

totalamount

e.g. 47,50

AN17

2

O

RESPONSE

The response (XML document) is returned as direct response to the HTTP GET/POST request.

Field

Tag name

Tag value and attributes

Format

min length

C/O

Response language

language

Same as in the request

A2

2

C

Text for displaying general terms and conditions to the buyer

This is only present in cases where the Buyer’s Assistant is in use!

termstext

AN

O

Link to general terms and conditions

This is only present in cases where the Buyer’s Assistant is in use!

termsurl

AN

O

Flag telling whether given payment method supports marketplace commission or not. See the example below. If this is false, the pmt_marketplacecommission must be 0,00 in the new payment request.

This can be ignored in most cases since it is omitted from the response if marketplace commission is not applicable in the payment service being used.

paymentmethod
attr: supports\
MarketplaceCommission

true or false

AN

4

O

Payment method code

This value is used in Payment interface call as the value of parameter pmt_paymentmethod.

code

e.g. FI01 or USPP

AN4

4

C

Payment method display name

displayname

AN80

C

A link to the payment method image if it is available in the requested language.

The attributes tell image file mime type and also image size in pixels when pixel size is applicable. That is, the file type is not a vector image.

imageurl
attr: mimetype
attr: width
attr: height

AN512

O

Extra payment method fee that is added to the payment total amount.

Important! This is only applicable in cases where the web store has agreed upon an extra fee for some payment methods. It is not recommended to use this feature but in cases where extra fee cannot be added in the web store, we have this one solution for it.

If this value is present in the response, web store software must take it into account when handling new payment OK response. That is, OK response's pmt_sellercosts value is larger than the value web store sent in original payment request. It is increased by this extra payment method fee amount if the payer chose this payment method.

extrapaymentmethodfee
attr: currency

e.g. 5,00
e.g. EUR

AN16

4

O

Request example (GET):

https://www.maksuturva.fi/GetPaymentMethods.pmt?sellerid=SELLERID&request_locale=fi&totalamount=47,50

https://www.maksuturva.fi/GetPaymentMethods.pmt?sellerid=SELLERID&request_locale=en&totalamount=512,89

Response examples:

Please notice that the three dots "..." are not part of the actual response.

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<paymentmethods>
    <language>en</language>
    <termstext>By using Maksuturvas payment service you agree to the terms of service</termstext>
    <termsurl>https://www.maksuturva.fi/documents/Maksuturva_General_Terms_and_Conditions_(customer).pdf</termsurl>
    ...
    <paymentmethod>
        <code>FI72</code>
        <displayname>B2B Invoice</displayname>
        <imageurl height="80" mimetype="image/png" width="150">https://www.maksuturva.fi/public_img/paymentmethods/FI72_en.png</imageurl>
        <extrapaymentmethodfee currency="EUR">5,00</extrapaymentmethodfee>
    </paymentmethod>
    ...
    <paymentmethod>
        <code>USPP</code>
        <displayname>PayPal</displayname>
        <imageurl height="80" mimetype="image/png" width="80">https://www.maksuturva.fi/public_img/paymentmethods/USPP_en.png</imageurl>
    </paymentmethod>
    ...
    <paymentmethod>
        <code>FI50</code>
        <displayname>Card payment (Visa, Visa Electron, MasterCard)</displayname>
        <imageurl height="80" mimetype="image/png" width="150">https://www.maksuturva.fi/public_img/paymentmethods/FI50_en.png</imageurl>
    </paymentmethod>
    ...
    <paymentmethod>
        <code>FI01</code>
        <displayname>Nordea E-payment</displayname>
        <imageurl height="80" mimetype="image/png" width="80">https://www.maksuturva.fi/public_img/paymentmethods/FI01_en.png</imageurl>
    </paymentmethod>
    ...
    <paymentmethod>
        <code>FI06</code>
        <displayname>Cooperative Bank E-payment</displayname>
        <imageurl height="80" mimetype="image/png" width="80">https://www.maksuturva.fi/public_img/paymentmethods/FI06_en.png</imageurl>
    </paymentmethod>
    ...
</paymentmethods>
 
An example with attribute supportsMarketplaceCommission:
 
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<paymentmethods>
    <language>en</language>
    <termstext>By using Maksuturvas payment service you agree to the terms of service</termstext>
    <termsurl>https://www.maksuturva.fi/documents/Maksuturva_General_Terms_and_Conditions_(customer).pdf</termsurl>
    ...
    <paymentmethod supportsMarketplaceCommission="false">
        <code>FI72</code>
        <displayname>B2B Invoice</displayname>
        <imageurl height="80" mimetype="image/png" width="150">https://www.maksuturva.fi/public_img/paymentmethods/FI72_en.png</imageurl>
        <extrapaymentmethodfee currency="EUR">5,00</extrapaymentmethodfee>
    </paymentmethod>
    ...
    ...
    <paymentmethod supportsMarketplaceCommission="true">
        <code>FI01</code>
        <displayname>Nordea E-payment</displayname>
        <imageurl height="80" mimetype="image/png" width="80">https://www.maksuturva.fi/public_img/paymentmethods/FI01_en.png</imageurl>
    </paymentmethod>
    ...
</paymentmethods>

  • No labels

This documentation is deprecated and only available for supporting old/legacy integrations using for example hashes.">This documentation is deprecated and only available for supporting old/legacy integrations using for example hashes.

New documentation can be found here: [DOCS:Home]">New documentation can be found here: [DOCS:Home]