--- schema_version: "1" id: 8fb9c84cfaa581b94953d05bf71039e88d3dfa8ff028edb3443baa3ee6f00337 title: SavedPaymentMethod collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_savedpaymentmethod.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_savedpaymentmethod.htm source_site: developer.salesforce.com content_type: documentation content_hash: 5a293b4e68e1cfc0f5cf0b3465405c4afa0b4733ad78e470afc0de0410c74235 description: Represents a payment method saved by an authenticated customer. This object is available in API version 58.0 and later --- # 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 one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience. ## 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. | | AsyncGatewayRefNumber | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort Description The payment transaction ID created by the payment gateway for asynchronous payments. This field is available in API version 66.0 and later. - For Adyen, use the pspReference. - For Stripe, use the fingerprint value. | | BankAccountHolderType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Determines whether the bank account is held by a business or an individual. Possible values are: - Business - Individual | | BankAccountType | Type string Properties Filter, Group, Nillable, Sort Description Characterizes the bank account, such as a checking or savings account. | | BankCode | Type string Properties Filter, Group, Nillable, Sort Description Code that represents the bank who issued the payment method. | | BankName | Type string Properties Filter, Group, Nillable, Sort Description Name of the bank that issued the payment method. | | BillingAddress | Type address Properties Filter, Nillable Description The billing address of the account holder of the payment method. This is the compound form of the billing address. Read-only. For details on compound address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | BillingCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 40 characters. | | BillingCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 80 characters. | | BillingGeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the billing address. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | BillingLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. For details on geolocation compound fields, see [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps."). | | BillingLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. | | BillingPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 20 characters. | | BillingState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. Maximum size is 80 characters. | | BillingStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Details for the billing address. | | 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. | | ExtendedPaymentMethodType | Type string Properties Create, Filter, Group, Nillable, Sort Description Other saved payment methods used for the transaction. This field is required when the value of the Type field is extd\_altrn\_payment\_method\_type or extd\_wallet. This field is available in API version 66.0 and later. | | 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. | | IsMerchantCreated | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the merchant saved the payment method on behalf of the payer. The Payer must provide consent to the merchant to save this information. The default value is false. | | IsSharedWithinSameAccount | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the saved payment method is visible to all contacts in an account (true) or only to the contact who created it (false). The default value is false. This field is available in API version 64.0 and later. | | 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 | | PaymentMethodSubType | Type string Properties Create, Filter, Group, Nillable, Sort Description A payment method that exists as a subtype of a payment method type. For example, Visa, Mastercard, and American Express exist as subtypes of the Card payment method. This field is available in API version 66.0 and later. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the payment was made outside of the Salesforce platform. This field is available in API version 66.0 and later. Possible values are: - External - Salesforce | | 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 | | StandardEntryClassCode | Type picklist Properties Filter, Group, Restricted picklist, Sort Description A three-letter code that indicates how a customer or a business initiated and authorized an ACH payment. Possible values are: - CCD—Corporate credit or debit entry - PPD—Prearranged payment or deposit entry - TEL—Telephone-initiated entry - WEB—Internet or mobile-initiated entry | | 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 - extd\_apm\_type - extd\_wallet - 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 these 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [SavedPaymentMethodFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [SavedPaymentMethodHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [SavedPaymentMethodOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [SavedPaymentMethodShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.