Package com.blockchyp.client.dto

Class CaptureSignatureRequest

java.lang.Object
com.blockchyp.client.dto.CaptureSignatureRequest
All Implemented Interfaces:
ICoreRequest, ISignatureRequest, ITerminalReference, ITimeoutRequest
public class CaptureSignatureRequest extends Object implements ITimeoutRequest, ICoreRequest, ISignatureRequest, ITerminalReference
A request for customer signature data.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CaptureSignatureRequest()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDestinationAccount()
    Gets the settlement account for merchants with split settlements.
    String
    getOrderRef()
    Gets an identifier from an external point of sale system.
    String
    getSigFile()
    Gets a location on the filesystem which a customer signature should be written to.
    SignatureFormat
    getSigFormat()
    Gets the image format to be used for returning signatures.
    int
    getSigWidth()
    Gets the width that the signature image should be scaled to, preserving the aspect ratio.
    String
    getTerminalName()
    Gets the name of the target payment terminal.
    String
    getTestCase()
    Gets can include a code used to trigger simulated conditions for the purposes of testing and certification.
    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
    isDisableSignature()
    Gets whether or not signature prompt should be skipped on the terminal.
    boolean
    isForce()
    Gets override any in-progress transactions.
    boolean
    isQueue()
    Gets adds the transaction to the queue and returns immediately.
    boolean
    isResetConnection()
    Gets forces the terminal cloud connection to be reset while a transactions is in flight.
    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
    setDestinationAccount(String value)
    Sets the settlement account for merchants with split settlements.
    void
    setDisableSignature(boolean value)
    Sets whether or not signature prompt should be skipped on the terminal.
    void
    setForce(boolean value)
    Sets override any in-progress transactions.
    void
    setOrderRef(String value)
    Sets an identifier from an external point of sale system.
    void
    setQueue(boolean value)
    Sets adds the transaction to the queue and returns immediately.
    void
    setResetConnection(boolean value)
    Sets forces the terminal cloud connection to be reset while a transactions is in flight.
    void
    setSigFile(String value)
    Sets a location on the filesystem which a customer signature should be written to.
    void
    setSigFormat(SignatureFormat value)
    Sets the image format to be used for returning signatures.
    void
    setSigWidth(int value)
    Sets the width that the signature image should be scaled to, preserving the aspect ratio.
    void
    setTerminalName(String value)
    Sets the name of the target payment terminal.
    void
    setTest(boolean value)
    Sets whether or not to route transaction to the test gateway.
    void
    setTestCase(String value)
    Sets can include a code used to trigger simulated conditions for the purposes of testing and certification.
    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

    • CaptureSignatureRequest

      public CaptureSignatureRequest()

  • 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.

    • setTestCase

      public void setTestCase(String value)
      Sets can include a code used to trigger simulated conditions for the purposes of testing and certification.
      Parameters:
      value - can include a code used to trigger simulated conditions for the purposes of testing and certification. Valid for test merchant accounts only.

    • getTestCase

      public String getTestCase()
      Gets can include a code used to trigger simulated conditions for the purposes of testing and certification.
      Specified by:
      getTestCase in interface ICoreRequest
      Returns:
      can include a code used to trigger simulated conditions for the purposes of testing and certification. Valid for test merchant accounts only.

    • setSigFile

      public void setSigFile(String value)
      Sets a location on the filesystem which a customer signature should be written to.
      Parameters:
      value - a location on the filesystem which a customer signature should be written to.

    • getSigFile

      public String getSigFile()
      Gets a location on the filesystem which a customer signature should be written to.
      Specified by:
      getSigFile in interface ISignatureRequest
      Returns:
      a location on the filesystem which a customer signature should be written to.

    • setSigFormat

      public void setSigFormat(SignatureFormat value)
      Sets the image format to be used for returning signatures.
      Parameters:
      value - the image format to be used for returning signatures.

    • getSigFormat

      public SignatureFormat getSigFormat()
      Gets the image format to be used for returning signatures.
      Specified by:
      getSigFormat in interface ISignatureRequest
      Returns:
      the image format to be used for returning signatures.

    • setSigWidth

      public void setSigWidth(int value)
      Sets the width that the signature image should be scaled to, preserving the aspect ratio.
      Parameters:
      value - the width that the signature image should be scaled to, preserving the aspect ratio. If not provided, the signature is returned in the terminal's max resolution.

    • getSigWidth

      public int getSigWidth()
      Gets the width that the signature image should be scaled to, preserving the aspect ratio.
      Specified by:
      getSigWidth in interface ISignatureRequest
      Returns:
      the width that the signature image should be scaled to, preserving the aspect ratio. If not provided, the signature is returned in the terminal's max resolution.

    • setDisableSignature

      public void setDisableSignature(boolean value)
      Sets whether or not signature prompt should be skipped on the terminal.
      Parameters:
      value - whether or not signature prompt should be skipped on the terminal. The terminal will indicate whether or not a signature is required by the card in the receipt suggestions response.

    • isDisableSignature

      public boolean isDisableSignature()
      Gets whether or not signature prompt should be skipped on the terminal.
      Specified by:
      isDisableSignature in interface ISignatureRequest
      Returns:
      whether or not signature prompt should be skipped on the terminal. The terminal will indicate whether or not a signature is required by the card in the receipt suggestions response.

    • setTerminalName

      public void setTerminalName(String value)
      Sets the name of the target payment terminal.
      Parameters:
      value - the name of the target payment terminal.

    • getTerminalName

      public String getTerminalName()
      Gets the name of the target payment terminal.
      Specified by:
      getTerminalName in interface ITerminalReference
      Returns:
      the name of the target payment terminal.

    • setResetConnection

      public void setResetConnection(boolean value)
      Sets forces the terminal cloud connection to be reset while a transactions is in flight.
      Parameters:
      value - forces the terminal cloud connection to be reset while a transactions is in flight. This is a diagnostic settings that can be used only for test transactions.

    • isResetConnection

      public boolean isResetConnection()
      Gets forces the terminal cloud connection to be reset while a transactions is in flight.
      Specified by:
      isResetConnection in interface ITerminalReference
      Returns:
      forces the terminal cloud connection to be reset while a transactions is in flight. This is a diagnostic settings that can be used only for test transactions.