Class RefundOrderRequest

Represents a request to refund all or part of a previously completed order.

Inheritance

Object

ZipRequestOptionsBase

RefundOrderRequest

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 RefundOrderRequest : ZipRequestOptionsBase

Properties

Amount

The amount of this refund. Required, must be a positive and non-zero value.

Declaration

public decimal Amount { get; set; }

Property Value

Type	Description
Decimal

MerchantRefundReference

A unique reference for this refund. Required.

Declaration

public string MerchantRefundReference { 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

OrderId

The unique reference of the order within the Zip system to be refunded against. Required.

Declaration

public string OrderId { get; set; }

Property Value

Type	Description
String

StoreId

Optional. When using a merchant level authentication scope this is supposed to give traceability from which store the order originated in.

Declaration

public string StoreId { get; set; }

Property Value

Type	Description
String

TerminalId

Required. A value that uniquley identifies the point of sale terminal being used as part of this request.

Declaration

public string TerminalId { get; set; }

Property Value

Type	Description
String

Methods

ApplyDefaults(ZipClientConfiguration)

Applies the default store id, terminal id and operator if appropriate.

Declaration

public override void ApplyDefaults(ZipClientConfiguration config)

Parameters

Type	Name	Description
ZipClientConfiguration	config	A ZipClientConfiguration instance containing the default values to use.

Overrides

ZipRequestOptionsBase.ApplyDefaults(ZipClientConfiguration)

GetCustomHttpHeaders()

Returns custom header values for StoreId (if not null or empty) and TerminalId.

Declaration

public override Dictionary<string, string> GetCustomHttpHeaders()

Returns

Type	Description
Dictionary<String, String>

Overrides

ZipRequestOptionsBase.GetCustomHttpHeaders()

Validate()

Validates this request as much as possible prior to sending it to the Zip API.

Declaration

public override void Validate()

Overrides

ZipRequestOptionsBase.Validate()

Exceptions

Type	Condition
ArgumentNullException	Thrown if any required properties are null.
ArgumentException	Thrown if any of request properties are invalid.