com.blockchyp.client.dto

Class BalanceResponse

java.lang.Object

com.blockchyp.client.dto.BalanceResponse

All Implemented Interfaces:

IAbstractAcknowledgement, ICoreResponse, IPaymentMethodResponse

public class BalanceResponse
extends Object
implements IAbstractAcknowledgement, ICoreResponse, IPaymentMethodResponse

The response to a balance request.

Constructor Summary

Constructors

Constructor and Description
BalanceResponse()

Method Summary

Modifier and Type	Method and Description
void	addCustomer(Customer value) Adds a customer data, if any.
AvsResponse	getAvsResponse() Gets address verification results if address information was submitted.
String	getBatchId() Gets the ID assigned to the batch.
String	getCardHolder() Gets the cardholder name.
Customer	getCustomer() Gets customer data, if any.
Collection<Customer>	getCustomers() Gets customer data, if any.
String	getDestinationAccount() Gets the settlement account for merchants with split settlements.
String	getEntryMethod() Gets the entry method for the transaction (CHIP, MSR, KEYED, etc).
String	getError() Gets the error, if an error occurred.
String	getExpMonth() Gets the card expiration month in MM format.
String	getExpYear() Gets the card expiration year in YY format.
String	getMaskedPan() Gets the masked primary account number.
String	getPaymentType() Gets the card brand (VISA, MC, AMEX, etc).
String	getPublicKey() Gets the BlockChyp public key if the user presented a BlockChyp payment card.
ReceiptSuggestions	getReceiptSuggestions() Gets suggested receipt fields.
String	getRemainingBalance() Gets remaining balance on the payment method.
String	getResponseDescription() Gets a narrative description of the transaction result.
String	getSig() Gets the ECC signature of the response.
String	getTickBlock() Gets the hash of the last tick block.
String	getTimestamp() Gets the timestamp of the transaction.
String	getToken() Gets the payment token, if the payment was enrolled in the vault.
String	getTransactionId() Gets the ID assigned to the transaction.
String	getTransactionRef() Gets the transaction reference string assigned to the transaction request.
String	getTransactionType() Gets the type of transaction.
boolean	isScopeAlert() Gets that the transaction did something that would put the system in PCI scope.
boolean	isSuccess() Gets whether or not the request succeeded.
boolean	isTest() Gets that the transaction was processed on the test gateway.
void	setAvsResponse(AvsResponse value) Sets address verification results if address information was submitted.
void	setBatchId(String value) Sets the ID assigned to the batch.
void	setCardHolder(String value) Sets the cardholder name.
void	setCustomer(Customer value) Sets customer data, if any.
void	setCustomers(Collection<Customer> value) Sets customer data, if any.
void	setDestinationAccount(String value) Sets the settlement account for merchants with split settlements.
void	setEntryMethod(String value) Sets the entry method for the transaction (CHIP, MSR, KEYED, etc).
void	setError(String value) Sets the error, if an error occurred.
void	setExpMonth(String value) Sets the card expiration month in MM format.
void	setExpYear(String value) Sets the card expiration year in YY format.
void	setMaskedPan(String value) Sets the masked primary account number.
void	setPaymentType(String value) Sets the card brand (VISA, MC, AMEX, etc).
void	setPublicKey(String value) Sets the BlockChyp public key if the user presented a BlockChyp payment card.
void	setReceiptSuggestions(ReceiptSuggestions value) Sets suggested receipt fields.
void	setRemainingBalance(String value) Sets remaining balance on the payment method.
void	setResponseDescription(String value) Sets a narrative description of the transaction result.
void	setScopeAlert(boolean value) Sets that the transaction did something that would put the system in PCI scope.
void	setSig(String value) Sets the ECC signature of the response.
void	setSuccess(boolean value) Sets whether or not the request succeeded.
void	setTest(boolean value) Sets that the transaction was processed on the test gateway.
void	setTickBlock(String value) Sets the hash of the last tick block.
void	setTimestamp(String value) Sets the timestamp of the transaction.
void	setToken(String value) Sets the payment token, if the payment was enrolled in the vault.
void	setTransactionId(String value) Sets the ID assigned to the transaction.
void	setTransactionRef(String value) Sets the transaction reference string assigned to the transaction request.
void	setTransactionType(String value) Sets the type of transaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

BalanceResponse

public BalanceResponse()

Method Detail

setSuccess

public void setSuccess(boolean value)

Sets whether or not the request succeeded.

Parameters:

value - whether or not the request succeeded.

isSuccess

public boolean isSuccess()

Gets whether or not the request succeeded.

Specified by:

isSuccess in interface IAbstractAcknowledgement

Returns:

whether or not the request succeeded.

setError

public void setError(String value)

Sets the error, if an error occurred.

Parameters:

value - the error, if an error occurred.

getError

public String getError()

Gets the error, if an error occurred.

Specified by:

getError in interface IAbstractAcknowledgement

Returns:

the error, if an error occurred.

setResponseDescription

public void setResponseDescription(String value)

Sets a narrative description of the transaction result.

Parameters:

value - a narrative description of the transaction result.

getResponseDescription

public String getResponseDescription()

Gets a narrative description of the transaction result.

Specified by:

getResponseDescription in interface IAbstractAcknowledgement

Returns:

a narrative description of the transaction result.

setTransactionId

public void setTransactionId(String value)

Sets the ID assigned to the transaction.

Parameters:

value - the ID assigned to the transaction.

getTransactionId

public String getTransactionId()

Gets the ID assigned to the transaction.

Specified by:

getTransactionId in interface ICoreResponse

Returns:

the ID assigned to the transaction.

setBatchId

public void setBatchId(String value)

Sets the ID assigned to the batch.

Parameters:

value - the ID assigned to the batch.

getBatchId

public String getBatchId()

Gets the ID assigned to the batch.

Specified by:

getBatchId in interface ICoreResponse

Returns:

the ID assigned to the batch.

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 ICoreResponse

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.

setTransactionType

public void setTransactionType(String value)

Sets the type of transaction.

Parameters:

value - the type of transaction.

getTransactionType

public String getTransactionType()

Gets the type of transaction.

Specified by:

getTransactionType in interface ICoreResponse

Returns:

the type of transaction.

setTimestamp

public void setTimestamp(String value)

Sets the timestamp of the transaction.

Parameters:

value - the timestamp of the transaction.

getTimestamp

public String getTimestamp()

Gets the timestamp of the transaction.

Specified by:

getTimestamp in interface ICoreResponse

Returns:

the timestamp of the transaction.

setTickBlock

public void setTickBlock(String value)

Sets the hash of the last tick block.

Parameters:

value - the hash of the last tick block.

getTickBlock

public String getTickBlock()

Gets the hash of the last tick block.

Specified by:

getTickBlock in interface ICoreResponse

Returns:

the hash of the last tick block.

setTest

public void setTest(boolean value)

Sets that the transaction was processed on the test gateway.

Parameters:

value - that the transaction was processed on the test gateway.

isTest

public boolean isTest()

Gets that the transaction was processed on the test gateway.

Specified by:

isTest in interface ICoreResponse

Returns:

that the transaction was processed on the test gateway.

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 ICoreResponse

Returns:

the settlement account for merchants with split settlements.

setSig

public void setSig(String value)

Sets the ECC signature of the response.

Parameters:

value - the ECC signature of the response. Can be used to ensure that it was signed by the terminal and detect man-in-the middle attacks.

getSig

public String getSig()

Gets the ECC signature of the response.

Specified by:

getSig in interface ICoreResponse

Returns:

the ECC signature of the response. Can be used to ensure that it was signed by the terminal and detect man-in-the middle attacks.

setToken

public void setToken(String value)

Sets the payment token, if the payment was enrolled in the vault.

Parameters:

value - the payment token, if the payment was enrolled in the vault.

getToken

public String getToken()

Gets the payment token, if the payment was enrolled in the vault.

Specified by:

getToken in interface IPaymentMethodResponse

Returns:

the payment token, if the payment was enrolled in the vault.

setEntryMethod

public void setEntryMethod(String value)

Sets the entry method for the transaction (CHIP, MSR, KEYED, etc).

Parameters:

value - the entry method for the transaction (CHIP, MSR, KEYED, etc).

getEntryMethod

public String getEntryMethod()

Gets the entry method for the transaction (CHIP, MSR, KEYED, etc).

Specified by:

getEntryMethod in interface IPaymentMethodResponse

Returns:

the entry method for the transaction (CHIP, MSR, KEYED, etc).

setPaymentType

public void setPaymentType(String value)

Sets the card brand (VISA, MC, AMEX, etc).

Parameters:

value - the card brand (VISA, MC, AMEX, etc).

getPaymentType

public String getPaymentType()

Gets the card brand (VISA, MC, AMEX, etc).

Specified by:

getPaymentType in interface IPaymentMethodResponse

Returns:

the card brand (VISA, MC, AMEX, etc).

setMaskedPan

public void setMaskedPan(String value)

Sets the masked primary account number.

Parameters:

value - the masked primary account number.

getMaskedPan

public String getMaskedPan()

Gets the masked primary account number.

Specified by:

getMaskedPan in interface IPaymentMethodResponse

Returns:

the masked primary account number.

setPublicKey

public void setPublicKey(String value)

Sets the BlockChyp public key if the user presented a BlockChyp payment card.

Parameters:

value - the BlockChyp public key if the user presented a BlockChyp payment card.

getPublicKey

public String getPublicKey()

Gets the BlockChyp public key if the user presented a BlockChyp payment card.

Specified by:

getPublicKey in interface IPaymentMethodResponse

Returns:

the BlockChyp public key if the user presented a BlockChyp payment card.

setScopeAlert

public void setScopeAlert(boolean value)

Sets that the transaction did something that would put the system in PCI scope.

Parameters:

value - that the transaction did something that would put the system in PCI scope.

isScopeAlert

public boolean isScopeAlert()

Gets that the transaction did something that would put the system in PCI scope.

Specified by:

isScopeAlert in interface IPaymentMethodResponse

Returns:

that the transaction did something that would put the system in PCI scope.

setCardHolder

public void setCardHolder(String value)

Sets the cardholder name.

Parameters:

value - the cardholder name.

getCardHolder

public String getCardHolder()

Gets the cardholder name.

Specified by:

getCardHolder in interface IPaymentMethodResponse

Returns:

the cardholder name.

setExpMonth

public void setExpMonth(String value)

Sets the card expiration month in MM format.

Parameters:

value - the card expiration month in MM format.

getExpMonth

public String getExpMonth()

Gets the card expiration month in MM format.

Specified by:

getExpMonth in interface IPaymentMethodResponse

Returns:

the card expiration month in MM format.

setExpYear

public void setExpYear(String value)

Sets the card expiration year in YY format.

Parameters:

value - the card expiration year in YY format.

getExpYear

public String getExpYear()

Gets the card expiration year in YY format.

Specified by:

getExpYear in interface IPaymentMethodResponse

Returns:

the card expiration year in YY format.

setAvsResponse

public void setAvsResponse(AvsResponse value)

Sets address verification results if address information was submitted.

Parameters:

value - address verification results if address information was submitted.

getAvsResponse

public AvsResponse getAvsResponse()

Gets address verification results if address information was submitted.

Specified by:

getAvsResponse in interface IPaymentMethodResponse

Returns:

address verification results if address information was submitted.

setReceiptSuggestions

public void setReceiptSuggestions(ReceiptSuggestions value)

Sets suggested receipt fields.

Parameters:

value - suggested receipt fields.

getReceiptSuggestions

public ReceiptSuggestions getReceiptSuggestions()

Gets suggested receipt fields.

Specified by:

getReceiptSuggestions in interface IPaymentMethodResponse

Returns:

suggested receipt fields.

setCustomer

public void setCustomer(Customer value)

Sets customer data, if any.

Parameters:

value - customer data, if any. Preserved for reverse compatibility.

getCustomer

public Customer getCustomer()

Gets customer data, if any.

Specified by:

getCustomer in interface IPaymentMethodResponse

Returns:

customer data, if any. Preserved for reverse compatibility.

setCustomers

public void setCustomers(Collection<Customer> value)

Sets customer data, if any.

Parameters:

value - customer data, if any.

getCustomers

public Collection<Customer> getCustomers()

Gets customer data, if any.

Specified by:

getCustomers in interface IPaymentMethodResponse

Returns:

customer data, if any.

setRemainingBalance

public void setRemainingBalance(String value)

Sets remaining balance on the payment method.

Parameters:

value - remaining balance on the payment method.

getRemainingBalance

public String getRemainingBalance()

Gets remaining balance on the payment method.

Returns:

remaining balance on the payment method.

addCustomer

public void addCustomer(Customer value)

Adds a customer data, if any.

Parameters:

value - customer data, if any.