Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,8 @@ Note, that at the moment HTTP 400 may occur also for 3rd party reasons - e.g. be

Email refunds are deprecated, please use `/payments/{transactionId}/refund` endpoint with the customer’s email.

**Note!** This function is outdated. A separate email refund action is not needed. Include the customer's email in the [refund payment request](#refund-payment), and the system will handle the email automatically.

`HTTP POST /payments/{transactionId}/refund/email` email refunds a payment by transaction ID.

?> Email refunds are always asynchronous. When a refund request is accepted, the response contain status `ok` and the callback will be called. The callback is not called with the actual outcome.
Expand Down Expand Up @@ -1020,6 +1022,7 @@ General API HTTP status codes and what to expect of them.
| currency | alpha3 | <center>x</center> | Currency, only `EUR` supported at the moment |
| language | alpha2 | <center>x</center> | Payment's language, currently supported are `FI`, `SV`, and `EN` |
| orderId (Deprecated) | string | <center>-</center> | (Deprecated) Order ID. Was used for e.g. Walley payments order ID. This field is deprecated but remains here as a reference for old integrations. |
| description | string | <center>-</center> | An internal information for the payment. Only visible in the Merchant panel. |
| items | [Item](#item)[] | <center>-</center> | Array of items. Always required for Shop-in-Shop payments. Required if VAT calculations are wanted in settlement reports. |
| customer | [Customer](#customer-1) | <center>x</center> | Customer information |
| deliveryAddress | [Address](#address) | <center>-</center> | Delivery address |
Expand All @@ -1033,20 +1036,20 @@ General API HTTP status codes and what to expect of them.

##### Item

| Field | Type | Required | Example | Description |
| ------------------------- | ------------------------- | ------------------ | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| unitPrice | integer | <center>x</center> | 1000 | Price per unit, in each country's minor unit, e.g. for Euros use cents. By default price should include VAT, unless [`usePricesWithoutVat`](#request-body) is set to true. Maximum value is 2147483647, minimum value is -2147483648. Negative value can't be used for Shop-in-Shop payments or when [`usePricesWithoutVat`](#request-body) is set to true. |
| units | integer | <center>x</center> | 5 | Quantity, how many items ordered. Negative values are not supported. Maximum value of 99999998. |
| vatPercentage | numeric | <center>x</center> | 25.5 | VAT percentage. Values between 0 and 100 are allowed with one number in decimal part. |
| productCode | string | <center>x</center> | 9a | Merchant product code. May appear on invoices of certain payment methods. Maximum of 100 characters. |
| description | string | <center>-</center> | Bear suits for adults | Item description. May appear on invoices of certain payment methods. Maximum of 1000 characters. |
| category | string | <center>-</center> | fur suits | Merchant specific item category. Maximum of 100 characters. |
| orderId (Deprecated) | string | <center>-</center> | | (Deprecated) Item level order ID (suborder ID). Mainly useful for Shop-in-Shop purchases. This field is deprecated but remains here as a reference for old integrations. |
| stamp | string | <center>-</center> | d4aca017-f1e7-4fa5-bfb5-2906e141ebac | Unique identifier for this item. Required for Shop-in-Shop payments. Required for item refunds. Maximum of 200 characters. |
| reference | string | <center>-</center> | fur-suits-5 | Reference for this item. Required for Shop-in-Shop payments. |
| merchant | string | <center>-</center> | 695874 | Merchant ID for the item. Required for Shop-in-Shop payments, do not use for normal payments. |
| commission | [Commission](#commission) | <center>-</center> | - | Shop-in-Shop commission. Do not use for normal payments. |
| deliveryDate (Deprecated) | string | <center>-</center> | 2019-12-31 | (Deprecated) When is this item going to be delivered. This field is deprecated but remains here as a reference for old integrations. |
| Field | Type | Required | Example | Description |
| ------------------------- | ------------------------- | ------------------ | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| unitPrice | integer | <center>x</center> | 1000 | Price per unit, in each country's minor unit, e.g. for Euros use cents. By default price should include VAT, unless [`usePricesWithoutVat`](#request-body) is set to true. Maximum value is 2147483647, minimum value is -2147483648. Negative value can't be used for Shop-in-Shop payments or when [`usePricesWithoutVat`](#request-body) is set to true. PayPal doesn’t support negative values. |
| units | integer | <center>x</center> | 5 | Quantity, how many items ordered. Negative values are not supported. Maximum value of 99999998. |
| vatPercentage | numeric | <center>x</center> | 25.5 | VAT percentage. Values between 0 and 100 are allowed with one number in decimal part. |
| productCode | string | <center>x</center> | 9a | Merchant product code. May appear on invoices of certain payment methods. Maximum of 100 characters. |
| description | string | <center>-</center> | Bear suits for adults | Item description. May appear on invoices of certain payment methods. Maximum of 1000 characters. |
| category | string | <center>-</center> | fur suits | Merchant specific item category. Maximum of 100 characters. |
| orderId (Deprecated) | string | <center>-</center> | | (Deprecated) Item level order ID (suborder ID). Mainly useful for Shop-in-Shop purchases. This field is deprecated but remains here as a reference for old integrations. |
| stamp | string | <center>-</center> | d4aca017-f1e7-4fa5-bfb5-2906e141ebac | Unique identifier for this item. Required for Shop-in-Shop payments. Required for item refunds. Maximum of 200 characters. |
| reference | string | <center>-</center> | fur-suits-5 | Reference for this item. Required for Shop-in-Shop payments. |
| merchant | string | <center>-</center> | 695874 | Merchant ID for the item. Required for Shop-in-Shop payments, do not use for normal payments. |
| commission | [Commission](#commission) | <center>-</center> | - | Shop-in-Shop commission. Do not use for normal payments. |
| deliveryDate (Deprecated) | string | <center>-</center> | 2019-12-31 | (Deprecated) When is this item going to be delivered. This field is deprecated but remains here as a reference for old integrations. |

##### Customer

Expand Down Expand Up @@ -1080,10 +1083,11 @@ These URLs must use HTTPS.

##### Commission

| Field | Type | Required | Example | Description |
| -------- | ------- | ------------------ | ------- | --------------------------------------------------------------------------------------------- |
| merchant | string | <center>x</center> | 695874 | Merchant who gets the commission |
| amount | integer | <center>x</center> | 250 | Amount of commission in currency's minor units, e.g. for Euros use cents. VAT not applicable. |
| Field | Type | Required | Example | Description |
| ------------- | ------- | ------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| merchant | string | <center>x</center> | 695874 | Merchant who gets the commission |
| amount | integer | <center>x</center> | 250 | Amount of commission in currency's minor units, e.g. for Euros use cents. VAT not applicable. |
| vatPercentage | integer | <center></center> | 25.5 | Commissions VAT percentage. Values between 0 and 100 are allowed with one number in decimal part. If not given, 25.5 will be used as default |

See [an example payload and response](/examples#create)

Expand Down