PaymentGateway

Platform entity that represents the connection to the external payment gateway. This object is available in API version 48.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), 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
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.
ExternalReference	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Allows Order Management Services to map an Order Management gateway to a Payments Platform gateway. This field is unique within your organization.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it's possible this record is only referenced (LastReferencedDate) but not viewed.
MerchantAccountId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the merchant account used by the payment gateway. This merchant account links to a merchant account at a payment processor. This field is a relationship field. Relationship Name MerchantAccount Relationship Type Lookup Refers To MerchantAccount
MerchantCredentialId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the merchant credential setup entity to reference merchant information. This field is a relationship field. Relationship Name MerchantCredential Relationship Type Lookup Refers To NamedCredential
PaymentGatewayName	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description User-defined name for the payment gateway.
PaymentGatewayProviderId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the merchant account used by the payment gateway. This merchant account links to a merchant account at a payment processor. This field is a relationship field. Relationship Name PaymentGatewayProvider Relationship Type Lookup Refers To PaymentGatewayProvider
Status	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines whether the Payments Platform can use this payment gateway for calls to the external payment gateway. Inactive payment gateways can’t be used. Possible values are: `Active` `Inactive`

Object Reference for the Salesforce Platform

PaymentGateway

Supported Calls

Special Access Rules

Fields