Class ZipOrder
Contains details of an order (request for payment) to be created within the Zip system.
Inherited Members
Namespace: Yort.Zip.InStore
Assembly: Yort.Zip.InStore.dll
Syntax
public class ZipOrder
Properties
| Improve this Doc View SourceAmount
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 |
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 |
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.
MerchantReference
The unique reference for this order as generated by the merchant. Required.
Declaration
public string MerchantReference { get; set; }
Property Value
Type | Description |
---|---|
String |
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 |
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.