• Home
  • API Documentation
Show / Hide Table of Contents
  • Yort.AfterPay.InStore
    • AfterPayApiError
      • ErrorCode
      • ErrorId
      • HttpStatusCode
      • Message
    • AfterPayApiException
      • AfterPayApiException
      • ErrorCode
      • ErrorId
      • HttpStatusCode
    • AfterPayCallContext
      • OperatorId
    • AfterPayClient
      • AfterPayClient
      • CreateOrder
      • DisposeManagedResources
      • Ping
      • PreapprovalEnquiry
      • RefundOrder
      • RegisterDevice
      • ReverseOrder
      • ReverseRefund
      • SendInvite
    • AfterPayConfiguration
      • AfterPayConfiguration
      • DefaultCurrency
      • DeviceId
      • DeviceKey
      • Environment
      • HttpClient
      • MerchantId
      • MinimumRetries
      • ProductName
      • ProductVendor
      • ProductVersion
      • RetryDelaySeconds
      • SystemClock
    • AfterPayConstants
      • JsonMediaType
      • ProductionRootUrl
      • SandboxRootUrl
    • AfterPayCreateOrderRequest
      • Amount
      • MerchantReference
      • OrderItems
      • PreapprovalCode
      • RequestedAt
      • RequestId
    • AfterPayCreateRefundRequest
      • Amount
      • MerchantReference
      • OrderId
      • OrderMerchantReference
      • RequestedAt
      • RequestId
    • AfterPayCurrencies
      • AustralianDollars
      • NewZealandDollars
    • AfterPayDeviceRegistration
      • DeviceId
      • Key
    • AfterPayDeviceRegistrationRequest
      • Attributes
      • Name
      • Secret
    • AfterPayEnvironment
      • Production
      • Sandbox
    • AfterPayInviteRequest
      • ExpectedAmount
      • MobileNumber
      • NormalizePhoneNumber
    • AfterPayMoney
      • AfterPayMoney
      • Amount
      • Currency
      • Equality
      • Equals
      • GetHashCode
      • Inequality
      • ToString
    • AfterPayMoneyJsonConverter
      • CanConvert
      • ReadJson
      • WriteJson
    • AfterPayOrder
      • Amount
      • MerchantReference
      • OrderedAt
      • OrderId
      • OrderItems
      • PreapprovalCode
      • RequestedAt
      • RequestId
    • AfterPayOrderItem
      • Name
      • Price
      • Quantity
      • Sku
    • AfterPayOrderReversal
      • RequestedAt
      • ReversedAt
      • ReverseId
      • ReversingRequestId
    • AfterPayPreapprovalRequest
      • PreapprovalCode
    • AfterPayPreapprovalResponse
      • Amount
      • ExpiresAt
      • Minimum
    • AfterPayRefund
      • Amount
      • MerchantReference
      • OrderId
      • OrderMerchantReference
      • RefundedAt
      • RefundId
      • RequestedAt
      • RequestId
    • AfterPayRefundReversal
      • RequestedAt
      • ReversedAt
      • ReverseId
      • ReversingRequestId
    • AfterPayReverseOrderRequest
      • RequestedAt
      • ReversingRequestId
    • AfterPayReverseRefundRequest
      • RequestedAt
      • ReversingRequestId
    • AfterPaySystemClock
      • DefaultInstance
      • Now
    • AfterPayToken
      • ExpiresAt
      • ExpiresIn
      • IsExpired
      • IssuedAt
      • Token
    • AfterPayTokenRequest
      • Key
    • IAfterPayClient
      • CreateOrder
      • Ping
      • PreapprovalEnquiry
      • RefundOrder
      • RegisterDevice
      • ReverseOrder
      • ReverseRefund
      • SendInvite
    • IAfterPaySystemClock
      • Now

Namespace Yort.AfterPay.InStore

Classes

AfterPayApiError

Represents an error response from the AfterPay API.

AfterPayApiException

Represents an exception thrown due to an error response from the AfterPay API.

AfterPayCallContext

Represents arguments to AfterPay API's that are common across most/all calls but are not part of the request content.

AfterPayClient

The main class used to access the AfterPay API, holding relevant configuration and providing methods for each REST API end point.

AfterPayConfiguration

Instances of this class represent configuration options for IAfterPayClient instances. The static members of this class provide global configuration common to all instances.

AfterPayConstants

Constant values relating to AfterPay.

AfterPayCreateOrderRequest

Represents a request to make a new AfterPay order (request payment for some items) via the AfterPay REST API.

AfterPayCreateRefundRequest

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

AfterPayCurrencies

Provides constants for currency codes known to be used by the AfterPay API.

AfterPayDeviceRegistration

Represents a successful response to a request to register a device AfterPayDeviceRegistrationRequest.

AfterPayDeviceRegistrationRequest

Represents a request to perform one-time registration of a device with the AfterPay REST API.

AfterPayInviteRequest

Represents a request to the AfterPay API to invite a customer to join AfterPay and/or create a payment barcode.

AfterPayMoneyJsonConverter

Ensures AfterPayMoney instances are serialized according to the AfterPay rules.

AfterPayOrder

Represents an order created within the AfterPay system via a AfterPayCreateOrderRequest.

AfterPayOrderItem

Represents an item being sold or returned as part of an AfterPay API transaction.

AfterPayOrderReversal

Represents a response from the AfterPay API to a AfterPayReverseOrderRequest.

AfterPayPreapprovalRequest

Represents a request to the AfterPay API for information about a pre-approval code generated by a customer.

AfterPayPreapprovalResponse

Represents the response from AfterPay to a AfterPayPreapprovalRequest.

AfterPayRefund

Represents a refund that has been successfully created with the AfterPay system.

AfterPayRefundReversal

Represents a reversed refund in the AfterPay system.

AfterPayReverseOrderRequest

Represents a request to reverse an order that was previously attempted in the AfterPay system.

AfterPayReverseRefundRequest

Represents a request to reverse a refund previously requested. This should only be done under error conditions where the state of the refund is unknown.

AfterPaySystemClock

Represents the default system clock used by the Yort.AfterPay.Instore library to retrieve the current date and time.

AfterPayToken

Represents an authorisation token returned from the AfterPay API.

AfterPayTokenRequest

Represents a request to the AfterPay API for a new security token used to authorise further requests.

Structs

AfterPayMoney

Represents a monetary or financial value in the AfterPay API as a tuple containing a numeric value and a string representing the associated currency.

Interfaces

IAfterPayClient

An interface for AfterPayClient to allow mocking the client for test purposes.

IAfterPaySystemClock

Interface for components that can return the current date and time.

Enums

AfterPayEnvironment

A enum providing a list of environments for the AfterPay API.

Back to top Copyright (c) 2017 Troy Willmot