com.ibm.retail.saf.provider
Interface PaymentResult

All Superinterfaces:
POSInfo, POSResult, java.io.Serializable
All Known Implementing Classes:
DefaultPaymentResult

public interface PaymentResult
extends POSResult

Contains the results obtained from performing a payment on the point-of-sale system.

A PaymentResult is returned from a request to tender payment on the point-of-sale system. Results from tendering operation are put in the PaymentResult object and returned to the client.


Method Summary
 java.lang.String getApprovalCode()
          Gets the EFT approval code
 java.util.Iterator getLegalText()
          Gets an iterator for the Legal text associated with tender
 java.lang.String getMaskedAccountNumber()
          Gets the masked payment card account number in this PaymentResult.
 java.lang.String getReferenceNumber()
          Gets the reference number associated with the payment tender in this PaymentResult.
 java.lang.String getResponseCode()
          Gets the EFT response code
 java.lang.String getSequenceNumber()
          Gets the EFT sequence number
 java.lang.String toString()
          Convert the PaymentResult details into a string
 
Methods inherited from interface com.ibm.retail.saf.provider.POSResult
getExceptions, hasExceptions
 
Methods inherited from interface com.ibm.retail.saf.provider.POSInfo
getExtendedAttribute, getExtendedAttributeNames, removeExtendedAttribute, setExtendedAttribute
 

Method Detail

getMaskedAccountNumber

public java.lang.String getMaskedAccountNumber()
Gets the masked payment card account number in this PaymentResult.

Returns:
string representing masked account number .

getReferenceNumber

public java.lang.String getReferenceNumber()
Gets the reference number associated with the payment tender in this PaymentResult.

Returns:
string representing reference number.

getResponseCode

public java.lang.String getResponseCode()
Gets the EFT response code

Returns:
string representing the response code

getApprovalCode

public java.lang.String getApprovalCode()
Gets the EFT approval code

Returns:
string representing the approval code

getSequenceNumber

public java.lang.String getSequenceNumber()
Gets the EFT sequence number

Returns:
string representing the response code

getLegalText

public java.util.Iterator getLegalText()
Gets an iterator for the Legal text associated with tender

Returns:
iterator that will return string per line of legal text.

toString

public java.lang.String toString()
Convert the PaymentResult details into a string

Overrides:
toString in class java.lang.Object
Returns:
String the string of PaymentResult details