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 ZipOrder

    Contains details of an order (request for payment) to be created within the Zip system.

    Inheritance
    Object
    ZipOrder
    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 class ZipOrder

    Properties

    | Improve this Doc View Source

    Amount

    The amount to be charged to the consumer by Zip. Required. Must be a positive, non-zero value.

    Declaration
    public decimal Amount { get; set; }
    Property Value
    Type Description
    Decimal
    | Improve this Doc View Source

    CustomerApprovalCode

    The pre-approval code generated by the csutomer using their Zip app or web login. Required.

    Declaration
    public string CustomerApprovalCode { get; set; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    Items

    A summary of the items purchased on this order which will be displayed to the end consumer as part of their purchase history. Optional.

    Declaration
    public List<ZipOrderItem> Items { get; set; }
    Property Value
    Type Description
    List<ZipOrderItem>
    Remarks

    This collection defaults to null, to add items first set it to either an empty collection or a pre-loaded collection of ZipOrderItem instances.

    | Improve this Doc View Source

    MerchantReference

    The unique reference for this order as generated by the merchant. Required.

    Declaration
    public string MerchantReference { get; set; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    Operator

    A reference (name or id) of the staff person serving the customer at the POS. Required.

    Declaration
    public string Operator { get; set; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    PaymentFlow

    Determines whether this order results in a payment or an authorisation which must be subsequently confirmed. Required.

    Declaration
    public string PaymentFlow { get; set; }
    Property Value
    Type Description
    String
    Remarks

    The default is Payment.

    See Also
    ZipPaymentFlow

    See Also

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