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
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
SaleRequest Constructors
SaleRequest Properties
SaleRequest Methods
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
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

SaleRequest Class

Stores information about a sales request.

Namespace

CommercePayments

Usage

This class holds all the required details about a sale request. Gateway adapters read the fields of this class object while constructing a sale JSON request thatis sent to the payment gateway. The object of this class is made available through commercepayments.paymentGatewayContext by calling getPaymentRequest().

Example

SaleRequest Constructors

The following are constructors for SaleRequest.

SaleRequest(amount)

Constructor for defining an amount for the sale request. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.

Signature

global SaleRequest(Double amount)

Parameters

  • amount:

    Type: Double

    Amount of the sale request.

SaleRequest Properties

The following are properties for SaleRequest.

accountId

Customer account ID for the sale request.

Signature

global String accountId {get; set;}

Property Value

Type: String

amount

Amount of the sale request. Can be positive only.

Signature

global Double amount {get; set;}

Property Value

Type: Double

comments

Additional information about the sale request.

Signature

global String comments {get; set;}

Property Value

Type: String

currencyIsoCode

Currency code for the sale request.

Signature

global String currencyIsoCode {get; set;}

Property Value

Type: String

enhancedPaymentData

Represents enhanced payment data, including Level 2 and Level 3 fields.

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

Signature

public commercepayments.EnhancedPaymentDataInput enhancedPaymentData {get; set;}

Property Value

Type: commercepayments.EnhancedPaymentDataInput

paymentInitiationSourceId

ID of the source that initiated the payment.

Supported only for third-party payment gateways; not supported for native payments. See PaymentInitiationSource object documentation for more information.

Signature

public String paymentInitiationSourceId {get; set;}

Property Value

Type: String

paymentMethod

Payment method used in the sale request.

Signature

global commercepayments.SaleApiPaymentMethodRequest paymentMethod {get; set;}

Property Value

Type: SaleApiPaymentMethodRequest

paymentMethodData

Payment method data used in the sale request.

This field is populated when SaleInput specifies a saved payment method. Accessible using paymentMethodData on SaleRequest. The map contains these fields from SavedPaymentMethod: GatewayToken, Type, GatewayReference, and StandardEntryCode for direct gateway interaction without querying the database.

Signature

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

Property Value

Type: Map<String,String>

submittedByMerchant

Indicates whether the sale request is submitted by the marchant (true) or not (false).

Signature

public Boolean submittedByMerchant {get; set;}

Property Value

Type: Boolean

SaleRequest Methods

The following are methods for SaleRequest.

equals(obj)

Compares this object with the specified object and returns true if both objects are equal; otherwise, returns false.

Signature

global Boolean equals(Object obj)

Parameters

  • obj:

    Type: Object

Return Value

Type: Boolean

hashCode()

Maintains the integrity of lists of type SaleRequest by determining the uniqueness of the external object records in a list.

Signature

global Integer hashCode()

Return Value

Type: Integer

toString()

Converts a date to a string.

Signature

global String toString()

Return Value

Type: String