com.blockchyp.client.dto

Class BalanceRequest

java.lang.Object

com.blockchyp.client.dto.BalanceRequest

All Implemented Interfaces:

ICoreRequest, IPaymentMethod, ITerminalReference, ITimeoutRequest

public class BalanceRequest
extends Object
implements ITimeoutRequest, ICoreRequest, IPaymentMethod, ITerminalReference

A request for the remaining balance on a payment type.

Constructor Summary

Constructors

Constructor and Description
BalanceRequest()

Method Summary

Modifier and Type	Method and Description
String	getAddress() Gets the cardholder address for use with address verification.
String	getCardholderName() Gets the cardholder name.
CardType	getCardType() Gets designates categories of cards: credit, debit, EBT.
String	getCvv() Gets the card CVV for use with PAN based transactions.
String	getDestinationAccount() Gets the settlement account for merchants with split settlements.
String	getExpMonth() Gets the card expiration month for use with PAN based transactions.
String	getExpYear() Gets the card expiration year for use with PAN based transactions.
String	getKsn() Gets the key serial number used for DUKPT encryption.
String	getOrderRef() Gets an identifier from an external point of sale system.
String	getPan() Gets the primary account number.
String	getPaymentType() Gets designates brands of payment methods: Visa, Discover, etc.
String	getPinBlock() Gets the encrypted pin block.
String	getPostalCode() Gets the cardholder postal code for use with address verification.
String	getRoutingNumber() Gets the ACH routing number for ACH transactions.
String	getTerminalName() Gets the name of the target payment terminal.
int	getTimeout() Gets the request timeout in seconds.
String	getToken() Gets the payment token to be used for this transaction.
String	getTrack1() Gets track 1 magnetic stripe data.
String	getTrack2() Gets track 2 magnetic stripe data.
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	isForce() Gets override any in-progress transactions.
boolean	isManualEntry() Gets that the payment entry method is a manual keyed transaction.
boolean	isQueue() Gets adds the transaction to the queue and returns immediately.
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	setAddress(String value) Sets the cardholder address for use with address verification.
void	setAsync(boolean value) Sets defers the response to the transaction and returns immediately.
void	setCardholderName(String value) Sets the cardholder name.
void	setCardType(CardType value) Sets designates categories of cards: credit, debit, EBT.
void	setCvv(String value) Sets the card CVV for use with PAN based transactions.
void	setDestinationAccount(String value) Sets the settlement account for merchants with split settlements.
void	setExpMonth(String value) Sets the card expiration month for use with PAN based transactions.
void	setExpYear(String value) Sets the card expiration year for use with PAN based transactions.
void	setForce(boolean value) Sets override any in-progress transactions.
void	setKsn(String value) Sets the key serial number used for DUKPT encryption.
void	setManualEntry(boolean value) Sets that the payment entry method is a manual keyed transaction.
void	setOrderRef(String value) Sets an identifier from an external point of sale system.
void	setPan(String value) Sets the primary account number.
void	setPaymentType(String value) Sets designates brands of payment methods: Visa, Discover, etc.
void	setPinBlock(String value) Sets the encrypted pin block.
void	setPostalCode(String value) Sets the cardholder postal code for use with address verification.
void	setQueue(boolean value) Sets adds the transaction to the queue and returns immediately.
void	setRoutingNumber(String value) Sets the ACH routing number for ACH transactions.
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	setToken(String value) Sets the payment token to be used for this transaction.
void	setTrack1(String value) Sets track 1 magnetic stripe data.
void	setTrack2(String value) Sets track 2 magnetic stripe data.
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 Detail

BalanceRequest

public BalanceRequest()

Method Detail

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.

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.

setToken

public void setToken(String value)

Sets the payment token to be used for this transaction.

Parameters:

value - the payment token to be used for this transaction. This should be used for recurring transactions.

getToken

public String getToken()

Gets the payment token to be used for this transaction.

Specified by:

getToken in interface IPaymentMethod

Returns:

the payment token to be used for this transaction. This should be used for recurring transactions.

setTrack1

public void setTrack1(String value)

Sets track 1 magnetic stripe data.

Parameters:

value - track 1 magnetic stripe data.

getTrack1

public String getTrack1()

Gets track 1 magnetic stripe data.

Specified by:

getTrack1 in interface IPaymentMethod

Returns:

track 1 magnetic stripe data.

setTrack2

public void setTrack2(String value)

Sets track 2 magnetic stripe data.

Parameters:

value - track 2 magnetic stripe data.

getTrack2

public String getTrack2()

Gets track 2 magnetic stripe data.

Specified by:

getTrack2 in interface IPaymentMethod

Returns:

track 2 magnetic stripe data.

setPan

public void setPan(String value)

Sets the primary account number.

Parameters:

value - the primary account number. We recommend using the terminal or e-commerce tokenization libraries instead of passing account numbers in directly, as this would put your application in PCI scope.

getPan

public String getPan()

Gets the primary account number.

Specified by:

getPan in interface IPaymentMethod

Returns:

the primary account number. We recommend using the terminal or e-commerce tokenization libraries instead of passing account numbers in directly, as this would put your application in PCI scope.

setRoutingNumber

public void setRoutingNumber(String value)

Sets the ACH routing number for ACH transactions.

Parameters:

value - the ACH routing number for ACH transactions.

getRoutingNumber

public String getRoutingNumber()

Gets the ACH routing number for ACH transactions.

Specified by:

getRoutingNumber in interface IPaymentMethod

Returns:

the ACH routing number for ACH transactions.

setCardholderName

public void setCardholderName(String value)

Sets the cardholder name.

Parameters:

value - the cardholder name. Only required if the request includes a primary account number or track data.

getCardholderName

public String getCardholderName()

Gets the cardholder name.

Specified by:

getCardholderName in interface IPaymentMethod

Returns:

the cardholder name. Only required if the request includes a primary account number or track data.

setExpMonth

public void setExpMonth(String value)

Sets the card expiration month for use with PAN based transactions.

Parameters:

value - the card expiration month for use with PAN based transactions.

getExpMonth

public String getExpMonth()

Gets the card expiration month for use with PAN based transactions.

Specified by:

getExpMonth in interface IPaymentMethod

Returns:

the card expiration month for use with PAN based transactions.

setExpYear

public void setExpYear(String value)

Sets the card expiration year for use with PAN based transactions.

Parameters:

value - the card expiration year for use with PAN based transactions.

getExpYear

public String getExpYear()

Gets the card expiration year for use with PAN based transactions.

Specified by:

getExpYear in interface IPaymentMethod

Returns:

the card expiration year for use with PAN based transactions.

setCvv

public void setCvv(String value)

Sets the card CVV for use with PAN based transactions.

Parameters:

value - the card CVV for use with PAN based transactions.

getCvv

public String getCvv()

Gets the card CVV for use with PAN based transactions.

Specified by:

getCvv in interface IPaymentMethod

Returns:

the card CVV for use with PAN based transactions.

setAddress

public void setAddress(String value)

Sets the cardholder address for use with address verification.

Parameters:

value - the cardholder address for use with address verification.

getAddress

public String getAddress()

Gets the cardholder address for use with address verification.

Specified by:

getAddress in interface IPaymentMethod

Returns:

the cardholder address for use with address verification.

setPostalCode

public void setPostalCode(String value)

Sets the cardholder postal code for use with address verification.

Parameters:

value - the cardholder postal code for use with address verification.

getPostalCode

public String getPostalCode()

Gets the cardholder postal code for use with address verification.

Specified by:

getPostalCode in interface IPaymentMethod

Returns:

the cardholder postal code for use with address verification.

setManualEntry

public void setManualEntry(boolean value)

Sets that the payment entry method is a manual keyed transaction.

Parameters:

value - that the payment entry method is a manual keyed transaction. If this is true, no other payment method will be accepted.

isManualEntry

public boolean isManualEntry()

Gets that the payment entry method is a manual keyed transaction.

Specified by:

isManualEntry in interface IPaymentMethod

Returns:

that the payment entry method is a manual keyed transaction. If this is true, no other payment method will be accepted.

setKsn

public void setKsn(String value)

Sets the key serial number used for DUKPT encryption.

Parameters:

value - the key serial number used for DUKPT encryption.

getKsn

public String getKsn()

Gets the key serial number used for DUKPT encryption.

Specified by:

getKsn in interface IPaymentMethod

Returns:

the key serial number used for DUKPT encryption.

setPinBlock

public void setPinBlock(String value)

Sets the encrypted pin block.

Parameters:

value - the encrypted pin block.

getPinBlock

public String getPinBlock()

Gets the encrypted pin block.

Specified by:

getPinBlock in interface IPaymentMethod

Returns:

the encrypted pin block.

setCardType

public void setCardType(CardType value)

Sets designates categories of cards: credit, debit, EBT.

Parameters:

value - designates categories of cards: credit, debit, EBT.

getCardType

public CardType getCardType()

Gets designates categories of cards: credit, debit, EBT.

Specified by:

getCardType in interface IPaymentMethod

Returns:

designates categories of cards: credit, debit, EBT.

setPaymentType

public void setPaymentType(String value)

Sets designates brands of payment methods: Visa, Discover, etc.

Parameters:

value - designates brands of payment methods: Visa, Discover, etc.

getPaymentType

public String getPaymentType()

Gets designates brands of payment methods: Visa, Discover, etc.

Specified by:

getPaymentType in interface IPaymentMethod

Returns:

designates brands of payment methods: Visa, Discover, etc.

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.