Update order session

Update a session that was created with Create order session. totalOrderAmount, totalOrderVatAmount and totalOrderAmountExclVat are the only required fields. If new order lines are provided then the corresponding new total amounts should also be provided, like in the example below. If new order lines are provided, all order lines in the already existing order session will be deleted and replaced.

curl -X POST 
-H 'authorization: Bearer v4.public.eyJpc3MiOiJs...' 
-H 'content-type: application/json' 
-d '{
  "orderLines": [
    {
      "description": "Coffee Machine X200",
      "quantity": 10,
      "reference": "111-222-333",
      "totalAmount": 500000,
      "totalVatAmount": 100000,
      "type": "physical",
      "unitDiscountAmount": 0,
      "unitPrice": 50000,
      "vat": 2500
    },
    {
      "description": "Shipping fee",
      "quantity": 1,
      "reference": "444-555-666",
      "totalAmount": 10000,
      "totalVatAmount": 2000,
      "type": "shippingFee",
      "unitDiscountAmount": 0,
      "unitPrice": 10000,
      "vat": 2500
    }
  ],
  "totalOrderAmount": 510000,
  "totalOrderAmountExclVat": 408000,
  "totalOrderVatAmount": 102000
}'
https://api.sandbox.ledyer.com/v1/sessions/:sessionId

Path parameters

sessionId string
The session ID string that was obtained when the session was [created](/docs/payment-products/checkout/create-order-session).

Request body

country string Optional
Country code such as `SE`, `FI` etc (ISO 3166-1 alpha-2).
currency string Optional
Example `SEK`, `NOK` (ISO 4217 alpha).
locale string Optional
Specify language for the checkout, `sv-SE`, `da-DK` etc (BCP 47).
metadata object Optional
Merchant may send a key/value object literal for internal use. Example: { "property1": "value1", "property2": "value2" }.
orderLines array Optional
An array of order lines.
Show child attributes
description string
Product name, description etc.
quantity integer
An integer from 1 to 99,999,999, inclusive.
reference string Optional
SKU or product reference.
totalAmount integer
Total amount in minor units.
totalVatAmount integer
Total VAT amount in minor units.
type string
Type of order line: `physical`, `shippingFee`, `discount`, `giftCard`.
unitDiscountAmount integer Optional
Discount per unit in minor units.
unitPrice integer
Price per unit in minor units.
vat integer
VAT rate in minor units (e.g., 2500 for 25%).
reference string Optional
This property can be used for merchant order reference and will be visible on the invoice. Maximum of 50 characters.
settings object Optional
An object containing various setting possibilities.
Show child attributes
security object Optional
Show child attributes
level integer Optional
Security level. Allowed values: `100`, `110`, `120`, `200`, `210`, `220`, `300`, `400`.
requireClientValidation boolean Optional
If `true`, Ledyer will wait for merchant validation before completing the order.
validationSuccessOnTimeout boolean Optional
If `true`, validation timeout is treated as success.
settlementReference string Optional
Maximum of 50 characters.
totalOrderAmount integer
Total order amount in minor units.
totalOrderAmountExclVat integer
Total order amount excl. VAT in minor units.
totalOrderVatAmount integer
Total order VAT amount in minor units.
{
	"checkoutUrl": "https://www.example.com",
	"expiresAt": "2021-09-01T11:25:32.805672147Z",
	"orderId": "or_1xDXf4gwlsnyERFywD9VYZT0Tpp",
	"sessionId": "se_1xDXf4JI3PJsGeVAvLE3hHqYS09"
}

Handling sessions

The sessionId should be stored and re-used until the purchase has been completed or the expiresAt time has been reached. The orderId should only be used in Backend to Backend calls.