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
BaseApiPaymentMethodRequest Constructors
BaseApiPaymentMethodRequest Properties
BaseApiPaymentMethodRequest Methods
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
SaleResponse Class
SalesforceResultCode Enum
SalesforceResultCodeInfo
StandardEntryClassCode Enum
TokenizeNotification Class
CommerceTax Namespace
commonserviceexcellence 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
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance 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

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.

BaseApiPaymentMethodRequest Class

Abstract class used to send information about a payment method to a gateway adapter during a service call.

Namespace

CommercePayments

Usage

BaseApiPaymentMethodRequest is the base class for SaleApiPaymentMethodRequest and AuthApiPaymentMethodRequest.

BaseApiPaymentMethodRequest Constructors

The following are constructors for BaseApiPaymentMethodRequest.

BaseApiPaymentMethodRequest(address, id, saveForFuture)

Constructs a payment method. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.

Signature

global BaseApiPaymentMethodRequest(commercepayments.AddressRequest address, String id, Boolean saveForFuture)

Parameters

  • address:

    Type: commercepayments.AddressRequest

    Sends

    data related on address request to a gateway adapter during a service call.

  • id:

    Type: String

  • saveForFuture:

    Type: Boolean

    Indicates whether Salesforce saves the payment method for future use.

BaseApiPaymentMethodRequest Properties

The following are properties for BaseApiPaymentMethodRequest.

address

The payment method’s address.

Signature

global commercepayments.AddressRequest address {get; set;}

Property Value

Type: AddressRequest

id

ID of the payment method request.

Signature

global String id {get; set;}

Property Value

Type: String

idType

ID of the payment method type.

Signature

public commercepayments.PaymentMethodIdType idType {get; set;}

Property Value

Type: commercepayments.PaymentMethodIdType

saveForFuture

Indicates whether the payment method is saved as a record in Salesforce for future use.

Signature

global Boolean saveForFuture {get; set;}

Property Value

Type: Boolean

BaseApiPaymentMethodRequest Methods

The following are methods for BaseApiPaymentMethodRequest.

equals(obj)

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

Signature

global 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 BaseApiPaymentMethodRequest 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