Class IPGApiResult


  • public class IPGApiResult
    extends Object
    An IPGApiResult object is returned when successfully calling IPGApiClient.commitTransaction(IPGApiTransaction). This class contains getter methods for accessing the data fields which give detailed information about the transaction approval.
    Author:
    Andreas Schmid
    • Constructor Detail

      • IPGApiResult

        public IPGApiResult​(de.firstdata.ipg.api.schema.IPGApiOrderResponse response)
        the constructor is invoked internally during the execution of IPGApiClient.commitTransaction(IPGApiTransaction)
        Parameters:
        response - the unmarshalled response object
    • Method Detail

      • getExternalMerchantID

        public String getExternalMerchantID()
        returns ExternalMerchantId from Response
        Returns:
        ExternalMerchantID
      • getDebugInformation

        public String getDebugInformation()
        returns debug information - for internal use only
        Returns:
        debug information
      • getCommercialServiceProvider

        public String getCommercialServiceProvider()
        returns the commercial 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
        Returns:
        the reference number as returned by the credit card processor
      • getProcessorResponseMessage

        public String getProcessorResponseMessage()
        returns the processing response message returned by the credit card processor - since the transaction has been approved, the string Function performed error-free is always returned
        Returns:
        the string Function performed error-free
      • getErrorMessage

        public String getErrorMessage()
        returns the processing error message - note that this element is always empty since the transaction has been approved
        Returns:
        an empty string
      • getOrderId

        public String getOrderId()
        returns the order ID which must be provided when referring to this transaction - you have to provide this ID when creating a follow-up transaction by calling one of the operations IPGApiClient#createPostAuthTransaction(double, String), IPGApiClient#createReturnTransaction(double, String), and IPGApiClient#createVoidTransaction(String, String)
        Returns:
        the transaction's order 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 approved this transaction
        Returns:
        the approval code as returned by the credit card processor
      • getAVSResponse

        public String getAVSResponse()
        returns the address verification response (AVS)
      • getTDate

        public String getTDate()
        returns the tDate which must be provided when voiding this transaction by creating a Void transaction object via IPGApiClient#createVoidTransaction(String, String)
        Returns:
        the transaction's tDate as returned by the First Data API Web Service
      • getTransactionResult

        public String getTransactionResult()
        returns the transaction result which is always set to APPROVED
        Returns:
        the string APPROVED
      • getTerminalID

        public String getTerminalID()
        returns the terminal id of this transaction
      • getProcessorResponseCode

        public String getProcessorResponseCode()
        Returns the processor response code
        Returns:
      • getProcessorApprovalCode

        public String getProcessorApprovalCode()
        Returns the processor approval code
        Returns:
      • getProcessorReceiptNumber

        public String getProcessorReceiptNumber()
        Returns the processor receipt number
        Returns:
      • getProcessorTraceNumber

        public String getProcessorTraceNumber()
        Returns the processor trace number
        Returns:
      • getProcessorCCVResponse

        public String getProcessorCCVResponse()
      • getBrand

        public String getBrand()
      • getCountry

        public String getCountry()
      • getPayerSecurityLevel

        public String getPayerSecurityLevel()
      • getPaymentType

        public String getPaymentType()
      • getTDateFormatted

        public String getTDateFormatted()
      • getMandateReference

        public String getMandateReference()
      • getRedirectURL

        public String getRedirectURL()
      • getProcessorInstallmentFirstAmount

        public BigDecimal getProcessorInstallmentFirstAmount()
      • getProcessorInstallmentOtherAmount

        public BigDecimal getProcessorInstallmentOtherAmount()
      • getProcessorInstallmentIssuerFeeAmount

        public BigDecimal getProcessorInstallmentIssuerFeeAmount()
      • getProcessorInstallmentTaxesAmount

        public BigDecimal getProcessorInstallmentTaxesAmount()
      • getProcessorInstallmentInsuranceAmount

        public BigDecimal getProcessorInstallmentInsuranceAmount()
      • getProcessorInstallmentOtherExpensesAmount

        public BigDecimal getProcessorInstallmentOtherExpensesAmount()
      • getProcessorInstallmentTotalAmount

        public BigDecimal getProcessorInstallmentTotalAmount()
      • getProcessorInstallmentRatePerYear

        public BigDecimal getProcessorInstallmentRatePerYear()
      • getProcessorVoucherRemainingAmount

        public BigDecimal getProcessorVoucherRemainingAmount()
      • getProcessorVoucherType

        public String getProcessorVoucherType()
      • getIpgTransactionId

        public Long getIpgTransactionId()
      • getHostedDataIds

        public List<String> getHostedDataIds()
      • getSecure3DResponse

        public de.firstdata.ipg.api.schema.Secure3DResponse getSecure3DResponse()
      • getSecurePlusResponse

        public de.firstdata.ipg.api.schema.SecurePlusResponse getSecurePlusResponse()
      • getProcessorNetworkInformation

        public String getProcessorNetworkInformation()
      • getUpdatedAccountStatus

        public String getUpdatedAccountStatus()
      • getUpdatedPrimaryAccountNumber

        public String getUpdatedPrimaryAccountNumber()
      • getUpdatedExpirationDate

        public String getUpdatedExpirationDate()
      • getUpdatedAccountErrorCode

        public String getUpdatedAccountErrorCode()