diff --git a/docs/README.md b/docs/README.md index 9d6f554..87f7969 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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. @@ -1020,6 +1022,7 @@ General API HTTP status codes and what to expect of them. | currency | alpha3 |
x
| Currency, only `EUR` supported at the moment | | language | alpha2 |
x
| Payment's language, currently supported are `FI`, `SV`, and `EN` | | orderId (Deprecated) | string |
-
| (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 |
-
| An internal information for the payment. Only visible in the Merchant panel. | | items | [Item](#item)[] |
-
| Array of items. Always required for Shop-in-Shop payments. Required if VAT calculations are wanted in settlement reports. | | customer | [Customer](#customer-1) |
x
| Customer information | | deliveryAddress | [Address](#address) |
-
| Delivery address | @@ -1033,20 +1036,20 @@ General API HTTP status codes and what to expect of them. ##### Item -| Field | Type | Required | Example | Description | -| ------------------------- | ------------------------- | ------------------ | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| unitPrice | integer |
x
| 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 |
x
| 5 | Quantity, how many items ordered. Negative values are not supported. Maximum value of 99999998. | -| vatPercentage | numeric |
x
| 25.5 | VAT percentage. Values between 0 and 100 are allowed with one number in decimal part. | -| productCode | string |
x
| 9a | Merchant product code. May appear on invoices of certain payment methods. Maximum of 100 characters. | -| description | string |
-
| Bear suits for adults | Item description. May appear on invoices of certain payment methods. Maximum of 1000 characters. | -| category | string |
-
| fur suits | Merchant specific item category. Maximum of 100 characters. | -| orderId (Deprecated) | string |
-
| | (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 |
-
| 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 |
-
| fur-suits-5 | Reference for this item. Required for Shop-in-Shop payments. | -| merchant | string |
-
| 695874 | Merchant ID for the item. Required for Shop-in-Shop payments, do not use for normal payments. | -| commission | [Commission](#commission) |
-
| - | Shop-in-Shop commission. Do not use for normal payments. | -| deliveryDate (Deprecated) | string |
-
| 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 |
x
| 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 |
x
| 5 | Quantity, how many items ordered. Negative values are not supported. Maximum value of 99999998. | +| vatPercentage | numeric |
x
| 25.5 | VAT percentage. Values between 0 and 100 are allowed with one number in decimal part. | +| productCode | string |
x
| 9a | Merchant product code. May appear on invoices of certain payment methods. Maximum of 100 characters. | +| description | string |
-
| Bear suits for adults | Item description. May appear on invoices of certain payment methods. Maximum of 1000 characters. | +| category | string |
-
| fur suits | Merchant specific item category. Maximum of 100 characters. | +| orderId (Deprecated) | string |
-
| | (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 |
-
| 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 |
-
| fur-suits-5 | Reference for this item. Required for Shop-in-Shop payments. | +| merchant | string |
-
| 695874 | Merchant ID for the item. Required for Shop-in-Shop payments, do not use for normal payments. | +| commission | [Commission](#commission) |
-
| - | Shop-in-Shop commission. Do not use for normal payments. | +| deliveryDate (Deprecated) | string |
-
| 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 @@ -1080,10 +1083,11 @@ These URLs must use HTTPS. ##### Commission -| Field | Type | Required | Example | Description | -| -------- | ------- | ------------------ | ------- | --------------------------------------------------------------------------------------------- | -| merchant | string |
x
| 695874 | Merchant who gets the commission | -| amount | integer |
x
| 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 |
x
| 695874 | Merchant who gets the commission | +| amount | integer |
x
| 250 | Amount of commission in currency's minor units, e.g. for Euros use cents. VAT not applicable. | +| vatPercentage | integer |
| 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)