Create Payment
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: | |||||
| NEW_PAYMENT_EXTENDED | AN50 | 4 | 50 | Action name. Always NEW_PAYMENT_EXTENDED. |
| 0004 | AN4 | 4 | 4 | Version of interface content or message |
| UTF-8 | AN15 |
|
| The character encoding of the input data. |
|
| AN15 |
|
| Technical seller id given to the webstore by Svea Payments. |
| nnn | N3 |
|
| Secret key generation or version related to the technical seller id. |
|
| AN20 |
|
| Unique Payment Identifier given to the payment transaction by the webstore. |
|
| AN50 |
|
| Order Identifier given to the order by the webstore. This should be known by the buyer. |
|
| 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 (Finanssiala). 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. |
| nnnnn,nn | AN17 | 4 |
| The total gross sum of product row types 1, 4, 5 and 6 ( Please notice that total amount to pay is actually See also: |
| nnnnn,nn | AN17 | 4 |
| The total gross sum of cost row types 2 and 3 ( Please notice that total amount to pay is actually See also: |
| e.g. EUR | AN3 | 3 | 3 | Currency used for the payment. |
|
| AN200 |
|
| The confirmation URL Please notice that this is mostly only a trigger to perform Payment Status Query . |
|
| 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 ( Must have no effect on payments or orders that have been confirmed earlier using payment status query. |
|
| 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 ( Must have no effect on payments or orders that have been confirmed earlier using payment status query. |
|
| AN320 |
|
| Email address of buyer. |
|
| AN100 |
| 100 | Name of buyer (billing) |
|
| AN100 |
| 100 | Address of buyer (billing). Street address or P.O. box |
|
| N20 |
| 20 | Postal code of buyer (billing) |
|
| AN100 |
| 100 | City of buyer (billing) |
| FI, SE, EN, ... | A2 | 2 | 2 | Country code of buyer (billing) |
|
| AN100 |
| 100 | Name of recipient (delivery). |
|
| AN100 |
| 100 | Address of recipient (delivery). Street address or P.O. box The delivery address ( |
|
| N20 |
| 20 | Postal code of recipient (delivery) |
|
| AN100 |
| 100 | City of recipient (delivery) |
| FI, SE, EN, ... | A2 | 2 | 2 | Country code of recipient (delivery) |
|
| N4 | 1 |
| The count or number of order rows as an integer. |
COMPULSORY YET IGNORED PARAMETERS: | |||||
|
| AN200 |
|
| Deprecated. URL must be valid. Use for example same value as in |
| Y or N | A1 | 1 | 1 | Tells whether escrow option is used with this payment. |
| N | A1 | 1 | 1 | Tells whether escrow option can be changed by the buyer. Currently always N. |
OPTIONAL PARAMETERS: | |||||
| 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. |
|
| AN4 | 4 |
| OPTIONAL. Payment method’s code. |
| 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. |
|
| AN40 |
|
| OPTIONAL. Phone number of buyer (billing) |
|
| AN11 | 9 |
| OPTIONAL. Buyer’s social security number or company’s business identification code. |
| 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,…): Single row’s total amount: | |||||
|
| 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 |
|
| 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. |
| 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 |
| 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. |
| nnnnn,nn | AN17 | 4 |
| Gross unit price (VAT included). |
| nn,nn | AN5 | 4 | 5 | VAT percentage. A decimal number with two decimal digits. The decimal delimiter is a comma. For example: 10,00 means ”10 %” |
| nn,nn | AN5 | 4 | 6 | Discount percentage. A decimal number with two decimal digits. The decimal delimiter is a comma. For example: 10,00 means ”10 %” |
| 1 = product | N5 | 1 | 1 | Row type. 1 = product See also: |
OPTIONAL ORDER ROW PARAMETERS (N=1,2,3,…): | |||||
|
| AN100 | 1 | 100 | OPTIONAL. Article or product number of this order row. |
| e.g. kpl or kg | AN3 | 1 | 3 | OPTIONAL. Unit of quantity of this order row, e.g. kpl, kg, l, m |
MARKETPLACE PARAMETERS: | |||||
| nn,nn | AN17 | 4 |
| The commission amount reserved and to be settled to the marketplace. |
|
| 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 |
---|---|---|---|---|
| NEW_PAYMENT_EXTENDED | AN50 | C | Action name. Always NEW_PAYMENT_EXTENDED. |
| 0004 | AN4 | C | Version of interface content or message. |
|
| AN20 | C | Unique Payment Identifier given to the payment transaction by the webstore. |
|
| 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 (Finanssiala). 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. |
| nnnnn,nn | AN17 | C | The total gross sum of product row types 1, 4, 5 and 6 ( Please notice that total amount to pay is actually See also: |
| e.g. EUR | AN3 | C
| Currency used for the payment. |
| nnnnn,nn | N17 | O | The total gross sum of cost row types 2 and 3 ( Please notice that total amount to pay is actually See also: Optional Invoicing Fee: Usually the |
|
| AN4 | C | Indicates what payment method the buyer chose. All the possible values are found from chapter Payment Method Codes. |
|
| 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
.
Svea Payments Oy
info.payments@svea.fi
+358 9 4241 7050 (weekdays 8:00 - 16:00)
Saavutettavuusseloste