Package com.blockchyp.client.dto

Class TransactionHistoryRequest

java.lang.Object
com.blockchyp.client.dto.TransactionHistoryRequest
All Implemented Interfaces:
ICoreRequest, ITimeoutRequest
public class TransactionHistoryRequest extends Object implements ITimeoutRequest, ICoreRequest
Models a batch history request.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TransactionHistoryRequest()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBatchId()
    Gets optional batch id.
    String
    getDestinationAccount()
    Gets the settlement account for merchants with split settlements.
    Date
    getEndDate()
    Gets optional end date filter for batch history.
    int
    getMaxResults()
    Gets max results to be returned by this request.
    String
    getOrderRef()
    Gets an identifier from an external point of sale system.
    String
    getQuery()
    Gets optional search query.
    Date
    getStartDate()
    Gets optional start date filter for batch history.
    int
    getStartIndex()
    Gets starting index for results to be returned.
    String
    getTerminalName()
    Gets optional terminal name.
    int
    getTimeout()
    Gets the request timeout in seconds.
    String
    getTransactionRef()
    Gets a user-assigned reference that can be used to recall or reverse transactions.
    boolean
    isAsync()
    Gets defers the response to the transaction and returns immediately.
    boolean
    isAutogeneratedRef()
    Gets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
    boolean
    isForce()
    Gets override any in-progress transactions.
    boolean
    isQueue()
    Gets adds the transaction to the queue and returns immediately.
    boolean
    isTest()
    Gets whether or not to route transaction to the test gateway.
    boolean
    isWaitForRemovedCard()
    Gets whether or not the request should block until all cards have been removed from the card reader.
    void
    setAsync(boolean value)
    Sets defers the response to the transaction and returns immediately.
    void
    setAutogeneratedRef(boolean value)
    Sets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
    void
    setBatchId(String value)
    Sets optional batch id.
    void
    setDestinationAccount(String value)
    Sets the settlement account for merchants with split settlements.
    void
    setEndDate(Date value)
    Sets optional end date filter for batch history.
    void
    setForce(boolean value)
    Sets override any in-progress transactions.
    void
    setMaxResults(int value)
    Sets max results to be returned by this request.
    void
    setOrderRef(String value)
    Sets an identifier from an external point of sale system.
    void
    setQuery(String value)
    Sets optional search query.
    void
    setQueue(boolean value)
    Sets adds the transaction to the queue and returns immediately.
    void
    setStartDate(Date value)
    Sets optional start date filter for batch history.
    void
    setStartIndex(int value)
    Sets starting index for results to be returned.
    void
    setTerminalName(String value)
    Sets optional terminal name.
    void
    setTest(boolean value)
    Sets whether or not to route transaction to the test gateway.
    void
    setTimeout(int value)
    Sets the request timeout in seconds.
    void
    setTransactionRef(String value)
    Sets a user-assigned reference that can be used to recall or reverse transactions.
    void
    setWaitForRemovedCard(boolean value)
    Sets whether or not the request should block until all cards have been removed from the card reader.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • TransactionHistoryRequest

      public TransactionHistoryRequest()

  • Method Details

    • setTimeout

      public void setTimeout(int value)
      Sets the request timeout in seconds.
      Parameters:
      value - the request timeout in seconds.

    • getTimeout

      public int getTimeout()
      Gets the request timeout in seconds.
      Specified by:
      getTimeout in interface ITimeoutRequest
      Returns:
      the request timeout in seconds.

    • setTest

      public void setTest(boolean value)
      Sets whether or not to route transaction to the test gateway.
      Parameters:
      value - whether or not to route transaction to the test gateway.

    • isTest

      public boolean isTest()
      Gets whether or not to route transaction to the test gateway.
      Specified by:
      isTest in interface ITimeoutRequest
      Returns:
      whether or not to route transaction to the test gateway.

    • setTransactionRef

      public void setTransactionRef(String value)
      Sets a user-assigned reference that can be used to recall or reverse transactions.
      Parameters:
      value - a user-assigned reference that can be used to recall or reverse transactions.

    • getTransactionRef

      public String getTransactionRef()
      Gets a user-assigned reference that can be used to recall or reverse transactions.
      Specified by:
      getTransactionRef in interface ICoreRequest
      Returns:
      a user-assigned reference that can be used to recall or reverse transactions.

    • setAutogeneratedRef

      public void setAutogeneratedRef(boolean value)
      Sets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
      Parameters:
      value - that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.

    • isAutogeneratedRef

      public boolean isAutogeneratedRef()
      Gets that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.
      Specified by:
      isAutogeneratedRef in interface ICoreRequest
      Returns:
      that the transaction reference was autogenerated and should be ignored for the purposes of duplicate detection.

    • setAsync

      public void setAsync(boolean value)
      Sets defers the response to the transaction and returns immediately.
      Parameters:
      value - defers the response to the transaction and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • isAsync

      public boolean isAsync()
      Gets defers the response to the transaction and returns immediately.
      Specified by:
      isAsync in interface ICoreRequest
      Returns:
      defers the response to the transaction and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • setQueue

      public void setQueue(boolean value)
      Sets adds the transaction to the queue and returns immediately.
      Parameters:
      value - adds the transaction to the queue and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • isQueue

      public boolean isQueue()
      Gets adds the transaction to the queue and returns immediately.
      Specified by:
      isQueue in interface ICoreRequest
      Returns:
      adds the transaction to the queue and returns immediately. Callers should retrive the transaction result using the Transaction Status API.

    • setWaitForRemovedCard

      public void setWaitForRemovedCard(boolean value)
      Sets whether or not the request should block until all cards have been removed from the card reader.
      Parameters:
      value - whether or not the request should block until all cards have been removed from the card reader.

    • isWaitForRemovedCard

      public boolean isWaitForRemovedCard()
      Gets whether or not the request should block until all cards have been removed from the card reader.
      Specified by:
      isWaitForRemovedCard in interface ICoreRequest
      Returns:
      whether or not the request should block until all cards have been removed from the card reader.

    • setForce

      public void setForce(boolean value)
      Sets override any in-progress transactions.
      Parameters:
      value - override any in-progress transactions.

    • isForce

      public boolean isForce()
      Gets override any in-progress transactions.
      Specified by:
      isForce in interface ICoreRequest
      Returns:
      override any in-progress transactions.

    • setOrderRef

      public void setOrderRef(String value)
      Sets an identifier from an external point of sale system.
      Parameters:
      value - an identifier from an external point of sale system.

    • getOrderRef

      public String getOrderRef()
      Gets an identifier from an external point of sale system.
      Specified by:
      getOrderRef in interface ICoreRequest
      Returns:
      an identifier from an external point of sale system.

    • setDestinationAccount

      public void setDestinationAccount(String value)
      Sets the settlement account for merchants with split settlements.
      Parameters:
      value - the settlement account for merchants with split settlements.

    • getDestinationAccount

      public String getDestinationAccount()
      Gets the settlement account for merchants with split settlements.
      Specified by:
      getDestinationAccount in interface ICoreRequest
      Returns:
      the settlement account for merchants with split settlements.

    • setQuery

      public void setQuery(String value)
      Sets optional search query.
      Parameters:
      value - optional search query. Will match amount, last 4 and customer name. batchId and terminalName are not supported with this option.

    • getQuery

      public String getQuery()
      Gets optional search query.
      Returns:
      optional search query. Will match amount, last 4 and customer name. batchId and terminalName are not supported with this option.

    • setBatchId

      public void setBatchId(String value)
      Sets optional batch id.
      Parameters:
      value - optional batch id.

    • getBatchId

      public String getBatchId()
      Gets optional batch id.
      Returns:
      optional batch id.

    • setTerminalName

      public void setTerminalName(String value)
      Sets optional terminal name.
      Parameters:
      value - optional terminal name.

    • getTerminalName

      public String getTerminalName()
      Gets optional terminal name.
      Returns:
      optional terminal name.

    • setStartDate

      public void setStartDate(Date value)
      Sets optional start date filter for batch history.
      Parameters:
      value - optional start date filter for batch history.

    • getStartDate

      public Date getStartDate()
      Gets optional start date filter for batch history.
      Returns:
      optional start date filter for batch history.

    • setEndDate

      public void setEndDate(Date value)
      Sets optional end date filter for batch history.
      Parameters:
      value - optional end date filter for batch history.

    • getEndDate

      public Date getEndDate()
      Gets optional end date filter for batch history.
      Returns:
      optional end date filter for batch history.

    • setMaxResults

      public void setMaxResults(int value)
      Sets max results to be returned by this request.
      Parameters:
      value - max results to be returned by this request.

    • getMaxResults

      public int getMaxResults()
      Gets max results to be returned by this request.
      Returns:
      max results to be returned by this request.

    • setStartIndex

      public void setStartIndex(int value)
      Sets starting index for results to be returned.
      Parameters:
      value - starting index for results to be returned.

    • getStartIndex

      public int getStartIndex()
      Gets starting index for results to be returned.
      Returns:
      starting index for results to be returned.