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
CaptureNotification Methods
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
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
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
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

CaptureNotification Class

When a payment gateway sends a notification for a capture transaction, the payment gateway adapter creates the CaptureNotification object to store information about the notification.

Namespace

CommercePayments

Usage

CaptureNotification is used in asynchronous payment gateway adapters.

Specify the CommercePayments namespace when creating an instance of this class. The constructor of this class takes no arguments. For example:

CommercePayments.CaptureNotification crn = new CommercePayments.CaptureNotification();

Example

1commercepayments.BaseNotification notification = null;
2        if ('CAPTURE'.equals(eventCode)) {
3            notification = new commercepayments.CaptureNotification();
4        } else if ('REFUND'.equals(eventCode)) {
5            notification = new commercepayments.ReferencedRefundNotification();
6        }

CaptureNotification Methods

The following are methods for CaptureNotification.

setAmount(amount)

Sets the transaction amount. Must be a non-negative value.

Signature

global void setAmount(Double amount)

Parameters

amount
Type: Double
The amount to be debited or captured.

Return Value

Type: void

setGatewayAvsCode(gatewayAvsCode)

Sets the AVS (address verification system) result code that the gateway returned. Maximum length of 64 characters.

Signature

public void setGatewayAvsCode(String gatewayAvsCode)

Parameters

gatewayAvsCode
Type: String
Used to verify the address mapped to a payment method when the payments platform requests tokenization from the payment gateway.

Return Value

Type: void

setGatewayDate(gatewayDate)

Sets the date that the transaction occurred. Some gateways don’t send this value.

Signature

global void setGatewayDate(Datetime gatewayDate)

Parameters

gatewayDate
Type: Datetime
Date and time of the gateway communication.

Return Value

Type: void

setGatewayMessage(gatewayMessage)

Sets error messages that the gateway returned for the payment request. Maximum length of 255 characters.

Signature

global void setGatewayMessage(String gatewayMessage)

Parameters

gatewayMessage
Type: String
Information on error messages sent from the gateway.

Return Value

Type: void

setGatewayReferenceDetails(gatewayReferenceDetails)

Sets additional data that you can use for subsequent transactions. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML.

Signature

global void setGatewayReferenceDetails(String gatewayReferenceDetails)

Parameters

gatewayReferenceDetails
Type: String

Return Value

Type: void

setGatewayReferenceNumber(gatewayReferenceNumber)

Sets the unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters.

Signature

global void setGatewayReferenceNumber(String gatewayReferenceNumber)

Parameters

gatewayReferenceNumber
Type: String
Unique transaction ID created by the payment gateway.

Return Value

Type: void

setGatewayResultCode(gatewayResultCode)

Sets a gateway-specific result code. The code can be mapped to a Salesforce-specific result code. Maximum length of 64 characters.

Signature

global void setGatewayResultCode(String gatewayResultCode)

Parameters

gatewayResultCode
Type: String
Gateway-specific result code. Map this value to a Salesforce-specific result code.

Return Value

Type: void

setGatewayResultCodeDescription(gatewayResultCodeDescription)

Sets a description of the gateway-specific result code that a gateway returned. Maximum length of 1000 characters.

Signature

global void setGatewayResultCodeDescription(String gatewayResultCodeDescription)

Parameters

gatewayResultCodeDescription
Type: String
Description of the gateway’s result code. Use this field to learn more about why the gateway returned a certain result code.

Return Value

Type: void

setId(id)

Sets the ID of a notification sent by the payment gateway.

Signature

global void setId(String id)

Parameters

id
Type: String

Return Value

Type: void

setSalesforceResultCodeInfo(salesforceResultCodeInfo)

Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.

Signature

global void setSalesforceResultCodeInfo(commercepayments.SalesforceResultCodeInfo salesforceResultCodeInfo)

Parameters

salesforceResultCodeInfo
Type: commercepayments.SalesforceResultCodeInfo
Description of the Salesforce result code value.

Return Value

Type: void

setStatus(status)

Sets the notification status to the same value that was sent by the gateway.

Signature

global void setStatus(commercepayments.NotificationStatus status)

Parameters

status
Type: NotificationStatus
Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.

Return Value

Type: void