• 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

Method CheckRefundStatus

CheckRefundStatus(String)

Returns updated status information for a previously submitted refund.

Declaration
public Task<OnlineEftposRefundStatus> CheckRefundStatus(string transactionId)
Parameters
Type Name Description
System.String transactionId

The unique id of a refund to retrieve the status of.

Returns
Type Description
Task<OnlineEftposRefundStatus>

A task whose result is an instance of OnlineEftposRefundStatus which describes the result of a successfully submitted refund.

Exceptions
Type Condition
OnlineEftposAuthenticationException

Thrown if a token cannot be obtained from the API. Usually this indicates incorrect credentials.

OnlineEftposException

Thrown if an exception occurs or error information is returned from the API.

See Also
SendRefund(OnlineEftposRefundRequest)
OnlineEftposRefundStatus

CheckRefundStatus(String)

Returns updated status information for a previously submitted refund.

Declaration
public Task<OnlineEftposRefundStatus> CheckRefundStatus(string transactionId)
Parameters
Type Name Description
System.String transactionId

The unique id of a refund to retrieve the status of.

Returns
Type Description
Task<OnlineEftposRefundStatus>

A task whose result is an instance of OnlineEftposRefundStatus which describes the result of a successfully submitted refund.

Exceptions
Type Condition
OnlineEftposAuthenticationException

Thrown if a token cannot be obtained from the API. Usually this indicates incorrect credentials.

OnlineEftposException

Thrown if an exception occurs or error information is returned from the API.

See Also
SendRefund(OnlineEftposRefundRequest)
OnlineEftposRefundStatus
Back to top Copyright (c) 2017 Troy Willmot