Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

PaymentGatewayProvider

Setup entity for payment gateways. Defines the connection to a payment gateway Apex adapter. This object is available in API version 48.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

Special Access Rules

To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience.

Fields

Field	Details
ApexAdapterId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of an APEX adapter class. The adapter interacts with your payment gateway to complete transactions. This field is unique within your organization. This field is a relationship field. Relationship Name ApexAdapter Relationship Type Lookup Refers To ApexClass
Comments	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Additional details about a record. Maximum of 1000 characters.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description (Optional) An internal name you assign the adapter. For reference only. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
IdempotencySupported	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description If the same payment request is made in rapid succession, this field defines whether the Payments platform charges the customer or merchant’s card multiple times for the same transaction. This situation can occur when a user clicks a Pay button twice, or the gateway’s server goes down after fulfilling a payment request and the client immediately tries making another payment. If this field has a value of Yes, the Payments platform ignores identical payment requests made immediately after an original request. Different payment gateways have varying levels of idempotency support. When configuring a new payment gateway integration, plan accordingly. Possible values are: `No` `Yes`
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Customer language used for the payment gateway.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
MasterLabel	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description User-friendly name of the payment gateway provider.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description Namespace for the payment gateway platform.

Object Reference for the Salesforce Platform

PaymentGatewayProvider

Supported Calls

Special Access Rules

Fields