SavedPaymentMethod

Represents a payment method saved by an authenticated customer. This object is available in API version 58.0 and later

Supported Calls

delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()

Special Access Rules

To access Salesforce Payments objects with the API, your org must have:

Salesforce Payments License
Payments Administrator permission set

Fields

Field	Details
AccountHolderEmail	Type string Properties Filter, Group, Nillable, Sort Description Email address of the payment method holder.
AccountHolderName	Type string Properties Filter, Group, Nillable, Sort Description Full name of the payment method holder.
BankAccountType	Type string Properties Filter, Group, Nillable, Sort Description Type of bank account such as a checking or savings account.
BankCode	Type string Properties Filter, Group, Nillable, Sort Description Code representing the bank that issued the payment method.
BankName	Type string Properties Filter, Group, Nillable, Sort Description Name of the bank that issued the payment method.
ExpiryMonth	Type int Properties Filter, Group, Nillable, Sort Description Month the payment method expires.
ExpiryYear	Type int Properties Filter, Group, Nillable, Sort Description Year the payment method expires.
GatewayReference	Type string Properties Filter, Group, idLookup, Nillable, Sort Description A reference to the saved payment owner at the payment gateway. For example, a Stripe customer ID.
GatewayToken	Type encryptedstring Properties Nillable Description Unencrypted unique token ID generated by the payment gateway to represent the card payment method during transactions. GatewayToken is for use with APIs earlier than version 52.0. For version 53.0 and latter, use the GatewayTokenEncrypted field. To secure the token, use the GatewayTokenEncrypted field. An error message appears if you try to record a GatewayToken for a card payment method that already has a GatewayToken or GatewayTokenEncrypted value.
IsDefault	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Customer’s default payment method. The default value is `false`.
Issuer	Type string Properties Filter, Group, Nillable, Sort Description Financial institution issuing the payment method.
Last4	Type string Properties Filter, Group, Nillable, Sort Description Last four digits of the payment method account number.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record or list view related to this record, but didn’t access it directly.
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 the user referenced this record but didn’t view it directly.
MerchantAccountId	Type reference Properties Filter, Group, Sort Description Identifies the Salesforce Payments Merchant Account. This field is a relationship field. Relationship Name MerchantAccount Relationship Type Lookup Refers To MerchantAccount
Name	Type string Properties Filter, Group, idLookup, Sort Description Name of the saved payment method.
Network	Type string Properties Filter, Group, Nillable, Sort Description Saved payment method card network, for example Visa or Union Pay.
Nickname	Type string Properties Filter, Group, Nillable, Sort Description Additional name or label to easily identify the payment method.
PaymentGatewayId	Type reference Properties Filter, Group, Sort Description The payment gateway that is used to create a gateway token. For transactions with a saved payment method in Salesforce, this field stores the payment gateway ID used in the transaction. This field is a relationship field. This field is a relationship field. Relationship Name PaymentGateway Relationship Type Lookup Refers To PaymentGateway
ReferenceOwnerId	Type reference Properties Filter, Group, Sort Description ID of the Account or Contact record that owns the payment method. This field is a polymorphic relationship field. Relationship Name ReferenceOwner Relationship Type Lookup Refers To Account or Contact
Status	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Status of the saved payment method. Possible values are: `Active` `AwaitingPayment` `Errored`—Failed `Expired`
Type	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type of saved payment method. Possible values are: `au_becs_debit` `bacs_debit` `bancontact` `card` `ideal` `sepa_debit` `us_bank_account` – ACH Direct Debit
UsageType	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Indicates if the payment method is used on or off session. Possible values are: `OffSession` `OnSession` `RestrictedOffSession`

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

SavedPaymentMethodChangeEvent: Change events are available for the object.
SavedPaymentMethodFeed: Feed tracking is available for the object.
SavedPaymentMethodHistory: History is available for tracked fields of the object.
SavedPaymentMethodOwnerSharingRule: Sharing rules are available for the object.
SavedPaymentMethodShare: Sharing is available for the object.

Object Reference for the Salesforce Platform

SavedPaymentMethod

Supported Calls

Special Access Rules

Fields

Associated Objects