com.blockchyp.client.dto

Class PaymentLinkRequest

java.lang.Object

com.blockchyp.client.dto.PaymentLinkRequest

All Implemented Interfaces:

ICoreRequest, IRequestAmount, ITerminalReference

public class PaymentLinkRequest
extends Object
implements ICoreRequest, IRequestAmount, ITerminalReference

Creates a payment link.

Constructor Summary

Constructors

Constructor and Description
PaymentLinkRequest()

Method Summary

Modifier and Type	Method and Description
String	getAmount() Gets the requested amount.
String	getCallbackUrl() Gets optional callback url to which transaction responses for this link will be posted.
String	getCurrencyCode() Gets the transaction currency code.
Customer	getCustomer() Gets customer information.
String	getDescription() Gets description explaining the transaction for display to the user.
String	getDestinationAccount() Gets the settlement account for merchants with split settlements.
String	getOrderRef() Gets an identifier from an external point of sale system.
String	getSubject() Gets subject of the payment email.
String	getTerminalName() Gets the name of the target payment terminal.
int	getTimeout() Gets the request timeout in seconds.
TransactionDisplayTransaction	getTransaction() Gets transaction details for display on the payment email.
String	getTransactionRef() Gets the transaction reference string assigned to the transaction request.
boolean	isAutoSend() Gets automatically send the link via an email.
boolean	isTaxExempt() Gets that the request is tax exempt.
boolean	isTest() Gets whether or not to route transaction to the test gateway.
void	setAmount(String value) Sets the requested amount.
void	setAutoSend(boolean value) Sets automatically send the link via an email.
void	setCallbackUrl(String value) Sets optional callback url to which transaction responses for this link will be posted.
void	setCurrencyCode(String value) Sets the transaction currency code.
void	setCustomer(Customer value) Sets customer information.
void	setDescription(String value) Sets description explaining the transaction for display to the user.
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	setSubject(String value) Sets subject of the payment email.
void	setTaxExempt(boolean value) Sets that the request is tax exempt.
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	setTransaction(TransactionDisplayTransaction value) Sets transaction details for display on the payment email.
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

PaymentLinkRequest

public PaymentLinkRequest()

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.

setCurrencyCode

public void setCurrencyCode(String value)

Sets the transaction currency code.

Parameters:

value - the transaction currency code.

getCurrencyCode

public String getCurrencyCode()

Gets the transaction currency code.

Specified by:

getCurrencyCode in interface IRequestAmount

Returns:

the transaction currency code.

setAmount

public void setAmount(String value)

Sets the requested amount.

Parameters:

value - the requested amount.

getAmount

public String getAmount()

Gets the requested amount.

Specified by:

getAmount in interface IRequestAmount

Returns:

the requested amount.

setTaxExempt

public void setTaxExempt(boolean value)

Sets that the request is tax exempt.

Parameters:

value - that the request is tax exempt. Only required for tax exempt level 2 processing.

isTaxExempt

public boolean isTaxExempt()

Gets that the request is tax exempt.

Specified by:

isTaxExempt in interface IRequestAmount

Returns:

that the request is tax exempt. Only required for tax exempt level 2 processing.

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.

setAutoSend

public void setAutoSend(boolean value)

Sets automatically send the link via an email.

Parameters:

value - automatically send the link via an email.

isAutoSend

public boolean isAutoSend()

Gets automatically send the link via an email.

Returns:

automatically send the link via an email.

setDescription

public void setDescription(String value)

Sets description explaining the transaction for display to the user.

Parameters:

value - description explaining the transaction for display to the user.

getDescription

public String getDescription()

Gets description explaining the transaction for display to the user.

Returns:

description explaining the transaction for display to the user.

setSubject

public void setSubject(String value)

Sets subject of the payment email.

Parameters:

value - subject of the payment email.

getSubject

public String getSubject()

Gets subject of the payment email.

Returns:

subject of the payment email.

setTransaction

public void setTransaction(TransactionDisplayTransaction value)

Sets transaction details for display on the payment email.

Parameters:

value - transaction details for display on the payment email.

getTransaction

public TransactionDisplayTransaction getTransaction()

Gets transaction details for display on the payment email.

Returns:

transaction details for display on the payment email.

setCustomer

public void setCustomer(Customer value)

Sets customer information.

Parameters:

value - customer information.

getCustomer

public Customer getCustomer()

Gets customer information.

Returns:

customer information.

setCallbackUrl

public void setCallbackUrl(String value)

Sets optional callback url to which transaction responses for this link will be posted.

Parameters:

value - optional callback url to which transaction responses for this link will be posted.

getCallbackUrl

public String getCallbackUrl()

Gets optional callback url to which transaction responses for this link will be posted.

Returns:

optional callback url to which transaction responses for this link will be posted.