AlternativePaymentMethod

Represents a payment method that doesn't have a defined Commerce Orders entity such as CardPaymentMethod or DigitalWallet. Common examples of alternative payment methods for Commerce Orders include CashOnDeliver, Klarna, and Direct Debit. AlternativePaymentMethod functions the same as any other type of payment method for processing transactions in the payment gateway. This object is available in API version 51.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. Commerce Payments entities are available only in Lightning Experience.

Fields

Field	Details
AccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account for the alternative payment method.
AlternativePaymentMethodNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Salesforce ID number for the alternative payment method.
AuditEmail	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description
Comments	Type textarea Properties Create, Nillable, Update Description Users can add comments to provide additional details about a record. Maximum of 1000 characters.
CompanyName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Company name for this payment method. Part of the payment method’s address.
Email	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the payment method holder.
GatewayToken	Type encryptedstring Properties Create, Nillable, Update Description Tokenized form of the alternative payment method, returned by the gateway. Stored as encrypted text.
GatewayTokenDetails	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Unique tokenized ID generated by the payment gateway when this payment method first interacts with the gateway. Used to identify the payment method during future transactions.
IpAddress	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description IP address for the payment method owner.
IsAutoPayEnabled	Type boolean Properties Create, Defaulted on create, Filter, Group, Update, Sort 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 Alternative Payment Method page layout in the UI. It isn't automatically added.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user only accessed this record or list view (LastReferencedDate) but not viewed it.
MacAddress	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Mac Address of the payment method holder.
NickName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description User-defined nickname for this payment method.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who owns the alternative payment method.
PaymentGatewayId	Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the payment gateway entity used to handle transactions from this payment method.
PaymentMethodAddress	Type address Properties Filter, Nillable Description User address column type. First name and last name are listed as separate fields.
PaymentMethodCity	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for this payment method.
PaymentMethodCountry	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for this payment method.
PaymentMethodGeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Part of the address for this payment method.
PaymentMethodLatitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Part of the address for this payment method.
PaymentMethodLongitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Part of the address for this payment method.
PaymentMethodPostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for this payment method.
PaymentMethodState	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for this payment method.
PaymentMethodStreet	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for this payment method.
Phone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the payment method's owner.
ProcessingMode	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Shows whether the payment method was created in Salesforce or externally. Required. Possible values are: `External`: Select this value if you create the alternative payment method record through any method other than Commerce Payments Connect API. `Salesforce`: Select this value if you use Commerce Payments Connect API to create the alternative payment method record.
Status	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The state of the payment method. Required. Possible values are: `Active`: The Payments Platform can use the alternative payment method to make payments. Active alternative payment methods can't be deleted. `Canceled`: The Payments Platform can no longer use the payment method to make payments. A value of `Canceled` can't be changed back to `Active` or `Inactive` `InActive`: The Payment Platform currently can't use the payment method to make payments. Admins can change this value to `Active` or `Canceled` when needed.

Object Reference for the Salesforce Platform

AlternativePaymentMethod

Supported Calls

Special Access Rules

Fields