Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

EnhancedPaymentDataInput Class

Sends enhanced payment data, including Level 2 and Level 3 fields, to the gateway adapter as part of the service call.

Namespace

CommercePayments

Usage

Supported only for third-party payment gateways; not supported for native payments.

EnhancedPaymentDataInput Properties

The following are properties for EnhancedPaymentDataInput.

additionalAttributes

Map of gateway-specific or custom fields.

Signature

public Map<String,String> additionalAttributes {get; set;}

Property Value

Type: Map<String,String>

discountAmount

Discount amount.

Signature

public Double discountAmount {get; set;}

Property Value

Type: Double

dutyAmount

The total amount charged as duty or import or export tariffs on the transaction.

Signature

public Double dutyAmount {get; set;}

Property Value

Type: Double

invoiceNumber

Invoice number associated with the payment.

Signature

public String invoiceNumber {get; set;}

Property Value

Type: String

lineItems

Collection of individual line items associated with the payment.

Signature

public List<commercepayments.LineItemInput> lineItems {get; set;}

Property Value

Type: List<commercepayments.LineItemInput>

referenceId

Customer reference or identifier.

Signature

public String referenceId {get; set;}

Property Value

Type: String

salesTaxAmount

Sales tax amount.

Signature

public Double salesTaxAmount {get; set;}

Property Value

Type: Double

shipFromZip

Origin postal code.

Signature

public String shipFromZip {get; set;}

Property Value

Type: String

shipToCountry

Destination country code.

Signature

public String shipToCountry {get; set;}

Property Value

Type: String

shipToZip

Destination postal code.

Signature

public String shipToZip {get; set;}

Property Value

Type: String

shippingAmount

Shipping or freight amount.

Signature

public Double shippingAmount {get; set;}

Property Value

Type: Double

taxRate

Percentage rate of tax applied to the transaction or line item.

Signature

public Double taxRate {get; set;}

Property Value

Type: Double

totalTaxAmount

Total tax amount for the transaction.

Signature

public Double totalTaxAmount {get; set;}

Property Value

Type: Double

EnhancedPaymentDataInput Methods

The following are methods for EnhancedPaymentDataInput.

equals(obj)

Maintains the integrity of lists of type EnhancedPaymentDataInput by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.

Signature

public Boolean equals(Object obj)

Parameters

  • obj: Type: Object External object whose key is to be validated.

Return Value

Type: Boolean

hashCode()

Maintains the integrity of lists of type EnhancedPaymentDataInput.

Signature

public Integer hashCode()

Return Value

Type: Integer

toString()

Converts a date to a string.

Signature

public String toString()

Return Value

Type: String