com.blockchyp.client.dto

Class TermsAndConditionsRequest

java.lang.Object

com.blockchyp.client.dto.TermsAndConditionsRequest

All Implemented Interfaces:

ICoreRequest, IPreviousTransaction, ISignatureRequest, ITerminalReference

public class TermsAndConditionsRequest
extends Object
implements ICoreRequest, IPreviousTransaction, ISignatureRequest, ITerminalReference

The fields needed for custom Terms and Conditions prompts.

Constructor Summary

Constructors

Constructor and Description
TermsAndConditionsRequest()

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	getTcAlias() Gets an alias for a Terms and Conditions template configured in the BlockChyp dashboard.
String	getTcContent() Gets the content of the terms and conditions that will be presented to the user.
String	getTcName() Gets the name of the Terms and Conditions the user is accepting.
String	getTerminalName() Gets the name of the target payment terminal.
int	getTimeout() Gets the request timeout in seconds.
String	getTransactionId() Gets the ID of the previous transaction being referenced.
String	getTransactionRef() Gets the transaction reference string assigned to the transaction request.
boolean	isSigRequired() Gets that a signature should be requested.
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	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	setSigRequired(boolean value) Sets that a signature should be requested.
void	setSigWidth(int value) Sets the width that the signature image should be scaled to, preserving the aspect ratio.
void	setTcAlias(String value) Sets an alias for a Terms and Conditions template configured in the BlockChyp dashboard.
void	setTcContent(String value) Sets the content of the terms and conditions that will be presented to the user.
void	setTcName(String value) Sets the name of the Terms and Conditions the user is accepting.
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	setTransactionId(String value) Sets the ID of the previous transaction being referenced.
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

TermsAndConditionsRequest

public TermsAndConditionsRequest()

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.

setTransactionId

public void setTransactionId(String value)

Sets the ID of the previous transaction being referenced.

Parameters:

value - the ID of the previous transaction being referenced.

getTransactionId

public String getTransactionId()

Gets the ID of the previous transaction being referenced.

Specified by:

getTransactionId in interface IPreviousTransaction

Returns:

the ID of the previous transaction being referenced.

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.

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.

setTcAlias

public void setTcAlias(String value)

Sets an alias for a Terms and Conditions template configured in the BlockChyp dashboard.

Parameters:

value - an alias for a Terms and Conditions template configured in the BlockChyp dashboard.

getTcAlias

public String getTcAlias()

Gets an alias for a Terms and Conditions template configured in the BlockChyp dashboard.

Returns:

an alias for a Terms and Conditions template configured in the BlockChyp dashboard.

setTcName

public void setTcName(String value)

Sets the name of the Terms and Conditions the user is accepting.

Parameters:

value - the name of the Terms and Conditions the user is accepting.

getTcName

public String getTcName()

Gets the name of the Terms and Conditions the user is accepting.

Returns:

the name of the Terms and Conditions the user is accepting.

setTcContent

public void setTcContent(String value)

Sets the content of the terms and conditions that will be presented to the user.

Parameters:

value - the content of the terms and conditions that will be presented to the user.

getTcContent

public String getTcContent()

Gets the content of the terms and conditions that will be presented to the user.

Returns:

the content of the terms and conditions that will be presented to the user.

setSigRequired

public void setSigRequired(boolean value)

Sets that a signature should be requested.

Parameters:

value - that a signature should be requested.

isSigRequired

public boolean isSigRequired()

Gets that a signature should be requested.

Returns:

that a signature should be requested.