Namespace Yort.OnlineEftpos
Classes
ApiErrorMessage
Represents an error message, often relating to a specific request field.
BankDefinition
Represents a bank known to be supported by Online EFTPOS, and the associated payer id types that is supports.
BankDeletedTrustRelationship
Provides details of the response from a bank for a request to delete a trust/autopay relationship.
BankDetails
Represents the details of a payer/account in a transaction.
CooperativeBankCustomerIdPayerId
Provides methods for validation and normalising a Co-operative Bank customer id.
ErasableString
Represents a string that is pinned in memory and can be overwritten when finished with, limiting the time window where the stored value can be obtained.
HateoasLink
Reperesents a "Hypermedia As The Engine Of Application State" link in a response from the server.
KnownBanks
Provides a list of banks known to be supported, and the payer id types each one supports.
MerchantDetails
Details of a merchant account associated with a transaction.
NotificationVerifierBase
Base class for INotificationVerifier providing reusable logic. Prefer INotificationVerifier for references.
NZMobilePayerIdType
Provides methods for validation and normalising NZ mobile phone number based payer ids.
OnlineEftposApiError
Represents error information returned from the Online EFTPOS API.
OnlineEftposApiException
Represent an error returned from the Online Eftpos API.
OnlineEftposAuthenticationException
Represents an exception thrown when a failure occurs obtaining a token from the Online Eftpos API.
OnlineEftposClient
Core class for communication with the PayMark Online Eftpos API. Provides methods for performing transactions such as payments and refunds.
OnlineEftposCredentials
Represents account credentials used to obtain tokens from the Online EFTPOS API.
OnlineEftposCredentialsProvider
Default credentials provider.
OnlineEftposDeleteTrustOptions
Represents details of trust/autopay relationship to be deleted via DeleteTrust(OnlineEftposDeleteTrustOptions).
OnlineEftposDeleteTrustResult
Represents the result of a request to delete an established trust/autopay relationship.
OnlineEftposException
Base type for exceptions thrown by this library. These indicate deliberately thrown exceptions rather than bugs within the library itself.
OnlineEftposInvalidDataException
Represents an exception thrown when a request contains invalid or missing data, validated prior to being sumitted to the API.
OnlineEftposNotification
Represents a notification about a payment status change from the Online EFTPOS system.
OnlineEftposPaymentRequest
Represents a request for payment.
OnlineEftposPaymentSearchOptions
Search criteria and options holder for PaymentSearch(OnlineEftposPaymentSearchOptions).
OnlineEftposPaymentSearchResult
Represents the results of a successful PaymentSearch(OnlineEftposPaymentSearchOptions) request.
OnlineEftposPaymentStatus
Represents the status of a payment transaction.
OnlineEftposRefundRequest
Represents a request to send a refund for a previous payment.
OnlineEftposRefundSearchOptions
Search criteria and options holder for RefundSearch(OnlineEftposRefundSearchOptions).
OnlineEftposRefundSearchResult
Represents the results of a successful RefundSearch(OnlineEftposRefundSearchOptions) request.
OnlineEftposRefundStatus
Represents the status of a refund transaction.
OnlineEftposRequestBuilder
Reduces the effort/code needed to construct a OnlineEftposPaymentRequest or OnlineEftposRefundRequest by using default & templated values for properties that do not change or have a predictable pattern.
OnlineEftposTransactionTypes
Provides string constants for known 'transaction types' used by Online EFTPOS.
OnlineEftposTrust
Represents details about an associated trust relationship in the response to a OnlineEftposPaymentRequest.
PayerId
Provides methods for validation and normalising payer ids.
PaymentDetails
Provides transaction details specific to a payment (request).
PaymentStatus
Provides a list of the possible states for a payment transaction, and details of each status.
RefundDetails
Provides transaction details specific to a refund (request).
RefundStatus
Provides a list of the possible states for a refund transaction, and details of each status.
Resource
Resource.Attribute
Resource.String
Sha512WithRsaVerifier
Default verifier for Online EFTPOS notifications, using SHA512withRSA signature verification.
TransactionRequestDetails
Represents transaction details common to all transaction types.
TransactionStatus
Represents a transaction status returned by the API.
TrustStatus
Represents the status of a trust relationship for Online EFTPOS.
WestpacCustomerIdPayerId
Provides methods for validation and normalising Westpac Customer Id based payer ids.
Interfaces
INotificationVerifier
Interface for components that can verify a OnlineEftposNotification as being valid and sent by the Online EFTPOS system.
IOnlineEftposClient
Primary interface for the OnlineEftposClient.
IOnlineEftposCredentialProvider
Interface for a component that can provide credentials submitted to the Online Eftpos API in order to obtain a token.
IPayerIdType
Common interface for components that can validate and normalise user input for a particular type of payer id.
Enums
OnlineEftposApiEnvironment
Represents the possible production and sandbox environments for the Online Eftpos API.
OnlineEftposApiVersion
Provides a list of the known and supported Online Eftpos API versions.