Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
order.sessions

aid_orders_id_session_post

Initiate a payment session for the order.

scopes:

  • admin:shopping
  • write:shopping

A session event will be added to the order

post/accounts/{aid}/shopping/orders/{order_id}/sessions

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

order_idstring required

The resource identifier string

Request body

idstring

The resource ID. Defaults to UUID v4

created_atstring date-time

Read-only timestamp, automatically assigned on back-end.

created_bystring

The resource ID. Defaults to UUID v4

amountinteger

Monetary amount in smallest unit for the currency success: description: | The result from the operation. type: boolean

processed_atstring date-time

The date and time when the capture was processed by payment gateway

metadataobject

Additional details about the operation

profile_idstring required

Configuration profile for the session to create

merchant_referencestring

Example request

{
  "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "amount": 27840,
  "items": [
    {
      "amount": 27840
    }
  ],
  "express": {
    "shipping_options": [
      {
        "id": "bring-pick-up-00001",
        "line_id": "bring-pick-up-00001-location-0a1f6b",
        "countries": [
          "NO"
        ],
        "amount": 3900,
        "vat_amount": 975,
        "vat": 25,
        "title": "Standard",
        "description": "Pick up at your nearest postal office",
        "delivery_method": "pick_up",
        "operator": "Bring",
        "operator_product_id": "pick-up-00001-location-0a1f6b",
        "eta": {
          "working_days": [
            1,
            2
          ],
          "shipping_day_of_week": 3,
          "arrival_day_of_week": 3,
          "starts_at": "2020-10-14T19:00:00Z",
          "ends_at": "2020-10-14T20:00:00Z"
        },
        "time_slot": {
          "starts_at": "2020-10-14T19:00:00Z",
          "ends_at": "2020-10-14T20:00:00Z"
        },
        "pick_up_address": {
          "first_name": "John",
          "last_name": "Doe",
          "co_address": "Land Lord",
          "postal_code": "0349",
          "postal_place": "Oslo",
          "country": "NO"
        },
        "metadata": {
          "operator_dest": "XAB1239",
          "number_x": 1921
        },
        "environmental_data": {
          "description": "Fossil free",
          "details": [
            {
              "label": "Carbon offset",
              "value": "1KG CO2"
            }
          ]
        }
      }
    ],
    "discount_codes": {
      "callback_url": "https://example.com/order/00128110/discount_codes_updated"
    },
    "shipping_address_callback_url": "https://example.com/order/00128110/address_updated"
  },
  "url": {
    "return_url": "https://example.com/accept"
  },
  "shipping_option": {
    "id": "bring-pick-up-00001",
    "line_id": "bring-pick-up-00001-location-0a1f6b",
    "countries": [
      "NO"
    ],
    "amount": 3900,
    "vat_amount": 975,
    "vat": 25,
    "title": "Standard",
    "description": "Pick up at your nearest postal office",
    "delivery_method": "pick_up",
    "operator": "Bring",
    "operator_product_id": "pick-up-00001-location-0a1f6b",
    "eta": {
      "working_days": [
        1,
        2
      ],
      "shipping_day_of_week": 3,
      "arrival_day_of_week": 3,
      "starts_at": "2020-10-14T19:00:00Z",
      "ends_at": "2020-10-14T20:00:00Z"
    },
    "time_slot": {
      "starts_at": "2020-10-14T19:00:00Z",
      "ends_at": "2020-10-14T20:00:00Z"
    },
    "pick_up_address": {
      "first_name": "John",
      "last_name": "Doe",
      "co_address": "Land Lord",
      "postal_code": "0349",
      "postal_place": "Oslo",
      "country": "NO"
    },
    "metadata": {
      "operator_dest": "XAB1239",
      "number_x": 1921
    },
    "environmental_data": {
      "description": "Fossil free",
      "details": [
        {
          "label": "Carbon offset",
          "value": "1KG CO2"
        }
      ]
    }
  }
}

Response

session

idstring

The resource ID. Defaults to UUID v4

created_atstring date-time

Read-only timestamp, automatically assigned on back-end.

created_bystring

The resource ID. Defaults to UUID v4

amountinteger

Monetary amount in smallest unit for the currency success: description: | The result from the operation. type: boolean

processed_atstring date-time

The date and time when the capture was processed by payment gateway

metadataobject

Additional details about the operation

Example response

{
  "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "amount": 27840,
  "items": [
    {
      "amount": 27840
    }
  ]
}