Get order session

Example Request

curl -X GET \
  -H 'authorization: Bearer v4.public.eyJpc3MiOiJs...' \
  https://api.sandbox.ledyer.com/v1/sessions/:sessionId \

Path parameters

sessionId

The session ID string that was obtained when the session was created.

Example Response

{
  "createdAt": "2022-02-13T21:15:52.597247Z",
  "customer": {
    "billingAddress": {
      "attentionName": "Åke anställd",
      "careOf": "",
      "city": "Solna",
      "companyName": "Rocket 4",
      "country": "SE",
      "postalCode": "999 33",
      "streetAddress": "Gatan 99"
    },
    "companyId": "559311-3714",
    "email": "jan@example.com",
    "firstName": "Jan",
    "invoceChannel": {
      "details": "",
      "type": "email"
    },
    "lastName": "Persson",
    "paymentMethod": {
      "provider": "ledyer",
      "type": "invoice"
    },
    "phone": "+46761010101",
    "reference1": "ref1",
    "reference2": "ref2",
    "shippingAddress": {
      "attentionName": "Gunnar Larsson",
      "careOf": "",
      "city": "Luleå",
      "companyName": "Pelles Tak",
      "contact": {
        "email": "micke.mottagare@email.com",
        "firstName": "Micke",
        "lastName": "Mottagare",
        "phone": "123456789"
      },
      "country": "Sweden",
      "postalCode": "333 33",
      "streetAddress": "Sommargatan 33"
    },
    "ssn": ""
  },
  "expiresAt": "2023-02-20T21:15:52.597247Z",
  "id": "se_1xE2fCIbZXHqB2tZctuZGlyCKnQ", // this is the session ID
  "merchantId": "ac_1xRXHKwBNxnbzMeJfy2olPJEKP7",
  "order": {
    "country": "SE",
    "currency": "SEK",
    "locale": "sv-SE",
    "metadata": {
      "foo": "bar"
    },
    "orderLines": [
      {
        "description": "Coffee Machine X200",
        "quantity": 10,
        "reference": "111-222-333",
        "totalAmount": 500000,
        "totalVatAmount": 100000,
        "type": "physical",
        "unitPrice": 50000,
        "vat": 2500
      },
      {
        "description": "Shipping fee",
        "quantity": 1,
        "reference": "444-555-666",
        "totalAmount": 10000,
        "totalVatAmount": 2000,
        "type": "shippingFee",
        "unitPrice": 10000,
        "vat": 2500
      }
    ],
    "reference": "A1B2C3D",
    "settings": {
      "customer": {
        "allowShippingAddress": true,
        "showNameFields": true,
        "showShippingAddressContact": true
      },
      "security": {
        "level": 300,
        "requireClientValidation": false
      },
      "urls": {
        "confirmation": "http://www.example.com/confirmation",
        "notification": "http://www.example.com/notification",
        "privacy": "http://www.example.com/privacy.html",
        "terms": "http://www.example.com/terms.html",
        "validate": "https://www.example.com/api/validate?order_id={order.id}"
      }
    },
    "settlementReference": "ABC123XYZ456",
    "source": "pos",
    "totalOrderAmount": 510000,
    "totalOrderVatAmount": 102000,
    "totalOrderAmountExclVat": 408000
  },
  "orderId": "or_1xE2fDBg9rRwh6nENMA3ly3B3Qg",
  "signState": "unsigned",
  "state": "open",
  "storeId": "421423100",
  "updatedAt": "2023-02-13T21:15:52.597247Z"
}

paymentMethod.type

string

Can be one of the following:

• advanceInvoice
• card
• invoice
• serviceInvoice

signState

string

Can be one of the following:

• fullSign
• partSign
• unsigned

state

string

Can be one of the following:

• authorized: The order has been completed.
• expired: The order session has expired.
• locked: The order can not be edited.
• open: The order can be edited.
• pendingSca: The order is waiting to be signed by one or more signatories.
• cancelled: The order session has been cancelled.