Namespace Yort.Zip.InStore

Classes

CancelOrderRequest

Represents a request to cancel an order that has not yet been approved by the consumer or reached a final status.

CancelOrderResponse

Contains details of a successful request to cancel an order via CancelOrderAsync(CancelOrderRequest).

CommitOrderRequest

Contains details of a request to commit an order that has been created using the Auth flow.

CreateOrderRequest

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

CreateOrderResponse

Contains the initial details of an order created in the Zip system.

EnrolRequest

Represents a request to allow a device to request the client id and secret required to request authorisation tokens.

EnrolResponse

Contains the result of a successful EnrolRequest.

OrderStatusRequest

Represents details of a request to retrieve the current status of an order in the Zip system.

OrderStatusResponse

Represents the response of a successful GetOrderStatusAsync(OrderStatusRequest) call.

RefundOrderRequest

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

RefundOrderResponse

Provides details of a successful refund created by RefundOrderAsync(RefundOrderRequest).

RollbackOrderRequest

Contains details of a request to rollback (undo/cancel) an order that has been created using the Auth flow.

ZipApiException

An exception thrown by ZipClient when an error response is received from the Zip API.

ZipClient

The main class used to interact with the Zip payments API.

ZipClientConfiguration

Provides details to a ZipClient instance about how to access the Zip API.

ZipEnvironment

Represents a particular environment for the Zip API (i.e test for NZ merchants, production for AU merchants etc).

ZipEnvironment.NewZealand

Provides pre-build environment instances for the New Zealand region.

ZipErrorResponse

Used to hold error messages and validation errors returned by the Zip API.

ZipOrder

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

ZipOrderItem

Represents information about an item purchased on a Zip order, used to show the end-consumer details of their purchase in the Zip consumer portal.

ZipOrderStatus

Provides a list of known statuses for Zip orders.

ZipPaymentFlow

A class that exposes constants for the known allowed values of the PaymentFlow property.

ZipRequestOptionsBase

Base class for request options classes, providing a common and extensible interface for all requests.

ZipValidationError

Represents a set of errors that relate to a specific request property.

Interfaces

IZipClient

An interface for the primary object used to access the Zip payments API.