Versions Compared

Key

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

Request (S2S HTTP POST)

Note that ANxx means that the field contains a maximum of xx alphanumeric characters. N means numeric. An optional field may be missing altogether, have an empty value or have a value of at least the minimum length. That is, minimum length does not make a field compulsory but when it is present in the request it must have at least the minimum length.

URL for testing is: https://test1.maksuturva.fi/NewPaymentExtended.pmt
Prodution: https://www.maksuturva.fi/NewPaymentExtended.pmt

Parameter name

Value

Format

Min length

Max length

Description

COMPULSORY PARAMETERS:
All of these must be present in the request.

pmt_action

NEW_PAYMENT_EXTENDED

AN50

4

50

Action name. Always NEW_PAYMENT_EXTENDED.

pmt_version

0004

AN4

4

4

Version of interface content or message

pmt_charsethttp

UTF-8

AN15

The character encoding of the input data.
The Svea Payments payment interface handles HTTP request parameters according to this character encoding. Please use only UTF-8. Even though ISO-8859-1 and ISO-8859-15 might also work, only UTF-8 data is preferred.

pmt_sellerid

AN15

Technical seller id given to the webstore by Svea Payments.

pmt_keygeneration

nnn
e.g. 001

N3

 

Secret key generation or version related to the technical seller id.
Default or initial value is 001.

pmt_id

AN20

Unique Payment Identifier given to the payment transaction by the webstore.

pmt_orderid

AN50

Order Identifier given to the order by the webstore. This should be known by the buyer.

pmt_reference

N20

4

20

The reference number (possibly) used when the payment is settled to the seller.

The reference number (4-20 digits) must comply with the guidelines (en, fi) for a formal reference number issued by the Federation of Finnish Financial Services (https://www.finanssiala.fi/). The reference number must be at least 4 digits, the last of which is a check digit.

Currently, Credit Reference or RF Reference format (RFnn nnnn …) is not supported.

pmt_amount

nnnnn,nn
e.g. 50,00 or 12500,90

AN17

4

The total gross sum of product row types 1, 4, 5 and 6 (pmt_row_typeN).
If the order does not contain any postal or handling cost rows (types 2 and 3), then this is the total amount of the order.
The amount must be presented with two decimals without thousands separator. The decimal delimiter is a comma, e.g. 94,80

Please notice that total amount to pay is actually pmt_amount + pmt_sellercosts.

See also: pmt_sellercosts, pmt_row_typeN

pmt_sellercosts

nnnnn,nn
e.g. 10,00 or 1024,90

AN17

4

The total gross sum of cost row types 2 and 3 (pmt_row_typeN).
The amount must be presented with two decimals without thousands separator. The decimal delimiter is a comma, e.g. 7,40

Please notice that total amount to pay is actually pmt_amount + pmt_sellercosts.

See also: pmt_amount, pmt_row_typeN

pmt_currency

e.g. EUR

AN3

3

3

Currency used for the payment.

pmt_okreturn

AN200

The confirmation URL
a) to which the buyer's browser will be directed to in case of confirmed payments
b) that is called in case of Svea’s server-to-server callback request

Please notice that this is mostly only a trigger to perform Payment Status Query .

pmt_errorreturn

AN200

The error URL to which the buyer's browser will be directed to if there an error occurs during the payment process. A query string parameter Payment ID (pmt_id) is appended to this URL before redirection.

Must have no effect on payments or orders that have been confirmed earlier using payment status query.

pmt_cancelreturn

AN200

The cancel URL to which the buyer's browser will be directed to if the buyer interrupts the paying process. A query string parameter Payment ID (pmt_id) is appended to this URL before redirection.

Must have no effect on payments or orders that have been confirmed earlier using payment status query.

pmt_buyeremail

AN320

Email address of buyer.

pmt_buyername

AN100

100

Name of buyer (billing)

pmt_buyeraddress

AN100

100

Address of buyer (billing). Street address or P.O. box

pmt_buyerpostalcode

N20

20

Postal code of buyer (billing)

pmt_buyercity

AN100

100

City of buyer (billing)

pmt_buyercountry

FI, SE, EN, ...

A2

2

2

Country code of buyer (billing)
(ISO 3166-1 alpha-2 standard based 2-character country code)

pmt_deliveryname

AN100

100

Name of recipient (delivery).

pmt_deliveryaddress

AN100

100

Address of recipient (delivery). Street address or P.O. box

The delivery address (pmt_deliveryaddress etc.) of each order must represent the real address to which the order is actually delivered. For example, if the buyer gives his home address the billing address (pmt_buyeraddress etc.) but chooses a delivery to a Parcel Point, the delivery address must be the Parcel Point's address.

pmt_deliverypostalcode

N20

20

Postal code of recipient (delivery)

pmt_deliverycity

AN100

100

City of recipient (delivery)

pmt_deliverycountry

FI, SE, EN, ...

A2

2

2

Country code of recipient (delivery)
(ISO 3166-1 alpha-2 standard based 2-character country code)

pmt_rows

N4

1

The count or number of order rows as an integer.

COMPULSORY YET IGNORED PARAMETERS:
These parameters are currently ignored, but validated to exist

pmt_delayedpayreturn

AN200

Deprecated. URL must be valid. Use for example same value as in pmt_cancelreturn.

pmt_escrow

Y or N

A1

1

1

Tells whether escrow option is used with this payment.

pmt_escrowchangeallowed

N

A1

1

1

Tells whether escrow option can be changed by the buyer. Currently always N.

OPTIONAL PARAMETERS:
An optional parameter may be missing altogether, have an empty value or have a value of at least the minimum length.

pmt_userlocale

fi_FI, sv_FI, en_FI(, de_FI, pl_FI, et_FI)

AN5

5

OPTIONAL. Buyer's (user's) locale. That is, information on the country and language of the buyer. ll_CC, where ll is a two character ISO 639-1 language code and CC is a two character ISO 3166 alpha-2 country code. The default fi_FI will be used if the locale is not given. For example sv_FI and en_FI will be accepted. In some cases also de_FI, pl_FI and et_FI might work.

pmt_paymentmethod

AN4

4

OPTIONAL. Payment method’s code.
Please check the possible values from chapter Payment Method Codes.

pmt_paymenturlexptime

e.g. 2023-02-13T13:03:07.776+02:00

AN

OPTIONAL. Expiration time for the payment URL ( in ISO OffsetDateTime format ). Expiration time is converted and stored in local time ( Europe/Helsinki ). Expiration time can be set max 2 months from payment create request time. Payment attempt with expired payment URL will result in error.

pmt_buyerphone

AN40

OPTIONAL. Phone number of buyer (billing)

pmt_buyeridentificationcode

AN11

9

OPTIONAL. Buyer’s social security number or company’s business identification code.

pmt_buyertype

PERSON_CUSTOMER, BUSINESS_CUSTOMER

AN50

OPTIONAL. Buyer type can be a person or a company. Together with related merchant service parameters this parameter can be used to select more appropriate web bank interface.

COMPULSORY ORDER ROW PARAMETERS (N=1,2,3,…):
That is, these are repeated N (=pmt_rows) times

Single row’s total amount: round( pmt_row_quantity * pmt_row_price_gross * ( 1 - 0.01 * pmt_row_discountpercentage ) )

pmt_row_nameN

AN40

1

40

Name of this order row.

In case of Invoice and B2B Invoice payment methods, these are shown in the invoice sent to the buyer.

Max length: 40 characters

pmt_row_descN

AN1000

1

1000

Currently recommended to be set as simply “-” (minus/short dash character, no quotation marks)

Detailed description of this order row. In case of Invoice and B2B Invoice payment methods, these are not shown in the invoice sent to the buyer.

pmt_row_quantityN

n,nn

AN10

1

The quantity of this order row. Preferably an integer value but also decimal number values with up to 2 decimal values are accepted. The decimal delimiter is a comma. For example: 1, 2 or 1,75

pmt_row_deliverydateN

dd.mm.yyyy

AN10

8

10

Order row delivery date of package or service in form dd.mm.yyyy.

Please set as current date, if there is no other logical value to use.

pmt_row_price_grossN

nnnnn,nn
e.g. 10,00 or 1024,90

AN17

4

Gross unit price (VAT included).
The amount must be presented with two decimals without thousands separator. The decimal delimiter is a comma. For example: 94,80

pmt_row_vatN

nn,nn
e.g. 24,00

AN5

4

5

VAT percentage. A decimal number with two decimal digits. The decimal delimiter is a comma. For example: 23,00 means ”23 %”

pmt_row_discountpercentageN

nn,nn
e.g. 10,00

AN5

4

6

Discount percentage. A decimal number with two decimal digits. The decimal delimiter is a comma. For example: 10,00 means ”10 %”

pmt_row_typeN

1 = product
2 = postal cost
3 = handling cost
4 = customized product (not eligible for returns)
5 = service
6 = discount

N5

1

1

Row type.

1 = product
2 = postal cost
3 = handling cost
4 = customized product (not eligible for returns)
5 = service
6 = discount (always negative value)

See also: pmt_amount, pmt_sellercosts

OPTIONAL ORDER ROW PARAMETERS (N=1,2,3,…):

pmt_row_articlenrN

AN100

1

100

OPTIONAL. Article or product number of this order row.

pmt_row_unitN

e.g. kpl or kg

AN3

1

3

OPTIONAL. Unit of quantity of this order row, e.g. kpl, kg, l, m

MARKETPLACE PARAMETERS:
These are supported only by separate agreement. Additional information available upon request.

pmt_marketplacecommission

nn,nn
e.g. 10,00

AN17

4

The commission amount reserved and to be settled to the marketplace.

pmt_marketplacereference

N20

4

20

OPTIONAL. The reference number (possibly) used when commission is settled to the marketplace.

Response (XML)

Success response

The success response is a XML document with root element <pmt>. The response contains information about the initiated payment (see table below).

Response value <pmt_paymenturl> is the address where the payer can be redirected instantly to continue the payment process.

Input name

Value

Format

C/O

Description

pmt_action

NEW_PAYMENT_EXTENDED

AN50

C

Action name. Always NEW_PAYMENT_EXTENDED.

pmt_version

0004

AN4

C

Version of interface content or message.

pmt_id

AN20

C

Unique Payment Identifier given to the payment transaction by the webstore.

pmt_reference

N20

C

The reference number (possibly) used when the payment is settled to the seller.

The reference number (4-20 digits) must comply with the guidelines (en, fi) for a formal reference number issued by the Federation of Finnish Financial Services (https://www.finanssiala.fi/). The reference number must be at least 4 digits, the last of which is a check digit.

Currently, Credit Reference or RF Reference format (RFnn nnnn …) is not supported.

pmt_amount

nnnnn,nn
e.g. 50,00 or 12500,90

AN17

C

The total gross sum of product row types 1, 4, 5 and 6 (pmt_row_typeN).
If the order does not contain any postal or handling cost rows (types 2 and 3), then this is the total amount of the order.
The amount must be presented with two decimals without thousands separator. The decimal delimiter is a comma, e.g. 94,80

Please notice that total amount to pay is actually pmt_amount + pmt_sellercosts.

See also: pmt_sellercosts

pmt_currency

e.g. EUR

AN3

C

Currency used for the payment.

pmt_sellercosts

nnnnn,nn
e.g. 10,00 or 1024,90

N17

O

The total gross sum of cost row types 2 and 3 (pmt_row_typeN).
The amount must be presented with two decimals without thousands separator. The decimal delimiter is a comma, e.g. 7,40

Please notice that total amount to pay is actually pmt_amount + pmt_sellercosts.

See also: pmt_amount

Optional Invoicing Fee:

Usually the pmt_sellercosts value in the response is exactly the same as the in the original new payment request. However, some payment methods make it possible for the webstore to determine an additional invoicing fee or extra handling cost (a fixed money amount). In cases where the buyer chooses such payment method, the invoicing fee is added as a new cost order row to the order by Svea Payments. Also the pmt_sellercosts value is increased by the same fee amount. In these cases the response contains a pmt_sellercosts value that is greater than the original value in the request. The difference could be exactly the invoicing fee and nothing else.

pmt_paymentmethod

AN4

C

Indicates what payment method the buyer chose. All the possible values are found from chapter Payment Method Codes.

pmt_paymenturl

AN200

C

The address where the payer can be redirected instantly to continue the payment process.

Error response

The error response is a XML document with root element <errors>. The error details are found under <error> elements that have type attribute "general" or "field". In case of fields, the field name is found from attribute name.