session
Sessions
checkout_session_profile_post
Create a corresponding Checkout Session for an order placed in your system using predefined session profile
Session with Instabank
Note that items is a required property when creating a session with Instabank configured.
scopes:
- admin:checkout
- write:checkout
post/accounts/{aid}/payments/sessions-profile
Request
- Base URLhttps://api.dintero.com/v1
- Auth
- HTTP bearer
- or API key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
include_sessionboolean
Include all details about the session created
Headers
Dintero-Feature-Togglesstring[]
Feature toggles that will change how the API works.
These feature toggles are usually the preferred way to use the API, but they break the current API.
- strict-session-amounts: order.amount must equal the sum of amounts in order.items + order.shipping_option.amount when creating sessions
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
Request body
Example request
{
"url": {
"return_url": "https://example.com/accept"
},
"customer": {
"email": "john.doe@example.com",
"phone_number": "+4799999999"
},
"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"
},
"metadata": {
"order_id": "xk39592f"
}
}Response
Referenced by this API but not published in the vendor's docs pages.
Changes
No recorded changes to this operation across all 1 revision of this API.