PaymentMethod

The method that a buyer uses to compensate the seller of a good or service. Common payment methods include cash, checks, credit or debit cards, money orders, bank transfers, and online payment services. This object is available in API version 48.0 and later.

Supported Calls

describeLayout(), describeSObjects(), query(), retrieve()

Special Access Rules

To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience.

Fields

Field	Details
AccountId	Type reference Properties Filter, Group, Nillable, Sort Description The account entity linked to this payment method. This is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account
Comments	Type textarea Properties Nillable Description Users can add comments to provide additional details about a record. Maximum of 1000 characters.
CompanyName	Type string Properties Filter, Group, Nillable, Sort Description Company name for this payment method. Part of the payment method’s address.
IsAutoPayEnabled	Type boolean Properties Create, Defaulted on create, Filter, Group, Update, Sort Description Indicates whether the payment method can be used for recurring payments (True) or not (False). The default value is False. This field is available in API v55.0 and later. For orgs that upgraded from v54.0, you must add this field to the Payment Method page layout in the UI. It isn't automatically added.
ImplementorType	Type string Properties Filter, Group, Nillable, Sort Description Shows the type of payment method.
Name	Type string Properties Filter, Group, idLookup, Sort Description Unique number assigned to the payment method. Numbers start at 1000 and are read only, but administrators can change the format.
NickName	Type string Properties Filter, Group, Nillable, Sort Description User-defined nickname for this payment method.
PaymentMethodAddress	Type address Properties Filter, Nillable Description Uses address column type. First name and last name are listed as separate fields.
PaymentMethodCity	Type string Properties Filter, Group, Nillable, Sort Description Part of the address for this payment method.
PaymentMethodCountry	Type string Properties Filter, Group, Nillable, Sort Description Part of the address for this payment method.
PaymentMethodGeocodeAccuracy	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Part of the address for this payment method.
PaymentMethodLatitude	Type double Properties Filter, Nillable, Sort Description Part of the address for this payment method.
PaymentMethodLongitude	Type double Properties Filter, Nillable, Sort Description Part of the address for this payment method.
PaymentMethodPostalCode	Type string Properties Filter, Group, Nillable, Sort Description Part of the address for this payment method.
PaymentMethodState	Type string Properties Filter, Group, Nillable, Sort Description Part of the address for this payment method.
PaymentMethodStreet	Type textarea Properties Filter, Group, Nillable, Sort Description Part of the address for this payment method.
Status	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The state of the payment method. Possible values are: `Active`—The Payments Platform can use the payment method to make payments. `Canceled`—The Payments Platform can no longer use the payment method to make payments. `InActive`—The Payments Platform currently can’t use the payment method to make payments. Admins can change this value to Active when needed.

Object Reference for the Salesforce Platform

PaymentMethod

Supported Calls

Special Access Rules

Fields