---
schema_version: "1"
id: 49b34b3c96445293c504096b7ca8bf51137f0e56dc5c6b10b1ec3e2871ed4e0c
title: AuditParamsRequest
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_class_commercepayments_AuditParamsRequest.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_AuditParamsRequest.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 52a901d062506ff710ee62027897609f4ce915412b76145cc036bf71cea48619
description: AuditParamsRequest is used for audit parameters in a transaction request. This is an abstract request class that is extended by the BaseRequest class.This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Email of the client that initiated the request.The customer’s IP address. Gateways often use this data in risk checks.Mac address of the customer’s device. Gateways often use this data in risk checks.Phone number of the client that initiated the request.
---
# 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](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_commercepayments.htm "Use the CommercePayments namespace to provide a safe and customizable platform for managing customer payments and refunds.")

## 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](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_AuditParamsRequest.htm#apex_commerce_payments_AuditParamsRequest_constructors)**
- **[AuditParamsRequest Properties](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_AuditParamsRequest.htm#apex_commerce_payments_AuditParamsRequest_properties)**

## AuditParamsRequest Constructors

The following are constructors for AuditParamsRequest.

- **[AuditParamsRequest(email, macAddress, ipAddress, phone)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_AuditParamsRequest.htm#apex_commerce_payments_AuditParamsRequest_ctor)**  
    This constructor is intended for test usage and throws an exception if used outside of the Apex test context.

### 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](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")
    
    Email of the client that initiated the request.
- **macAddress**:
    
    Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")
    
    Mac address of the customer’s device. Gateways often use this data in risk checks.
- **ipAddress**:
    
    Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")
    
    The customer’s IP address. Gateways often use this data in risk checks.
- **phone**:
    
    Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")
    
    Phone number of the client that initiated the request.

## AuditParamsRequest Properties

The following are properties for AuditParamsRequest.

- **[email](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_AuditParamsRequest.htm#apex_commerce_payments_AuditParamsRequest_email)**  
    Email of the client that initiated the request.
- **[ipAddress](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_AuditParamsRequest.htm#apex_commerce_payments_AuditParamsRequest_ipAddress)**  
    The customer’s IP address. Gateways often use this data in risk checks.
- **[macAddress](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_AuditParamsRequest.htm#apex_commerce_payments_AuditParamsRequest_macAddress)**  
    Mac address of the customer’s device. Gateways often use this data in risk checks.
- **[phone](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_AuditParamsRequest.htm#apex_commerce_payments_AuditParamsRequest_phone)**  
    Phone number of the client that initiated the request.

### email

Email of the client that initiated the request.

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

### ipAddress

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

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

### macAddress

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

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

### phone

Phone number of the client that initiated the request.

#### Property Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")