--- title: "transactions_get" method: GET path: "/accounts/{aid}/payments/transactions" tags: ["Transactions"] --- # transactions_get `GET /accounts/{aid}/payments/transactions` scopes: - admin:checkout - read:checkout ## Query parameters - `id` string[] - `limit` integer - `starting_after` string, checkout-id - `status` string[] - `payment_product` string[] - `payment_product_type` string[] - `card_brand` string[] - `merchant_reference` string - `merchant_reference_2` string - `session_id` string[] - `store_id` string[] - `payout_correlation_id` string[] - `currency` string[] - `amount` integer - `amount.gte` integer - `amount.lte` integer - `created_at.gte` string, isodate - `created_at.lte` string, isodate - `captured_at.gte` string, isodate - `captured_at.lte` string, isodate - `refunded_at.gte` string, isodate - `refunded_at.lte` string, isodate - `search` string - `payment_operation` string - `customer_id` string - `includes` string[] - `payout_destination_id` string - `token_id` string[] - `authorization_expires_at.gte` string, isodate - `authorization_expires_at.lte` string, isodate - `terminal_id` string - `channel` string[] ## Response `200` Transactions - Transaction[] - `id` string — An ID that uniquely identifies the resource - `created_at` string, date-time — When the transaction was created - `payment_product` 'bambora' | 'collector' | 'dintero' | 'dintero_psp' | 'instabank' | 'klarna' | 'netaxept' | 'payex' | 'santander' | 'swish' | 'vipps' | 'kravia' | 'two' | 'seitatech', required — The payment product corresponding to this transaction - `payment_product_type` 'bambora.applepay' | 'bambora.creditcard' | 'bambora.googlepay' | 'bambora.mobilepay' | 'bambora.vipps' | 'collector.invoice' | 'collector.invoice_b2b' | 'collector.invoice_b2b_preapproved' | 'collector.installment' | 'dintero.zero' | 'dintero.wallets' | 'dintero.external' | 'dintero_psp.creditcard' | 'dintero_psp.vipps' | 'dintero_psp.googlepay' | 'dintero_psp.applepay' | 'dintero_psp.clicktopay' | 'instabank.finance' | 'instabank.invoice' | 'instabank.installment' | 'instabank.postponement' | 'klarna.klarna' | 'klarna.billie' | 'kravia.invoice_b2b' | 'kravia.invoice_b2b_grouped' | 'kravia.invoice_b2c' | 'two.invoice_b2b' | 'netaxept.creditcard' | 'payex.creditcard' | 'payex.mobilepay' | 'payex.swish' | 'payex.vipps' | 'payex.applepay' | 'payex.clicktopay' | 'payex.googlepay' | 'santander.debit_account' | 'seitatech.in_person' | 'swish.swish' | 'vipps', required — The payment product type corresponding to this transaction - `amount` integer, required — Non-negative, minor units. Total amount of the transaction - `currency` string, iso4217-code, required — ISO 4217 transaction currency - `payout_destination_id` string — An id that identifies the seller, value will be included in the settlement reports - `merchant_reference` string — A reference specified by the merchant to identify the transaction - `channel` 'ecommerce' | 'in_app' | 'in_store' — The channel for the transaction - `platform_type` 'aggregator' | 'marketplace' — Type of platform the merchant is. - `merchant_reference_2` string — A reference specified by the merchant to identify the transaction, can be updated after the transaction has been created - `dynamic_descriptor` string — A short reference / descriptor that will show up on the customers bank statement - `payment_operation` 'unscheduled_purchase' | 'recurring_purchase' | 'generate_payment_token' — Initiated by the merchant or used to generate a token - `settlement_status` 'NOT_SETTLED' | 'PENDING_SETTLEMENT' | 'PARTIALLY_SETTLED' | 'SETTLED' — Overall settlement status after the events - `customer` object - `customer_id` string — Customer id - `email` string — Customer email address - `phone_number` string — Customer phone number, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `my_dintero` MyDinteroUserCreation — Options for myDintero - `actions` string[], required — Actions to perform on the customer - `terms` object, required — Terms and conditions accepted - `id` string, uuid, required — id of the myDintero terms and conditions - `url` string, uri, required — Url to the terms and conditions accepted by the customer - `customer_ip` string — The IP address of the customer - `user_agent` string — The full user agent string of the device the customer used to submit the transaction - `initiating_system_request_headers` SystemRequestHeaders - `dintero-system-name` string — The name of the ecommerce solution - `dintero-system-version` string — The version number of the ecommerce solution - `dintero-system-plugin-name` string — The name of the ecommerce plugin - `dintero-system-plugin-version` string — The version number of the ecommerce plugin - `user-agent` string — The user-agent that performed the request - `shipping_address` OrderAddress — Address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `shipping_option` MultiShipmentTopLevelShippingOption — A shipping option - `id` string, required — Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. - `line_id` string, required — Unique id of the specific configuration of this shipping product - `countries` string[] — Countries where this shipping option can be used - `amount` integer, required — The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `title` string, required — A shipping option title. Eg. "Standard" - `description` string — A short description of the shipping option product - `delivery_method` 'delivery' | 'pick_up' | 'unspecified' | 'none' - `operator` string, required — Name of company that provides shipping service - `operator_product_id` string — The operators own id for this shipping product - `eta` object — Relative time for delivery or pick-up - `working_days` number[] — The expected range of days until the relative time is reached. A range of `[0,0]` means the relative time is today. `[0,3]` means the relative time is within the next 3 days. - `shipping_day_of_week` number — The day of the week the relative time for shipping is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `arrival_day_of_week` number — The day of the week the relative time for arrival is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `starts_at` string, date-time - `ends_at` string, date-time - `time_slot` object — A specified time for delivery to customer - `starts_at` string, date-time - `ends_at` string, date-time - `pick_up_address` object — Additional information about the shipping address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `website_url` string — The website URL of the customer. - `opening_hours` unknown - `distance` number — Distance in kilometers from the shipping_address. - `metadata` object — Additional metadata about the shipping_option - `environmental_data` object — Environmental data about the shipping option - `description` string, required — A short description of the environmental data, something like - "Fossil free", - "Carbon neutral" - "Low emissions" - "Renewable Energy Sourced" - "Eco-certified Fleet" - `details` object[] - `label` string, required — Give context to the value field. Example: - "CO2 emissions" - "Energy consumption" - "Carbon footprint" - "Carbon offset" - "Trees planted" - "Renewable energy percentage" - `value` string, required - `thumbnail_url` string, uri — URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `pay_in_store` object — Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method `dintero.zero` is enabled - `type` 'full', required - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - `type` 'proportional', required - `destinations` string[] — Seller ids that will be debited for the payment fees All destinations must be included in the list of splits - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - `payout_destination_id` string, required — An id that identifies the seller Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `amount` integer, required — The split amount in smallest unit for the currency, e.g. cents. - `shipments` MultiShipmentShippingOption[] — For multiple shipments we have a single top-level shipping object that contains the shipments for the order. The shipping options defined in `shipments` must contain `shipment_items` that define what items belong to what shipment. For multiple shipments: - do not define `splits` on the toplevel shipping option - do not define `fee_split` on the toplevel shipping option - the `pay_in_store` option is not compatible with `shipments` - empty shipments array is not allowed - single item multi shipping option is not allowed - `id` string, required — Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. - `line_id` string, required — Unique id of the specific configuration of this shipping product - `countries` string[] — Countries where this shipping option can be used - `amount` integer, required — The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `title` string, required — A shipping option title. Eg. "Standard" - `description` string — A short description of the shipping option product - `delivery_method` 'delivery' | 'pick_up' | 'unspecified' | 'none' - `operator` string, required — Name of company that provides shipping service - `operator_product_id` string — The operators own id for this shipping product - `eta` object — Relative time for delivery or pick-up - `working_days` number[] — The expected range of days until the relative time is reached. A range of `[0,0]` means the relative time is today. `[0,3]` means the relative time is within the next 3 days. - `shipping_day_of_week` number — The day of the week the relative time for shipping is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `arrival_day_of_week` number — The day of the week the relative time for arrival is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `starts_at` string, date-time - `ends_at` string, date-time - `time_slot` object — A specified time for delivery to customer - `starts_at` string, date-time - `ends_at` string, date-time - `pick_up_address` object — Additional information about the shipping address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `website_url` string — The website URL of the customer. - `opening_hours` unknown - `distance` number — Distance in kilometers from the shipping_address. - `metadata` object — Additional metadata about the shipping_option - `environmental_data` object — Environmental data about the shipping option - `description` string, required — A short description of the environmental data, something like - "Fossil free", - "Carbon neutral" - "Low emissions" - "Renewable Energy Sourced" - "Eco-certified Fleet" - `details` object[] - `label` string, required — Give context to the value field. Example: - "CO2 emissions" - "Energy consumption" - "Carbon footprint" - "Carbon offset" - "Trees planted" - "Renewable energy percentage" - `value` string, required - `thumbnail_url` string, uri — URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `pay_in_store` object — Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method `dintero.zero` is enabled - `type` 'full', required - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - `type` 'proportional', required - `destinations` string[] — Seller ids that will be debited for the payment fees All destinations must be included in the list of splits - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - `payout_destination_id` string, required — An id that identifies the seller Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `amount` integer, required — The split amount in smallest unit for the currency, e.g. cents. - `shipment_id` string — For orders that have multiple shipments. The shipping options will be grouped by `shipment_id`. The top-level multi shipment shipping option array at `order.shipping_option.shipments` will contain one shipping option per `shipment_id` found in the shipping options sprovided in `express.shipping_options`. In order to present multiple shipping options for a given `shipment_id` set the same shipment_id to all the shipping options for that shipment. - `shipment_items` MultiShipmentItem[] — An array of objects specifying what items will be delivered by this shipment. Should only be specified when an order has multiple shipments so the checkout knows what items will be shipped by the shipping options. If there are multiple shipments the session (and resulting transaction) will have a single top-level shipping object that contains multiple `shipments` for the order. - `line_id` string, required — The line_id or an item in order.items - `quantity` number — The quantity of the product in the item line. - `billing_address` OrderAddress — Address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `store` Store - `id` string, required - `name` string — name of the store, aka trade name of the store - `business_name` string — Official name of the person or entity that owns the store. - `address` Address - `address_line` string, required - `address_line_2` string - `postal_code` string - `postal_place` string, required - `country` string, iso-3166-1, required — ISO 3166-1 country code - `chain` string - `email` string - `gln` string - `organization_number` string - `phone_number` string - `mcc` string, iso-18245 — A four-digit Merchant Category Code (MCC) for the store [ISO 18245:2003](https://www.iso.org/standard/33365.html) - `bax` string — Merchant number associated with the stores payment terminal - `terminal_id` string — Id to a specific point-of-sale (POS) terminal or workstation - `payout_destination_id` string — The payout destination id for the merchant of record, i.e. the seller responsible for the transaction. Required when `seitatech.in_person` payment is enabled. - `status` 'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'CAPTURED' | 'PARTIALLY_CAPTURED' | 'PARTIALLY_CAPTURED_REFUNDED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'DECLINED' | 'FAILED' | 'UNKNOWN' | 'ON_HOLD' — The current status of the transaction - `gift_cards` Giftcard[] — The gift cards that used to partially or fully authorize the transaction - `type` 'dintero.wallets', required - `card_id` string, required - `amount` integer, required — Non-negative, minor units. Total amount for the gift card - `masked_card_token` string - `items` object[] — The applicable transaction items - `id` string — The ID or SKU of the product on the line - `groups` object[] — The groups the product on the line belongs to - `id` string, required — Group ID - `name` string — Group name - `line_id` string — the number of the line (or id), must be `unique` between all items. `required` when Instabank payment is configured. - `version` number — The version where the item was added or last updated, see the events for the source. - `description` string — A short, localized description of the line item - `quantity` number — The quantity of the product in the item line. Quantities are usually whole numbers, but can also be decimal, in cases where the product is sold by weight, volume or other denominations. - `amount` integer — The total monetary amount of the line item, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. In smallest unit for the currency, e.g. cents - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `unit_volume` number — The volume of one item in m³ (cubic meters) - `unit_weight` number — The volume of one item in kg (kilo grams) - `unit_dimensional_weight` number — The dimensional weight (also known as volumetric) value unit of one item. [Dimensional weight at Wikipedia](https://en.wikipedia.org/wiki/Dimensional_weight) - `type` 'physical' | 'digital' | 'service' | 'gift_card' | 'shipping' | 'surcharge' — The type of order item this is. - **physical** - a physical item which must be delivered or handed over - **digital** - a digital item which doesn't need shipping - **service** - payment for services like maintenance performed in your home - **gift_card** - usage of a gift card, where the amount is usually a negative number - **shipping** - payment for shipping of the order - **surcharge** - extra incurred costs, like taxes or necessary rounding - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - `type` 'proportional', required - `destinations` string[] — Seller ids that will be debited for the payment fees All destinations must be included in the list of splits - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - `payout_destination_id` string, required — An id that identifies the seller Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `amount` integer, required — The split amount in smallest unit for the currency, e.g. cents. - `thumbnail_url` string, uri — URL to a thumbnail of the item. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `emd` Emd — Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/). Some items require extra information to be provided when using Klarna as an enabled payment option. - `event` object[] — Only required if the item is related to an event or multiple events, like for example tickets to a concert. If you are selling an event package as a single ticket or item that includes multiple events, for example a festival, you need to provide information about all the individual events that are part of the package. - `event_name` string, required — Name of the event, e.g. "Fancy Singer" - `event_company` string, required — Name of the company arranging the event, e.g. "Happy Parties Ltd." - `genre_of_event` string, required — Category or type of venue, e.g. "Pop" - `arena_name` string — Name of the venue, e.g. "Song Arena" - `arena_location` object - `street_address` string — Street address representing the venue location, e.g. "Sonja Henies plass 2" - `postal_code` string — Postal code for the venue location, e.g. "0185" - `city` string, required — City that the venue is located in, e.g. "Oslo" - `country` string, required — Country that the venue is located in (ISO 3166-1 alpha-2 format), e.g. "NO" - `start_time` string, date-time, required — Start time of the event (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `end_time` string, date-time, required — End time of the event (ISO 8601 format), e.g. "2023-08-16T16:00:00Z". If a timezone is not specified we assume UTC. - `access_controlled_venue` boolean — If tickets are digitally checked when entering the venue, e.g. true - `ticket_delivery_method` 'pick_up' | 'email' | 'post' | 'phone', required - `ticket_delivery_recipient` string, required — Name of the recipient the ticket is delivered to, e.g. "recipient@mail.com". If email or phone, then use either the email address or the phone number respectively. - `affiliate_name` string — Name of the affiliate that originated the purchase. - `subscription` EmdRecurring — Only required if the item is related to a subscription. If that is the case, you need to provide information about both the subscription and the customer account. - `subscription` EmdSubscription, required — Details related to the subscription. - `subscription_name` string, required — Name of the product on subscription, e.g. "Contact lenses" - `start_time` string, date-time, required — The start time of the subscription (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC - `end_time` string, date-time, required — The end time of the subscription (ISO 8601 format), e.g. "2023-09-16T15:00:00Z". If a timezone is not specified we assume UTC - `auto_renewal_of_subscription` boolean, required — Whether the subscription will be auto renewed upon expiry, e.g. true - `affiliate_name` string — Name of the affiliate that originated the purchase. - `customer_account_info` EmdCustomerAccountInfo, required — Information related to the customer that wants to purchase the subscription. - `unique_account_identifier` string, required — Unique name / number to identify the specific customer account. Max 24 characters, e.g. "Adam Adamsson" - `account_registration_date` string, required — The date and time the account was registered (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `account_last_modified` string, required — The date and time the account was last modified (ISO 8601 format), e.g. "2023-10-16T15:00:00Z". If a timezone is not specified we assume UTC. - `travel` EmdTravel — Only required if the item is part of a travel-related transaction. If that is the case, you need to provide information about the itinerary to be booked. - `air_reservation_details` EmdAirReservationDetails — Details about the reservation of airline tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdAirReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one flight from Oslo to Munich, and another flight from Munich to Dubai, you need to provide one itinerary object for each of these two flights, and so on. - `departure` string, required — IATA Airport Code (three letters), e.g. "OSL" - `departure_city` string — City the flight departs from, e.g. "Oslo" - `arrival` string, required — IATA Airport Code (three letters), e.g. "MUC" - `arrival_city` string — City the flight arrives in, e.g. "Munich" - `carrier` string, required — IATA Airline standard (two letters or digits), e.g. "LH" - `segment_price` integer — Price for that specific segment of the flight in smallest unit of local currency, e.g. 200000 - `departure_date` string, required — Departure date (ISO 8601 format), e.g. "2023-08-16T15:00:00Z" If a timezone is not specified, we assume UTC. - `ticket_delivery_method` 'pick_up' | 'email' | 'post' | 'phone', required - `ticket_delivery_recipient` string, required — Name of the recipient the ticket is delivered to, e.g. "Maximilian". If email or phone, then use either the email address or the phone number respectively. - `passenger_id` integer[] — IDs of all the passengers included in this itinerary. - `class` string — Travel class, e.g. "First Class" - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - `insurance_company` string — Name of the company which offers the insurance, e.g. "Oopsie Insurance Ltd." - `insurance_type` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' — Type of insurance, e.g. "travel" - `insurance_price` integer — Price of the insurance in smallest unit of local currency, e.g. 50000 - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - `id` integer — Passenger id, e.g. 1 - `title` 'mr' | 'mrs' | 'ms' | '' — Passenger title, e.g. "mr". Blank if under 12 years. - `first_name` string, required — First name of the passenger, e.g. "Paul" - `last_name` string, required — Last name of the passenger, e.g. "Lamb" - `affiliate_name` string — Name of the affiliate that originated the purchase. - `bus_reservation_details` EmdBusReservationDetails — Details about the reservation of bus tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdBusReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one bus journey from Oslo to Munich, and another bus journey from Munich to Rome, you need to provide one itinerary object for each of these two bus journeys, and so on. - `departure_city` string, required — City the bus departs from, e.g. "Oslo" - `arrival_city` string, required — City the bus arrives in, e.g. "Munich" - `carrier` string, required — Name of transportation company. "Big Bus Travels Ltd." - `segment_price` integer — Price for that specific segment of the bus journey in smallest unit of local currency, e.g. 200000 - `departure_date` string, required — Departure date (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified, we assume UTC. - `ticket_delivery_method` 'pick_up' | 'email' | 'post' | 'phone', required - `ticket_delivery_recipient` string, required — Name of the recipient the ticket is delivered to, e.g. "Maximilian". If email or phone, then use either the email address or the phone number respectively. - `passenger_id` integer[] — IDs of all the passengers included in this itinerary. - `class` string — Travel class, e.g. "First Class" - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - `insurance_company` string — Name of the company which offers the insurance, e.g. "Oopsie Insurance Ltd." - `insurance_type` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' — Type of insurance, e.g. "travel" - `insurance_price` integer — Price of the insurance in smallest unit of local currency, e.g. 50000 - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - `id` integer — Passenger id, e.g. 1 - `title` 'mr' | 'mrs' | 'ms' | '' — Passenger title, e.g. "mr". Blank if under 12 years. - `first_name` string, required — First name of the passenger, e.g. "Paul" - `last_name` string, required — Last name of the passenger, e.g. "Lamb" - `affiliate_name` string — Name of the affiliate that originated the purchase. - `train_reservation_details` EmdTrainReservationDetails — Details about the reservation of train tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdTrainReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one train journey from Oslo to Munich, and another train journey from Munich to Rome, you need to provide one itinerary object for each of these two train journeys, and so on. - `departure_city` string, required — City the train departs from, e.g. "Oslo" - `arrival_city` string, required — City the train arrives in, e.g. "Munich" - `carrier` string, required — Name of transportation company. "Big Train Travels Ltd." - `segment_price` integer — Price for that specific segment of the train journey in smallest unit of local currency, e.g. 200000 - `departure_date` string, required — Departure date (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified, we assume UTC. - `ticket_delivery_method` 'pick_up' | 'email' | 'post' | 'phone', required - `ticket_delivery_recipient` string, required — Name of the recipient the ticket is delivered to, e.g. "Maximilian". If email or phone, then use either the email address or the phone number respectively. - `passenger_id` integer[], required — IDs of all the passengers included in this itinerary. - `class` string — Travel class, e.g. "First Class" - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - `insurance_company` string — Name of the company which offers the insurance, e.g. "Oopsie Insurance Ltd." - `insurance_type` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' — Type of insurance, e.g. "travel" - `insurance_price` integer — Price of the insurance in smallest unit of local currency, e.g. 50000 - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - `id` integer — Passenger id, e.g. 1 - `title` 'mr' | 'mrs' | 'ms' | '' — Passenger title, e.g. "mr". Blank if under 12 years. - `first_name` string, required — First name of the passenger, e.g. "Paul" - `last_name` string, required — Last name of the passenger, e.g. "Lamb" - `affiliate_name` string — Name of the affiliate that originated the purchase. - `ferry_reservation_details` EmdFerryReservationDetails — Details about the reservation of ferry tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdFerryReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one ferry journey from Oslo to Kiel, and another ferry journey from Kiel to Gothenburg, you need to provide one itinerary object for each of these two ferry journeys, and so on. - `departure_city` string, required — City the ferry departs from, e.g. "Oslo" - `arrival_city` string, required — City the ferry arrives in, e.g. "Munich" - `carrier` string, required — Name of transportation company. "Big Ferry Travels Ltd." - `segment_price` integer — Price for that specific segment of the ferry journey in smallest unit of local currency, e.g. 200000 - `departure_date` string, required — Departure date (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified, we assume UTC. - `ticket_delivery_method` 'pick_up' | 'email' | 'post' | 'phone', required - `ticket_delivery_recipient` string, required — Name of the recipient the ticket is delivered to, e.g. "Maximilian". If email or phone, then use either the email address or the phone number respectively. - `passenger_id` integer[] — IDs of all the passengers included in this itinerary. - `class` string — Travel class, e.g. "First Class" - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - `insurance_company` string — Name of the company which offers the insurance, e.g. "Oopsie Insurance Ltd." - `insurance_type` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' — Type of insurance, e.g. "travel" - `insurance_price` integer — Price of the insurance in smallest unit of local currency, e.g. 50000 - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - `id` integer — Passenger id, e.g. 1 - `title` 'mr' | 'mrs' | 'ms' | '' — Passenger title, e.g. "mr". Blank if under 12 years. - `first_name` string, required — First name of the passenger, e.g. "Paul" - `last_name` string, required — Last name of the passenger, e.g. "Lamb" - `affiliate_name` string — Name of the affiliate that originated the purchase. - `hotel_reservation_details` EmdHotelReservationDetails — Details about the reservation of hotel rooms. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdHotelReservationDetailsItinerary[], required — Hotel itinerary data, one per hotel stay. If you are selling a package that contains multiple hotel stays, you need to provide itinerary data for each of the individual stays. - `hotel_name` string — Name of the hotel, e.g. "Premium Hotel" - `address` object — Address details of the hotel. - … - `start_time` string, required — Start time of the hotel stay (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified, we assume UTC. - `end_time` string, required — End time of the hotel stay (ISO 8601 format), e.g. "2023-08-20T15:00:00Z". If a timezone is not specified, we assume UTC. - `number_of_rooms` integer, required — Number of rooms booked, e.g. 2 - `passenger_id` integer[], required — IDs of all the passengers included in this itinerary. - `ticket_delivery_method` 'pick_up' | 'email' | 'post' | 'phone', required - `ticket_delivery_recipient` string, required — Name of the recipient the ticket is delivered to, e.g. "Maximilian". If email or phone, then use either the email address or the phone number respectively. - `hotel_price` integer, required — Price for the hotel stay in smallest unit of local currency, e.g. 200000 - `class` string — Travel class, e.g. "First Class" - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - `insurance_company` string — Name of the company which offers the insurance, e.g. "Oopsie Insurance Ltd." - `insurance_type` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' — Type of insurance, e.g. "travel" - `insurance_price` integer — Price of the insurance in smallest unit of local currency, e.g. 50000 - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - `id` integer — Passenger id, e.g. 1 - `title` 'mr' | 'mrs' | 'ms' | '' — Passenger title, e.g. "mr". Blank if under 12 years. - `first_name` string, required — First name of the passenger, e.g. "Paul" - `last_name` string, required — Last name of the passenger, e.g. "Lamb" - `affiliate_name` string — Name of the affiliate that originated the purchase. - `car_rental_reservation_details` EmdCarRentalReservationDetails — Details about the reservation of rental cars. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdCarRentalReservationDetailsItinerary[], required — Car rental itinerary data, one per car rental. If you are selling a package that contains multiple car rentals, you need to provide itinerary data for each of the individual rentals. - `rental_company` string, required — Name of the car rental company, e.g. "Premium Cars Ltd." - `drivers_id` integer[] — Driver IDs. - `pick_up_location` object — Details related to the pick up location. - … - `drop_off_location` object — Details related to the drop off location. - … - `start_time` string, required — Start time of the car rental reservation (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified, we assume UTC. - `end_time` string, required — End time of the car rental reservation (ISO 8601 format), e.g. "2023-08-20T15:00:00Z". If a timezone is not specified, we assume UTC. - `car_price` integer — Price for the car rental reservation in smallest unit of local currency, e.g. 500000 - `class` string — Travel class, e.g. "Premium Cars Premium Class" - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - `insurance_company` string — Name of the company which offers the insurance, e.g. "Oopsie Insurance Ltd." - `insurance_type` 'cancellation' | 'travel' | 'cancellation_travel' | 'bankruptcy' — Type of insurance, e.g. "travel" - `insurance_price` integer — Price of the insurance in smallest unit of local currency, e.g. 50000 - `drivers` EmdTravelPassenger[], required — Driver data, one per driver. - `id` integer — Passenger id, e.g. 1 - `title` 'mr' | 'mrs' | 'ms' | '' — Passenger title, e.g. "mr". Blank if under 12 years. - `first_name` string, required — First name of the passenger, e.g. "Paul" - `last_name` string, required — Last name of the passenger, e.g. "Lamb" - `affiliate_name` string — Name of the affiliate that originated the purchase. - `marketplace_order` EmdMarketplaceOrder — Only required if them item is related to a marketplace order. If that is the case, you need to provide information about both the seller and the winner. - `seller_info` EmdMarketplaceSellerInfo, required — Details related to the seller involved in the marketplace order. - `unique_account_identifier_seller` object — Details about the seller. - `email` string — Seller's email address, e.g. "seller@mail.com" - `phone_number` string — Seller's phone number, e.g. "97712123" - `other` string - `sub_merchant_id` string, required — Name or unique number of the selling/delivering merchant, e.g. "Marketbrick Ltd." - `product_category` string, required — Name of the category to which the specific good belongs to, according to the selling merchant's categorization, e.g. "Phones". - `product_name` string — Name of the good purchased. - `account_registration_date` string, date-time, required — Date and time that the account was registered (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `account_last_modified` EmdMarketplaceAccountLastModified, required - `password` string, date-time, required — Date and time that the password was last modified (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `email` string, date-time, required — Date and time that the email was last modified (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `listing` string, date-time, required — Date and time that the listing details were last modified (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `login` string, date-time, required — Date and time that the login details were last changed (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `address` string, date-time, required — Date and time that the (physical) address was last modified (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `seller_rating` number — Current rating of the good purchased according to the marketplace's rating scale, e.g. 5 - `number_of_trades` integer, required — Number of trades the sub-merchant did in the last 12 months, e.g. 23 - `volume_of_trades` integer — Volumes of trades the sub-merchant did in the last 12 months, e.g. 230 - `winner_info` EmdMarketplaceWinnerInfo, required — Details related to the winner involved in the marketplace order. - `unique_account_identifier_winner` object — Details about the winner. - `email` string — Winner's email address, e.g. "winner@mail.com" - `phone_number` string — Winner's phone number, e.g. "97712123" - `other` string - `account_registration_date` string, date-time, required — Date and time that the account was registered (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `account_last_modified` EmdMarketplaceAccountLastModified, required - `password` string, date-time, required — Date and time that the password was last modified (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `email` string, date-time, required — Date and time that the email was last modified (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `listing` string, date-time, required — Date and time that the listing details were last modified (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `login` string, date-time, required — Date and time that the login details were last changed (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `address` string, date-time, required — Date and time that the (physical) address was last modified (ISO 8601 format), e.g. "2023-08-17T15:00:00Z". If a timezone is not specified we assume UTC. - `number_of_trades` integer, required — Number of trades the winner did in the last 12 months, e.g. 23 - `volume_of_trades` integer — Volumes of trades the winner did in the last 12 months, e.g. 230 - `store` Store - `id` string, required - `name` string — name of the store, aka trade name of the store - `business_name` string — Official name of the person or entity that owns the store. - `address` Address - `address_line` string, required - `address_line_2` string - `postal_code` string - `postal_place` string, required - `country` string, iso-3166-1, required — ISO 3166-1 country code - `chain` string - `email` string - `gln` string - `organization_number` string - `phone_number` string - `mcc` string, iso-18245 — A four-digit Merchant Category Code (MCC) for the store [ISO 18245:2003](https://www.iso.org/standard/33365.html) - `bax` string — Merchant number associated with the stores payment terminal - `terminal_id` string — Id to a specific point-of-sale (POS) terminal or workstation - `payout_destination_id` string — The payout destination id for the merchant of record, i.e. the seller responsible for the transaction. Required when `seitatech.in_person` payment is enabled. - `eligible_for_discount` boolean — The item is eligible for discount - `is_changed` boolean — Discount applied to amount - `gross_amount` number — The origin item amount before any discount - `discount_lines` DiscountItem[] - `amount` integer — Monetary amount in smallest unit for the currency - `percentage` number — Optional, set if the amount given was from a percentage discount - `discount_type` 'customer' | 'periodic' | 'manual' | 'loyalty' | 'total' | 'employee' | 'external' - `discount_id` string - `description` string - `line_id` integer - `url` object - `redirect_url` string, uri — URL the customer is redirected after checkout completes (successfully or failed) - `approval_url` string, uri — URL the customer is redirected to for authentication. - `callback_url` string, uri — URL that Checkout will call when the session payment is complete and the transaction has been authorized - `events` object[] — All events recorded on the transaction - `id` string - `transaction_status` 'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'CAPTURED' | 'PARTIALLY_CAPTURED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'DECLINED' | 'FAILED' | 'UNKNOWN' | 'ON_HOLD' — The transaction state after this event - `gift_cards` object[] — The gift cards that was used as part of this event - `type` 'dintero.wallets', required - `card_id` string, required - `amount` integer, required — Non-negative, minor units. Total amount for the gift card - `masked_card_token` string - `transaction_id` string, required — The external transaction ID - `event` 'INITIALIZE' | 'AUTHORIZE' | 'CAPTURE' | 'REFUND' | 'VOID' | 'INITIATE_REFUND' | 'INITIATE_VOID' | 'INITIATE_CAPTURE' | 'SETTLEMENT' — the event type - `success` boolean — The event operation completed with success - `correction` object — Correction of the transaction status and event after a failed operation - `event_ids` string[] — List of event ids added to correct the transaction status - `status` string, required — status the transaction was corrected to - `remaining_capture_amount` integer, required — Monetary amount in smallest unit for the currency - `remaining_refund_amount` integer, required — Monetary amount in smallest unit for the currency - `remaining_void_amount` integer, required — Monetary amount in smallest unit for the currency - `error` object — The event error is only used when the success is `false`. - `code` string — The code used to identify the error/warning - `message` string, required — The human readable description of the error/warning - `type` string[] - `result_code` string — Result code received from Visa or Mastercard - `retry_policy` object — Information about retry policy for the error - `retry_codes` string[], required — List of retry codes applicable for this error - `retry_after` string — ISO 8601 timestamp indicating when to retry the operation. Will only be present if retry_codes contains `RETRY_AFTER_DELAY` - `amount` number — Amount captured or refunded - `calculated_vat_amount` number — Best-effort calculation of the VAT amount in this transaction - `items` object[] — The applicable event items - `discount_lines` DiscountItem[] — Metadata about discounts given - `amount` integer — Monetary amount in smallest unit for the currency - `percentage` number — Optional, set if the amount given was from a percentage discount - `discount_type` 'customer' | 'periodic' | 'manual' | 'loyalty' | 'total' | 'employee' | 'external' - `discount_id` string - `description` string - `line_id` integer - `id` string — The ID or SKU of the product on the line - `groups` object[] — The groups the product on the line belongs to - `id` string, required — Group ID - `name` string — Group name - `line_id` string — the number of the line (or id), must be `unique` between all items. `required` when Instabank payment is configured. - `version` number — The version where the item was added or last updated, see the events for the source. - `description` string — A short, localized description of the line item - `quantity` number — The quantity of the product in the item line. Quantities are usually whole numbers, but can also be decimal, in cases where the product is sold by weight, volume or other denominations. - `amount` integer — The total monetary amount of the line item, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. In smallest unit for the currency, e.g. cents - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `unit_volume` number — The volume of one item in m³ (cubic meters) - `unit_weight` number — The volume of one item in kg (kilo grams) - `unit_dimensional_weight` number — The dimensional weight (also known as volumetric) value unit of one item. [Dimensional weight at Wikipedia](https://en.wikipedia.org/wiki/Dimensional_weight) - `type` 'physical' | 'digital' | 'service' | 'gift_card' | 'shipping' | 'surcharge' — The type of order item this is. - **physical** - a physical item which must be delivered or handed over - **digital** - a digital item which doesn't need shipping - **service** - payment for services like maintenance performed in your home - **gift_card** - usage of a gift card, where the amount is usually a negative number - **shipping** - payment for shipping of the order - **surcharge** - extra incurred costs, like taxes or necessary rounding - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - `type` 'proportional', required - `destinations` string[] — Seller ids that will be debited for the payment fees All destinations must be included in the list of splits - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - `payout_destination_id` string, required — An id that identifies the seller Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `amount` integer, required — The split amount in smallest unit for the currency, e.g. cents. - `thumbnail_url` string, uri — URL to a thumbnail of the item. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `emd` Emd — Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/). Some items require extra information to be provided when using Klarna as an enabled payment option. - `event` object[] — Only required if the item is related to an event or multiple events, like for example tickets to a concert. If you are selling an event package as a single ticket or item that includes multiple events, for example a festival, you need to provide information about all the individual events that are part of the package. - `event_name` string, required — Name of the event, e.g. "Fancy Singer" - `event_company` string, required — Name of the company arranging the event, e.g. "Happy Parties Ltd." - `genre_of_event` string, required — Category or type of venue, e.g. "Pop" - `arena_name` string — Name of the venue, e.g. "Song Arena" - `arena_location` object - `street_address` string — Street address representing the venue location, e.g. "Sonja Henies plass 2" - `postal_code` string — Postal code for the venue location, e.g. "0185" - `city` string, required — City that the venue is located in, e.g. "Oslo" - `country` string, required — Country that the venue is located in (ISO 3166-1 alpha-2 format), e.g. "NO" - `start_time` string, date-time, required — Start time of the event (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `end_time` string, date-time, required — End time of the event (ISO 8601 format), e.g. "2023-08-16T16:00:00Z". If a timezone is not specified we assume UTC. - `access_controlled_venue` boolean — If tickets are digitally checked when entering the venue, e.g. true - `ticket_delivery_method` 'pick_up' | 'email' | 'post' | 'phone', required - `ticket_delivery_recipient` string, required — Name of the recipient the ticket is delivered to, e.g. "recipient@mail.com". If email or phone, then use either the email address or the phone number respectively. - `affiliate_name` string — Name of the affiliate that originated the purchase. - `subscription` EmdRecurring — Only required if the item is related to a subscription. If that is the case, you need to provide information about both the subscription and the customer account. - `subscription` EmdSubscription, required — Details related to the subscription. - `subscription_name` string, required — Name of the product on subscription, e.g. "Contact lenses" - `start_time` string, date-time, required — The start time of the subscription (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC - `end_time` string, date-time, required — The end time of the subscription (ISO 8601 format), e.g. "2023-09-16T15:00:00Z". If a timezone is not specified we assume UTC - `auto_renewal_of_subscription` boolean, required — Whether the subscription will be auto renewed upon expiry, e.g. true - `affiliate_name` string — Name of the affiliate that originated the purchase. - `customer_account_info` EmdCustomerAccountInfo, required — Information related to the customer that wants to purchase the subscription. - `unique_account_identifier` string, required — Unique name / number to identify the specific customer account. Max 24 characters, e.g. "Adam Adamsson" - `account_registration_date` string, required — The date and time the account was registered (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `account_last_modified` string, required — The date and time the account was last modified (ISO 8601 format), e.g. "2023-10-16T15:00:00Z". If a timezone is not specified we assume UTC. - `travel` EmdTravel — Only required if the item is part of a travel-related transaction. If that is the case, you need to provide information about the itinerary to be booked. - `air_reservation_details` EmdAirReservationDetails — Details about the reservation of airline tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdAirReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one flight from Oslo to Munich, and another flight from Munich to Dubai, you need to provide one itinerary object for each of these two flights, and so on. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `bus_reservation_details` EmdBusReservationDetails — Details about the reservation of bus tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdBusReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one bus journey from Oslo to Munich, and another bus journey from Munich to Rome, you need to provide one itinerary object for each of these two bus journeys, and so on. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `train_reservation_details` EmdTrainReservationDetails — Details about the reservation of train tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdTrainReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one train journey from Oslo to Munich, and another train journey from Munich to Rome, you need to provide one itinerary object for each of these two train journeys, and so on. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `ferry_reservation_details` EmdFerryReservationDetails — Details about the reservation of ferry tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdFerryReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one ferry journey from Oslo to Kiel, and another ferry journey from Kiel to Gothenburg, you need to provide one itinerary object for each of these two ferry journeys, and so on. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `hotel_reservation_details` EmdHotelReservationDetails — Details about the reservation of hotel rooms. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdHotelReservationDetailsItinerary[], required — Hotel itinerary data, one per hotel stay. If you are selling a package that contains multiple hotel stays, you need to provide itinerary data for each of the individual stays. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `car_rental_reservation_details` EmdCarRentalReservationDetails — Details about the reservation of rental cars. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdCarRentalReservationDetailsItinerary[], required — Car rental itinerary data, one per car rental. If you are selling a package that contains multiple car rentals, you need to provide itinerary data for each of the individual rentals. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `drivers` EmdTravelPassenger[], required — Driver data, one per driver. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `marketplace_order` EmdMarketplaceOrder — Only required if them item is related to a marketplace order. If that is the case, you need to provide information about both the seller and the winner. - `seller_info` EmdMarketplaceSellerInfo, required — Details related to the seller involved in the marketplace order. - `unique_account_identifier_seller` object — Details about the seller. - … - `sub_merchant_id` string, required — Name or unique number of the selling/delivering merchant, e.g. "Marketbrick Ltd." - `product_category` string, required — Name of the category to which the specific good belongs to, according to the selling merchant's categorization, e.g. "Phones". - `product_name` string — Name of the good purchased. - `account_registration_date` string, date-time, required — Date and time that the account was registered (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `account_last_modified` EmdMarketplaceAccountLastModified, required - … - `seller_rating` number — Current rating of the good purchased according to the marketplace's rating scale, e.g. 5 - `number_of_trades` integer, required — Number of trades the sub-merchant did in the last 12 months, e.g. 23 - `volume_of_trades` integer — Volumes of trades the sub-merchant did in the last 12 months, e.g. 230 - `winner_info` EmdMarketplaceWinnerInfo, required — Details related to the winner involved in the marketplace order. - `unique_account_identifier_winner` object — Details about the winner. - … - `account_registration_date` string, date-time, required — Date and time that the account was registered (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `account_last_modified` EmdMarketplaceAccountLastModified, required - … - `number_of_trades` integer, required — Number of trades the winner did in the last 12 months, e.g. 23 - `volume_of_trades` integer — Volumes of trades the winner did in the last 12 months, e.g. 230 - `store` Store - `id` string, required - `name` string — name of the store, aka trade name of the store - `business_name` string — Official name of the person or entity that owns the store. - `address` Address - `address_line` string, required - `address_line_2` string - `postal_code` string - `postal_place` string, required - `country` string, iso-3166-1, required — ISO 3166-1 country code - `chain` string - `email` string - `gln` string - `organization_number` string - `phone_number` string - `mcc` string, iso-18245 — A four-digit Merchant Category Code (MCC) for the store [ISO 18245:2003](https://www.iso.org/standard/33365.html) - `bax` string — Merchant number associated with the stores payment terminal - `terminal_id` string — Id to a specific point-of-sale (POS) terminal or workstation - `payout_destination_id` string — The payout destination id for the merchant of record, i.e. the seller responsible for the transaction. Required when `seitatech.in_person` payment is enabled. - `created_at` string, date-time - `created_by` string - `request_id` string, uuid - `metadata` object — Additional details about the event - `bambora:transaction:status` string - `bambora:transactionoperation:id` string - `bambora:meta:action:source` string - `bambora:meta:action:code` string - `bambora:meta:action:type` string - `payout_correlation_id` string — Id that will be referenced on the settlement report, unique for this event - `collector:Invoice.InvoiceStatus` number — External status reported after adding invoice and activating invoice - `collector:CorrelationId` string — External request id - `collector:Invoice.PaymentReference` string — The payment identification number. This is the id the customer must use when they do a payment of an invoice. - `collector:Invoice.LowestAmountToPay` number — The lowest amount to pay on the invoice. - `collector:Invoice.TotalAmount` number — The total amount to pay for the invoice. - `collector:Invoice.DueDate` string — The due date of the invoice. - `collector:Invoice.InvoiceUrl` string — The url to invoice in pdf format. - `collector:Invoice.CurrentInvoiceNumber` string — The invoice number of the invoice that this event belongs to. - `collector:Invoice.NewInvoiceNumber` string — The invoice number for the next capture. - `instabank:Sale.Status` string — External status reported after the transaction event - `instabank:RequestId` string — External request id - `dintero_psp:operation_ref` string — Unique reference of operation - `dintero_psp:authorization_operation_ref` string — Reference to authorization operation upon void or capture - `dintero_psp:capture_operation_ref` string — Reference to capture operation upon refund - `dintero_psp:sale_operation_ref` string — Reference to sale operation upon sale refund - `dintero_psp:network:correlation_id` string — Reference to the operation, assigned by the card network. - `dintero_psp:network:acquirer_stan` string — System Trace Audit Number (STAN) is a number Dintero assigns to uniquely identify a transaction on the card network. Present on Mastercard transactions only. - `dintero_psp:network:lifecycle_trace_id` string — Reference to the original authorization. The value is assigned to the original authorization, and is present on subsequent incremental authorizations, captures, and reversals. Present on Mastercard transactions only. - `klarna:reference` string — Internal reference sent to Klarna for the capture/refund. This will be included in the settlement files. - `klarna:headers:capture_id` string — Id of the capture created in Klarna - `klarna:headers:refund_id` string — Id of the refund created in Klarna - `klarna:headers:location` string — The URI at which the capture or refund created in Klarna can be found - `klarna:authorization_expiration` string — Authorization expiration date (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". - `klarna:authorization_expiration_reason` string — The reason for extending the authorization date. This will be included after extending authorization. - `klarna:authorization_expiration_reference` string — A reference specified by the merchant to identify the transaction. This will be included after extending authorization. - `klarna:authorization_expiration_error_reason` string — The reason an error occurred when trying to extend the authorization date. This will be included after extending authorization. - `klarna:order_amount_update_error` string — The error code returned by Klarna when an order amount update fails. This will be included after attempting to update the order amount. - `klarna:order_amount_update_can_retry` '0' | '1' — Indicates whether the order amount update can be retried after a failure. "0" means the update cannot be retried, "1" means retry is allowed. This will be included after attempting to update the order amount. - `netaxept:transaction_id` string - `netaxept:operation` string - `netaxept:execution_time` string - `netaxept:bat_number` string - `netaxept:response_code` string - `netaxept:terminal_url` string - `payex:transaction:id` string - `payex:transaction:number` union - number - string - `payex:transaction:type` string - `payex:transaction:state` string - `payex:transaction:created` string, date-time - `payex:transaction:payee_reference` string - `santander:debit_account.ApplicationNumber` string — ID of the application provided by Santander - `santander:debit_account.StatusCode` string — Status code from Santander - `swish:payment_request:token` string - `swish:payment_request:get_payment_url` string - `swish:id` string - `swish:originalPaymentReference` string - `swish:paymentReference` string - `swish:amount` string - `swish:dateCreated` string - `swish:datePaid` string - `swish:status` string - `swish:errorCode` string - `swish:errorMessage` string - `vipps:transactionInfo.timeStamp` string, date-time - `vipps:transactionInfo.transactionId` string - `vipps:transactionInfo.status` 'INITIATE' | 'RESERVE' | 'CANCEL' | 'CAPTURE' | 'SALE' | 'VOID' | 'Captured' | 'Cancelled' | 'Refund' - `vipps:transaction.transactionText` string - `kravia:invoice_date` string, date — The date of the invoice. - `kravia:invoice_due_date` string, date — The due date of the invoice. - `kravia:invoice_number` string — The invoice number on the invoice. - `kravia:creditor_id` string — The ID of the creditor. - `kravia:invoice_id` string — ID of the invoice in Kravia system. - `kravia:payment_details:bank_account:bban` string — The payment recipient's bank account. - `kravia:payment_details:bank_account:iban` string — The IBAN of the payment recipient's bank account. - `kravia:payment_details:bank_account:swift` string — The SWIFT code of the payment recipient's bank account. - `kravia:payment_details:kid` string — The KID for the payment. - `terminal_id` string — The ID of the terminal that was used in the event. - `refund_timeout_at` string, date-time — The timeout for `INITIATE_REFUND` events, the transaction will then be updated with failed `REFUND` event, and new refund request can be started - `device_serial_number` string — Serial number of the terminal id - `seitatech:refund_request:id` string — Refund request ID - `seitatech:refund_request:status` string — Status of the refund request - `seitatech:uniqueId` string — Unique transaction ID from the terminal. - `seitatech:receiptNumber` string — Receipt number from the terminal. Unique per terminal; use together with terminal_id from store for a globally unique reference. - `seitatech:outcome` string — Raw outcome code from the terminal ECR response. - `seitatech:merchantCategoryCode` string - `seitatech:applicationIdentifier` string — EMV application identifier (AID). - `seitatech:acquirer` string - `seitatech:actionCode` string - `seitatech:archiveId` string - `seitatech:authorizer` string - `seitatech:batchId` string - `seitatech:customerReceipt` string — Customer receipt text from the terminal. - `seitatech:customerReceiptPart2` string - `seitatech:field41` string — ISO 8583 field 41 - terminal ID. - `seitatech:field42` string — ISO 8583 field 42 - merchant ID. - `seitatech:merchantReceipt` string — Merchant receipt text from the terminal. - `seitatech:merchantReceiptPart2` string - `seitatech:reasonCode` string - `seitatech:responseCode` string - `seitatech:serviceIdentifier` string - `seitatech:aip` string — EMV Application Interchange Profile. - `seitatech:atc` string — EMV Application Transaction Counter. - `seitatech:cid` string — EMV Cryptogram Information Data. - `seitatech:cvm` string — EMV Cardholder Verification Method. - `seitatech:tvr` string — EMV Terminal Verification Results. - `seitatech:languageCode` string - `seitatech:tsi` string — EMV Transaction Status Information. - `seitatech:terminalSerialNumber` string - `seitatech:transactionType` string - `seitatech:saleAmount` string — Sale amount in minor units. - `seitatech:batchUuid` string - `seitatech:outcomeReason` string — Reason code for non-approved outcomes. - `seitatech:posReferenceData` string — POS reference data (M3 field), used as payout correlation ID. - `seitatech:conlonToken` string - `two:order_id` string — A globally unique Order ID set by Two. - `two:remaining_order_id` string — A globally unique ID set by Two for the remaining order. - `two:invoice_url` string, uri — Link to the invoice pdf. - `two:invoice_number` string — The invoice number. - `two:credit_note_url` string, uri — Link to the credit note pdf. - `two:credit_note_number` string — The credit note number. - `two:due_date` string — The invoice due date . - `correlation_request_id` string, uuid — The event correlation to existing event. The property will be set if the event is an CAPTURE or REFUND of correlated INITIATE_CAPTURE or INITIATE_REFUND event. - `event_reference` string — Reference for the transaction event provided by the merchant. - For captures, this is `capture_reference` - For refunds, this is `refund_reference` When relevant, it will be visible on the Dintero settlement report. - `request_headers` RequestHeaders - `dintero-system-name` string — The name of the ecommerce solution - `dintero-system-version` string — The version number of the ecommerce solution - `dintero-system-plugin-name` string — The name of the ecommerce plugin - `dintero-system-plugin-version` string — The version number of the ecommerce plugin - `user-agent` string — The user-agent that performed the request - `dintero-checkout-instance-id` string — The instance of the checkout that performed the request - `settlements` TransactionSettlementsRead - `events` TransactionSettlementsEvent[], required — One item per payout to the merchants bank account - `settlement_id` string, required — Id of the settlement this was paid in - `provider_reference` string, required — The providers reference for the settlement - `event_correlation_id` string — Id for matching to transaction event - `amount` number, required — The amount paid out in this settlement - `capture` number — Amount captured in this settlement - `refund` number — Amount refunded in this settlement - `fee` number — Fee of the capture in this settlement - `settlement_status` 'NOT_SETTLED' | 'PENDING_SETTLEMENT' | 'PARTIALLY_SETTLED' | 'SETTLED' - `session_id` string — The session id for the transaction - `session` Session - `url` SessionUrls, required - `return_url` string, uri, required — URL to page where Checkout will redirect the customer to after the Checkout process has ended. If a transaction was completed successfully, a `transaction_id` will be appended to the URL as a `query` string parameter > A `transaction_id` will be appended to the URL if the > Checkout failed with `error=capture` > A transaction with status `ON_HOLD` must be handled as a payment > that is pending approval, where the transaction will later be updated > with a final payment staus `AUTHORIZED` or `FAILED`. > We recommend that `callback_url` is used to receive the callback when > the transaction changes status from `ON_HOLD` to `AUTHORIZED` or `FAILED`. > Alternative is to do an hourly/daily poll on the transaction to check > if the status has changed. *Example*: - `customer` SessionCustomer - `customer_id` string — Customer id - `email` string — Customer email address - `phone_number` string — Customer phone number, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `order` SessionOrder, required - `amount` integer, required — The amount to authorize/capture including VAT and discounts. In smallest unit for the currency, e.g. cents The `amount` should be equal to the sum of the `items.amount` + `shipping_option.amount`. - `currency` string, iso4217-code, required — The three-character ISO-4217 currency. https://en.wikipedia.org/wiki/ISO_4217 - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. In smallest unit for the currency, e.g. cents The `vat_amount` should be equal to the sum of the `items.vat_amount` + `shipping_option.vat_amount`. - `merchant_reference_2` string — A reference by the merchant to identify the corresponding order for the Checkout Session - `event_reference` string — Default event_reference to include in transaction events. The value is included in the settlement report Use of `capture_reference` and `refund_reference` during capture and refund overrides the provided value - `shipping_address` OrderAddress — Address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `billing_address` OrderAddress — Address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `partial_payment` boolean — This is a partial payment where the `order.amount` can be lower or equal to the sum of `order.items.amount` - `items` object[] — Details about the order items. #### Instabank `required` if Instabank payment is configured in and partial_payment is false. All items must include a unique `line_id`, quantity and amount #### Collector Bank `required` if Collector Bank payment is configured in and partial_payment is false. All items must include a unique `line_id`, quantity and amount - `id` string — The ID or SKU of the product on the line - `groups` object[] — The groups the product on the line belongs to - `id` string, required — Group ID - `name` string — Group name - `line_id` string — the number of the line (or id), must be `unique` between all items. `required` when Instabank payment is configured. - `version` number — The version where the item was added or last updated, see the events for the source. - `description` string — A short, localized description of the line item - `quantity` number — The quantity of the product in the item line. Quantities are usually whole numbers, but can also be decimal, in cases where the product is sold by weight, volume or other denominations. - `amount` integer — The total monetary amount of the line item, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. In smallest unit for the currency, e.g. cents - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `unit_volume` number — The volume of one item in m³ (cubic meters) - `unit_weight` number — The volume of one item in kg (kilo grams) - `unit_dimensional_weight` number — The dimensional weight (also known as volumetric) value unit of one item. [Dimensional weight at Wikipedia](https://en.wikipedia.org/wiki/Dimensional_weight) - `type` 'physical' | 'digital' | 'service' | 'gift_card' | 'shipping' | 'surcharge' — The type of order item this is. - **physical** - a physical item which must be delivered or handed over - **digital** - a digital item which doesn't need shipping - **service** - payment for services like maintenance performed in your home - **gift_card** - usage of a gift card, where the amount is usually a negative number - **shipping** - payment for shipping of the order - **surcharge** - extra incurred costs, like taxes or necessary rounding - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - `type` 'proportional', required - `destinations` string[] — Seller ids that will be debited for the payment fees All destinations must be included in the list of splits - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - `payout_destination_id` string, required — An id that identifies the seller Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `amount` integer, required — The split amount in smallest unit for the currency, e.g. cents. - `thumbnail_url` string, uri — URL to a thumbnail of the item. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `emd` Emd — Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/). Some items require extra information to be provided when using Klarna as an enabled payment option. - `event` object[] — Only required if the item is related to an event or multiple events, like for example tickets to a concert. If you are selling an event package as a single ticket or item that includes multiple events, for example a festival, you need to provide information about all the individual events that are part of the package. - `event_name` string, required — Name of the event, e.g. "Fancy Singer" - `event_company` string, required — Name of the company arranging the event, e.g. "Happy Parties Ltd." - `genre_of_event` string, required — Category or type of venue, e.g. "Pop" - `arena_name` string — Name of the venue, e.g. "Song Arena" - `arena_location` object - … - `start_time` string, date-time, required — Start time of the event (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `end_time` string, date-time, required — End time of the event (ISO 8601 format), e.g. "2023-08-16T16:00:00Z". If a timezone is not specified we assume UTC. - `access_controlled_venue` boolean — If tickets are digitally checked when entering the venue, e.g. true - `ticket_delivery_method` 'pick_up' | 'email' | 'post' | 'phone', required - `ticket_delivery_recipient` string, required — Name of the recipient the ticket is delivered to, e.g. "recipient@mail.com". If email or phone, then use either the email address or the phone number respectively. - `affiliate_name` string — Name of the affiliate that originated the purchase. - `subscription` EmdRecurring — Only required if the item is related to a subscription. If that is the case, you need to provide information about both the subscription and the customer account. - `subscription` EmdSubscription, required — Details related to the subscription. - … - `customer_account_info` EmdCustomerAccountInfo, required — Information related to the customer that wants to purchase the subscription. - … - `travel` EmdTravel — Only required if the item is part of a travel-related transaction. If that is the case, you need to provide information about the itinerary to be booked. - `air_reservation_details` EmdAirReservationDetails — Details about the reservation of airline tickets. - … - `bus_reservation_details` EmdBusReservationDetails — Details about the reservation of bus tickets. - … - `train_reservation_details` EmdTrainReservationDetails — Details about the reservation of train tickets. - … - `ferry_reservation_details` EmdFerryReservationDetails — Details about the reservation of ferry tickets. - … - `hotel_reservation_details` EmdHotelReservationDetails — Details about the reservation of hotel rooms. - … - `car_rental_reservation_details` EmdCarRentalReservationDetails — Details about the reservation of rental cars. - … - `marketplace_order` EmdMarketplaceOrder — Only required if them item is related to a marketplace order. If that is the case, you need to provide information about both the seller and the winner. - `seller_info` EmdMarketplaceSellerInfo, required — Details related to the seller involved in the marketplace order. - … - `winner_info` EmdMarketplaceWinnerInfo, required — Details related to the winner involved in the marketplace order. - … - `store` Store - `id` string, required - `name` string — name of the store, aka trade name of the store - `business_name` string — Official name of the person or entity that owns the store. - `address` Address - `address_line` string, required - `address_line_2` string - `postal_code` string - `postal_place` string, required - `country` string, iso-3166-1, required — ISO 3166-1 country code - `chain` string - `email` string - `gln` string - `organization_number` string - `phone_number` string - `mcc` string, iso-18245 — A four-digit Merchant Category Code (MCC) for the store [ISO 18245:2003](https://www.iso.org/standard/33365.html) - `bax` string — Merchant number associated with the stores payment terminal - `terminal_id` string — Id to a specific point-of-sale (POS) terminal or workstation - `payout_destination_id` string — The payout destination id for the merchant of record, i.e. the seller responsible for the transaction. Required when `seitatech.in_person` payment is enabled. - `eligible_for_discount` boolean — The item is eligible for discount - `is_changed` boolean — Discount applied to amount - `gross_amount` number — The origin item amount before any discount - `discount_lines` DiscountItem[] - `amount` integer — Monetary amount in smallest unit for the currency - `percentage` number — Optional, set if the amount given was from a percentage discount - `discount_type` 'customer' | 'periodic' | 'manual' | 'loyalty' | 'total' | 'employee' | 'external' - `discount_id` string - `description` string - `line_id` integer - `gross_amount` number — The origin amount to authorize/capture including VAT before any discount, only set if the session was updated when calculating discounts. In smallest unit for the currency, e.g. cents - `is_changed` boolean — The original order amount was changed by discount given. - `shipping_option` MultiShipmentTopLevelShippingOption — A shipping option - `id` string, required — Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. - `line_id` string, required — Unique id of the specific configuration of this shipping product - `countries` string[] — Countries where this shipping option can be used - `amount` integer, required — The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `title` string, required — A shipping option title. Eg. "Standard" - `description` string — A short description of the shipping option product - `delivery_method` 'delivery' | 'pick_up' | 'unspecified' | 'none' - `operator` string, required — Name of company that provides shipping service - `operator_product_id` string — The operators own id for this shipping product - `eta` object — Relative time for delivery or pick-up - `working_days` number[] — The expected range of days until the relative time is reached. A range of `[0,0]` means the relative time is today. `[0,3]` means the relative time is within the next 3 days. - `shipping_day_of_week` number — The day of the week the relative time for shipping is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `arrival_day_of_week` number — The day of the week the relative time for arrival is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `starts_at` string, date-time - `ends_at` string, date-time - `time_slot` object — A specified time for delivery to customer - `starts_at` string, date-time - `ends_at` string, date-time - `pick_up_address` object — Additional information about the shipping address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `website_url` string — The website URL of the customer. - `opening_hours` unknown - `distance` number — Distance in kilometers from the shipping_address. - `metadata` object — Additional metadata about the shipping_option - `environmental_data` object — Environmental data about the shipping option - `description` string, required — A short description of the environmental data, something like - "Fossil free", - "Carbon neutral" - "Low emissions" - "Renewable Energy Sourced" - "Eco-certified Fleet" - `details` object[] - `label` string, required — Give context to the value field. Example: - "CO2 emissions" - "Energy consumption" - "Carbon footprint" - "Carbon offset" - "Trees planted" - "Renewable energy percentage" - `value` string, required - `thumbnail_url` string, uri — URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `pay_in_store` object — Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method `dintero.zero` is enabled - `type` 'full', required - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - `type` 'proportional', required - `destinations` string[] — Seller ids that will be debited for the payment fees All destinations must be included in the list of splits - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - `payout_destination_id` string, required — An id that identifies the seller Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `amount` integer, required — The split amount in smallest unit for the currency, e.g. cents. - `shipments` MultiShipmentShippingOption[] — For multiple shipments we have a single top-level shipping object that contains the shipments for the order. The shipping options defined in `shipments` must contain `shipment_items` that define what items belong to what shipment. For multiple shipments: - do not define `splits` on the toplevel shipping option - do not define `fee_split` on the toplevel shipping option - the `pay_in_store` option is not compatible with `shipments` - empty shipments array is not allowed - single item multi shipping option is not allowed - `id` string, required — Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. - `line_id` string, required — Unique id of the specific configuration of this shipping product - `countries` string[] — Countries where this shipping option can be used - `amount` integer, required — The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `title` string, required — A shipping option title. Eg. "Standard" - `description` string — A short description of the shipping option product - `delivery_method` 'delivery' | 'pick_up' | 'unspecified' | 'none' - `operator` string, required — Name of company that provides shipping service - `operator_product_id` string — The operators own id for this shipping product - `eta` object — Relative time for delivery or pick-up - `working_days` number[] — The expected range of days until the relative time is reached. A range of `[0,0]` means the relative time is today. `[0,3]` means the relative time is within the next 3 days. - `shipping_day_of_week` number — The day of the week the relative time for shipping is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `arrival_day_of_week` number — The day of the week the relative time for arrival is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `starts_at` string, date-time - `ends_at` string, date-time - `time_slot` object — A specified time for delivery to customer - `starts_at` string, date-time - `ends_at` string, date-time - `pick_up_address` object — Additional information about the shipping address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `website_url` string — The website URL of the customer. - `opening_hours` unknown - `distance` number — Distance in kilometers from the shipping_address. - `metadata` object — Additional metadata about the shipping_option - `environmental_data` object — Environmental data about the shipping option - `description` string, required — A short description of the environmental data, something like - "Fossil free", - "Carbon neutral" - "Low emissions" - "Renewable Energy Sourced" - "Eco-certified Fleet" - `details` object[] - … - `thumbnail_url` string, uri — URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `pay_in_store` object — Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method `dintero.zero` is enabled - `type` 'full', required - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - `type` 'proportional', required - `destinations` string[] — Seller ids that will be debited for the payment fees All destinations must be included in the list of splits - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - `payout_destination_id` string, required — An id that identifies the seller Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `amount` integer, required — The split amount in smallest unit for the currency, e.g. cents. - `shipment_id` string — For orders that have multiple shipments. The shipping options will be grouped by `shipment_id`. The top-level multi shipment shipping option array at `order.shipping_option.shipments` will contain one shipping option per `shipment_id` found in the shipping options sprovided in `express.shipping_options`. In order to present multiple shipping options for a given `shipment_id` set the same shipment_id to all the shipping options for that shipment. - `shipment_items` MultiShipmentItem[] — An array of objects specifying what items will be delivered by this shipment. Should only be specified when an order has multiple shipments so the checkout knows what items will be shipped by the shipping options. If there are multiple shipments the session (and resulting transaction) will have a single top-level shipping object that contains multiple `shipments` for the order. - `line_id` string, required — The line_id or an item in order.items - `quantity` number — The quantity of the product in the item line. - `store` Store - `id` string, required - `name` string — name of the store, aka trade name of the store - `business_name` string — Official name of the person or entity that owns the store. - `address` Address - `address_line` string, required - `address_line_2` string - `postal_code` string - `postal_place` string, required - `country` string, iso-3166-1, required — ISO 3166-1 country code - `chain` string - `email` string - `gln` string - `organization_number` string - `phone_number` string - `mcc` string, iso-18245 — A four-digit Merchant Category Code (MCC) for the store [ISO 18245:2003](https://www.iso.org/standard/33365.html) - `bax` string — Merchant number associated with the stores payment terminal - `terminal_id` string — Id to a specific point-of-sale (POS) terminal or workstation - `payout_destination_id` string — The payout destination id for the merchant of record, i.e. the seller responsible for the transaction. Required when `seitatech.in_person` payment is enabled. - `discount_lines` DiscountItem[] — Discounts given, additions to any items discount_lines. - `amount` integer — Monetary amount in smallest unit for the currency - `percentage` number — Optional, set if the amount given was from a percentage discount - `discount_type` 'customer' | 'periodic' | 'manual' | 'loyalty' | 'total' | 'employee' | 'external' - `discount_id` string - `description` string - `line_id` integer - `discount_codes` string[] - `gift_cards` Giftcard[] — The gift cards selected, the part of `order.amount` that will be authorized using gift cards - `type` 'dintero.wallets', required - `card_id` string, required - `amount` integer, required — Non-negative, minor units. Total amount for the gift card - `masked_card_token` string - `emd` Emd — Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/). Some items require extra information to be provided when using Klarna as an enabled payment option. - `event` object[] — Only required if the item is related to an event or multiple events, like for example tickets to a concert. If you are selling an event package as a single ticket or item that includes multiple events, for example a festival, you need to provide information about all the individual events that are part of the package. - `event_name` string, required — Name of the event, e.g. "Fancy Singer" - `event_company` string, required — Name of the company arranging the event, e.g. "Happy Parties Ltd." - `genre_of_event` string, required — Category or type of venue, e.g. "Pop" - `arena_name` string — Name of the venue, e.g. "Song Arena" - `arena_location` object - `street_address` string — Street address representing the venue location, e.g. "Sonja Henies plass 2" - `postal_code` string — Postal code for the venue location, e.g. "0185" - `city` string, required — City that the venue is located in, e.g. "Oslo" - `country` string, required — Country that the venue is located in (ISO 3166-1 alpha-2 format), e.g. "NO" - `start_time` string, date-time, required — Start time of the event (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `end_time` string, date-time, required — End time of the event (ISO 8601 format), e.g. "2023-08-16T16:00:00Z". If a timezone is not specified we assume UTC. - `access_controlled_venue` boolean — If tickets are digitally checked when entering the venue, e.g. true - `ticket_delivery_method` 'pick_up' | 'email' | 'post' | 'phone', required - `ticket_delivery_recipient` string, required — Name of the recipient the ticket is delivered to, e.g. "recipient@mail.com". If email or phone, then use either the email address or the phone number respectively. - `affiliate_name` string — Name of the affiliate that originated the purchase. - `subscription` EmdRecurring — Only required if the item is related to a subscription. If that is the case, you need to provide information about both the subscription and the customer account. - `subscription` EmdSubscription, required — Details related to the subscription. - `subscription_name` string, required — Name of the product on subscription, e.g. "Contact lenses" - `start_time` string, date-time, required — The start time of the subscription (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC - `end_time` string, date-time, required — The end time of the subscription (ISO 8601 format), e.g. "2023-09-16T15:00:00Z". If a timezone is not specified we assume UTC - `auto_renewal_of_subscription` boolean, required — Whether the subscription will be auto renewed upon expiry, e.g. true - `affiliate_name` string — Name of the affiliate that originated the purchase. - `customer_account_info` EmdCustomerAccountInfo, required — Information related to the customer that wants to purchase the subscription. - `unique_account_identifier` string, required — Unique name / number to identify the specific customer account. Max 24 characters, e.g. "Adam Adamsson" - `account_registration_date` string, required — The date and time the account was registered (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `account_last_modified` string, required — The date and time the account was last modified (ISO 8601 format), e.g. "2023-10-16T15:00:00Z". If a timezone is not specified we assume UTC. - `travel` EmdTravel — Only required if the item is part of a travel-related transaction. If that is the case, you need to provide information about the itinerary to be booked. - `air_reservation_details` EmdAirReservationDetails — Details about the reservation of airline tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdAirReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one flight from Oslo to Munich, and another flight from Munich to Dubai, you need to provide one itinerary object for each of these two flights, and so on. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `bus_reservation_details` EmdBusReservationDetails — Details about the reservation of bus tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdBusReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one bus journey from Oslo to Munich, and another bus journey from Munich to Rome, you need to provide one itinerary object for each of these two bus journeys, and so on. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `train_reservation_details` EmdTrainReservationDetails — Details about the reservation of train tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdTrainReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one train journey from Oslo to Munich, and another train journey from Munich to Rome, you need to provide one itinerary object for each of these two train journeys, and so on. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `ferry_reservation_details` EmdFerryReservationDetails — Details about the reservation of ferry tickets. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdFerryReservationDetailsItinerary[], required — Itinerary data, one per segment. If you are selling a ticket that contains one ferry journey from Oslo to Kiel, and another ferry journey from Kiel to Gothenburg, you need to provide one itinerary object for each of these two ferry journeys, and so on. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `hotel_reservation_details` EmdHotelReservationDetails — Details about the reservation of hotel rooms. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdHotelReservationDetailsItinerary[], required — Hotel itinerary data, one per hotel stay. If you are selling a package that contains multiple hotel stays, you need to provide itinerary data for each of the individual stays. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `passengers` EmdTravelPassenger[] — Passenger data, one per passenger. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `car_rental_reservation_details` EmdCarRentalReservationDetails — Details about the reservation of rental cars. - `pnr` string — Trip booking number, e.g. "VH67899" - `itinerary` EmdCarRentalReservationDetailsItinerary[], required — Car rental itinerary data, one per car rental. If you are selling a package that contains multiple car rentals, you need to provide itinerary data for each of the individual rentals. - … - `insurance` EmdTravelInsurance[] — Insurance data, one per segment - … - `drivers` EmdTravelPassenger[], required — Driver data, one per driver. - … - `affiliate_name` string — Name of the affiliate that originated the purchase. - `marketplace_order` EmdMarketplaceOrder — Only required if them item is related to a marketplace order. If that is the case, you need to provide information about both the seller and the winner. - `seller_info` EmdMarketplaceSellerInfo, required — Details related to the seller involved in the marketplace order. - `unique_account_identifier_seller` object — Details about the seller. - … - `sub_merchant_id` string, required — Name or unique number of the selling/delivering merchant, e.g. "Marketbrick Ltd." - `product_category` string, required — Name of the category to which the specific good belongs to, according to the selling merchant's categorization, e.g. "Phones". - `product_name` string — Name of the good purchased. - `account_registration_date` string, date-time, required — Date and time that the account was registered (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `account_last_modified` EmdMarketplaceAccountLastModified, required - … - `seller_rating` number — Current rating of the good purchased according to the marketplace's rating scale, e.g. 5 - `number_of_trades` integer, required — Number of trades the sub-merchant did in the last 12 months, e.g. 23 - `volume_of_trades` integer — Volumes of trades the sub-merchant did in the last 12 months, e.g. 230 - `winner_info` EmdMarketplaceWinnerInfo, required — Details related to the winner involved in the marketplace order. - `unique_account_identifier_winner` object — Details about the winner. - … - `account_registration_date` string, date-time, required — Date and time that the account was registered (ISO 8601 format), e.g. "2023-08-16T15:00:00Z". If a timezone is not specified we assume UTC. - `account_last_modified` EmdMarketplaceAccountLastModified, required - … - `number_of_trades` integer, required — Number of trades the winner did in the last 12 months, e.g. 23 - `volume_of_trades` integer — Volumes of trades the winner did in the last 12 months, e.g. 230 - `payout_destination_id` string — An id that identifies the seller, value will be included in the settlement reports. Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `merchant_reference` string, required — A reference by the merchant to identify the corresponding order for the Checkout Session - `expires_at` string, date-time — The session expiration time after which the Checkout page wouldn't be available - `checkboxes` Checkbox[] — Configuration for checkboxes that should be part of the checkout - `id` string, required — ID to assign to the checkbox so you can reference it later - `label` string, required — Label that should be visible next to the checkbox - `checked` boolean — If the checkbox should be checked by default or not - `required` boolean — If the checkbox should be required or not - `link` object - `url` string, required — Link URL - `text` string, required — Link text - `express` object — ### Present only for _Express Checkout_ sessions. An _Express Checkout_ session is a session where the end user will submit a shipping address and then select a shipping option before the before a payment method is selected and the payment is initiated. Endpoints used in the _Express Checkout_ flow. 1. [Set shipping address](/checkout-api/view/checkout_sid_json_order_shipping_address_put) 2. [Set shipping option](/checkout-api/view/checkout_sid_json_order_items_shipping_option_put) - `shipping_options` object[], required — Shipping options that will be presented to the end user after the end user has submitted a shipping address. To dynamically update the shipping_options when the _`order.shipping_address`_ is changed by the end user in the checkout, use the _`url.shipping_address_callback_url`_. If the merchant is not able to ship the order to the end users shipping address, use an empty array. If there is only one option, a free delivery, the order still has to contain one option with a _`price.amount`_ of 0. - `id` string, required — Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. - `line_id` string, required — Unique id of the specific configuration of this shipping product - `countries` string[] — Countries where this shipping option can be used - `amount` integer, required — The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `title` string, required — A shipping option title. Eg. "Standard" - `description` string — A short description of the shipping option product - `delivery_method` 'delivery' | 'pick_up' | 'unspecified' | 'none' - `operator` string, required — Name of company that provides shipping service - `operator_product_id` string — The operators own id for this shipping product - `eta` object — Relative time for delivery or pick-up - `working_days` number[] — The expected range of days until the relative time is reached. A range of `[0,0]` means the relative time is today. `[0,3]` means the relative time is within the next 3 days. - `shipping_day_of_week` number — The day of the week the relative time for shipping is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `arrival_day_of_week` number — The day of the week the relative time for arrival is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `starts_at` string, date-time - `ends_at` string, date-time - `time_slot` object — A specified time for delivery to customer - `starts_at` string, date-time - `ends_at` string, date-time - `pick_up_address` object — Additional information about the shipping address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `website_url` string — The website URL of the customer. - `opening_hours` unknown - `distance` number — Distance in kilometers from the shipping_address. - `metadata` object — Additional metadata about the shipping_option - `environmental_data` object — Environmental data about the shipping option - `description` string, required — A short description of the environmental data, something like - "Fossil free", - "Carbon neutral" - "Low emissions" - "Renewable Energy Sourced" - "Eco-certified Fleet" - `details` object[] - `label` string, required — Give context to the value field. Example: - "CO2 emissions" - "Energy consumption" - "Carbon footprint" - "Carbon offset" - "Trees planted" - "Renewable energy percentage" - `value` string, required - `thumbnail_url` string, uri — URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `pay_in_store` object — Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method `dintero.zero` is enabled - `type` 'full', required - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - `type` 'proportional', required - `destinations` string[] — Seller ids that will be debited for the payment fees All destinations must be included in the list of splits - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - `payout_destination_id` string, required — An id that identifies the seller Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `amount` integer, required — The split amount in smallest unit for the currency, e.g. cents. - `shipment_id` string — For orders that have multiple shipments. The shipping options will be grouped by `shipment_id`. The top-level multi shipment shipping option array at `order.shipping_option.shipments` will contain one shipping option per `shipment_id` found in the shipping options sprovided in `express.shipping_options`. In order to present multiple shipping options for a given `shipment_id` set the same shipment_id to all the shipping options for that shipment. - `shipment_items` MultiShipmentItem[] — An array of objects specifying what items will be delivered by this shipment. Should only be specified when an order has multiple shipments so the checkout knows what items will be shipped by the shipping options. If there are multiple shipments the session (and resulting transaction) will have a single top-level shipping object that contains multiple `shipments` for the order. - `line_id` string, required — The line_id or an item in order.items - `quantity` number — The quantity of the product in the item line. - `shipping_mode` 'shipping_required' | 'shipping_not_required' - `discount_codes` object — Enable discount codes for Express Checkout - `max_count` number — Limit how many discount codes can be added by the customer - `callback_url` string, uri — URL that Checkout will POST to when the user has submitted/changed the discount codes for an express session. Dintero will not attempt a retry after a failed delivery attempt. Following situations is considered as failed delivery - HTTP status codes that are not 200. - A request timeout (60 seconds) - Any connection error such as connection timeout, bad certificate, etc The response from the callback will be used to update the order amount, items discount_lines and shipping options. See [POST example/discount_codes_callback_url](/api-reference/example-session-callbacks/example_discount_codes_callback_url) for details about the request and response. - `shipping_address_callback_url` string, uri — URL that Checkout will POST to when the end user has submitted/changed a shipping address for an express-session. Dintero will not attempt a retry after a failed delivery attempt. Following situations is considered as failed delivery - HTTP status codes that are not 200. - A request timeout (60 seconds) - Any connection error such as connection timeout, bad certificate, etc The response from the callback will be used to update the shipping options. See [POST example/shipping_address_callback_url](/api-reference/example-session-callbacks/example_shipping_address_callback_url) for details about the request and response. - `customer_types` string[] — Limit the lind of customers that can be submitted via the address form in the express checkout. - `default_different_billing_shipping_address` string[] — Configure the default behavior for how Checkout presents the shipping and billing addresses. If `[]`, Checkout defaults to assuming the shipping and billing addresses are the same. If `["b2b"]`, Checkout defaults to assuming different addresses for B2B only. If `["b2c"]`, Checkout defaults to assuming different addresses for B2C only. If `["b2b", "b2c"]`, Checkout defaults to assuming different addresses for all customer types. If omitted, Checkout defaults to the same behaviour as setting `[]`. This will only have an effect if `allow_different_billing_shipping_address` is set. - `configuration` object, required - `auto_capture` boolean — If `true` the transaction from the payment session will be captured automatically after the transaction has been `AUTHORIZED`. The checkout sessions `callback_url` will not be called until after the transaction has been `CAPTURED`. If `auto_capture` is not specified it defaults to `false`. A successful auto-capture of a transaction sometimes requires more than one capture attempt. This can be the case if the payment gateway is down or is experiencing heavy traffic. Dintero will attempts capture retries for 48 hours, the `callback_url` will be invoked when capture succeeds. Manual capture of a transaction that is pending auto-capture will stop the auto-capture process from completing the capture. - `channel` 'ecommerce' | 'in_app' | 'in_store' | 'hosted' — `channel` enables special behaviour for various scenarios. The majority of web integrations will not need to set this property. ### ecommerce The default channel (also used if channel is not specified). The url in the session created response body opens the Dintero Checkout page. ### in_app The `in_app` channel is intended for payments done from mobile devices where `url.return_url` can be set to the application's appswitch URL. #### Session deeplink URL Creating a session with `channel=in_app` will return an appswitch deeplink URL if the enabled payment options in the session supports it Appswitch deeplink is currently only supported for sessions that has only Vipps enabled via Dintero PSP, Vipps, Worldline (bambora) or Swedbank (payex), MobilePay enabled via Woldline (bambora) or Swedbank (payex) or Swish - configuration.vipps.enabled - configuration.payex.vipps.enabled - configuration.payex.mobilepay.enabled - configuration.dintero_psp.vipps.enabled - configuration.bambora.vipps.enabled - configuration.swish.swish.enabled > `in_app` is currently not supported when express is enabled > `in_app` with deeplink URL is not supported if `publish` is enabled ### in_store The `in_store` channel is intended for payments done in physical stores. Depending on the payment_type, choosing `in_store` will change the behaviour of the payment. ### hosted The `hosted` channel will skip the Dintero Checkout page and the returned `url` takes the end user directly to the payment service's payment page, if the enabled payment options in the session support it. If the url to the hosted page is a universal link then visiting the url can launch an app if the device used supports universal links and the payment app is installed on the device. The Vipps and MobilePay hosted page acts as a universal link. The `hosted` channel is currently only supported for sessions that have a single payment method enabled and the payment method is one of the following: - configuration.vipps.enabled - configuration.payex.vipps.enabled - configuration.payex.mobilepay.enabled - configuration.dintero_psp.vipps.enabled - configuration.bambora.vipps.enabled If the session contains more than one enabled payment method, or the payment method does not support the `hosted` channel, the setting is ignored and the `url` will open the Dintero Checkout (the default `ecommerce` behaviour). - `publish` object[] — Publish checkout message to the customer. - `channel` 'sms' | 'push', required - `type` 'checkout-link' | 'app' | 'terminal', required - `id` string - `status` 'sent' | 'skipped' | 'failed' — status of the message sent to the customer. **`skipped`** will used in case where publish cannot be sent given the `session.customer`. - `active_payment_types` object - `enabled` boolean — Use this flag as wildcard to include all active payment types configured for a given currency when creating a payment session. - `default_payment_type` 'bambora.applepay' | 'bambora.creditcard' | 'bambora.googlepay' | 'bambora.mobilepay' | 'bambora.vipps' | 'dintero.zero' | 'dintero_psp.applepay' | 'dintero_psp.creditcard' | 'dintero_psp.vipps' | 'dintero_psp.googlepay' | 'dintero_psp.clicktopay' | 'instabank.finance' | 'instabank.invoice' | 'instabank.installment' | 'instabank.postponement' | 'vipps' | 'payex.creditcard' | 'payex.mobilepay' | 'payex.swish' | 'payex.vipps' | 'payex.applepay' | 'payex.clicktopay' | 'payex.googlepay' | 'collector.finance' | 'collector.invoice' | 'collector.invoice_b2b' | 'collector.invoice_b2b_preapproved' | 'collector.installment_b2b_preapproved' | 'collector.installment' | 'santander.debit_account' | 'swish.swish' | 'netaxept.creditcard' | 'klarna.klarna' | 'klarna.billie' | 'kravia.invoice_b2b' | 'kravia.invoice_b2b_grouped' | 'kravia.invoice_b2c' | 'seitatech.in_person' | 'two.invoice_b2b' — Configure the default payment type, the selected payment when loading the checkout window. The value must be an enabled payment type. - `bambora` unknown - `dintero` unknown - `dintero_psp` unknown - `instabank` unknown - `netaxept` unknown - `payex` unknown - `vipps` unknown - `collector` unknown - `klarna` unknown - `kravia` unknown - `two` unknown - `santander` unknown - `seitatech` unknown - `swish` unknown - `payout` unknown - `allow_express_wallet_payment` boolean — When enabled, wallet payments (like Apple Pay and Google Pay) can be used in their express mode, allowing customers to complete purchases with a single tap, bypassing the standard checkout flow. - `age_verification` unknown - `discounts` object — Configuration for discounts calculations - `type` 'discounts' - `express_discount_codes` object - `payability` unknown - `enabled` boolean, required — The discounts will be given by the configured express callback url. The callback URL will be invoked when the session is updated with a discount code, and the response used to update the discounts on the order items and the shipping options. - `order` object — Configure discounts calculation on the session order. - `enabled` boolean, required — Enable discount calculation on order items eligible for discount - A session that has the `customer.customer_id` set will have its discounts calculated when the session is created. - A session with no customer_id will only have the discounts calculated when the customer is identified by the checkout page. - The autorized amount will be the net amount from the original session amount specified when the session was created. - `theme` object — Customize the appearance of the checkout. - `backdrop` string — Color on backdrop shown in desktop mode Color, supported formats are - hex: `#ff0000` - rgb: `rgb(255,0,0)` - rgba: `rgba(255,0,0,0.5)` - `primary` string — Primary color used on pay button and other buttons. Color, supported formats are - hex: `#ff0000` - rgb: `rgb(255,0,0)` - rgba: `rgba(255,0,0,0.5)` - `cardRadius` string — Radius on card element in the checkout. - `buttonRadius` string — Radius on buttons in the checkout. - `countries` object — Country preferences - `preferred_country` string, iso3166-alpha2 — Country to use as default in address and phone country code - `allow_countries` string[] — List of countries where the customer is allowed to set their address. If empty, all countries are allowed, except for the ones in `deny_countries`. A country can not be in both `allow_countries` and `deny_countries`. - `deny_countries` string[] — List of countries where the customer is not allowed to set their address. A country can not be in both `allow_countries` and `deny_countries`. - `default_customer_type` 'b2c' | 'b2b' — Customer type to use as default for the customer. - `allow_different_billing_shipping_address` string[] — Allow that the shipping and billing address can be different. An array of strings, the values `b2c` and `b2b` can be used to limit the what types of customer that are allowed to submit different addresses for shipping and billing. By default we limit the shipping and billing addresses to be equal for both B2C and B2B customers. - `id` string — The ID of the Checkout - `created_at` string, date-time — Time when the Checkout was created - `updated_at` string, date-time — Last time when the Checkout was updated - `customer_ip` string — 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_agent` string — The full user agent of the device the customer used when visiting the checkout page - `initiating_system_request_headers` SystemRequestHeaders - `dintero-system-name` string — The name of the ecommerce solution - `dintero-system-version` string — The version number of the ecommerce solution - `dintero-system-plugin-name` string — The name of the ecommerce plugin - `dintero-system-plugin-version` string — The version number of the ecommerce plugin - `user-agent` string — The user-agent that performed the request - `payment_operation` 'unscheduled_purchase' | 'recurring_purchase' | 'generate_payment_token' — Initiated by the merchant or used to generate a token - `events` object[] — Checkout process events - `created_at` string, date-time - `id` string - `request_id` string - `name` 'INITIATED' | 'VISITED' | 'COMPLETED' | 'AUTHORIZED' | 'DECLINED' | 'PAY_LOCK_START' | 'PAY_LOCK_META' | 'PAY_LOCK_END' | 'PAY_FAILED' | 'ON_HOLD_CALLBACK_SENT' | 'AUTH_CALLBACK_SENT' | 'FAILED' | 'UNKNOWN' | 'PAYMENT_TOKEN_FLOW_START' | 'UPDATE_SESSION' | 'CANCELLED' | 'SET_BILLING_ADDRESS' | 'SET_DISCOUNT_CODES' | 'SET_SHIPPING_ADDRESS' | 'SET_SHIPPING_OPTION' | 'SET_GIFT_CARD' | 'PUSH_NOTIFICATION_SENT' | 'SECRET_CONFIRMATION_CODE_SENT' | 'SET_MY_DINTERO' | 'ADD_PAYMENT_INFORMATION' - `request_headers` RequestHeaders - `dintero-system-name` string — The name of the ecommerce solution - `dintero-system-version` string — The version number of the ecommerce solution - `dintero-system-plugin-name` string — The name of the ecommerce plugin - `dintero-system-plugin-version` string — The version number of the ecommerce plugin - `user-agent` string — The user-agent that performed the request - `dintero-checkout-instance-id` string — The instance of the checkout that performed the request - `details` object - `error` string - `payment_product_type` string - `amount` integer - `shipping_option` MultiShipmentTopLevelShippingOption — A shipping option - `id` string, required — Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. - `line_id` string, required — Unique id of the specific configuration of this shipping product - `countries` string[] — Countries where this shipping option can be used - `amount` integer, required — The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `title` string, required — A shipping option title. Eg. "Standard" - `description` string — A short description of the shipping option product - `delivery_method` 'delivery' | 'pick_up' | 'unspecified' | 'none' - `operator` string, required — Name of company that provides shipping service - `operator_product_id` string — The operators own id for this shipping product - `eta` object — Relative time for delivery or pick-up - `working_days` number[] — The expected range of days until the relative time is reached. A range of `[0,0]` means the relative time is today. `[0,3]` means the relative time is within the next 3 days. - `shipping_day_of_week` number — The day of the week the relative time for shipping is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `arrival_day_of_week` number — The day of the week the relative time for arrival is on. 1 is Monday, 2 is Tuesday, ..., 7 is Sunday. - `starts_at` string, date-time - `ends_at` string, date-time - `time_slot` object — A specified time for delivery to customer - `starts_at` string, date-time - `ends_at` string, date-time - `pick_up_address` object — Additional information about the shipping address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `website_url` string — The website URL of the customer. - `opening_hours` unknown - `distance` number — Distance in kilometers from the shipping_address. - `metadata` object — Additional metadata about the shipping_option - `environmental_data` object — Environmental data about the shipping option - `description` string, required — A short description of the environmental data, something like - "Fossil free", - "Carbon neutral" - "Low emissions" - "Renewable Energy Sourced" - "Eco-certified Fleet" - `details` object[] - … - `thumbnail_url` string, uri — URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `pay_in_store` object — Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method `dintero.zero` is enabled - `type` 'full', required - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - `type` 'proportional', required - `destinations` string[] — Seller ids that will be debited for the payment fees All destinations must be included in the list of splits - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - `payout_destination_id` string, required — An id that identifies the seller Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `amount` integer, required — The split amount in smallest unit for the currency, e.g. cents. - `shipments` MultiShipmentShippingOption[] — For multiple shipments we have a single top-level shipping object that contains the shipments for the order. The shipping options defined in `shipments` must contain `shipment_items` that define what items belong to what shipment. For multiple shipments: - do not define `splits` on the toplevel shipping option - do not define `fee_split` on the toplevel shipping option - the `pay_in_store` option is not compatible with `shipments` - empty shipments array is not allowed - single item multi shipping option is not allowed - `id` string, required — Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. - `line_id` string, required — Unique id of the specific configuration of this shipping product - `countries` string[] — Countries where this shipping option can be used - `amount` integer, required — The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `title` string, required — A shipping option title. Eg. "Standard" - `description` string — A short description of the shipping option product - `delivery_method` 'delivery' | 'pick_up' | 'unspecified' | 'none' - `operator` string, required — Name of company that provides shipping service - `operator_product_id` string — The operators own id for this shipping product - `eta` object — Relative time for delivery or pick-up - … - `time_slot` object — A specified time for delivery to customer - … - `pick_up_address` object — Additional information about the shipping address - … - `metadata` object — Additional metadata about the shipping_option - `environmental_data` object — Environmental data about the shipping option - … - `thumbnail_url` string, uri — URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `pay_in_store` object — Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method `dintero.zero` is enabled - … - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - … - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - … - `shipment_id` string — For orders that have multiple shipments. The shipping options will be grouped by `shipment_id`. The top-level multi shipment shipping option array at `order.shipping_option.shipments` will contain one shipping option per `shipment_id` found in the shipping options sprovided in `express.shipping_options`. In order to present multiple shipping options for a given `shipment_id` set the same shipment_id to all the shipping options for that shipment. - `shipment_items` MultiShipmentItem[] — An array of objects specifying what items will be delivered by this shipment. Should only be specified when an order has multiple shipments so the checkout knows what items will be shipped by the shipping options. If there are multiple shipments the session (and resulting transaction) will have a single top-level shipping object that contains multiple `shipments` for the order. - … - `shipping_address` OrderAddress — Address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `bambora` object - `session_token` string - `session_url` string - `wallet_session_id` string - `klarna` object - `client_token` string, required - `session_id` string, required - `seitatech:payment_reference` string - `seitatech:terminal_id` string - `seitatech:terminal_tms_id` string - `payex:payment:id` string - `vipps:payment:id` string - `vipps:gateway_api_version` string - `collector:invoice_b2b:addresses` CollectorB2BPaymentOperationAddress[] - `business_name` string, required — ACME Inc - `organization_number` string, required — The organization number of the customer. For Norway, the length is 9. For Sweden, it's either 10 or 12 digits. - `address_line` string, required — Gaustadalleen 21 - `postal_code` string, required — The zip code / postal code of the address. - `postal_place` string, required — The name of the postal code - `country` string, iso3166-alpha2, required — Country of the location - `address_id` string — The unique identification of the address from the available addresses for the business - `collector:installment:products` CollectorProduct[] - `id` string, required — Id for the payment product - `type` 'interest_free' | 'annuity', required - `credit_time` integer, required — Number of months - `campaign_fee` integer, required — The fee for a "Buy now – pay later" Payment product - `origination_fee` integer, required — The startup fee for the payment product - `notification_fee` integer, required — The notification fee for the payment product - `annual_interest_rate` string — The interest rate for the payment product. - `effective_annual_interest_rate` string — The effective annual interest rate for the payment product - `total_amount` integer, required — The total amount to pay - `monthly_amount` integer, required — The amount to pay pr month - `first_monthly_amount` integer, required — The amount to pay in the first invoice. Origantion fee is added to the first invoice. - `my_dintero` MyDinteroUserCreation — Options for myDintero - `actions` string[], required — Actions to perform on the customer - `terms` object, required — Terms and conditions accepted - `id` string, uuid, required — id of the myDintero terms and conditions - `url` string, uri, required — Url to the terms and conditions accepted by the customer - `organization_number` string - `previous_order` SessionOrder - `amount` integer, required — The amount to authorize/capture including VAT and discounts. In smallest unit for the currency, e.g. cents The `amount` should be equal to the sum of the `items.amount` + `shipping_option.amount`. - `currency` string, iso4217-code, required — The three-character ISO-4217 currency. https://en.wikipedia.org/wiki/ISO_4217 - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. In smallest unit for the currency, e.g. cents The `vat_amount` should be equal to the sum of the `items.vat_amount` + `shipping_option.vat_amount`. - `merchant_reference_2` string — A reference by the merchant to identify the corresponding order for the Checkout Session - `event_reference` string — Default event_reference to include in transaction events. The value is included in the settlement report Use of `capture_reference` and `refund_reference` during capture and refund overrides the provided value - `shipping_address` OrderAddress — Address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `billing_address` OrderAddress — Address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `partial_payment` boolean — This is a partial payment where the `order.amount` can be lower or equal to the sum of `order.items.amount` - `items` object[] — Details about the order items. #### Instabank `required` if Instabank payment is configured in and partial_payment is false. All items must include a unique `line_id`, quantity and amount #### Collector Bank `required` if Collector Bank payment is configured in and partial_payment is false. All items must include a unique `line_id`, quantity and amount - `id` string — The ID or SKU of the product on the line - `groups` object[] — The groups the product on the line belongs to - … - `line_id` string — the number of the line (or id), must be `unique` between all items. `required` when Instabank payment is configured. - `version` number — The version where the item was added or last updated, see the events for the source. - `description` string — A short, localized description of the line item - `quantity` number — The quantity of the product in the item line. Quantities are usually whole numbers, but can also be decimal, in cases where the product is sold by weight, volume or other denominations. - `amount` integer — The total monetary amount of the line item, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. In smallest unit for the currency, e.g. cents - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `unit_volume` number — The volume of one item in m³ (cubic meters) - `unit_weight` number — The volume of one item in kg (kilo grams) - `unit_dimensional_weight` number — The dimensional weight (also known as volumetric) value unit of one item. [Dimensional weight at Wikipedia](https://en.wikipedia.org/wiki/Dimensional_weight) - `type` 'physical' | 'digital' | 'service' | 'gift_card' | 'shipping' | 'surcharge' — The type of order item this is. - **physical** - a physical item which must be delivered or handed over - **digital** - a digital item which doesn't need shipping - **service** - payment for services like maintenance performed in your home - **gift_card** - usage of a gift card, where the amount is usually a negative number - **shipping** - payment for shipping of the order - **surcharge** - extra incurred costs, like taxes or necessary rounding - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - … - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - … - `thumbnail_url` string, uri — URL to a thumbnail of the item. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `emd` Emd — Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/). Some items require extra information to be provided when using Klarna as an enabled payment option. - … - `store` Store - … - `eligible_for_discount` boolean — The item is eligible for discount - `is_changed` boolean — Discount applied to amount - `gross_amount` number — The origin item amount before any discount - `discount_lines` DiscountItem[] - … - `gross_amount` number — The origin amount to authorize/capture including VAT before any discount, only set if the session was updated when calculating discounts. In smallest unit for the currency, e.g. cents - `is_changed` boolean — The original order amount was changed by discount given. - `shipping_option` MultiShipmentTopLevelShippingOption — A shipping option - `id` string, required — Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. - `line_id` string, required — Unique id of the specific configuration of this shipping product - `countries` string[] — Countries where this shipping option can be used - `amount` integer, required — The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `title` string, required — A shipping option title. Eg. "Standard" - `description` string — A short description of the shipping option product - `delivery_method` 'delivery' | 'pick_up' | 'unspecified' | 'none' - `operator` string, required — Name of company that provides shipping service - `operator_product_id` string — The operators own id for this shipping product - `eta` object — Relative time for delivery or pick-up - … - `time_slot` object — A specified time for delivery to customer - … - `pick_up_address` object — Additional information about the shipping address - … - `metadata` object — Additional metadata about the shipping_option - `environmental_data` object — Environmental data about the shipping option - … - `thumbnail_url` string, uri — URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `pay_in_store` object — Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method `dintero.zero` is enabled - … - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - … - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - … - `shipments` MultiShipmentShippingOption[] — For multiple shipments we have a single top-level shipping object that contains the shipments for the order. The shipping options defined in `shipments` must contain `shipment_items` that define what items belong to what shipment. For multiple shipments: - do not define `splits` on the toplevel shipping option - do not define `fee_split` on the toplevel shipping option - the `pay_in_store` option is not compatible with `shipments` - empty shipments array is not allowed - single item multi shipping option is not allowed - … - `store` Store - `id` string, required - `name` string — name of the store, aka trade name of the store - `business_name` string — Official name of the person or entity that owns the store. - `address` Address - … - `chain` string - `email` string - `gln` string - `organization_number` string - `phone_number` string - `mcc` string, iso-18245 — A four-digit Merchant Category Code (MCC) for the store [ISO 18245:2003](https://www.iso.org/standard/33365.html) - `bax` string — Merchant number associated with the stores payment terminal - `terminal_id` string — Id to a specific point-of-sale (POS) terminal or workstation - `payout_destination_id` string — The payout destination id for the merchant of record, i.e. the seller responsible for the transaction. Required when `seitatech.in_person` payment is enabled. - `discount_lines` DiscountItem[] — Discounts given, additions to any items discount_lines. - `amount` integer — Monetary amount in smallest unit for the currency - `percentage` number — Optional, set if the amount given was from a percentage discount - `discount_type` 'customer' | 'periodic' | 'manual' | 'loyalty' | 'total' | 'employee' | 'external' - `discount_id` string - `description` string - `line_id` integer - `discount_codes` string[] - `gift_cards` Giftcard[] — The gift cards selected, the part of `order.amount` that will be authorized using gift cards - `type` 'dintero.wallets', required - `card_id` string, required - `amount` integer, required — Non-negative, minor units. Total amount for the gift card - `masked_card_token` string - `emd` Emd — Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/). Some items require extra information to be provided when using Klarna as an enabled payment option. - `event` object[] — Only required if the item is related to an event or multiple events, like for example tickets to a concert. If you are selling an event package as a single ticket or item that includes multiple events, for example a festival, you need to provide information about all the individual events that are part of the package. - … - `subscription` EmdRecurring — Only required if the item is related to a subscription. If that is the case, you need to provide information about both the subscription and the customer account. - … - `travel` EmdTravel — Only required if the item is part of a travel-related transaction. If that is the case, you need to provide information about the itinerary to be booked. - … - `marketplace_order` EmdMarketplaceOrder — Only required if them item is related to a marketplace order. If that is the case, you need to provide information about both the seller and the winner. - … - `payout_destination_id` string — An id that identifies the seller, value will be included in the settlement reports. Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `merchant_reference` string, required — A reference by the merchant to identify the corresponding order for the Checkout Session - `updated_order` SessionOrder - `amount` integer, required — The amount to authorize/capture including VAT and discounts. In smallest unit for the currency, e.g. cents The `amount` should be equal to the sum of the `items.amount` + `shipping_option.amount`. - `currency` string, iso4217-code, required — The three-character ISO-4217 currency. https://en.wikipedia.org/wiki/ISO_4217 - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. In smallest unit for the currency, e.g. cents The `vat_amount` should be equal to the sum of the `items.vat_amount` + `shipping_option.vat_amount`. - `merchant_reference_2` string — A reference by the merchant to identify the corresponding order for the Checkout Session - `event_reference` string — Default event_reference to include in transaction events. The value is included in the settlement report Use of `capture_reference` and `refund_reference` during capture and refund overrides the provided value - `shipping_address` OrderAddress — Address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `billing_address` OrderAddress — Address - `first_name` string - `last_name` string - `address_line` string — Gaustadalleen 21 - `address_line_2` string — PB 123 - `co_address` string - `business_name` string — Name of the company - `postal_code` string — The zip code / postal code of the address. - `postal_place` string — The name of the postal code - `country` string, iso3166-alpha2 — Country of the location - `phone_number` string — mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) - `email` string — The email address of a person or an organization - `latitude` number - `longitude` number - `comment` string — Comment about the address - `organization_number` string — The organization number of the customer. - `organization_type` string — Type indicating what kind of organization it is. - `customer_reference` string — The customer's reference - `cost_center` string — For companies that needs to specify a cost center. - `partial_payment` boolean — This is a partial payment where the `order.amount` can be lower or equal to the sum of `order.items.amount` - `items` object[] — Details about the order items. #### Instabank `required` if Instabank payment is configured in and partial_payment is false. All items must include a unique `line_id`, quantity and amount #### Collector Bank `required` if Collector Bank payment is configured in and partial_payment is false. All items must include a unique `line_id`, quantity and amount - `id` string — The ID or SKU of the product on the line - `groups` object[] — The groups the product on the line belongs to - … - `line_id` string — the number of the line (or id), must be `unique` between all items. `required` when Instabank payment is configured. - `version` number — The version where the item was added or last updated, see the events for the source. - `description` string — A short, localized description of the line item - `quantity` number — The quantity of the product in the item line. Quantities are usually whole numbers, but can also be decimal, in cases where the product is sold by weight, volume or other denominations. - `amount` integer — The total monetary amount of the line item, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. In smallest unit for the currency, e.g. cents - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `unit_volume` number — The volume of one item in m³ (cubic meters) - `unit_weight` number — The volume of one item in kg (kilo grams) - `unit_dimensional_weight` number — The dimensional weight (also known as volumetric) value unit of one item. [Dimensional weight at Wikipedia](https://en.wikipedia.org/wiki/Dimensional_weight) - `type` 'physical' | 'digital' | 'service' | 'gift_card' | 'shipping' | 'surcharge' — The type of order item this is. - **physical** - a physical item which must be delivered or handed over - **digital** - a digital item which doesn't need shipping - **service** - payment for services like maintenance performed in your home - **gift_card** - usage of a gift card, where the amount is usually a negative number - **shipping** - payment for shipping of the order - **surcharge** - extra incurred costs, like taxes or necessary rounding - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - … - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - … - `thumbnail_url` string, uri — URL to a thumbnail of the item. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `emd` Emd — Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/). Some items require extra information to be provided when using Klarna as an enabled payment option. - … - `store` Store - … - `eligible_for_discount` boolean — The item is eligible for discount - `is_changed` boolean — Discount applied to amount - `gross_amount` number — The origin item amount before any discount - `discount_lines` DiscountItem[] - … - `gross_amount` number — The origin amount to authorize/capture including VAT before any discount, only set if the session was updated when calculating discounts. In smallest unit for the currency, e.g. cents - `is_changed` boolean — The original order amount was changed by discount given. - `shipping_option` MultiShipmentTopLevelShippingOption — A shipping option - `id` string, required — Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. - `line_id` string, required — Unique id of the specific configuration of this shipping product - `countries` string[] — Countries where this shipping option can be used - `amount` integer, required — The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents - `vat_amount` integer — The VAT of the `amount` parameter. Only used for display purposes. - `vat` number — The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2. - `title` string, required — A shipping option title. Eg. "Standard" - `description` string — A short description of the shipping option product - `delivery_method` 'delivery' | 'pick_up' | 'unspecified' | 'none' - `operator` string, required — Name of company that provides shipping service - `operator_product_id` string — The operators own id for this shipping product - `eta` object — Relative time for delivery or pick-up - … - `time_slot` object — A specified time for delivery to customer - … - `pick_up_address` object — Additional information about the shipping address - … - `metadata` object — Additional metadata about the shipping_option - `environmental_data` object — Environmental data about the shipping option - … - `thumbnail_url` string, uri — URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image: - all images should preferrably have the same dimensions - max file size should be less than 2MB - `pay_in_store` object — Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method `dintero.zero` is enabled - … - `fee_split` PayoutFeeSplit — Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations - … - `splits` PayoutSplit[] — An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture. `auto_capture` cannot be enabled when splits are defined as empty array. - … - `shipments` MultiShipmentShippingOption[] — For multiple shipments we have a single top-level shipping object that contains the shipments for the order. The shipping options defined in `shipments` must contain `shipment_items` that define what items belong to what shipment. For multiple shipments: - do not define `splits` on the toplevel shipping option - do not define `fee_split` on the toplevel shipping option - the `pay_in_store` option is not compatible with `shipments` - empty shipments array is not allowed - single item multi shipping option is not allowed - … - `store` Store - `id` string, required - `name` string — name of the store, aka trade name of the store - `business_name` string — Official name of the person or entity that owns the store. - `address` Address - … - `chain` string - `email` string - `gln` string - `organization_number` string - `phone_number` string - `mcc` string, iso-18245 — A four-digit Merchant Category Code (MCC) for the store [ISO 18245:2003](https://www.iso.org/standard/33365.html) - `bax` string — Merchant number associated with the stores payment terminal - `terminal_id` string — Id to a specific point-of-sale (POS) terminal or workstation - `payout_destination_id` string — The payout destination id for the merchant of record, i.e. the seller responsible for the transaction. Required when `seitatech.in_person` payment is enabled. - `discount_lines` DiscountItem[] — Discounts given, additions to any items discount_lines. - `amount` integer — Monetary amount in smallest unit for the currency - `percentage` number — Optional, set if the amount given was from a percentage discount - `discount_type` 'customer' | 'periodic' | 'manual' | 'loyalty' | 'total' | 'employee' | 'external' - `discount_id` string - `description` string - `line_id` integer - `discount_codes` string[] - `gift_cards` Giftcard[] — The gift cards selected, the part of `order.amount` that will be authorized using gift cards - `type` 'dintero.wallets', required - `card_id` string, required - `amount` integer, required — Non-negative, minor units. Total amount for the gift card - `masked_card_token` string - `emd` Emd — Details related to [Klarna EMD](https://docs.klarna.com/klarna-payments/in-depth-knowledge/extra-merchant-data/). Some items require extra information to be provided when using Klarna as an enabled payment option. - `event` object[] — Only required if the item is related to an event or multiple events, like for example tickets to a concert. If you are selling an event package as a single ticket or item that includes multiple events, for example a festival, you need to provide information about all the individual events that are part of the package. - … - `subscription` EmdRecurring — Only required if the item is related to a subscription. If that is the case, you need to provide information about both the subscription and the customer account. - … - `travel` EmdTravel — Only required if the item is part of a travel-related transaction. If that is the case, you need to provide information about the itinerary to be booked. - … - `marketplace_order` EmdMarketplaceOrder — Only required if them item is related to a marketplace order. If that is the case, you need to provide information about both the seller and the winner. - … - `payout_destination_id` string — An id that identifies the seller, value will be included in the settlement reports. Note: The seller must be configured before the funds will be paid out. See https://docs.dintero.com/docs/checkout/split-payment/add-payout-destinations - `merchant_reference` string, required — A reference by the merchant to identify the corresponding order for the Checkout Session - `updated_order_result` object - `status` 'NOT_MODIFIED' — The status of the order object after the update, e.g. if the update modified the order object or not. - `previous_express` SessionExpress - `express` object — ### Present only for _Express Checkout_ sessions. An _Express Checkout_ session is a session where the end user will submit a shipping address and then select a shipping option before the before a payment method is selected and the payment is initiated. Endpoints used in the _Express Checkout_ flow. 1. [Set shipping address](/checkout-api/view/checkout_sid_json_order_shipping_address_put) 2. [Set shipping option](/checkout-api/view/checkout_sid_json_order_items_shipping_option_put) - `shipping_options` ShippingOption[], required — Shipping options that will be presented to the end user after the end user has submitted a shipping address. To dynamically update the shipping_options when the _`order.shipping_address`_ is changed by the end user in the checkout, use the _`url.shipping_address_callback_url`_. If the merchant is not able to ship the order to the end users shipping address, use an empty array. If there is only one option, a free delivery, the order still has to contain one option with a _`price.amount`_ of 0. - … - `shipping_mode` 'shipping_required' | 'shipping_not_required' - `discount_codes` object — Enable discount codes for Express Checkout - … - `shipping_address_callback_url` string, uri — URL that Checkout will POST to when the end user has submitted/changed a shipping address for an express-session. Dintero will not attempt a retry after a failed delivery attempt. Following situations is considered as failed delivery - HTTP status codes that are not 200. - A request timeout (60 seconds) - Any connection error such as connection timeout, bad certificate, etc The response from the callback will be used to update the shipping options. See [POST example/shipping_address_callback_url](/api-reference/example-session-callbacks/example_shipping_address_callback_url) for details about the request and response. - `customer_types` string[] — Limit the lind of customers that can be submitted via the address form in the express checkout. - `default_different_billing_shipping_address` string[] — Configure the default behavior for how Checkout presents the shipping and billing addresses. If `[]`, Checkout defaults to assuming the shipping and billing addresses are the same. If `["b2b"]`, Checkout defaults to assuming different addresses for B2B only. If `["b2c"]`, Checkout defaults to assuming different addresses for B2C only. If `["b2b", "b2c"]`, Checkout defaults to assuming different addresses for all customer types. If omitted, Checkout defaults to the same behaviour as setting `[]`. This will only have an effect if `allow_different_billing_shipping_address` is set. - `updated_express` SessionExpress - `express` object — ### Present only for _Express Checkout_ sessions. An _Express Checkout_ session is a session where the end user will submit a shipping address and then select a shipping option before the before a payment method is selected and the payment is initiated. Endpoints used in the _Express Checkout_ flow. 1. [Set shipping address](/checkout-api/view/checkout_sid_json_order_shipping_address_put) 2. [Set shipping option](/checkout-api/view/checkout_sid_json_order_items_shipping_option_put) - `shipping_options` ShippingOption[], required — Shipping options that will be presented to the end user after the end user has submitted a shipping address. To dynamically update the shipping_options when the _`order.shipping_address`_ is changed by the end user in the checkout, use the _`url.shipping_address_callback_url`_. If the merchant is not able to ship the order to the end users shipping address, use an empty array. If there is only one option, a free delivery, the order still has to contain one option with a _`price.amount`_ of 0. - … - `shipping_mode` 'shipping_required' | 'shipping_not_required' - `discount_codes` object — Enable discount codes for Express Checkout - … - `shipping_address_callback_url` string, uri — URL that Checkout will POST to when the end user has submitted/changed a shipping address for an express-session. Dintero will not attempt a retry after a failed delivery attempt. Following situations is considered as failed delivery - HTTP status codes that are not 200. - A request timeout (60 seconds) - Any connection error such as connection timeout, bad certificate, etc The response from the callback will be used to update the shipping options. See [POST example/shipping_address_callback_url](/api-reference/example-session-callbacks/example_shipping_address_callback_url) for details about the request and response. - `customer_types` string[] — Limit the lind of customers that can be submitted via the address form in the express checkout. - `default_different_billing_shipping_address` string[] — Configure the default behavior for how Checkout presents the shipping and billing addresses. If `[]`, Checkout defaults to assuming the shipping and billing addresses are the same. If `["b2b"]`, Checkout defaults to assuming different addresses for B2B only. If `["b2c"]`, Checkout defaults to assuming different addresses for B2C only. If `["b2b", "b2c"]`, Checkout defaults to assuming different addresses for all customer types. If omitted, Checkout defaults to the same behaviour as setting `[]`. This will only have an effect if `allow_different_billing_shipping_address` is set. - `updated_express_result` object - `status` 'NOT_MODIFIED' — The status of the express object after the update, e.g. if the update modified the express object or not. - `gift_card` object - `card_id` string - `card_amount` number - `masked_card_token` string - `currency` string - `transaction_event_id` string — Reference to the transaction event ID in case of `AUTH_CALLBACK_SENT` event - `transaction_id` string — Transaction which has been created using the checkout. - `updated_at` string, date-time — When the transaction was last modified. - `metadata` object — Additional details about the transaction - `merchant_name` string - `merchant_country` string - `merchant_category_code` string - `session:profile_id` string — Profile Id used when session was created - `event_reference` string — Event Reference used when session was created, default value that will be used on capture and refund - `payout` 'payout_account' | 'payout_splits' | 'payout_destination_id' — How settlement payout will be done by Dintero - `payout_account`: Payout directly to merchant - `payout_splits`: Payout is splitted to one or more sellers - `payout_destination_id`: Payout is done to a single seller - `payout_correlation_id` string — Id that will be referenced on the settlement report - `gateway:id` string — Order Id in Klarna - `bambora:merchant_number` string - `bambora:transaction_id` string - `bambora:reference` string - `bambora:acquirer` string - `bambora:wallet` string - `collector:StoreId` string — The Collector Store ID of the payment - `collector:Invoice.InvoiceNumber` string — The invoice number of the invoice. - `collector:Invoice.OrderNumber` string — Corresponds to the Dintero session ID - `collector:Invoice.CountryCode` string — The country of the payment - `collector:Invoice.ProductCode` string - `collector:Invoice.InvoiceType` string - `collector:Invoice.SettlementReference` string — The SettlementReference used for the payment. - `instabank:Sale.ExternalReference` string — External reference for the transaction - `instabank:Sale.Sequence` number — External case sequence (id) - `instabank:Sale.Product.Name` string — Payment product name - `klarna:authorized_payment_method:type` 'invoice' | 'fixed_amount' | 'base_account' | 'direct_debit' | 'direct_bank_transfer' | 'b2b_invoice' | 'card' | 'slice_it_by_card' | 'pay_later_by_card' | 'pay_by_card' | 'fixed_sum_credit' - `klarna:authorized_payment_method:number_of_days` string - `klarna:authorized_payment_method:number_of_installments` string - `klarna:authorized_payment_method:fraud_status` 'ACCEPTED' | 'PENDING' — Fraud status for order - `netaxept:merchant_id` string - `netaxept:transaction_id` string - `payex:payment:payee_info:payee_id` string - `payex:payment:payee_info:payee_name` string - `payex:payment:payee_info:subsite` string - `payex:payment:id` string - `payex:payment:number` union - number - string - `payex:payment:operation` string - `payex:payment:created` string, date-time - `santander:debit_account.ApplicationNumber` string — ID of the application provided by Santander - `santander:debit_account.StatusCode` string — Status code from Santander - `swish:payment_request:id` string - `swish:swish_number` string - `swish:id` string — Payment request id - `swish:paymentReference` string — Capture payment reference from bank - `vipps:transaction.orderId` string - `vipps:transaction.transactionText` string - `vipps:merchantInfo.merchantSerialNumber` string, ^\d{6}$ — Unique id for this merchant's sales channel: website, mobile app etc. Short name: MSN. - `vipps:merchantInfo.paymentType` 'eComm Regular Payment' - `kravia:invoice_number` string — The invoice number. - `kravia:invoice_reference` string — The invoice reference. - `kravia:invoice_channel` 'merchant' | 'kravia' — Invoice channel to use for delivering the invoice. - `kravia:invoice_url` string, uri — URL to download the invoice PDF. - `two:order_id` string — A globally unique ID set by Two. - `two:payment_url` string, uri — The url for payment verification. - `two:merchant_id` string — A unique id for the merchant - `checkboxes` Checkbox[] — Configuration for checkboxes that should be part of the checkout - `id` string, required — ID to assign to the checkbox so you can reference it later - `label` string, required — Label that should be visible next to the checkbox - `checked` boolean — If the checkbox should be checked by default or not - `required` boolean — If the checkbox should be required or not - `link` object - `url` string, required — Link URL - `text` string, required — Link text - `card` Card - `brand` string — Visa, MasterCard, etc. The brand of the card. - `masked_pan` string - `expiry_date` string, \d{2}/\d{4} - `type` 'Credit' | 'Debit' | 'Credit Card' | 'Debit Card' | 'Prepaid' - `region` 'domestic' | 'eea' | 'eea-uk' | 'europe' | 'inter' — The region in which the transaction takes place, determined by location of merchant and issuer. * `domestic`: merchant and issuer within the same country. * `eea`: merchant and issuer within EEA, but not the same country. * `eea-uk`: merchant and issuer within EEA plus United Kingdom, but one or both not withing EEA. * `europe`: merchant and issuer within Europe, but one or both not within EEA plus United Kingdom. * `inter`: merchant and/or issuer not within Europe. - `country` string, iso-3166-1 — The country the card is issued in - `product_platform` 'consumer' | 'commercial' - `issuing_bank` string — The name of the bank that issued the card used - `acquirer_transaction_type` '3DSECURE' | 'SSL' — 3DSECURE or SSL. Indicates the transaction type of the acquirer. - `acquirer_stan` string — The System Trace Audit Number assigned by the acquirer to uniquely identify the transaction. - `acquirer_terminal_id` string — The ID of the acquirer terminal. - `acquirer_transaction_time` string, date-time — The ISO-8601 date and time of the acquirer transaction. - `authentication_status` 'Y' | 'A' | 'U' | 'N' — Y, A, U or N. Indicates the status of the authentication. - `three_ds_version` string - `three_ds_server_trans_id` string - `eci` string - `payment_system_type` string - `payment_token` string — The payment token generated by the authorization. Only available for transactions created from session where the generate_payment_token option is enabled in the session configuration, or from payment token sessions where payment_token is included in the token_provider.token_types - [POST /v1/sessions/payment-token](/api-reference/session/checkout_payment_token_session_post) - `payment_token_id` string — The id of the payment_token, only included in transaction where a payment_token was generated. - `recurrence_token` string — The recurrence token generated by the authorization. Only available for transactions created from session where the generate_recurrence_token option is enabled in the session configuration, or from payment token sessions where recurrence_token is included in the token_provider.token_types - [POST /v1/sessions/payment-token](/api-reference/session/checkout_payment_token_session_post) - `recurrence_token_id` string — The id of the recurrence_token, only included in transaction where a recurrence_token was generated. - `card_holder_tokenization_consent` 'opt_in' | 'opt_out' — The card holder's consent to tokenization, as provided during authorization. This is only a hint, and the final decision is made by the card issuer. - `entry_method` 'chip' | 'contactless' | 'magstripe' — How the card was read. - `verified_identity` VerifiedIdentity — Verified identity of the customer aka payer - `type` 'collector-idp' | 'dintero-idp', required - `iss` string, uri, required - `sub` string - `aud` string, required - `acr` string, uri, required — Authentication Context Class Reference. - `auth_time` string, date-time, required - `national_idp` string, required - `national_country` string, iso3166-alpha2, required - `nonce` string - `name` string - `given_name` string - `family_name` string ## Other responses - `400` — Bad / Invalid request - `401` — Access forbidden, invalid JWT token was used - `403` — Forbidden - `500` — Unexpected Error --- [API](https://skmtc.net/dintero/apis/account-management-api.md) · [All operations](https://skmtc.net/dintero/apis/account-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dintero/account-management-api/versions/9b83a4199008/schema)