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
CommerceOrders Namespace
CommercePayments Namespace
AbstractResponse Class
AbstractTransactionResponse Class
AddressRequest Class
AlternativePaymentMethodRequest Class
AlternativePaymentMethodResponse Class
AuditParamsRequest
AuditParamsRequest Constructors
AuditParamsRequest Properties
AuthApiPaymentMethodRequest Class
AuthorizationRequest Class
AuthorizationResponse Class
AuthorizationReversalRequest Class
AuthorizationReversalResponse 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
GatewayErrorResponse Class
GatewayNotificationResponse Class
GatewayResponse Interface
NotificationClient Class
NotificationSaveResult Class
NotificationStatus Enum
PaymentGatewayAdapter Interface
PaymentGatewayAsyncAdapter Interface
PaymentGatewayContext Class
PaymentGatewayNotificationContext Class
PaymentGatewayNotificationRequest Class
PaymentMethodDetailsResponse Class
PaymentMethodTokenizationRequest Class
PaymentMethodTokenizationResponse Class
PaymentsHttp Class
PostAuthApiPaymentMethodRequest Class
PostAuthorizationRequest Class
PostAuthorizationResponse Class
ReferencedRefundNotification Class
ReferencedRefundRequest
ReferencedRefundResponse Class
RefundRequest Class
RequestType Enum
SaleApiPaymentMethodRequest Class
SaleRequest Class
SaleResponse Class
SalesforceResultCode Enum
SalesforceResultCodeInfo
CommerceTax Namespace
Compression Namespace (Developer Preview)
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace (Developer Preview)
Functions Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

AuditParamsRequest

AuditParamsRequest is used for audit parameters in a transaction request. This is an abstract request class that is extended by the BaseRequest class.

Namespace

CommercePayments

Usage

AuditParamsRequest is an abstract class that holds attributes related to audit parameters such as email, IP address, MAC address, and phone number. This class can't be instantiated on its own. All CommercePayments request classes extend this class.

AuditParamsRequest Constructors

The following are constructors for AuditParamsRequest.

AuditParamsRequest(email, macAddress, ipAddress, phone)

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

Signature

AuditParamsRequest(String email, String macAddress, String ipAddress, String phone)

Parameters

email
Type: String
Email of the client that initiated the request.
macAddress
Type: String
Mac address of the customer’s device. Gateways often use this data in risk checks.
ipAddress
Type: String
The customer’s IP address. Gateways often use this data in risk checks.
phone
Type: String
Phone number of the client that initiated the request.

AuditParamsRequest Properties

The following are properties for AuditParamsRequest.

email

Email of the client that initiated the request.

Property Value

Type: String

ipAddress

The customer’s IP address. Gateways often use this data in risk checks.

Property Value

Type: String

macAddress

Mac address of the customer’s device. Gateways often use this data in risk checks.

Property Value

Type: String

phone

Phone number of the client that initiated the request.

Property Value

Type: String