paynet
Class Transaction

java.lang.Object
  paynet.Transaction

Direct Known Subclasses:

PayByTouchTransaction, PaynetTransaction

public abstract class Transaction
extends java.lang.Object

Constructor Summary

Transaction()
default constructor

Transaction(org.w3c.dom.Document doc)
constructor built from an Xml document.

Transaction(Transaction transaction)
constructor for transaction built from an existing transaction.

Transaction(core.xml.Xml root)
constructor built from an Xml.

Method Summary

java.lang.String	getAav() Account Authentication Value (for VbV and SecureCode
java.lang.String	getAccountNumber() account number (only last 4 digits are stored in DB)
double	getAmount() amount in currency
java.lang.String	getApprovalCode()
AVV	getAvv() AVV
int	getCurrency() currency
java.lang.String	getCvv() Cvv2 - for credit card sales
java.lang.String	getEasyStreetVerbose() returns verbose response.
java.lang.Double	getExchangeRate()
java.lang.String	getExpiration() Expiriation Date 'MMYY' - for credit card sales
java.lang.String	getGoodsIndicator() Goods Indicator (physical or electronic goods) - for credit card sales
java.lang.String	getMerchant()
int	getMerchantId() merchant ID in GPN database
java.lang.String	getOriginalTransactionNumber() original transaction number -for refunds
java.lang.String	getPlatform() platform (paybytouch, paymentek, etc) in GPN database
int	getPlatformId()
java.lang.String	getResponseCode()
java.lang.String	getResponseMessage()
java.lang.String	getRoutingNumber() routing number (identifies account holder's financial institution) - for direct debit transactions
java.lang.String	getTerminal() terminal Id
java.lang.String	getTrackData() Track Data - for retail credit card sales
java.lang.String	getTranDate()
int	getTransactionId() transaction ID in GPN database
java.lang.String	getTransactionNumber()
java.lang.String	getTransactionType() transaction type
int	getTransactionTypeId()
java.lang.String	getTranTime()
java.lang.String	getXid() Merchant unique identifier (for VbV)
boolean	isApproved() is the transaction approved? set this bit before saving
boolean	isEasyStreetVerbose()
boolean	isSecureCode() MasterCard SecureCode
boolean	isVerifiedByVisa() Verified By Visa
java.lang.String	responseXml() Transction response method
void	setAav(java.lang.String aav)
void	setAccountNumber(java.lang.String accountNumber)
void	setAmount(double amount)
void	setApprovalCode(java.lang.String approvalCode)
void	setAvv(AVV avv)
void	setCurrency(int currency)
void	setCvv(java.lang.String cvv)
void	setExchangeRate(java.lang.Double exchangeRate)
void	setExpiration(java.lang.String expiration)
void	setGoodsIndicator(java.lang.String goodsIndicator)
void	setIsApproved(boolean isApproved)
void	setIsEasyStreetVerbose(boolean isEasy) EasyStreet stuff (an old API we're staying backwards compatible with)
void	setIsSecureCode(boolean secureCode)
void	setIsVerifiedByVisa(boolean isVerified)
void	setOriginalTransactionNumber(java.lang.String originalTransactionNumber)
void	setPlatformId(int platformId)
void	setResponseCode(java.lang.String responseCode)
void	setResponseMessage(java.lang.String responseMessage)
void	setRoutingNumber(java.lang.String routingNumber)
void	setTerminal(java.lang.String terminal)
void	setTrackData(java.lang.String trackData)
void	setTranDate(java.lang.String tranDate)
void	setTransactionNumber(java.lang.String transactionNumber)
void	setTransactionTypeId(int transactionTypeId)
void	setTranTime(java.lang.String tranTime)
void	setXid(java.lang.String xid)
abstract Transaction	submit() Submit this Transaction object (this should be written for subclasses)
org.w3c.dom.Element	toXml(core.xml.Xml root) XML representation of this Transaction object.
java.lang.String	trace() Transction toString method - mostly useful for diagnostics
abstract void	validate() Validate this Transaction object (this should be written for subclasses)

Methods inherited from class java.lang.Object

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

Constructor Detail

Transaction

public Transaction()

default constructor

Transaction

public Transaction(Transaction transaction)
            throws core.xml.XMLException

constructor for transaction built from an existing transaction. Useful for converting between different types of Transactions

Parameters:

root -

Throws:

core.xml.XMLException

Transaction

public Transaction(org.w3c.dom.Document doc)
            throws core.xml.XMLException

constructor built from an Xml document. Subclasses may override this method to allow for more fields

Parameters:

doc -

Throws:

core.xml.XMLException

Transaction

public Transaction(core.xml.Xml root)
            throws core.xml.XMLException

constructor built from an Xml. Subclasses may override this method to allow for more fields

Parameters:

root -

Throws:

core.xml.XMLException

Method Detail

validate

public abstract void validate()
                       throws PaynetException

Validate this Transaction object (this should be written for subclasses)

Throws:

PaynetException

submit

public abstract Transaction submit()
                            throws PaynetException

Submit this Transaction object (this should be written for subclasses)

Throws:

PaynetException

getTransactionId

public int getTransactionId()

transaction ID in GPN database

getMerchantId

public int getMerchantId()

merchant ID in GPN database

getMerchant

public java.lang.String getMerchant()

getPlatform

public java.lang.String getPlatform()

platform (paybytouch, paymentek, etc) in GPN database

getPlatformId

public int getPlatformId()

setPlatformId

public void setPlatformId(int platformId)

getTransactionType

public java.lang.String getTransactionType()

transaction type

getTransactionTypeId

public int getTransactionTypeId()

setTransactionTypeId

public void setTransactionTypeId(int transactionTypeId)

getTerminal

public java.lang.String getTerminal()

terminal Id

setTerminal

public void setTerminal(java.lang.String terminal)

getAccountNumber

public java.lang.String getAccountNumber()

account number (only last 4 digits are stored in DB)

setAccountNumber

public void setAccountNumber(java.lang.String accountNumber)

getCurrency

public int getCurrency()

currency

setCurrency

public void setCurrency(int currency)

getAmount

public double getAmount()

amount in currency

setAmount

public void setAmount(double amount)

getCvv

public java.lang.String getCvv()

Cvv2 - for credit card sales

setCvv

public void setCvv(java.lang.String cvv)

getAvv

public AVV getAvv()

AVV

setAvv

public void setAvv(AVV avv)

getExpiration

public java.lang.String getExpiration()

Expiriation Date 'MMYY' - for credit card sales

setExpiration

public void setExpiration(java.lang.String expiration)

getTrackData

public java.lang.String getTrackData()

Track Data - for retail credit card sales

setTrackData

public void setTrackData(java.lang.String trackData)

getRoutingNumber

public java.lang.String getRoutingNumber()

routing number (identifies account holder's financial institution) - for direct debit transactions

setRoutingNumber

public void setRoutingNumber(java.lang.String routingNumber)

getOriginalTransactionNumber

public java.lang.String getOriginalTransactionNumber()

original transaction number -for refunds

setOriginalTransactionNumber

public void setOriginalTransactionNumber(java.lang.String originalTransactionNumber)

getGoodsIndicator

public java.lang.String getGoodsIndicator()

Goods Indicator (physical or electronic goods) - for credit card sales

setGoodsIndicator

public void setGoodsIndicator(java.lang.String goodsIndicator)

isVerifiedByVisa

public boolean isVerifiedByVisa()

Verified By Visa

setIsVerifiedByVisa

public void setIsVerifiedByVisa(boolean isVerified)

isSecureCode

public boolean isSecureCode()

MasterCard SecureCode

setIsSecureCode

public void setIsSecureCode(boolean secureCode)

getAav

public java.lang.String getAav()

Account Authentication Value (for VbV and SecureCode

setAav

public void setAav(java.lang.String aav)

getXid

public java.lang.String getXid()

Merchant unique identifier (for VbV)

setXid

public void setXid(java.lang.String xid)

getTransactionNumber

public java.lang.String getTransactionNumber()

setTransactionNumber

public void setTransactionNumber(java.lang.String transactionNumber)

getApprovalCode

public java.lang.String getApprovalCode()

setApprovalCode

public void setApprovalCode(java.lang.String approvalCode)

getExchangeRate

public java.lang.Double getExchangeRate()

setExchangeRate

public void setExchangeRate(java.lang.Double exchangeRate)

isApproved

public boolean isApproved()

is the transaction approved? set this bit before saving

setIsApproved

public void setIsApproved(boolean isApproved)

getResponseCode

public java.lang.String getResponseCode()

setResponseCode

public void setResponseCode(java.lang.String responseCode)

getResponseMessage

public java.lang.String getResponseMessage()

setResponseMessage

public void setResponseMessage(java.lang.String responseMessage)

getTranDate

public java.lang.String getTranDate()

setTranDate

public void setTranDate(java.lang.String tranDate)

getTranTime

public java.lang.String getTranTime()

setTranTime

public void setTranTime(java.lang.String tranTime)

setIsEasyStreetVerbose

public void setIsEasyStreetVerbose(boolean isEasy)

EasyStreet stuff (an old API we're staying backwards compatible with)

isEasyStreetVerbose

public boolean isEasyStreetVerbose()

getEasyStreetVerbose

public java.lang.String getEasyStreetVerbose()

returns verbose response. EasyStreet stuff (an old API we're staying backwards compatible with) example: responseCode=00,message=APPROVAL 123456,tranDate=041217,tranTime=120800,avsResult=X, referenceNumber=123456789012,approvalCode=123456,terminalId=1234567890,amount=12.34, address1=12345 Road,address2=,zip=12345,aptHouseNumber=3 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ATTENTION DEVELOPERS!!! any changes made to this function should also be reflected when returning sample strings in response to test cards in gateway.EasyStreet.java !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

toXml

public org.w3c.dom.Element toXml(core.xml.Xml root)
                          throws PaynetException

XML representation of this Transaction object. Subclasses may override this method to add more nodes

Throws:

PaynetException

trace

public java.lang.String trace()
                       throws core.xml.XMLException,
                              PaynetException,
                              java.io.IOException

Transction toString method - mostly useful for diagnostics

Throws:

core.xml.XMLException

PaynetException

java.io.IOException

responseXml

public java.lang.String responseXml()
                             throws core.xml.XMLException,
                                    PaynetException,
                                    java.io.IOException

Transction response method

Throws:

core.xml.XMLException

PaynetException

java.io.IOException