• Articles
  • Api Documentation

    Show / Hide Table of Contents
    • Yort.Humm.InStore
      • CreateKeyRequest
      • CreateKeyResponse
      • HummApiUrlSelector
      • HummClient
      • HummClientConfiguration
      • HummCountry
      • HummEnvironment
      • HummResponseSignatureException
      • HummStatusCodes
      • IHummApiUrlSelector
      • IHummClient
      • InviteRequest
      • InviteResponse
      • PendingAuthorisationEventArgs
      • ProcessAuthorisationRequest
      • ProcessAuthorisationResponse
      • ProcessSalesAdjustmentRequest
      • ProcessSalesAdjustmentResponse
      • ProcessSalesAdjustmentReversalRequest
      • ProcessSalesAdjustmentReversalResponse
      • PurchaseItemsCollection
      • RequestStates
      • SendReceiptRequest
      • SendReceiptResponse
    • Yort.Humm.InStore.Infrastructure
      • Hmac256SignatureGenerator
      • ISignatureGenerator
      • RequestBase
      • ResponseBase
      • SignedRequestWriter

    Namespace Yort.Humm.InStore

    Classes

    CreateKeyRequest

    Represents a request to swap a device (initialisation) token for a device key used to sign future requests.

    CreateKeyResponse

    Contains details of a response to a CreateKeyRequest.

    HummApiUrlSelector

    Determines the correct base URI for calling Humm based on a country and API enviroment.

    HummClient

    The primary object used to make requests to Humm.

    HummClientConfiguration

    Provides information to a HummClient about how to operate and default values to use for requests.

    HummResponseSignatureException

    Thrown if the signature on a ResponseBase did not verify as correct.

    HummStatusCodes

    Provides constants for known Humm status codes (returned in Code).

    InviteRequest

    Represents a request to send an SMS to a mobile phone number inviting someone to sign up to Humm.

    InviteResponse

    Represents a response to a InviteRequest.

    PendingAuthorisationEventArgs

    Arguments for the PendingAuthorisation event.

    ProcessAuthorisationRequest

    Represents a request to generate a payment plan/contract for the specified amount using the provided pre-approval code generated by a customer's device.

    ProcessAuthorisationResponse

    Contains details of a response to a ProcessAuthorisationRequest.

    ProcessSalesAdjustmentRequest

    Represents a request to full or partially refund a previously successful ProcessAuthorisationAsync(ProcessAuthorisationRequest) request.

    ProcessSalesAdjustmentResponse

    Contains details of a response to a ProcessSalesAdjustmentRequest.

    ProcessSalesAdjustmentReversalRequest

    Represents a prior ProcessSalesAdjustmentAsync(ProcessSalesAdjustmentRequest) request be reversed/undone/cancelled.

    ProcessSalesAdjustmentReversalResponse

    Contains details of a response to a ProcessSalesAdjustmentReversalRequest.

    PurchaseItemsCollection

    A collection representing a list of purchased items, used to provide extra details about a Humm transaction.

    RequestStates

    Provides a set of constants for possible Status values.

    SendReceiptRequest

    Represents a request to associate a POS receipt number with a prior authorisation request.

    SendReceiptResponse

    Contains details of a response to a ProcessAuthorisationRequest.

    Interfaces

    IHummApiUrlSelector

    An interface for components that can decide on the base URL to call for Humm.

    IHummClient

    An interface for the HummClient provided to allow mocking/stubbing etc.

    Enums

    HummCountry

    Provides a list of countries in which Humm/Oxipay API's are available.

    HummEnvironment

    Specifies which Humm API endpoints should be used.

    Back to top Copyright (c) 2020 Troy Willmot