AbstractTransactionResponse Class

Abstract class for storing normalized information sent from payment gateways about a payment transaction. Holds the common response fields sent from payment gateways for authorization, sale, capture, and refund transactions.

CommercePayments

Specify the CommercePayments namespace when creating an instance of this class. The constructor of this class takes no arguments. For example:

CommercePayments.AbstractTransactionResponse atr = new CommercePayments.AbstractTransactionResponse();

The following are methods for AbstractTransactionResponse.

Sets the transaction amount. Must be a non-negative value.

global void setAmount(Double amount)

  • amount:

    Type: Double

    The amount of the transaction.

Type: void

Sets the AVS (address verification system) result code that the gateway returned. Maximum length of 64 characters.

global void setGatewayAvsCode(String gatewayAvsCode)

  • gatewayAvsCode:

    Type: String

    Used to verify

    the address mapped to a payment method when the payments platform requests tokenization from the payment gateway.

Type: void

Sets the date that the notification occurred. Some gateways don’t send this value.

global void setGatewayDate(Datetime gatewayDate)

  • gatewayDate:

    Type: Datetime

    The date that the transaction occurred.

Type: void

Sets error messages that the gateway returned for the notification request. Maximum length of 255 characters.

global void setGatewayMessage(String gatewayMessage)

  • gatewayMessage:

    Type: String

    The message that the gateway returned with the transaction request. Contains additional information about the transaction.

Type: void

Sets the payment gateway’s reference details.

global void setGatewayReferenceDetails(String gatewayReferenceDetails)

  • gatewayReferenceDetails:

    Type: String

    Provides information about

    the gateway communication.

Type: void

Sets the payment gateway’s reference number.

global void setGatewayReferenceNumber(String gatewayReferenceNumber)

  • gatewayReferenceNumber:

    Type: String

    Unique transaction ID created by the payment gateway.

Type: void

Sets a gateway-specific result code. You can map the result code to a Salesforce-specific result code. Maximum length of 64 characters.

global void setGatewayResultCode(String gatewayResultCode)

  • gatewayResultCode:

    Type: String

    Gateway-specific result code.

    Must be mapped to a Salesforce-specific result code.

Type: void

Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.

global void setGatewayResultCodeDescription(String gatewayResultCodeDescription)

  • gatewayResultCodeDescription:

    Type: String

    Provides additional information about

    the result code and why the gateway returned the specific code. Descriptions vary between different gateways.

Type: void

Sets the Salesforce-specific result code information.

global void setSalesforceResultCodeInfo(commercepayments.SalesforceResultCodeInfo salesforceResultCodeInfo)

  • salesforceResultCodeInfo:

    Type: commercepayments.SalesforceResultCodeInfo

    Payment gateways have many response codes

    for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.

Type: void