PaymentInfoMagcard (posper 3.0 API)

java.lang.Object
- org.posper.tpv.payment.PaymentInfo
- - org.posper.tpv.payment.PaymentInfoMagcard

Direct Known Subclasses:

PaymentInfoMembercard
```
public class PaymentInfoMagcard
extends PaymentInfo
```
Instances of this class are used to pass information from the payment dialog to the payment gateway and vice versa. The instances are also attached to the respective Payment as a transient entity to make the information available for ticket printing (please note that the instance is no longer available once a ticket has been reloaded at a later point of time. Information that shall be made persistent must be stored in the Payment instance itself.

Author:

hans

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`authorizedAmount`
`protected double`	`m_dNewTotal`
`protected double`	`m_dTip`
`protected double`	`m_dTotal`
`protected String`	`m_sAuthorization`
`protected String`	`m_sCardCircuit`
`protected String`	`m_sCardNumber`
`protected String`	`m_sExpirationDate`
`protected String`	`m_sHolderName`
`protected String`	`m_sMessage`
`protected String`	`m_sRawData`
`protected String`	`m_sTerminalId`
`protected String`	`m_sTicketNumber`
`protected String`	`m_sTimestamp`
`protected String`	`m_sTrack1`
`protected String`	`m_sTransactionID`
`protected TransactionType`	`m_transactionType`

Constructor Summary

Constructors
Constructor and Description
`PaymentInfoMagcard(String sHolderName, String sCardNumber, String sExpirationDate, String sTransactionID, double dTotal)` Creates a new instance of PaymentInfoMagcard
`PaymentInfoMagcard(String sHolderName, String sCardNumber, String sExpirationDate, String sTransactionID, double dTotal, TransactionType taType, String sTrack1)` Creates a new instance of PaymentInfoMagcard
`PaymentInfoMagcard(String sHolderName, String sCardNumber, String sExpirationDate, String sTransactionID, double dTotal, TransactionType taType, String sTrack1, String sRawData)` Creates a new instance of PaymentInfoMagcard
`PaymentInfoMagcard(String sHolderName, String sCardNumber, String sExpirationDate, String sTransactionID, double dTotal, TransactionType taType, String sTrack1, String sRawData, String sZipCode)` Creates a new instance of PaymentInfoMagcard

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PaymentInfo`	`clonePayment()`
`String`	`getAuthorization()` Return the authorization string
`double`	`getAuthorizedAmount()`
`String`	`getCardCircuit()`
`String`	`getCardNumber()` Return the card number
`String`	`getExpirationDate()` Return the expiration date.
`String`	`getHolderName()` Return the holder name as XML escaped string to be used in printer templates
`String`	`getMessage()` Return the (error) message string
`String`	`getName()`
`double`	`getNewTotal()`
`String`	`getRawData()`
`String`	`getTerminalId()`
`String`	`getTicketNumber()`
`String`	`getTimestamp()`
`double`	`getTip()`
`double`	`getTotal()`
`String`	`getTrack1()`
`String`	`getTrack1Unframed()`
`String`	`getTransactionID()` Return the transaction ID
`TransactionType`	`getTransactionType()`
`String`	`getZipCode()`
`boolean`	`hasAuthorization()` Indicates if the gateway has returned an autorization string.
`boolean`	`isPartialAuth()`
`void`	`paymentError(String sMessage)` Set the (error) message string
`String`	`printAuthorization()` Same as getAuthorization
`String`	`printCardNumber()` Prints the last four characters of the card number string prepended by asterisks.
`String`	`printCreditBarcode()` Print the barcode for a credit receipt
`String`	`printExpirationDate()` Same as getExpirationDate
`String`	`printHolderName()` Return the holder name
`String`	`printTransactionID()` Same as getTransactionID
`void`	`setAuthorization(String sAuthorization)` Set the authorization string to indicate that the gateway has delivered sufficient information to proceed.
`void`	`setAuthorizedAmount(double authorizedAmount)`
`void`	`setCardCircuit(String m_sCardCircuit)`
`void`	`setCardNumber(String m_sCardNumber)`
`void`	`setExpirationDate(String m_sExpirationDate)`
`void`	`setHolderName(String sHolderName)` Set the holder name to indicate that the enquiry was successfully completed.
`void`	`setMessage(String m_sMessage)` Set the message to be shown after card swipe.
`void`	`setNewTotal(double m_dNewTotal)`
`void`	`setPartialAuth(boolean partialAuth)`
`void`	`setRawData(String m_sRawData)`
`void`	`setTerminalId(String m_sTerminalId)`
`void`	`setTicketNumber(String m_sTicketNumber)`
`void`	`setTimestamp(String m_sTimestamp)`
`void`	`setTip(double m_dTip)`
`double`	`setTotal(double dTotal)`
`void`	`setTransactionID(String sTransactionID)`
`void`	`setTransactionType(TransactionType transactionType)`
`void`	`setZipCode(String m_zipCode)`

Methods inherited from class org.posper.tpv.payment.PaymentInfo
printsTotal, printTotal

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_dTotal
```
protected double m_dTotal
```

m_dNewTotal
```
protected double m_dNewTotal
```

m_dTip
```
protected double m_dTip
```

m_sHolderName
```
protected String m_sHolderName
```

m_sCardNumber
```
protected String m_sCardNumber
```

m_sExpirationDate
```
protected String m_sExpirationDate
```

m_sTrack1
```
protected String m_sTrack1
```

m_sRawData
```
protected String m_sRawData
```

m_sTransactionID
```
protected String m_sTransactionID
```

m_sAuthorization
```
protected String m_sAuthorization
```

m_sMessage
```
protected String m_sMessage
```

m_sCardCircuit
```
protected String m_sCardCircuit
```

m_sTerminalId
```
protected String m_sTerminalId
```

m_sTimestamp
```
protected String m_sTimestamp
```

m_sTicketNumber
```
protected String m_sTicketNumber
```

m_transactionType

protected TransactionType m_transactionType

authorizedAmount
```
protected double authorizedAmount
```

Constructor Detail

PaymentInfoMagcard

public PaymentInfoMagcard(String sHolderName,
                          String sCardNumber,
                          String sExpirationDate,
                          String sTransactionID,
                          double dTotal)

Creates a new instance of PaymentInfoMagcard

Parameters:: sHolderName -; sCardNumber -; sExpirationDate -; sTransactionID -; dTotal -

PaymentInfoMagcard

public PaymentInfoMagcard(String sHolderName,
                          String sCardNumber,
                          String sExpirationDate,
                          String sTransactionID,
                          double dTotal,
                          TransactionType taType,
                          String sTrack1)

Creates a new instance of PaymentInfoMagcard

Parameters:: sHolderName -; sCardNumber -; sExpirationDate -; sTransactionID -; dTotal -; taType -; sTrack1 -

PaymentInfoMagcard

public PaymentInfoMagcard(String sHolderName,
                          String sCardNumber,
                          String sExpirationDate,
                          String sTransactionID,
                          double dTotal,
                          TransactionType taType,
                          String sTrack1,
                          String sRawData)

Creates a new instance of PaymentInfoMagcard

Parameters:: sHolderName -; sCardNumber -; sExpirationDate -; sTransactionID -; dTotal -; taType -; sTrack1 -; sRawData -

PaymentInfoMagcard

public PaymentInfoMagcard(String sHolderName,
                          String sCardNumber,
                          String sExpirationDate,
                          String sTransactionID,
                          double dTotal,
                          TransactionType taType,
                          String sTrack1,
                          String sRawData,
                          String sZipCode)

Creates a new instance of PaymentInfoMagcard

Parameters:: sHolderName -; sCardNumber -; sExpirationDate -; sTransactionID -; dTotal -; taType -; sTrack1 -; sRawData -; sZipCode -

Method Detail
- clonePayment
```
public PaymentInfo clonePayment()
```
  Specified by:
  
  clonePayment in class PaymentInfo
- getName
```
public String getName()
```
  Specified by:
  
  getName in class PaymentInfo
- getTotal
```
public double getTotal()
```
  Specified by:
  
  getTotal in class PaymentInfo
- setTotal
```
public double setTotal(double dTotal)
```
- hasAuthorization
```
public boolean hasAuthorization()
```
  Indicates if the gateway has returned an autorization string.
  
  Returns:
  
  true or false
- printHolderName
```
public String printHolderName()
```
  Return the holder name
  
  Returns:
  
  the holder name
- getHolderName
```
public String getHolderName()
```
  Return the holder name as XML escaped string to be used in printer templates
  
  Returns:
  
  the holder name
- getCardNumber
```
public String getCardNumber()
```
  Return the card number
  
  Returns:
  
  the holder name
- getExpirationDate
```
public String getExpirationDate()
```
  Return the expiration date. Note that the format can depends on the use case. If a card has been swiped, the string will have the format YYMM. If the date has been entered manually, the format is likely to be MMYYYY, which we suggest as entry mask in the form. The gateway class should test if track1 data are available and, if so, use these. For manual entry the gateway must reformat the data if necessary.
  
  Returns:
  
  the expiration date
- getTransactionID
```
public String getTransactionID()
```
  Return the transaction ID
  
  Returns:
  
  the transaction ID
- getTerminalId
```
public String getTerminalId()
```
- setTerminalId
```
public void setTerminalId(String m_sTerminalId)
```
- getCardCircuit
```
public String getCardCircuit()
```
- setCardCircuit
```
public void setCardCircuit(String m_sCardCircuit)
```
- setCardNumber
```
public void setCardNumber(String m_sCardNumber)
```
- setExpirationDate
```
public void setExpirationDate(String m_sExpirationDate)
```
- setHolderName
```
public void setHolderName(String sHolderName)
```
  Set the holder name to indicate that the enquiry was successfully completed.
  
  Parameters:
  
  sHolderName - set the name of the card holder as e.g. returned by the gateway.
- setTransactionID
```
public void setTransactionID(String sTransactionID)
```
- getAuthorization
```
public String getAuthorization()
```
  Return the authorization string
  
  Returns:
  
  the authorization string
- getMessage
```
public String getMessage()
```
  Return the (error) message string
  
  Returns:
  
  the (error) message string
- setMessage
```
public void setMessage(String m_sMessage)
```
  Set the message to be shown after card swipe. This should be used for error messages. on OK the message should remain empty.
  
  Parameters:
  
  m_sMessage -
- paymentError
```
public void paymentError(String sMessage)
```
  Set the (error) message string
  
  Parameters:
  
  sMessage - the (error) message string
- setAuthorization
```
public void setAuthorization(String sAuthorization)
```
  Set the authorization string to indicate that the gateway has delivered sufficient information to proceed.
  
  Parameters:
  
  sAuthorization - the authorization string
- printCardNumber
```
public String printCardNumber()
```
  Prints the last four characters of the card number string prepended by asterisks.
  
  Returns:
- printExpirationDate
```
public String printExpirationDate()
```
  Same as getExpirationDate
  
  Returns:
- printAuthorization
```
public String printAuthorization()
```
  Same as getAuthorization
  
  Returns:
- printTransactionID
```
public String printTransactionID()
```
  Same as getTransactionID
  
  Returns:
- printCreditBarcode
```
public String printCreditBarcode()
```
  Print the barcode for a credit receipt
  
  Returns:
  
  the barcode string
- getTimestamp
```
public String getTimestamp()
```
- setTimestamp
```
public void setTimestamp(String m_sTimestamp)
```
- getTransactionType
```
public TransactionType getTransactionType()
```
- setTransactionType
```
public void setTransactionType(TransactionType transactionType)
```
- getTrack1
```
public String getTrack1()
```
- getTip
```
public double getTip()
```
- setTip
```
public void setTip(double m_dTip)
```
- getNewTotal
```
public double getNewTotal()
```
- setNewTotal
```
public void setNewTotal(double m_dNewTotal)
```
- getRawData
```
public String getRawData()
```
- setRawData
```
public void setRawData(String m_sRawData)
```
- isPartialAuth
```
public boolean isPartialAuth()
```
- setPartialAuth
```
public void setPartialAuth(boolean partialAuth)
```
- getAuthorizedAmount
```
public double getAuthorizedAmount()
```
- setAuthorizedAmount
```
public void setAuthorizedAmount(double authorizedAmount)
```
- getTicketNumber
```
public String getTicketNumber()
```
- setTicketNumber
```
public void setTicketNumber(String m_sTicketNumber)
```
- getZipCode
```
public String getZipCode()
```
- setZipCode
```
public void setZipCode(String m_zipCode)
```
- getTrack1Unframed
```
public String getTrack1Unframed()
```

Class PaymentInfoMagcard

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.posper.tpv.payment.PaymentInfo

Methods inherited from class java.lang.Object

Field Detail

m_dTotal

m_dNewTotal

m_dTip

m_sHolderName

m_sCardNumber

m_sExpirationDate

m_sTrack1

m_sRawData

m_sTransactionID

m_sAuthorization

m_sMessage

m_sCardCircuit

m_sTerminalId

m_sTimestamp

m_sTicketNumber

m_transactionType

authorizedAmount

Constructor Detail

PaymentInfoMagcard

PaymentInfoMagcard

PaymentInfoMagcard

PaymentInfoMagcard

Method Detail

clonePayment

getName

getTotal

setTotal

hasAuthorization

printHolderName

getHolderName

getCardNumber

getExpirationDate

getTransactionID

getTerminalId

setTerminalId

getCardCircuit

setCardCircuit

setCardNumber

setExpirationDate

setHolderName

setTransactionID

getAuthorization

getMessage

setMessage

paymentError

setAuthorization

printCardNumber

printExpirationDate

printAuthorization

printTransactionID

printCreditBarcode

getTimestamp

setTimestamp

getTransactionType

setTransactionType

getTrack1

getTip

setTip

getNewTotal

setNewTotal

getRawData

setRawData

isPartialAuth

setPartialAuth

getAuthorizedAmount

setAuthorizedAmount

getTicketNumber

setTicketNumber

getZipCode

setZipCode

getTrack1Unframed