Payment Menu v2 – Fees And Discounts

Fees And Discounts

If you want to add fees or discounts to your payment order, this can be done by adding them as orderItems in your request. Use positive amounts for fees and negative amounts for discounts. Remember that the sum of the orderItems must match the total payment order amount.

Restricting the fee or discount to certain instruments is also possible. Simply add the restrictedToInstruments field and which instruments the fee or discount applies to. This is currently available for invoice only.

The example below shows a fee which only applies to Swedish invoices. Other options for some of the fields are in the table at the bottom.

Fee Request

Request

1
2
3
4

POST /psp/paymentorders HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json;version=3.1/3.0/2.0      // Version optional for 3.0 and 2.0

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
      "orderItems": [
             {
                 "reference": "I1",
                 "name": "InvoiceFee",
                 "type": "PAYMENT_FEE",
                 "class": "Fees",
                 "description": "Fee for paying with Invoice",
                 "quantity": 1,
                 "quantityUnit": "pcs",
                 "unitPrice": 1900,
                 "vatPercent": 0,
                 "amount": 1900,
                 "vatAmount": 0,
                 "restrictedToInstruments": [
                     "Invoice-PayExFinancingSe"
                 ]
             }
         ]
}

Show fields

Field	Type	Description
	`orderItems`	`array`	The array of items being purchased with the order. Note that authorization `orderItems` will not be printed on invoices, so lines meant for print must be added in the Capture request. The authorization `orderItems` will, however, be used in the Merchant Portal when captures or reversals are performed, and might be shown other places later. It is required to use this field to be able to send Capture `orderItems`. `Capture` requests should only contain items meant to be captured from the order.
	`reference`	`string`	A reference that identifies the order item.
	`name`	`string`	The name of the order item.
	`type`	`string`	`PRODUCT`, `SERVICE`, `SHIPPING_FEE`, `PAYMENT_FEE` `DISCOUNT`, `VALUE_CODE` or `OTHER`. The type of the order item. `PAYMENT_FEE` is the amount you are charged with when you are paying with invoice. The amount can be defined in the `amount` field below.
	`class`	`string`	The classification of the order item. Can be used for assigning the order item to a specific product category, such as `MobilePhone`. Note that `class` cannot contain spaces and must follow the regex pattern `[\w-]*`. Swedbank Pay may use this field for statistics.
	`itemUrl`	`string`	The URL to a page that can display the purchased item, product or similar.
︎︎︎	`imageUrl`	`string`	The URL to an image of the order item.
	`description`	`string`	A 40 character length textual description of the purchase.
	`discountDescription`	`string`	Used for discounts only. The human readable description of the possible discount.
	`quantity`	`number`	The 4 decimal precision quantity of order items being purchased.
	`quantityUnit`	`string`	The unit of the quantity, such as `pcs`, `grams`, or similar. This is used for your own book keeping.
	`unitPrice`	`integer`	The price per unit of order item, including VAT.
	`discountPrice`	`integer`	Used for discounts only. If the order item is purchased at a discounted price. This field should contain that price, including VAT.
	`vatPercent`	`integer`	The percent value of the VAT multiplied by 100, so `25%` becomes `2500`.
	`amount`	`integer`	The transaction amount (including VAT, if any) entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK.
	`vatAmount`	`integer`	The payment’s VAT (Value Added Tax) `amount`, entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK. The `vatAmount` entered will not affect the `amount` shown on the payment page, which only shows the total `amount`. This field is used to specify how much of the total `amount` the VAT will be. Set to `0` (zero) if there is no VAT `amount` charged.
	`restrictedToInstruments`	`array`	A list of the instruments you wish to restrict the payment to. Currently `Invoice` only. `Invoice` supports the subtypes `PayExFinancingNo`, `PayExFinancingSe` and `PayMonthlyInvoiceSe`, separated by a dash, e.g.; `Invoice-PayExFinancingNo`. The fee or discount applies to all instruments if a restriction is not included. Use of this field requires an agreement with Swedbank Pay.