• API Documentation
Show / Hide Table of Contents
  • Yort.OnlineEftpos
    • ApiErrorMessage
      • Field
      • Message
    • BankDefinition
      • BankDefinition
      • DisplayName
      • Id
      • PayerIdTypes
    • BankDeletedTrustRelationship
      • Id
      • Status
    • BankDetails
      • BankId
      • EnsureValid
      • PayerId
      • PayerIdType
    • CooperativeBankCustomerIdPayerId
      • DisplayName
      • IsValid
      • Name
      • Normalize
    • ErasableString
      • Clear
      • Dispose
      • ErasableString
      • IsCleared
      • IsDisposed
      • Value
    • HateoasLink
      • Href
      • Rel
      • Title
    • INotificationVerifier
      • ThrowIfNotVerified
      • Verify
    • IOnlineEftposClient
      • ApiEnvironment
      • ApiVersion
      • CheckPaymentStatus
      • CheckRefundStatus
      • DeleteTrust
      • PaymentSearch
      • RefundSearch
      • RequestPayment
      • SendRefund
    • IOnlineEftposCredentialProvider
      • GetCredentials
    • IPayerIdType
      • DisplayName
      • IsValid
      • Name
      • Normalize
    • KnownBanks
      • AddBank
      • All
      • GetBank
      • RemoveBank
    • MerchantDetails
      • CallbackUrl
      • EnsureValid
      • MerchantIdCode
      • MerchantUrl
    • NotificationVerifierBase
      • GetPublicKey
      • NotificationVerifierBase
      • ThrowIfNotVerified
      • Verify
    • NZMobilePayerIdType
      • DisplayName
      • IsValid
      • Name
      • Normalize
    • OnlineEftposApiEnvironment
      • Live
      • Sandbox
      • Uat
    • OnlineEftposApiError
      • Error
      • Messages
      • Reference
    • OnlineEftposApiException
      • ErrorContent
      • ErrorMessage
      • OnlineEftposApiException
      • ReasonPhrase
      • StatusCode
    • OnlineEftposApiVersion
      • None
      • V1P1
    • OnlineEftposAuthenticationException
      • Error
      • ErrorDescription
      • ErrorUrl
      • OnlineEftposAuthenticationException
      • ReasonPhrase
      • StatusCode
    • OnlineEftposClient
      • ApiEnvironment
      • ApiVersion
      • CheckPaymentStatus
      • CheckRefundStatus
      • DeleteTrust
      • Dispose
      • OnlineEftposClient
      • PaymentSearch
      • RefundSearch
      • RequestPayment
      • SendRefund
    • OnlineEftposCredentials
      • ConsumerKey
      • ConsumerSecret
      • Dispose
      • OnlineEftposCredentials
    • OnlineEftposCredentialsProvider
      • Dispose
      • GetCredentials
      • OnlineEftposCredentialsProvider
    • OnlineEftposDeleteTrustOptions
      • EnsureValid
      • TrustId
    • OnlineEftposDeleteTrustResult
      • Bank
      • BankId
      • CreationTime
      • Id
      • Links
      • MerchantIdCode
      • ModificationTime
      • PayerId
      • PayerIdType
    • OnlineEftposException
      • OnlineEftposException
    • OnlineEftposInvalidDataException
      • OnlineEftposInvalidDataException
    • OnlineEftposNotification
      • MerchantOrderId
      • OnlineEftposNotification
      • Signature
      • SignedData
      • Status
      • TransactionId
      • TrustId
      • TrustStatus
    • OnlineEftposPaymentRequest
      • Bank
      • EnsureValid
      • Merchant
      • Transaction
    • OnlineEftposPaymentSearchOptions
      • BuildSearchQueryString
      • CreationTime
      • Fields
      • Limit
      • MerchantIdCode
      • Offset
      • OrderId
      • PaginationUri
      • PayerId
      • Status
    • OnlineEftposPaymentSearchResult
      • Links
      • NextPageUri
      • Payments
      • PreviousPageUri
    • OnlineEftposPaymentStatus
      • Bank
      • CreationTime
      • Id
      • Merchant
      • ModificationTime
      • Status
      • Transaction
      • Trust
    • OnlineEftposRefundRequest
      • EnsureValid
      • Merchant
      • Transaction
    • OnlineEftposRefundSearchOptions
      • BuildSearchQueryString
      • CreationTime
      • Fields
      • Limit
      • MerchantIdCode
      • Offset
      • PaginationUri
      • PayerId
      • RefundId
      • Status
    • OnlineEftposRefundSearchResult
      • Links
      • NextPageUri
      • PreviousPageUri
      • Refunds
    • OnlineEftposRefundStatus
      • CreationTime
      • Id
      • Merchant
      • ModificationTime
      • Status
      • Transaction
    • OnlineEftposRequestBuilder
      • CallbackUrlTemplate
      • CreatePaymentRequest
      • CreateRefundRequest
      • DefaultCurrency
      • DefaultCurrencyMultiplier
      • DefaultMerchantId
      • DefaultMerchantIdCode
      • DefaultMerchantUrl
      • DefaultUserAgent
      • DefaultUserIP
      • OnlineEftposRequestBuilder
      • PurchaseDescriptionTemplate
      • RefundReasonTemplate
    • OnlineEftposTransactionTypes
      • Regular
      • Trusted
      • TrustSetup
    • OnlineEftposTrust
      • Id
      • Status
    • PayerId
      • FromPhoneNumber
      • IsPhoneNumberValidId
    • PaymentDetails
      • Amount
      • Currency
      • Description
      • EnsureValid
      • OrderId
      • SettlementDate
      • TransactionType
    • PaymentStatus
      • Authorised
      • Declined
      • Error
      • Expired
      • FromString
      • New
      • Refunded
      • Submitted
    • RefundDetails
      • EnsureValid
      • OriginalPaymentId
      • RefundAmount
      • RefundId
      • RefundReason
    • RefundStatus
      • Declined
      • Error
      • FromString
      • Refunded
      • Unsubmitted
    • Resource
    • Resource.Attribute
    • Resource.String
      • ApplicationName
      • Hello
    • Sha512WithRsaVerifier
      • Dispose
      • Sha512WithRsaVerifier
      • Verify
    • TransactionRequestDetails
      • EnsureValid
      • UserAgent
      • UserIPAddress
    • TransactionStatus
      • Description
      • Equality
      • Equals
      • GetHashCode
      • Inequality
      • IsTerminal
      • Name
    • TrustStatus
      • Active
      • Cancelled
      • Equals
      • GetHashCode
      • Implicit
      • Pending
      • ToString
    • WestpacCustomerIdPayerId
      • DisplayName
      • IsValid
      • Name
      • Normalize

Class OnlineEftposClient

Core class for communication with the PayMark Online Eftpos API. Provides methods for performing transactions such as payments and refunds.

Inheritance
System.Object
OnlineEftposClient
Implements
IOnlineEftposClient
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Yort.OnlineEftpos
Assembly: cs.temp.dll.dll
Syntax
public sealed class OnlineEftposClient : IOnlineEftposClient, IDisposable

Constructors

Name Description
OnlineEftposClient(IOnlineEftposCredentialProvider, OnlineEftposApiVersion, OnlineEftposApiEnvironment)

Minium constructor.

OnlineEftposClient(IOnlineEftposCredentialProvider, OnlineEftposApiVersion, OnlineEftposApiEnvironment)

Minium constructor.

OnlineEftposClient(IOnlineEftposCredentialProvider, OnlineEftposApiVersion, OnlineEftposApiEnvironment, HttpClient)

Full constructor.

OnlineEftposClient(IOnlineEftposCredentialProvider, OnlineEftposApiVersion, OnlineEftposApiEnvironment, HttpClient)

Full constructor.

Properties

Name Description
ApiEnvironment

Returns a value indicating the sandbox or production environment of the Online Eftpos API this client will connect to.

ApiEnvironment

Returns a value indicating the sandbox or production environment of the Online Eftpos API this client will connect to.

ApiVersion

Returns a value indicating the version of the Online Eftpos API this client will connect to.

ApiVersion

Returns a value indicating the version of the Online Eftpos API this client will connect to.

Methods

Name Description
CheckPaymentStatus(String)

Returns updated status information for a previously submitted payment request.

CheckPaymentStatus(String)

Returns updated status information for a previously submitted payment request.

CheckRefundStatus(String)

Returns updated status information for a previously submitted refund.

CheckRefundStatus(String)

Returns updated status information for a previously submitted refund.

DeleteTrust(OnlineEftposDeleteTrustOptions)

Deletes a trust/autopay relationship previously established via RequestPayment(OnlineEftposPaymentRequest).

DeleteTrust(OnlineEftposDeleteTrustOptions)

Deletes a trust/autopay relationship previously established via RequestPayment(OnlineEftposPaymentRequest).

Dispose()

Disposes this instance and all internal resources, except the HttpClient provided in the constructor.

Dispose()

Disposes this instance and all internal resources, except the HttpClient provided in the constructor.

PaymentSearch(OnlineEftposPaymentSearchOptions)

Searches for payments based on one or more provided criteria and returns a OnlineEftposPaymentSearchResult containing any found transactions.

PaymentSearch(OnlineEftposPaymentSearchOptions)

Searches for payments based on one or more provided criteria and returns a OnlineEftposPaymentSearchResult containing any found transactions.

RefundSearch(OnlineEftposRefundSearchOptions)

Searches for refunds based on one or more provided criteria and returns a OnlineEftposRefundSearchResult containing any found transactions.

RefundSearch(OnlineEftposRefundSearchOptions)

Searches for refunds based on one or more provided criteria and returns a OnlineEftposRefundSearchResult containing any found transactions.

RequestPayment(OnlineEftposPaymentRequest)

Starts a payment transaction. Sends a request for payment to the API, which will be forwarded to the payer for approval.

RequestPayment(OnlineEftposPaymentRequest)

Starts a payment transaction. Sends a request for payment to the API, which will be forwarded to the payer for approval.

SendRefund(OnlineEftposRefundRequest)

Sends a refund for a previous payment to the original payer.

SendRefund(OnlineEftposRefundRequest)

Sends a refund for a previous payment to the original payer.

Back to top Copyright (c) 2017 Troy Willmot