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(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

Special Access Rules

To access Commerce Payments entities, your org must have a Salesforce Order Management license with the Payment Platform org permission activated. Commerce Payments entities are available only in Lightning Experience.

Fields

Field	Details
ApexAdapterId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Apex adapter reference for your payment gateway. This field is unique within your organization.
Comments	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Users can add comments to provide additional details about a record. Maximum of 1000 characters.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description (Optional) The username of the developer who configured the payment gateway. For reference only.
IdempotencySupported	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Defines whether the Payments Platform will charge the customer/merchant’s card multiple times for the same transaction if the same request is made in rapid succession. This can occur when a user clicks a Pay button twice, or if 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 Specifies the name of the payment gateway provider.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description Namespace for the payment gateway platform.

Object Reference for Salesforce and Lightning Platform

PaymentGatewayProvider

Supported Calls

Special Access Rules

Fields