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
AuthorizationReversalRequest Constructors
AuthorizationReversalRequest Properties
AuthorizationReversalRequest Methods
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
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.

AuthorizationReversalRequest Class

Sends information about an authorization reversal request to a gateway adapter during a service call.

Namespace

CommercePayments

Example

Add your reversal classes to your payment gateway adapter. We recommend adding AuthorizationReversal as a possible requestType value when calling processRequest on the gateway’s response.

1global commercepayments.GatewayResponse processRequest(commercepayments.paymentGatewayContext gatewayContext) {
2        commercepayments.RequestType requestType = gatewayContext.getPaymentRequestType();
3        commercepayments.GatewayResponse response;
4        
5        try {
6        //add other requestType values here
7        //..
8        else if (requestType == commercepayments.RequestType.AuthorizationReversal) {
9                response = createAuthReversalResponse((commercepayments.AuthorizationReversalRequest)gatewayContext.getPaymentRequest());}
10        
11        return response;

Then, add a class that sets the amount of the authorization reversal request, as well as gateway information and the Salesforce result code.

1global commercepayments.GatewayResponse createAuthReversalResponse(commercepayments.AuthorizationReversalRequest authReversalRequest) {
2        commercepayments.AuthorizationReversalResponse authReversalResponse = new commercepayments.AuthorizationReversalResponse();
3        if(authReversalRequest.amount!=null )
4        {
5            authReversalResponse.setAmount(authReversalRequest.amount);
6        }
7        else
8        {
9             throw new SalesforceValidationException('Required Field Missing : Amount');             
10        }
11   
12        system.debug('Response - success');
13        authReversalResponse.setGatewayDate(system.now());
14        authReversalResponse.setGatewayResultCode('00');
15        authReversalResponse.setGatewayResultCodeDescription('Transaction Normal');
16        authReversalResponse.setGatewayReferenceNumber('SF'+getRandomNumber(6));
17        authReversalResponse.setSalesforceResultCodeInfo(SUCCESS_SALESFORCE_RESULT_CODE_INFO);
18        return authReversalResponse;
19    }

AuthorizationReversalRequest Constructors

The following are constructors for AuthorizationReversalRequest.

AuthorizationReversalRequest(amount, authorizationId)

Constructor for building the amount in an authorization reversal request. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.

Signature

global AuthorizationReversalRequest(Double amount, String authorizationId)

Parameters

  • amount:

    Type: Double

    The amount of the authorization reversal request.

  • authorizationId:

    Type: String

    The authorization request to be reversed.

AuthorizationReversalRequest Properties

The following are properties for AuthorizationReversalRequest.

accountId

References the customer account for the transaction where the authorization reversal was performed.

Signature

global String accountId {get; set;}

Property Value

Type: String

amount

The total amount of the authorization reversal request. Can be positive or negative.

Signature

global Double amount {get; set;}

Property Value

Type: Double

paymentAuthorizationId

References the payment authorization to be reversed.

Signature

global String paymentAuthorizationId {get; set;}

Property Value

Type: String

AuthorizationReversalRequest Methods

The following are methods for AuthorizationReversalRequest.

equals(obj)

Maintains the integrity of lists of type AuthorizationReversalRequest by determining the equality of external objects in a list. This method is dynamic and 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 AuthorizationReversalRequest by determining the uniqueness of the external object 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