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

Version 1 Next »

Request parameters

Payment status query is possible as soon as the payment has been successfully received and saved by Svea Payments.

Webstore delivers the query parameters in a <form> using POST method as hidden input fields (<input type=hidden>) to address https://www.maksuturva.fi/PaymentStatusQuery.pmt
(or https://test1.maksuturva.fi/PaymentStatusQuery.pmt in testing environment).

Skip to contents in this page

Field

Input name

Value

Format

C/O

Description

Action code

pmtq_action

PAYMENT_STATUS_QUERY

AN50

C

PAYMENT_STATUS_QUERY

Message version

pmtq_version

0005

AN4

C

Version of the interface content.

Seller ID

pmtq_sellerid

AN15

C

Seller ID given to the webstore by Svea Payments. Technical interface user id.

Payment ID

pmtq_id

AN20

C

Unique identifying number given to the payment transaction by webstore.

Response type

pmtq_resptype

XML

AN4

C

Currently only XML is supported.

Hash algorithm

pmtq_hashversion

AN10

C

Name of the algorithm used to calculate the hash. For more details, see section Hash Calculation.

Hash

pmtq_hash

AN128

C

Hash calculated from predefined message fields and the webstore's secret key. The following fields are used to calculate the hash:
pmtq_action
pmtq_version
pmtq_sellerid
pmtq_id
For more details, see section Hash Generation.

Secret key generation

pmtq_keygeneration

N3

C

Generation number of the secret key given to the seller by Svea Payments.
Default is 001

Response parameter

The character encoding of response message (XML) is UTF-8. Additionally, the only supported response type is XML. These restrictions are present because buyer’s address information received from credit check (for invoice and part payment) can contain characters that are not present in character sets ISO-8859-1 or ISO-8859-15.

Field

Input name

Value

Format

C/O

Description

Action code

pmtq_action

AN50

C

PAYMENT_STATUS_QUERY

Message version

pmtq_version

AN4

C

Version of interface content. Same as in the input message.

Seller ID

pmtq_sellerid

AN15

C

Seller ID given to the webstore by Svea Payments. Technical interface user id.

Payment ID

pmtq_id

AN20

C

Unique identifying number given to the payment transaction by webstore.

Order ID

pmtq_orderid

AN50

C

New 09-2021 Contains the order id the payment was created with.

Sum of products and services of the order

pmtq_amount

AN17

C

The total sum of products and services of the order.
If the order does not contain any postal or handling costs, then this is the total amount of the order.
The amount must be presented with two decimals. The decimal delimiter is a comma, e.g. 94,80

Response code

pmtq_returncode

AN

C

Indicates success or failure. Values and explanations of all the codes can be found at section Payment response.

Response text

pmtq_returntext

AN100

O

Brief description of the response code.

Tracking codes of the deliverable of the order

pmtq_trackingcodes

AN400

C

Tracking codes or information of untraceable deliveries submitted to Svea Payments system regarding this payment. Format [XX|XY|YY] 0-n times depending on the count of submitted tracking codes or information of untraceable deliveries.
XX = Delivery type code
XY = Tracking code, or the submitted text in case of untraceable delivery
YY = Delivery status, see section Delivery status code values

Sum of delivery and handling costs of the order

pmtq_sellercosts

AN17

O

The total sum of delivery and handling costs of the order.
The amount must be presented with two decimals. The decimal delimiter is a comma, e.g. 7,40

Invoicing fee sum

pmtq_invoicingfee

AN17

O

New 09-2021 Only available when the payer chose a payment method that has invoicing fee associated to it. The amount is presented with two descimals. The decimal delimiter is a comma, e.g. 7,40

Payment Method

pmtq_paymentmethod

AN4

O

Indicates what payment method the buyer chose. For available codes, see section Payment Method Codes.

Important! Please do not use the values of the table above in production. Instead, retrieve official payment method codes and names using GetPaymentMethods.pmt API (see chapter Retrieve Available Payment Methods).

Escrow is being used

pmtq_escrow

Satisfaction Guarantee payments = Y
Direct payments = N

AN1

O

Tells whether escrow option is used with this payment. Values: Y/N
The value is always Y for payment services using Buyer’s Assistant. Correspondingly, the value is always N for Direct payment services (that do not use Buyer’s Assistant or return/refund tools).

Verification info

pmtq_certification

Y,N

A1

O

Y = The payment has been verified. That is, the payer’s identity has been confirmed somehow. In case of Invoice and Part Payment payment methods, Svea Payments has information about the payer’s identity which is not the case with other payment methods.
N = The payment has not been verified, or there is no verification information available.

Payment service response code 1

pmtq_externalcode1

AN50

O

Informal/additional payment service response information received from the external payment service provider in error situations.

In case of Nets (formerly known as Luottokunta), the LKPRC code.

In OK cases this could contain for example external payment service provider’s archive code of the payment.

Payment service response code 2

pmtq_externalcode2

AN50

O

Informal/additional payment service response information received from the external payment service provider in error situations.

In case of Nets (formerly known as Luottokunta), the LKSRC code.

In OK cases this could contain for example external payment service provider’s archive code of the payment.

Payment service response text

pmtq_externaltext

AN200

O

Informal/additional payment service response information received from the
external payment service provider.

Contains either information about successful payment or an error.

If the external payment service provider does not provide this response information, this is either empty or it could contain for example external payment service provider’s archive code or some other unique id of the payment.

Time when the buyer began the payment process

pmtq_paymentstarttimestamp

dd.MM.yyyy hh:mm:ss

AN19

O

The time when payer transfered to the Payment Service.

Payment date

pmtq_paymentdate

dd.MM.yyyy

AN10

O

The date when payer paid. Or if it’s not available, the date when the money was found from Svea Payments Customer Assets bank account statement.

Hash

pmtq_hash

AN128

C

Hash calculated from predefined response message fields and the webstore's secret key. Uses the same version, key generation etc values that were in the request. The following fields are used to calculate the hash:

  • pmtq_action

  • pmtq_version

  • pmtq_sellerid

  • pmtq_id

  • pmtq_amount

  • pmtq_returncode

  • pmtq_returntext

  • pmtq_sellercosts (if available)

  • pmtq_paymentmethod (if available)

  • pmtq_escrow (if available)

  • pmtq_certification (if available)

  • pmtq_paymentdate (if available)

  • No labels