Apex Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
Idempotency Guidelines
RequestType Enum
SalesforceResultCode Enum
Glossary
Newer Version Available
commercepayments Namespace
Use the commercepayments namespace to provide a
safe and customizable platform for managing customer payments and refunds.
The following are the classes in the commercepayments namespace.
-
Use Cases for the commercepayments Namespace
Review use cases for common actions performed within the commercepayments platform. -
Idempotency Guidelines
Idempotency represents the ability of a payment gateway to recognize duplicate requests submitted either in error or maliciously, and then process the duplicate requests accordingly. When working with an idempotent gateway, consider these important guidelines. -
AbstractResponse
Contains the normalized response fields from payment gateways that are common to all the other gateway responses. This class can’t be instantiated on its own. This class implements the GatewayResponse class. Other GatewayResponse classes extend this class to inherit common properties. -
AuditParamsRequest
AuditParamsRequest is used for audit parameters in a transaction request. This is an abstract request class that is extended by the BaseRequest class. -
BaseRequest
BaseRequest is extended by all the request classes. -
CaptureResponse
The payment gateway adapter sends this response for the Capture request type. This class extends AbstractResponse and inherits its methods. -
CaptureRequest
Represents a Capture request. This class extends the BaseRequest class and inherits all its methods. -
CustomMetadataTypeInfo
Access information about custom metadata. The PaymentGatewayAdapter can send CustomMetadataTypeInfo to transaction requests through the response object’s SalesforceResultCodeInfo. -
GatewayErrorResponse
Use to respond with an Error following high-level errors from the PaymentGateway adapter, such as request-forbidden responses, custom validation errors, or expired API tokens. -
GatewayResponse Interface
Generic payment gateway response interface. It can be referred, but gateway adapters shouldn’t implement this interface. -
PaymentGatewayAdapter Interface
PaymentGatewayAdapters can implement this interface in order to process requests. -
PaymentGatewayContext Class
Wraps the information related to a payment request. -
PaymentsHttp
Make an HTTP request to start the interaction with the payment gateway. -
ReferencedRefundRequest
Access information about the referenced refund requests. Extends RefundRequest. -
ReferencedRefundResponse
The payment gateway adapter sends this response for the ReferencedRefund request type. -
RequestType Enum
Payment Transaction request type. -
SalesforceResultCode Enum
Defines the gateway call status values in Salesforce based on the call status values that the payment gateway returned. -
SalesforceResultCodeInfo
Apex object for storing Salesforce result code information from payment gateway adapters.