Class ProcessingException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- de.firstdata.ipg.api.client.exception.ClientException
-
- de.firstdata.ipg.api.client.exception.ProcessingException
-
- All Implemented Interfaces:
Serializable
public class ProcessingException extends ClientException
An instance of this class is thrown in case the credit card processor has failed to process your transaction due to invalid transaction data. It contains attributes describing the error cause in detail. You can access these attributes by calling the appropriategetter
methods.- Author:
- Andreas Schmid
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ProcessingException(String message, de.firstdata.ipg.api.schema.IPGApiOrderResponse response)
creates an instance of this class taking an error message and an unmarhalled response object as arguments - note that you should never call this constructor, since it is internally invoked byIPGApiClient.commitTransaction(de.firstdata.ipgapi.client.IPGApiTransaction)
when receiving a processing error from the First Data API Web Service
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getApprovalCode()
returns the code which is created by the credit card processor when having processing this transaction - note that this element might be empty in case the transaction fas failed before reaching the credit card processorString
getAVSResponse()
returns the address verification response (AVS) - currently, AVS is not supported by the First Data API, i.e.String
getBrand()
String
getCommercialServiceProvider()
returns the commetcial service providerString
getErrorMessage()
returns the processing error message starting with the error code followed by an error description - in case the error has been found by the credit card processor, this description is the same as the one returned bygetProcessorResponseMessage()
String
getExternalMerchantID()
Long
getIpgTransactionId()
returns the transaction ID with which this transaction can be referred to - note that this ID cannot be provided for any follow-up transactions since the transaction has failedString
getOrderId()
returns the order ID with which this transaction can be referred to - note that this ID cannot be provided for any follow-up transactions since the transaction has failedString
getProcessorReferenceNumber()
returns the reference number the credit card processor uses for referring to this transaction - note that this element might be empty in case the transaction fas failed before reaching the credit card processorString
getProcessorResponseCode()
String
getProcessorResponseMessage()
returns the processing error message returned by the credit card processor - note that this element might be empty in case the transaction fas failed before reaching the credit card processorde.firstdata.ipg.api.schema.IPGApiOrderResponse
getResponse()
String
getTDate()
returns the tDate of this transaction - note that this tDate cannot be used when voiding the transaction since it has failedString
getTransactionResult()
returns the transaction result which is either DECLINE or FRAUD depending on the error causeString
getTransactionTime()
returns the time stamp set by the First Data API Web Service before returning the transaction result-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Constructor Detail
-
ProcessingException
public ProcessingException(String message, de.firstdata.ipg.api.schema.IPGApiOrderResponse response)
creates an instance of this class taking an error message and an unmarhalled response object as arguments - note that you should never call this constructor, since it is internally invoked byIPGApiClient.commitTransaction(de.firstdata.ipgapi.client.IPGApiTransaction)
when receiving a processing error from the First Data API Web Service- Parameters:
message
- a string describing the errorresponse
- an unmarshalled response object
-
-
Method Detail
-
getCommercialServiceProvider
public String getCommercialServiceProvider()
returns the commetcial service provider- Returns:
- the commercial service provider - currently, BNLP will always be returned
-
getTransactionTime
public String getTransactionTime()
returns the time stamp set by the First Data API Web Service before returning the transaction result- Returns:
- the time stamp in millisecs representing the difference between the current time and midnight, January 1, 1970 UTC
-
getProcessorReferenceNumber
public String getProcessorReferenceNumber()
returns the reference number the credit card processor uses for referring to this transaction - note that this element might be empty in case the transaction fas failed before reaching the credit card processor- Returns:
- the reference number as returned by the credit card processor
-
getProcessorResponseMessage
public String getProcessorResponseMessage()
returns the processing error message returned by the credit card processor - note that this element might be empty in case the transaction fas failed before reaching the credit card processor- Returns:
- the error message returned as by the credit card processor
-
getErrorMessage
public String getErrorMessage()
returns the processing error message starting with the error code followed by an error description - in case the error has been found by the credit card processor, this description is the same as the one returned bygetProcessorResponseMessage()
- Returns:
- the processing error message consisting of an error code and an error description
-
getOrderId
public String getOrderId()
returns the order ID with which this transaction can be referred to - note that this ID cannot be provided for any follow-up transactions since the transaction has failed- Returns:
- the transaction's order ID as returned by the First Data API Web Service
-
getIpgTransactionId
public Long getIpgTransactionId()
returns the transaction ID with which this transaction can be referred to - note that this ID cannot be provided for any follow-up transactions since the transaction has failed- Returns:
- the transaction ID as returned by the First Data API Web Service
-
getApprovalCode
public String getApprovalCode()
returns the code which is created by the credit card processor when having processing this transaction - note that this element might be empty in case the transaction fas failed before reaching the credit card processor- Returns:
- the approval code as returned by the credit card processor
-
getAVSResponse
public String getAVSResponse()
returns the address verification response (AVS) - currently, AVS is not supported by the First Data API, i.e. an empty string is always returned- Returns:
- an empty string
-
getTDate
public String getTDate()
returns the tDate of this transaction - note that this tDate cannot be used when voiding the transaction since it has failed- Returns:
- the transaction's tDate as returned by the First Data API Web Service
-
getTransactionResult
public String getTransactionResult()
returns the transaction result which is either DECLINE or FRAUD depending on the error cause- Returns:
- either the string DECLINE or FRAUD
-
getProcessorResponseCode
public String getProcessorResponseCode()
-
getResponse
public de.firstdata.ipg.api.schema.IPGApiOrderResponse getResponse()
-
getExternalMerchantID
public String getExternalMerchantID()
-
getBrand
public String getBrand()
-
-