Apex Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Apex Developer Guide
Release Notes
Getting Started with Apex
Writing Apex
Running Apex
Invoking Apex
Apex Transactions and Governor Limits
Using Salesforce Features with Apex
Actions
Apex Cursors (Beta)
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
Building an Asynchronous Gateway Adapter
Set Up an Asynchronous Payment Gateway Adapter
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
Data Cloud In Apex
DataWeave in Apex
Moderate Feed Items with Triggers
Experience Cloud Sites
Email
External Services
Flows
Formula Evaluation in Apex
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
PDF

Set Up a Synchronous Payment Gateway Adapter

For payments transactions, you can configure Salesforce to interface with a synchronous payment gateway adapter.
Available in: Salesforce Summer ’20 and later
Available in: API 49.0 and later

To access the commercepayments API, you need the PaymentPlatform org permission.

  1. Create your payment gateway adapter Apex classes. For instructions, see Building a Synchronous Gateway Adapter.
  2. Create a named credential.
    1. From Setup, in the Quick Find box, enter Named Credentials, and then select New..
    2. Complete the required fields, including the URL for your payment gateway.
  3. Create a payment gateway provider. The PaymentGatewayProvider object stores details about the payment gateway that Salesforce Payments communicates with when processing a transaction.
    1. Generate an access token according to the instructions in Connect to Connect REST API Using OAuth.
      The response includes the access token, specified in the access_token property, and the server instance, specified in the instance_url property. Use this information to make API calls to build the payment gateway provider.
    2. Execute a POST call to the resource using the domain in the instance_url. For example, https://instance_name.my.salesforce.com/services/data/vapi_version/tooling/sobjects/PaymentGatewayProvider.
      Use this payload as the request body, replacing value with the correct data.
      {
        "ApexAdapterId": "value",
        "DeveloperName": "value",
        "MasterLabel": "value",
        "IdempotencySupported": "value",
        "Comments": "value"
        }
        
        Example:
        {
        "ApexAdapterId": "01pxx0000004UU8AAM",
        "DeveloperName": "MyNewGatewayProvider",
        "MasterLabel": "My New Gateway Provider",
        "IdempotencySupported": "Yes",
        "Comments": "Custom made gateway provider."
        }
  4. Create a payment gateway record. The PaymentGateway object stores information about the connection to the external payment gateway. The record requires these field values.
    • Payment Gateway Name: Name of the external payment gateway.
    • Merchant Credential ID: ID of the named credential that you created.
    • Payment Gateway Provider ID: ID of the payment gateway provider that you created.
    • Status: Active