Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Invoking Apex
Apex Transactions and Governor Limits
Using Salesforce Features with Apex
Actions
Approval Processing
Authentication
Chatter Answers and Ideas
Use Cases for the CommercePayments Namespace
Payment Gateway Adapters
Building a Synchronous Gateway Adapter
Set Up a Synchronous Payment Gateway Adapter in Salesforce
Building an Asynchronous Gateway Adapter
Set Up an Asynchronous Payment Gateway Adapter in Salesforce
Builder Examples for Payment Gateway Adapters
Payment Authorization Reversal Service
Tokenization Service
Alternative Payment Methods
Process Payments
Process Refund
Idempotency Guidelines
Sample Payment Gateway Implementation for CommercePayments
Connect in Apex
Moderate Chatter Private Messages with Triggers
DataWeave in Apex (Beta)
Moderate Feed Items with Triggers
Experience Cloud Sites
Email
External Services
Flows
Metadata
Permission Set Groups
Platform Cache
Salesforce Knowledge
Salesforce Files
Salesforce Connect
Salesforce Reports and Dashboards API via Apex
Salesforce Sites
Support Classes
Territory Management 2.0
Integration and Apex Utilities
Debugging, Testing, and Deploying Apex
Apex Reference
Appendices
Glossary
PDF

Newer Version Available

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

Building a Synchronous Gateway Adapter

In synchronous payment configurations, the Salesforce payment platform sends transaction information to the gateway, and then waits for a gateway response that contains the final transaction status. Salesforce will create a transaction only if the transaction is successful in the gateway.

A synchronous gateway adapter implements the PaymentGatewayAdapter Interface. In this topic, we’ll break down a sample asynchronous adapter by looking at PaymentGatewayAdapter, and then the processRequest class, which drives most of the communication between the payment platform and the payment gateway.

Payment gateway adapters can’t make future calls, external callouts using System.Http, asynchronous calls, queueable calls, or execute DMLs using SOQL.

Note

PaymentGatewayAdapter

All synchronous gateway must implement the PaymentGatewayAdapter interface. All PaymentGatewayAdapters are required to implement the processRequest method.

Processing an Initial Payment Request

When the payments platform receives a payments API request, it passes the request to your gateway adapter for further evaluation. The adapter begins the request evaluation process by calling the processRequest method, which represents the first step in a synchronous payment flow. We can break the processRequest implementation into three parts.

First, it builds a payment request object that the gateway can understand.

Then, the adapter sends the request to the payment gateway.

Finally, the adapter creates a response object to store data from the gateway’s response. The type of response object will vary based on whether you originally made a payment capture request or a refund request.