Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Please notice, that this service is intended to be used by webstore software providers that provide their hosting services for multiple webstores. This service enables webstore software providers to offer webstores seamless and easy integration to Svea Payments as their Payment Service Provider. In other words, a single webstore does not gain anything from integrating this service. Furthermore, this service requires use of a webstore software provider ID which is different kind of credentials than webstore ID used for example in Payments API.

Webstore software provider can send information about the webstore using this interface for faster and simpler webstore subscription and deployment procedure at Svea Payments. Webstore fills in the missing information and makes his choices regarding Svea Payments services and finally signs the subscription using Internet banking credentials (TUPAS) or orders paper contracts by mail for signing.

The response message indicates following result scenarios:

  • Created a new customer and a new payment service

  • Added a new payment service for existing customer

  • Payment service creation failed. Detailed error reason and description are included in the response.

Table of Contents

Subscription Request

Webstore software delivers information about the webstore, the company running the webstore and service parameters in a <form> using POST method as hidden input fields (<input type=hidden>) to address https://www.maksuturva.fi/MerchantSubscription.pmt (or https://test1.maksuturva.fi/MerchantSubscription.pmt in test environment).

Field

Input name

Value

Format

Min length

C/O

Description

Interface version

srv_version

0002

AN4

4

C

Interface version of this subscription message

Webstore software provider’s account for subscribing for new Svea Payments services

srv_webstoreserviceid

AN15

1

C

The user account for webstore software provider.

Finnish business identification code of the company running the webstore

srv_businessid

AN15

9

O

Finnish business identification code of the company running the webstore

Name of the company

srv_businessname

AN80

1

O

The official name of the company running the webstore

Marketing name of the company

srv_marketingname

AN80

1

O

Marketing name of the company (for example used with postal packages)

WWW address of the company (not the webstore!)

srv_businesswww

AN200

4

O

WWW address of the company (not the webstore!)

E-mail of the company

srv_businessemail

AN80

4

O

E-mail of the company

Phone number of the company

srv_businessphone

AN40

1

O

Phone number of the company

Fax number of the company

srv_businessfax

AN40

1

O

Fax number of the company

Default bank account of the webstore (IBAN)

srv_webstoreiban

AN30

18

O

Default bank account of the webstore (IBAN). This is the account that will receive compensations from Svea Payments Oy.

Account number must be a Finnish bank account in IBAN form.

Name of the webstore

srv_webstorename

AN80

1

C

Name of the webstore (will be shown to buyers in Svea Payments service)

WWW address of the webstore

srv_webstorewww

AN200

4

O

WWW address of the webstore (will be shown to buyers in Svea Payments service)

Webstore customer service contact information

srv_webstorecustomerservice

AN100

1

O

Webstore customer service contact information.

This will be part of confirmation and other e-mails sent to buyers from Svea Payments service. This must be comprehensible by Finnish, Swedish and English speaking persons.

Example:  ”info@verkkokauppa.fi, (09) 123 4567”.

Street address of the company

srv_businessaddress

AN100

5

O

Street address of the company running the webstore

P.O.box of the company

srv_businesspobox

AN10

4

O

P.O.box of the company

Postal code of the company

srv_businesspostalcode

AN5

5

O

Postal code of the company

City of the company

srv_businesscity

AN40

1

O

City of the company

Country (code) of the company

srv_businesscountrycode

AN2

2

O

Country (code) of the company. Based on ISO 3166-1 standard. Default:  FI

Billing address of the company

srv_billingaddress

AN100

5

O

Billing street address of the company running the webstore.

Billing address information must be given, if it’s different from company’s generic address information described above.

Billing P.O.box of the company

srv_billingpobox

AN10

4

O

Billing P.O.box of the company

Billing postal code of the company

srv_billingpostalcode

AN5

5

O

Billing postal code of the company

Billing city of the company

srv_billingcity

AN40

1

O

Billing city of the company

Billing country (code) of the company

srv_billingcountrycode

AN2

2

O

Billing country of the company. Based on ISO 3166-1 standard. Default:  FI

Street address of the webstore

srv_webstoreaddress

AN100

1

O

Street address of the webstore.

Webstore’s address information must be given, if it’s different from company’s default address.

P.O.box of the webstore

srv_webstorepobox

AN10

4

O

P.O.box of the webstore

Postal code of the webstore

srv_webstorepostalcode

AN5

1

O

Postal code of the webstore

City of the webstore

srv_webstorecity

AN40

1

O

City of the webstore

Country (code) of the webstore

srv_webstorecountrycode

AN2

1

O

Country of the webstore. Based on ISO 3166-1 standard. Default:  FI

Name of the company’s contact person

srv_contactpersonname

AN80

1

O

Name of the company’s contact person (used by Svea Payments Oy to contact the company).

E-mail of the company’s contact person

srv_contactpersonemail

AN80

4

O

E-mail of the company’s contact person

Phone number of the company’s contact person

srv_contactpersonphone

AN40

1

O

Phone number of the company’s contact person

Mobile phone number of the company’s contact person

srv_contactpersonmobile

AN40

1

O

Mobile phone number of the company’s contact person

Fax number of the company’s contact person

srv_contactpersonfax

AN40

1

O

Fax of the company’s contact person

Name of the company’s billing contact person

srv_billingpersonname

AN80

1

O

Name of the company’s billing contact person (used by Svea Payments Oy to contact the company in billing issues).

E-mail of the company’s billing contact person

srv_billingpersonemail

AN80

4

O

E-mail of the company’s billing contact person

Phone number of the company’s billing contact person

srv_billingpersonphone

AN40

1

O

Phone number of the company’s billing contact person

Mobile phone number of the company’s billing contact person

srv_billingpersonmobile

AN40

1

O

Mobile phone number of the company’s billing contact person

Fax number of the company’s billing contact person

srv_billingpersonfax

AN40

1

O

Fax of the company’s billing contact person

Name of the company’s technical contact person

srv_webstorepersonname

AN80

1

O

Name of the company’s technical contact person (used by Svea Payments Oy to contact the company in technical issues).

E-mail of the company’s technical contact person

srv_webstorepersonemail

AN80

4

O

E-mail of the company’s technical contact person

Phone number of the company’s technical contact person

srv_webstorepersonphone

AN40

1

O

Phone number of the company’s technical contact person

Mobile phone number of the company’s technical contact person

srv_webstorepersonmobile

AN40

1

O

Mobile phone number of the company’s technical contact person

Fax number of the company’s technical contact person

srv_webstorepersonfax

AN40

1

O

Fax of the company’s technical contact person

Payment methods for the webstore

srv_paymentmethodinfo

AN200

1

O

Codes for payment methods that the webstore desires to use via Svea Payments service. Possible codes can be found in section Payment Method Codes.

 

The first character of the field defines a separator, and may not be part of any payment method code. Recommended is semicolon ( ; ). The first character must be a separator, even if the field data contains only one payment method code.

If this field is not present, the service will be assigned all available payment methods.

Delivery methods for the webstore

srv_deliverymethodinfo

AN200

1

O

Codes for delivery methods that the webstore desires to use with Svea Payments service. Possible codes can be found in section Delivery Method Codes.

 

The first character of the field defines a separator, and may not be part of any delivery method code. Recommended is semicolon ( ; ). The first character must be a separator, even if the field data contains only one delivery method code.

If this field is not present, the service will be assigned all available delivery methods.

Service begin date for the webstore’s Svea Payments service

srv_servicebegindate

dd.mm.yyyy

AN10

10

O

Desired service begin date for the webstore’s Svea Payments service.

If this is not given, service will start immediately when the agreement has been signed and handled by Svea Payments Oy.

Campaign code

srv_campaigncode

AN10

5

O

NOT IN USE. Might affect service agreement details and/or the pricing.

Additional information about the subscription

srv_additionalinformation

AN2000

1

O

Free form field for additional information.

Desired response type

srv_resptype

POST

AN4

3

O

Defines the format of response. Choices are: POST / XML.

Only POST is supported currently. This means: the user’s browser is redirected back to webstore software provider’s site according to given OK, return and cancel URLs.

Ok return url

srv_okreturn

AN200

11

C

The URL, where the browser is redirected after a successful service subscription.

Must include protocol (http/https).

Error return url

srv_errorreturn

AN200

11

O

The URL, where the browser is redirected after an erroneous service subscription.

Must include protocol (http/https).

Cancel return url

srv_cancelreturn

AN200

11

O

The URL, where the browser is redirected if the user cancels the service subscription.

Must include protocol (http/https).

Charset for calculating the hash

srv_charset

ISO-8859-1,
ISO-8859-15 or
UTF-8

AN15

5

O

Defines, which character set has been used to calculate the hash.

Choices are: ISO-8859-1, ISO-8859-15 and UTF-8, default is ISO-8859-1.

Hash algorithm

srv_hashversion

AN10

1

C

Algorithm for calculating the hash.

For more information, see ”Svea Payments Interface Integration Guidelines” document.

Hash

srv_hash

AN128

32

C

Hash calculated from predefined message fields and the webstore software provider's secret key. The following fields are used to calculate the hash:

  •  srv_webstorewww

 

For more details, see section Hash Calculation.

Secret key generation

srv_keygeneration

Default: 001

N3

1

C

Generation of the secret key (first key is 001)

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.