Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
AbstractResponse Class
AbstractTransactionResponse Class
AccountType Enum
AccountHolderType Enum
AddressRequest Class
AlternativePaymentMethodRequest Class
AlternativePaymentMethodResponse Class
AuditParamsRequest
AuthApiPaymentMethodRequest Class
AuthorizationRequest Class
AuthorizationResponse Class
AuthorizationReversalRequest Class
AuthorizationReversalResponse Class
BankType Enum
BankPaymentMethodRequest Class
BankPaymentMethodResponse Class
BaseApiPaymentMethodRequest Class
BaseNotification Class
BasePaymentMethodRequest Class
BaseRequest Class
CaptureNotification Class
CaptureRequest Class
CaptureResponse Class
CardCategory Enum
CardPaymentMethodRequest Class
CardPaymentMethodResponse Class
CardType Enum
CustomMetadataTypeInfo Class
EnhancedPaymentDataInput Class
EnhancedPaymentDataInput Properties
EnhancedPaymentDataInput Methods
GatewayErrorResponse Class
GatewayNotificationResponse Class
GatewayResponse Interface
NotificationClient Class
NotificationSaveResult Class
NotificationStatus Enum
PaymentGatewayAdapter Interface
PaymentGatewayAsyncAdapter Interface
PaymentGatewayContext Class
PaymentGatewayNotificationContext Class
PaymentGatewayNotificationRequest Class
PaymentMethodDetailsResponse Class
LineItemInput Class
PaymentMethodIdType Enum
PaymentMethodTokenizationRequest Class
PaymentMethodTokenizationResponse Class
PaymentsHttp Class
PostAuthApiPaymentMethodRequest Class
PostAuthorizationRequest Class
PostAuthorizationResponse Class
ReferencedRefundNotification Class
ReferencedRefundRequest
ReferencedRefundResponse Class
RefundRequest Class
RequestType Enum
RetryCategory Enum
RetryDecision Enum
SaleApiPaymentMethodRequest Class
SaleNotification Class
SaleRequest Class
SaleResponse Class
SalesforceResultCode Enum
SalesforceResultCodeInfo
StandardEntryClassCode Enum
TokenizeNotification Class
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

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