Show / Hide Table of Contents

Class OrderManagementOrder

Inheritance
System.Object
OrderManagementOrder
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 OrderManagementOrder

Properties

| Improve this Doc View Source

BillingAddress

Customer billing address.

Declaration
[JsonProperty(PropertyName = "billing_address")]
public OrderManagementAddressInfo BillingAddress { get; set; }
Property Value
Type Description
OrderManagementAddressInfo

Customer billing address.

| Improve this Doc View Source

CapturedAmount

The total amount of all captures. In minor units.

Declaration
[JsonProperty(PropertyName = "captured_amount")]
public int CapturedAmount { get; set; }
Property Value
Type Description
System.Int32

The total amount of all captures. In minor units.

| Improve this Doc View Source

Captures

List of captures for this order.

Declaration
[JsonProperty(PropertyName = "captures")]
public ICollection<OrderManagementCapture> Captures { get; set; }
Property Value
Type Description
System.Collections.Generic.ICollection<OrderManagementCapture>

List of captures for this order.

| Improve this Doc View Source

CreatedAt

The time for the purchase. Formatted according to ISO 8601.

Declaration
[JsonProperty(PropertyName = "created_at")]
public string CreatedAt { get; set; }
Property Value
Type Description
System.String

The time for the purchase. Formatted according to ISO 8601.

| Improve this Doc View Source

Customer

Information about the customer placing the order.

Declaration
[JsonProperty(PropertyName = "customer")]
public OrderManagementCustomer Customer { get; set; }
Property Value
Type Description
OrderManagementCustomer

Information about the customer placing the order.

| Improve this Doc View Source

ExpiresAt

Order expiration time. The order can only be captured until this time. Formatted according to ISO 8601.

Declaration
[JsonProperty(PropertyName = "expires_at")]
public string ExpiresAt { get; set; }
Property Value
Type Description
System.String

Order expiration time. The order can only be captured until this time. Formatted according to ISO 8601.

| Improve this Doc View Source

FraudStatus

Fraud status for the order. Either ACCEPTED, PENDING or REJECTED.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty(PropertyName = "fraud_status")]
public OrderManagementFraudStatus FraudStatus { get; set; }
Property Value
Type Description
OrderManagementFraudStatus

Fraud status for the order. Either ACCEPTED, PENDING or REJECTED.

| Improve this Doc View Source

InitialPaymentMethod

Initial payment method for this order

Declaration
[JsonProperty(PropertyName = "initial_payment_method")]
public OrderManagementInitialPaymentMethod InitialPaymentMethod { get; set; }
Property Value
Type Description
OrderManagementInitialPaymentMethod

Initial payment method for this order

| Improve this Doc View Source

KlarnaReference

A Klarna generated reference that is shorter than the Klarna Order Id and is used as a customer friendly reference. It is most often used as a reference when Klarna is communicating with the customer with regard to payment statuses.

Declaration
[JsonProperty(PropertyName = "klarna_reference")]
public string KlarnaReference { get; set; }
Property Value
Type Description
System.String

A Klarna generated reference that is shorter than the Klarna Order Id and is used as a customer friendly reference. It is most often used as a reference when Klarna is communicating with the customer with regard to payment statuses.

| Improve this Doc View Source

Locale

The customers locale. Specified according to RFC 1766.

Declaration
[JsonProperty(PropertyName = "locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

The customers locale. Specified according to RFC 1766.

| Improve this Doc View Source

MerchantData

Text field for storing data about the order. Set at order creation.

Declaration
[JsonProperty(PropertyName = "merchant_data")]
public string MerchantData { get; set; }
Property Value
Type Description
System.String

Text field for storing data about the order. Set at order creation.

| Improve this Doc View Source

MerchantReference1

The order number that the merchant should assign to the order. This is how a customer would reference the purchase they made. If supplied, it is labeled as the Order Number within post purchase communications as well as the Klarna App.

Declaration
[JsonProperty(PropertyName = "merchant_reference1")]
public string MerchantReference1 { get; set; }
Property Value
Type Description
System.String

The order number that the merchant should assign to the order. This is how a customer would reference the purchase they made. If supplied, it is labeled as the Order Number within post purchase communications as well as the Klarna App.

| Improve this Doc View Source

MerchantReference2

Can be used to store your internal reference to the order. This is generally an internal reference number that merchants use as alternate identifier that matches their internal ERP or Order Management system.

Declaration
[JsonProperty(PropertyName = "merchant_reference2")]
public string MerchantReference2 { get; set; }
Property Value
Type Description
System.String

Can be used to store your internal reference to the order. This is generally an internal reference number that merchants use as alternate identifier that matches their internal ERP or Order Management system.

| Improve this Doc View Source

OrderAmount

The order amount in minor units. That is the smallest currency unit available such as cent or penny.

Declaration
[JsonProperty(PropertyName = "order_amount")]
public int OrderAmount { get; set; }
Property Value
Type Description
System.Int32

The order amount in minor units. That is the smallest currency unit available such as cent or penny.

| Improve this Doc View Source

OrderId

The unique order ID. Cannot be longer than 255 characters.

Declaration
[JsonProperty(PropertyName = "order_id")]
public string OrderId { get; set; }
Property Value
Type Description
System.String

The unique order ID. Cannot be longer than 255 characters.

| Improve this Doc View Source

OrderLines

An array of order_line objects. Each line represents one item in the cart.

Declaration
[JsonProperty(PropertyName = "order_lines")]
public ICollection<OrderLine> OrderLines { get; set; }
Property Value
Type Description
System.Collections.Generic.ICollection<OrderLine>

An array of order_line objects. Each line represents one item in the cart.

| Improve this Doc View Source

OriginalOrderAmount

The original order amount. In minor units.

Declaration
[JsonProperty(PropertyName = "original_order_amount")]
public int OriginalOrderAmount { get; set; }
Property Value
Type Description
System.Int32

The original order amount. In minor units.

| Improve this Doc View Source

PurchaseCountry

The purchase country. Formatted according to ISO 3166-1 alpha-2.

Declaration
[JsonProperty(PropertyName = "purchase_country")]
public string PurchaseCountry { get; set; }
Property Value
Type Description
System.String

The purchase country. Formatted according to ISO 3166-1 alpha-2.

| Improve this Doc View Source

PurchaseCurrency

The currency for this order. Specified in ISO 4217 format.

Declaration
[JsonProperty(PropertyName = "purchase_currency")]
public string PurchaseCurrency { get; set; }
Property Value
Type Description
System.String

The currency for this order. Specified in ISO 4217 format.

| Improve this Doc View Source

RefundedAmount

The total amount of refunded for this order. In minor units.

Declaration
[JsonProperty(PropertyName = "refunded_amount")]
public int RefundedAmount { get; set; }
Property Value
Type Description
System.Int32

The total amount of refunded for this order. In minor units.

| Improve this Doc View Source

Refunds

List of refunds for this order.

Declaration
[JsonProperty(PropertyName = "refunds")]
public ICollection<OrderManagementRefund> Refunds { get; set; }
Property Value
Type Description
System.Collections.Generic.ICollection<OrderManagementRefund>

List of refunds for this order.

| Improve this Doc View Source

RemainingAuthorizedAmount

The remaining authorized amount for this order. To increase the remaining_authorized_amount the order_amount needs to be increased.

Declaration
[JsonProperty(PropertyName = "remaining_authorized_amount")]
public int RemainingAuthorizedAmount { get; set; }
Property Value
Type Description
System.Int32

The remaining authorized amount for this order. To increase the remaining_authorized_amount the order_amount needs to be increased.

| Improve this Doc View Source

ShippingAddress

Customer shipping address.

Declaration
[JsonProperty(PropertyName = "shipping_address")]
public OrderManagementAddressInfo ShippingAddress { get; set; }
Property Value
Type Description
OrderManagementAddressInfo

Customer shipping address.

| Improve this Doc View Source

Status

The order status.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty(PropertyName = "status")]
public OrderManagementOrderStatus Status { get; set; }
Property Value
Type Description
OrderManagementOrderStatus

The order status.

  • Improve this Doc
  • View Source
Back to top Copyright (c) 2005-2019 Klarna Bank AB (publ). All rights reserved.