Show / Hide Table of Contents
    • Yort.Zip.InStore
      • CancelOrderRequest
      • CancelOrderResponse
      • CommitOrderRequest
      • CreateOrderRequest
      • CreateOrderResponse
      • EnrolRequest
      • EnrolResponse
      • IZipClient
      • OrderStatusRequest
      • OrderStatusResponse
      • RefundOrderRequest
      • RefundOrderResponse
      • RollbackOrderRequest
      • ZipApiException
      • ZipClient
      • ZipClientConfiguration
      • ZipEnvironment
      • ZipEnvironment.NewZealand
      • ZipErrorResponse
      • ZipOrder
      • ZipOrderItem
      • ZipOrderStatus
      • ZipPaymentFlow
      • ZipRequestOptionsBase
      • ZipValidationError

    Class ZipOrderStatus

    Provides a list of known statuses for Zip orders.

    Inheritance
    Object
    ZipOrderStatus
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Yort.Zip.InStore
    Assembly: Yort.Zip.InStore.dll
    Syntax
    public static class ZipOrderStatus

    Fields

    | Improve this Doc View Source

    Approved

    The order has been approved and paid for by the customer. This status is relevant to an order that has been created with the Auth flow.

    Declaration
    public const string Approved = "approved"
    Field Value
    Type Description
    String
    | Improve this Doc View Source

    Cancelled

    The order has been cancelled either prior to the customer approving/declining, or the order has been rolled back by the merchant after a succesful Auth.

    Declaration
    public const string Cancelled = "cancelled"
    Field Value
    Type Description
    String
    | Improve this Doc View Source

    Complete

    The order has been paid and the order is complete. This means either the Payment flow as used and payment successful, or the the Auth was used and the payment was committed.

    Declaration
    public const string Complete = "complete"
    Field Value
    Type Description
    String
    | Improve this Doc View Source

    Declined

    The order was declined by the user.

    Declaration
    public const string Declined = "declined"
    Field Value
    Type Description
    String
    | Improve this Doc View Source

    Expired

    The order has timed out.

    Declaration
    public const string Expired = "expired"
    Field Value
    Type Description
    String
    | Improve this Doc View Source

    Pending

    Indicates the order is still pending approval or cancellation by the system/consumer. The client should continue polling.

    Declaration
    public const string Pending = "pending"
    Field Value
    Type Description
    String

    Methods

    | Improve this Doc View Source

    IsTerminalStatus(String)

    Returns true if the status provider is a known, final status - that is a status that should not change again.

    Declaration
    public static bool IsTerminalStatus(string status)
    Parameters
    Type Name Description
    String status

    The status to check.

    Returns
    Type Description
    Boolean

    True if the status is final, otherwise false.

    • Improve this Doc
    • View Source
    Back to top Copyright (c) 2020 Troy Willmot