v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
session
Sessions
checkout_session_cancel_post

Cancel a session
The session transaction will be voided in case where it is initialized or authorized.
Cancel is not allowed in case where the current transaction state is not initialized or authorized.
scopes:
admin:checkout
write:checkout
post/accounts/{aid}/payments/sessions/{session_id}/cancel
Path parameters

session_idstring checkout-id required
The session ID
Headers

Dintero-System-Namestring
The name of the ecommerce solution
Example: woocommerce
Dintero-System-Versionstring
The version number of the ecommerce solution
Example: 5.4
Dintero-System-Plugin-Namestring
The name of the ecommerce plugin
Example: Dintero.Checkout.WooCommerce
Dintero-System-Plugin-Versionstring
The version number of the ecommerce plugin
Example: 2.3.4
Response

checkout session
idstring
The ID of the Checkout
created_atstring date-time
Time when the Checkout was created
expires_atstring date-time
The session expiration time after which the Checkout page wouldn't be available
updated_atstring date-time
Last time when the Checkout was updated
customer_ipstring
The IP of the customer upon visiting the page. If the page is visited multiple times, the field is always updated with the last known value.
user_agentstring
The full user agent of the device the customer used when visiting the checkout page
payment_operation'unscheduled_purchase' | 'recurring_purchase' | 'generate_payment_token'
Initiated by the merchant or used to generate a token
transaction_idstring
Transaction which has been created using the checkout.
cancelled_bystring
cancelled_atstring date-time
The date-time when the resource was cancelled
Example response

{
  "url": {
    "return_url": "https://example.com/accept"
  },
  "customer": {
    "email": "john.doe@example.com",
    "phone_number": "+4799999999",
    "my_dintero": {
      "terms": {
        "url": "https://example.com/toc"
      }
    },
    "tokens": {
      "payex.creditcard": {
        "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
      },
      "bambora.creditcard": {
        "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
      },
      "dintero_psp.creditcard": {
        "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
      }
    }
  },
  "order": {
    "amount": 72200,
    "currency": "NOK",
    "vat_amount": 13660,
    "shipping_address": {
      "first_name": "John",
      "last_name": "Doe",
      "co_address": "Land Lord",
      "postal_code": "0349",
      "postal_place": "Oslo",
      "country": "NO"
    },
    "billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "co_address": "Land Lord",
      "postal_code": "0349",
      "postal_place": "Oslo",
      "country": "NO"
    },
    "items": [
      {
        "amount": 2000,
        "quantity": 2,
        "line_id": "1",
        "description": "Forsvinnignspølse",
        "vat": 20,
        "id": "10"
      },
      {
        "amount": 6600,
        "quantity": 2,
        "line_id": "2",
        "description": "Vissvossafår på neppebrød",
        "vat": 20,
        "id": "6",
        "eligible_for_discount": true,
        "is_changed": true,
        "gross_amount": 10000,
        "discount_lines": [
          {
            "amount": 4400,
            "discount_type": "customer",
            "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
            "description": "Vossafestpris",
            "line_id": 1
          }
        ]
      },
      {
        "amount": 59700,
        "quantity": 3,
        "line_id": "3",
        "description": "Luftboller",
        "vat": 20,
        "id": "1"
      }
    ],
    "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"
          }
        ]
      },
      "splits": [
        {
          "payout_destination_id": "seller-1",
          "amount": 29700
        }
      ],
      "shipments": [
        {
          "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"
              }
            ]
          },
          "splits": [
            {
              "payout_destination_id": "seller-1",
              "amount": 29700
            }
          ],
          "shipment_items": [
            {
              "line_id": "line-id-1"
            }
          ]
        }
      ]
    },
    "store": {
      "id": "sc029",
      "name": "SC Oslo",
      "business_name": "SC Oslo AS",
      "address": {
        "address_line": "Sommerkroveien 34",
        "address_line_2": "PB 123",
        "postal_code": "0349",
        "postal_place": "Oslo",
        "country": "NO"
      },
      "chain": "SuperChain",
      "email": "contact@superchain.com",
      "gln": "5790001398644",
      "organization_number": "123456789MVA",
      "phone_number": "+4738260107",
      "mcc": "5814",
      "bax": "102603",
      "terminal_id": "T0292",
      "payout_destination_id": "seller-1"
    },
    "discount_lines": [
      {
        "amount": 4400,
        "percentage": 44,
        "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
        "line_id": 1
      }
    ],
    "discount_codes": [
      "SUMMER20"
    ],
    "emd": {
      "event": [
        {
          "event_name": "Michael Jackson",
          "event_company": "Diamond Events",
          "genre_of_event": "Pop",
          "arena_name": "Oslo Spektrum",
          "arena_location": {
            "street_address": "Sonja Henies plass 2",
            "postal_code": "0185",
            "city": "Oslo",
            "country": "NO"
          },
          "start_time": "2023-08-16T15:00:00Z",
          "end_time": "2023-08-16T16:00:00Z",
          "access_controlled_venue": true,
          "ticket_delivery_method": "email",
          "ticket_delivery_recipient": "recipient@mail.com",
          "affiliate_name": "Klarna affiliate"
        }
      ],
      "subscription": {
        "subscription": {
          "subscription_name": "Contact lenses",
          "start_time": "2023-08-16T15:00:00Z",
          "end_time": "2023-09-16T15:00:00Z",
          "auto_renewal_of_subscription": true,
          "affiliate_name": "Klarna affiliate"
        },
        "customer_account_info": {
          "unique_account_identifier": "Adam Adamsson",
          "account_registration_date": "2023-08-16T15:00:00Z",
          "account_last_modified": "2023-10-16T15:00:00Z"
        }
      },
      "travel": {
        "air_reservation_details": {
          "pnr": "VH67899",
          "itinerary": [
            {
              "departure": "OSL",
              "departure_city": "Oslo",
              "arrival": "MUC",
              "arrival_city": "Munich",
              "carrier": "LH",
              "segment_price": 200000,
              "departure_date": "2023-08-16T15:00:00Z",
              "ticket_delivery_method": "phone",
              "ticket_delivery_recipient": "97712123",
              "passenger_id": [
                1
              ],
              "class": "First Class"
            }
          ],
          "insurance": [
            {
              "insurance_company": "Oopsie Insurance Ltd.",
              "insurance_type": "travel",
              "insurance_price": 50000
            }
          ],
          "passengers": [
            {
              "id": 1,
              "title": "mr",
              "first_name": "Paul",
              "last_name": "Lamb"
            }
          ],
          "affiliate_name": "Klarna affiliate"
        },
        "bus_reservation_details": {
          "pnr": "VH67899",
          "itinerary": [
            {
              "departure_city": "Oslo",
              "arrival_city": "Munich",
              "carrier": "Big Bus Travels Ltd.",
              "segment_price": 200000,
              "departure_date": "2023-08-16T15:00:00Z",
              "ticket_delivery_method": "phone",
              "ticket_delivery_recipient": "97712123",
              "passenger_id": [
                1
              ],
              "class": "First Class"
            }
          ],
          "insurance": [
            {
              "insurance_company": "Oopsie Insurance Ltd.",
              "insurance_type": "travel",
              "insurance_price": 50000
            }
          ],
          "passengers": [
            {
              "id": 1,
              "title": "mr",
              "first_name": "Paul",
              "last_name": "Lamb"
            }
          ],
          "affiliate_name": "Klarna affiliate"
        },
        "train_reservation_details": {
          "pnr": "VH67899",
          "itinerary": [
            {
              "departure_city": "Oslo",
              "arrival_city": "Munich",
              "carrier": "Big Train Travels Ltd.",
              "segment_price": 200000,
              "departure_date": "2023-08-16T15:00:00Z",
              "ticket_delivery_method": "phone",
              "ticket_delivery_recipient": "97712123",
              "passenger_id": [
                1
              ],
              "class": "First Class"
            }
          ],
          "insurance": [
            {
              "insurance_company": "Oopsie Insurance Ltd.",
              "insurance_type": "travel",
              "insurance_price": 50000
            }
          ],
          "passengers": [
            {
              "id": 1,
              "title": "mr",
              "first_name": "Paul",
              "last_name": "Lamb"
            }
          ],
          "affiliate_name": "Klarna affiliate"
        },
        "ferry_reservation_details": {
          "pnr": "VH67899",
          "itinerary": [
            {
              "departure_city": "Oslo",
              "arrival_city": "Munich",
              "carrier": "Big Ferry Travels Ltd.",
              "segment_price": 200000,
              "departure_date": "2023-08-16T15:00:00Z",
              "ticket_delivery_method": "phone",
              "ticket_delivery_recipient": "97712123",
              "passenger_id": [
                1
              ],
              "class": "First Class"
            }
          ],
          "insurance": [
            {
              "insurance_company": "Oopsie Insurance Ltd.",
              "insurance_type": "travel",
              "insurance_price": 50000
            }
          ],
          "passengers": [
            {
              "id": 1,
              "title": "mr",
              "first_name": "Paul",
              "last_name": "Lamb"
            }
          ],
          "affiliate_name": "Klarna affiliate"
        },
        "hotel_reservation_details": {
          "pnr": "VH67899",
          "itinerary": [
            {
              "hotel_name": "Premium Hotel",
              "address": {
                "street_address": "Karl Johans gt. 31",
                "postal_code": "0159",
                "city": "Oslo",
                "country": "NO"
              },
              "start_time": "2023-08-16T15:00:00Z",
              "end_time": "2023-08-20T15:00:00Z",
              "number_of_rooms": 2,
              "passenger_id": [
                1
              ],
              "ticket_delivery_method": "phone",
              "ticket_delivery_recipient": "97712123",
              "hotel_price": 200000,
              "class": "First Class"
            }
          ],
          "insurance": [
            {
              "insurance_company": "Oopsie Insurance Ltd.",
              "insurance_type": "travel",
              "insurance_price": 50000
            }
          ],
          "passengers": [
            {
              "id": 1,
              "title": "mr",
              "first_name": "Paul",
              "last_name": "Lamb"
            }
          ],
          "affiliate_name": "Klarna affiliate"
        },
        "car_rental_reservation_details": {
          "pnr": "VH67899",
          "itinerary": [
            {
              "rental_company": "Premium Cars",
              "drivers_id": [
                1
              ],
              "pick_up_location": {
                "street_address": "Karl Johans gt. 31",
                "postal_code": "0159",
                "city": "Oslo",
                "country": "NO"
              },
              "drop_off_location": {
                "street_address": "Karl Johans gt. 31",
                "postal_code": "0159",
                "city": "Oslo",
                "country": "NO"
              },
              "start_time": "2023-08-16T15:00:00Z",
              "end_time": "2023-08-20T15:00:00Z",
              "car_price": 500000,
              "class": "Premium Cars Premium Class"
            }
          ],
          "insurance": [
            {
              "insurance_company": "Oopsie Insurance Ltd.",
              "insurance_type": "travel",
              "insurance_price": 50000
            }
          ],
          "drivers": [
            {
              "id": 1,
              "title": "mr",
              "first_name": "Paul",
              "last_name": "Lamb"
            }
          ],
          "affiliate_name": "Klarna affiliate"
        }
      },
      "marketplace_order": {
        "seller_info": {
          "unique_account_identifier_seller": {
            "phone_number": "97712123"
          },
          "sub_merchant_id": "Marketbrick Ltd.",
          "product_category": "Phones",
          "product_name": "iPhone 14 Pro Max",
          "account_registration_date": "2023-08-16T15:00:00Z",
          "account_last_modified": {
            "password": "2023-08-17T15:00:00Z",
            "email": "2023-08-17T15:00:00Z",
            "listing": "2023-08-17T15:00:00Z",
            "login": "2023-08-17T15:00:00Z",
            "address": "2023-08-17T15:00:00Z"
          },
          "seller_rating": 5,
          "number_of_trades": 23,
          "volume_of_trades": 230
        },
        "winner_info": {
          "unique_account_identifier_winner": {
            "phone_number": "97712123"
          },
          "account_registration_date": "2023-08-16T15:00:00Z",
          "account_last_modified": {
            "password": "2023-08-17T15:00:00Z",
            "email": "2023-08-17T15:00:00Z",
            "listing": "2023-08-17T15:00:00Z",
            "login": "2023-08-17T15:00:00Z",
            "address": "2023-08-17T15:00:00Z"
          },
          "number_of_trades": 23,
          "volume_of_trades": 230
        }
      }
    }
  },
  "checkboxes": [
    {
      "link": {
        "text": "Terms for checkbox action"
      }
    }
  ],
  "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"
            }
          ]
        },
        "splits": [
          {
            "payout_destination_id": "seller-1",
            "amount": 29700
          }
        ],
        "shipment_items": [
          {
            "line_id": "line-id-1"
          }
        ]
      }
    ],
    "discount_codes": {
      "callback_url": "https://example.com/order/00128110/discount_codes_updated"
    },
    "shipping_address_callback_url": "https://example.com/order/00128110/address_updated"
  },
  "configuration": {
    "merchant": {
      "name": "TKP tech AS",
      "country": "NO"
    }
  },
  "initiating_system_request_headers": {
    "dintero-system-name": "woocommerce",
    "dintero-system-version": "5.0.0",
    "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
    "dintero-system-plugin-version": "2021.03.02",
    "user-agent": "Mozilla: Mozilla/5.0"
  },
  "events": [
    {
      "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
      "name": "INITIATED",
      "created_at": "2019-05-09T09:13:40.306Z",
      "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
    },
    {
      "name": "VISITED",
      "created_at": "2019-05-09T09:13:50.548Z"
    },
    {
      "name": "PAY_FAILED",
      "created_at": "2019-05-09T09:14:10.548Z",
      "details": {
        "error": "Rejected",
        "payment_product_type": "instabank.finance"
      }
    },
    {
      "name": "FAILED",
      "created_at": "2019-05-09T09:16:11.786Z"
    }
  ]
}
v1

checkout_session_cancel_post

Path parameters

Headers

Response

Present only for Express Checkout sessions.

Example response
