Apex Reference Guide

Apex Reference Guide
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
AbstractResponse Class
AddressRequest Class
AuditParamsRequest
AbstractTransactionResponse Class
AuthApiPaymentMethodRequest Class
AuthorizationReversalRequest Class
AuthorizationReversalResponse Class
AuthorizationRequest Class
AuthorizationResponse Class
BaseApiPaymentMethodRequest Class
BaseNotification Class
BasePaymentMethodRequest Class
BaseRequest Class
CaptureNotification Class
CaptureRequest Class
CaptureResponse Class
CardCategory Enum
CardPaymentMethodRequest Class
CustomMetadataTypeInfo Class
GatewayErrorResponse Class
GatewayNotificationResponse Class
GatewayResponse Interface
NotificationClient Class
NotificationSaveResult Class
NotificationStatus Enum
PaymentGatewayAdapter Interface
PaymentGatewayAsyncAdapter Interface
PaymentGatewayContext Class
PaymentGatewayContext Constructors
PaymentGatewayContext Methods
PaymentGatewayNotificationContext Class
PaymentMethodTokenizationRequest Class
PaymentMethodTokenizationResponse Class
PaymentGatewayNotificationRequest Class
PaymentsHttp Class
RefundRequest Class
ReferencedRefundNotification Class
ReferencedRefundRequest
ReferencedRefundResponse Class
RequestType Enum
SaleApiPaymentMethodRequest Class
SaleRequest Class
SaleResponse Class
SalesforceResultCode Enum
SalesforceResultCodeInfo
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace (Developer Preview)
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Functions Namespace
Invocable Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site 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

PaymentGatewayContext Class

Wraps the information related to a payment request.

Namespace

CommercePayments

Usage

The constructor of this class takes no arguments. For example:

CommercePayments.PaymentGatewayContext pgc = new CommercePayments.PaymentGatewayContext();

Example

1global commercepayments.GatewayResponse processRequest(commercepayments.PaymentGatewayContext gatewayContext) {
2    commercepayments.RequestType requestType = gatewayContext.getPaymentRequestType();
3    if (requestType == commercepayments.RequestType.Capture) {
4        commercepayments.CaptureRequest captureRequest = (commercepayments.CaptureRequest) gatewayContext.getPaymentRequest();
5    }
6}

PaymentGatewayContext Constructors

The following are constructors for PaymentGatewayContext.

PaymentGatewayContext(request, requestType)

Constructor to enable instance creation. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.

Signature

global PaymentGatewayContext(commercepayments.PaymentGatewayRequest request, String requestType)

Parameters

request
Type: commercepayments.PaymentGatewayRequest
Raw payload. Sensitive attributes are masked to ensure PCI compliance.
requestType
Type: String
Defines the type of request made to the gateway

PaymentGatewayContext Methods

The following are methods for PaymentGatewayContext.

getPaymentRequest()

Returns the payment request object.

Signature

global commercepayments.PaymentGatewayRequest getPaymentRequest()

Return Value

Type: PaymentGatewayRequest

getPaymentRequestType()

Returns the payment request type.

Signature

global String getPaymentRequestType()

Return Value

Type: String