Class CheckoutOrder

Inheritance

System.Object

CheckoutOrder

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Klarna.Rest.Core.Model

Assembly: Klarna.Rest.Core.dll

Syntax

public class CheckoutOrder

Properties

| Improve this Doc View Source

Attachment

Additional purchase information required for some industries.

Declaration

[JsonProperty(PropertyName = "attachment")]
public Attachment Attachment { get; set; }

Property Value

Type	Description
Attachment

| Improve this Doc View Source

BillingCheckoutAddress

Once the customer has provided any data in the checkout iframe, updates to this object will be ignored (without generating an error).

Declaration

[JsonProperty(PropertyName = "billing_address")]
public CheckoutAddressInfo BillingCheckoutAddress { get; set; }

Property Value

Type	Description
CheckoutAddressInfo

| Improve this Doc View Source

CheckoutCustomer

Information about the liable customer of the order.

Declaration

[JsonProperty(PropertyName = "customer")]
public CheckoutCustomer CheckoutCustomer { get; set; }

Property Value

Type	Description
CheckoutCustomer

| Improve this Doc View Source

CheckoutOptions

Options for the purchase.

Declaration

[JsonProperty(PropertyName = "options")]
public CheckoutOptions CheckoutOptions { get; set; }

Property Value

Type	Description
CheckoutOptions

| Improve this Doc View Source

CompletedAt

ISO 8601 datetime. When the customer completed the order.

Declaration

[JsonProperty(PropertyName = "completed_at")]
public string CompletedAt { get; set; }

Property Value

Type	Description
System.String

Remarks

Read only

| Improve this Doc View Source

ExternalCheckouts

List of external checkouts.

Declaration

[JsonProperty(PropertyName = "externa_checkouts")]
public ICollection<PaymentProvider> ExternalCheckouts { get; set; }

Property Value

Type	Description
System.Collections.Generic.ICollection<PaymentProvider>

| Improve this Doc View Source

ExternalPaymentMethods

List of external payment methods.

Declaration

[JsonProperty(PropertyName = "external_payment_methods")]
public ICollection<PaymentProvider> ExternalPaymentMethods { get; set; }

Property Value

Type	Description
System.Collections.Generic.ICollection<PaymentProvider>

| Improve this Doc View Source

Gui

The gui object.

Declaration

[JsonProperty(PropertyName = "gui")]
public Gui Gui { get; set; }

Property Value

Type	Description
Gui

| Improve this Doc View Source

HtmlSnippet

The HTML snippet that is used to render the checkout in an iframe.

Declaration

[JsonProperty(PropertyName = "html_snippet")]
public string HtmlSnippet { get; set; }

Property Value

Type	Description
System.String

Remarks

Read only

| Improve this Doc View Source

LastModifiedAt

ISO 8601 datetime. When the order was last modified.

Declaration

[JsonProperty(PropertyName = "last_modified_at")]
public string LastModifiedAt { get; set; }

Property Value

Type	Description
System.String

Remarks

Read only

| Improve this Doc View Source

Locale

RFC 1766 customer's locale.

Declaration

[JsonProperty(PropertyName = "locale")]
public string Locale { get; set; }

Property Value

Type	Description
System.String

Remarks

Required

| Improve this Doc View Source

MerchantData

Pass through field (max 1024 characters).

Declaration

[JsonProperty(PropertyName = "merchant_data")]
public string MerchantData { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

MerchantReference1

Used for storing merchant's internal order number or other reference. If set, will be shown on the confirmation page as "order number" (max 255 characters).

Declaration

[JsonProperty(PropertyName = "merchant_reference1")]
public string MerchantReference1 { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

MerchantReference2

Used for storing merchant's internal order number of other reference (max 255 characters).

Declaration

[JsonProperty(PropertyName = "merchant_reference2")]
public string MerchantReference2 { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

MerchantRequested

Stored merchant requested data.

Declaration

[JsonProperty(PropertyName = "merchant_requested")]
public MerchantRequested MerchantRequested { get; set; }

Property Value

Type	Description
MerchantRequested

Remarks

Read only

| Improve this Doc View Source

MerchantUrls

The MerchantUrls object.

Declaration

[JsonProperty(PropertyName = "merchant_urls")]
public CheckoutMerchantUrls MerchantUrls { get; set; }

Property Value

Type	Description
CheckoutMerchantUrls

Remarks

Required

| Improve this Doc View Source

Name

The merchant name (max 255 characters).

Declaration

[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
System.String

Remarks

Read only

| Improve this Doc View Source

OrderAmount

Non-negative, minor units. Total amount of the order, including tax and any discounts.

Declaration

[JsonProperty(PropertyName = "order_amount")]
public int OrderAmount { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Required

| Improve this Doc View Source

OrderId

The unique order ID (max 255 characters).

Declaration

[JsonProperty(PropertyName = "order_id")]
public string OrderId { get; set; }

Property Value

Type	Description
System.String

Remarks

Read only

| Improve this Doc View Source

OrderLines

The applicable order lines (max 1000)

Declaration

[JsonProperty(PropertyName = "order_lines")]
public ICollection<OrderLine> OrderLines { get; set; }

Property Value

Type	Description
System.Collections.Generic.ICollection<OrderLine>

Remarks

Required

| Improve this Doc View Source

OrderTaxAmount

Non-negative, minor units. The total tax amount of the order.

Declaration

[JsonProperty(PropertyName = "order_tax_amount")]
public int OrderTaxAmount { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Required

| Improve this Doc View Source

PurchaseCountry

ISO 3166 alpha-2 purchase country.

Declaration

[JsonProperty(PropertyName = "purchase_country")]
public string PurchaseCountry { get; set; }

Property Value

Type	Description
System.String

Remarks

Required

| Improve this Doc View Source

PurchaseCurrency

ISO 4217 purchase currency.

Declaration

[JsonProperty(PropertyName = "purchase_currency")]
public string PurchaseCurrency { get; set; }

Property Value

Type	Description
System.String

Remarks

Required

| Improve this Doc View Source

Recurring

Indicates whether this purchase will create a token that can be used by the merchant to create recurring purchases. This must be enabled for the merchant to use. Default: false

Declaration

[JsonProperty(PropertyName = "recurring")]
public bool Recurring { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

RecurringDescription

Description recurring subscriptions.

Declaration

[JsonProperty(PropertyName = "recurring_description")]
public string RecurringDescription { get; set; }

Property Value

Type	Description
System.String

Remarks

Read only

| Improve this Doc View Source

RecurringToken

Token to be used when creating recurring orders.

Declaration

[JsonProperty(PropertyName = "recurring_token")]
public string RecurringToken { get; set; }

Property Value

Type	Description
System.String

Remarks

Read only

| Improve this Doc View Source

SelectedShippingOption

Current shipping options selected by the customer.

Declaration

[JsonProperty(PropertyName = "selected_shipping_option")]
public ShippingOption SelectedShippingOption { get; set; }

Property Value

Type	Description
ShippingOption

Remarks

Read only

| Improve this Doc View Source

ShippingCheckoutAddress

Unless the customer has explicitly chosen to enter a separate shipping address, this is a clone of BillingAddress.

Declaration

[JsonProperty(PropertyName = "shipping_address")]
public CheckoutAddressInfo ShippingCheckoutAddress { get; set; }

Property Value

Type	Description
CheckoutAddressInfo

Remarks

Read only

| Improve this Doc View Source

ShippingCountries

A list of countries (ISO 3166 alpha-2). Default is PurchaseCountry only.

Declaration

[JsonProperty(PropertyName = "shipping_countries")]
public ICollection<string> ShippingCountries { get; set; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.String>

| Improve this Doc View Source

ShippingOptions

A list of shipping options available for this order.

Declaration

[JsonProperty(PropertyName = "shipping_options")]
public ICollection<ShippingOption> ShippingOptions { get; set; }

Property Value

Type	Description
System.Collections.Generic.ICollection<ShippingOption>

| Improve this Doc View Source

StartedAt

ISO 8601 datetime. When the merchant created the order.

Declaration

[JsonProperty(PropertyName = "started_at")]
public string StartedAt { get; set; }

Property Value

Type	Description
System.String

Remarks

Read only

| Improve this Doc View Source

Status

The current status of the order.

Declaration

[JsonProperty(PropertyName = "status")]
public string Status { get; set; }

Property Value

Type	Description
System.String

Remarks

Read only