CardPaymentMethod

References a credit card or debit card payment method. This entity implements the PaymentMethod entity interface. 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.

Fields

Field	Details
AccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Customer account for this payment method.
AutoCardType	Type string Properties Create, Filter, Group, Nillable, Sort Description Card network type, derived from the card number. This is a system field.
CardBin	Type int Properties Create, Filter, Group, Nillable, Sort Description First six digits of the card number.
CardCategory	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Defines whether the card is a credit card or debit card. Possible values are: `CreditCard`—Credit Card `DebitCard`—Debit Card
CardHolderFirstName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description First name of the cardholder.
CardHolderLastName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Last name of the cardholder.
CardHolderName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Full name of the cardholder.
CardLastFour	Type int Properties Create, Filter, Group, Nillable, Sort Description Last four digits of the credit card or debit card.
CardPaymentMethodNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-defined unique ID for the card payment method.
CardType	Type picklist Properties Create, Filter, Group, Nillable, Sort Description Defines the credit card bank. Possible values are: `AmericanExpress` `DinersClub` `JCB` `Maestro` `MasterCard` `Visa`
CardTypeCategory	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Defines the credit card bank. Used for internal reference. Possible values are: `AMERICANEXPRESS`—American Express `DINERSCLUB`—Diners Club `JCB` `MAESTRO`—Maestro `MASTER`—Master Card `VISA`—Visa
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 of the cardholder.
DisplayCardNumber	Type string Properties Filter, Group, Nillable, Sort Description Masked digits for the full credit card number except the last four digits.
Email	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Fraud parameter.
ExpiryMonth	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The card’s expiration month.
ExpiryYear	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The card’s expiration year.
GatewayToken	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique ID generated by the payment gateway for this card for future transactions.
InputCardNumber	Type string Properties Create, Filter, Group, Nillable, Sort Description Input field for the card number. This field doesn’t store the card number directly, but instead populates CardBin, LastFour, and DisplayCardNumber based on the value entered in InputCardNumber.
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, this record might only have been referenced (LastReferencedDate) and not viewed.
NickName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description User-defined nickname for this card payment method.
PaymentGatewayId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The payment gateway used to create a gateway token. For transactions with a saved payment method in Salesforce, this field stores the payment gateway record used in the transaction.
PaymentMethodAddress	Type address Properties Filter, Nillable Description Full address related to this card payment method. Also known as the billing address.
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 Possible values are: `Address` `Block` `City` `County` `ExtendedZip` `NearAddress` `Neighborhood` `State` `Street` `Unknown` `Zip`
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.
StartMonth	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Start month of the card.
StartYear	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Start year of the card.
Status	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Possible values are: `Active` `Canceled` `InActive`

Object Reference for Salesforce and Lightning Platform

CardPaymentMethod

Supported Calls

Special Access Rules

Fields