com.blockchyp.client.dto

Class CaptureSignatureRequest

java.lang.Object

com.blockchyp.client.dto.CaptureSignatureRequest

All Implemented Interfaces:

ICoreRequest, ISignatureRequest, ITerminalReference

public class CaptureSignatureRequest
extends Object
implements ICoreRequest, ISignatureRequest, ITerminalReference

A request for customer signature data.

Constructor Summary

Constructors

Constructor and Description
CaptureSignatureRequest()

Method Summary

Modifier and Type	Method and 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.
int	getTimeout() Gets the request timeout in seconds.
String	getTransactionRef() Gets the transaction reference string assigned to the transaction request.
boolean	isDisableSignature() Gets whether or not signature prompt should be skipped on the terminal.
boolean	isTest() Gets whether or not to route transaction to the test gateway.
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	setOrderRef(String value) Sets an identifier from an external point of sale system.
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	setTimeout(int value) Sets the request timeout in seconds.
void	setTransactionRef(String value) Sets the transaction reference string assigned to the transaction request.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptureSignatureRequest

public CaptureSignatureRequest()

Method Detail

setTransactionRef

public void setTransactionRef(String value)

Sets the transaction reference string assigned to the transaction request.

Parameters:

value - the transaction reference string assigned to the transaction request. If no transaction ref was assiged on the request, then the gateway will randomly generate one.

getTransactionRef

public String getTransactionRef()

Gets the transaction reference string assigned to the transaction request.

Specified by:

getTransactionRef in interface ICoreRequest

Returns:

the transaction reference string assigned to the transaction request. If no transaction ref was assiged on the request, then the gateway will randomly generate one.

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.

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 ICoreRequest

Returns:

whether or not to route transaction to the test gateway.

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 ICoreRequest

Returns:

the request timeout in seconds.

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.