Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
commercepayments Namespace
Use Cases for the commercepayments Namespace
Idempotency Guidelines
AbstractResponse
AuditParamsRequest
BaseRequest
CaptureResponse
CaptureRequest
CustomMetadataTypeInfo
GatewayErrorResponse
GatewayErrorResponse Constructors
GatewayResponse Interface
PaymentGatewayAdapter Interface
PaymentGatewayContext Class
PaymentsHttp
ReferencedRefundRequest
ReferencedRefundResponse
RequestType Enum
SalesforceResultCode Enum
SalesforceResultCodeInfo
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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.

Namespace

commercepayments

GatewayErrorResponse Constructors

The following are constructors for GatewayErrorResponse.

GatewayErrorResponse(errorCode, errorMessage)

Constructor to create a GatewayErrorResponse object that accepts errorCode and errorMessage.

Signature

global GatewayErrorResponse(String errorCode, String errorMessage)

Parameters

errorCode
Type: String
Should match with the HTTP status code to be returned to the user. Here are a few examples.
  • If the status code is for a bad request, the errorCode should be 400.
  • If the status code is for a forbidden request, errorCode should be 403.
  • If errorCode isn’t a valid HTTP status code, a 500 internal server error is returned.

errorCode must have a value, otherwise the platform throws an error.

Note

errorMessage
Type: String
The message response to users following an error.

errorMessage must have a value, otherwise the platform throws an error.

Note