SavedPaymentMethod

Represents a payment method saved by an authenticated customer.

Introduced in API version 58.0.

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

  • 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.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Email address of the payment method holder.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Full name of the payment method holder.

  • Type: string

  • Properties: Create, Filter, Group, idLookup, Nillable, Sort

  • Introduced: API version 66.0

  • Description:

    The payment transaction ID created by the payment gateway for asynchronous payments.

    • For Adyen, use the pspReference.
    • For Stripe, use the fingerprint value.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 62.0
  • Description: Determines whether the bank account is held by a business or an individual.
  • Possible values:
    • Business — Business
    • Individual — Individual
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 59.0
  • Description: Characterizes the bank account, such as a checking or savings account.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Code that represents the bank who issued the payment method.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Name of the bank that issued the payment method.
  • Type: address
  • Properties: Filter, Nillable
  • Introduced: API version 62.0
  • 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.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Details for the billing address. Maximum size is 40 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Details for the billing address. Maximum size is 80 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Accuracy level of the geocode for the billing address. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort
  • 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.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort
  • 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 for details on geolocation compound fields.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Details for the billing address. Maximum size is 20 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Details for the billing address. Maximum size is 80 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Details for the billing address.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 60.0
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Month the payment method expires.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Year the payment method expires.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 66.0
  • 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.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort
  • Description: A reference to the saved payment owner at the payment gateway. For example, a Stripe customer ID.

  • Type: encryptedstring

  • Properties: Create, 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.

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort

  • Description:

    Customer’s default payment method.

    The default value is false.

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort

  • Introduced: API version 62.0

  • 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.

  • Default value: false

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort
  • Introduced: API version 64.0
  • 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.
  • Default value: false
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Financial institution issuing the payment method.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Last four digits of the payment method account number.

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    Identifies the Salesforce Payments Merchant Account.

    This field is a relationship field.

  • Relationship name: MerchantAccount

  • Relationship type: relationship

  • Refers to: MerchantAccount

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort
  • Description: Name of the saved payment method.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Saved payment method card network, for example Visa or Union Pay.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 59.0
  • Description: Additional name or label to easily identify the payment method.

  • Type: reference

  • Properties: Create, 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: relationship

  • Refers to: PaymentGateway

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 66.0
  • 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.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 66.0
  • Description: Indicates whether the payment was made outside of the Salesforce platform.
  • Possible values:
    • External — External
    • Salesforce — Salesforce

  • Type: reference

  • Properties: Create, 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: polymorphic

  • Refers to: Account, Contact

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 62.0
  • Description: A three-letter code that indicates how a customer or a business initiated and authorized an ACH payment.
  • Possible values:
    • CCD — CCD — Corporate credit or debit entry
    • PPD — PPD — Prearranged payment or deposit entry
    • TEL — TEL — Telephone-initiated entry
    • WEB — WEB — Internet or mobile-initiated entry
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort
  • Description: Status of the saved payment method.
  • Possible values:
    • Active — Active
    • AwaitingPayment — AwaitingPayment
    • Errored — Errored — Failed
    • Expired — Expired
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Type of saved payment method.
  • Possible values:
    • au_becs_debit — au_becs_debit
    • bacs_debit — bacs_debit
    • bancontact — bancontact
    • card — card
    • extd_apm_type — extd_apm_type
    • extd_wallet — extd_wallet
    • ideal — ideal
    • sepa_debit — sepa_debit
    • us_bank_account — us_bank_account — ACH Direct Debit
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort
  • Description: Indicates if the payment method is used on or off session.
  • Possible values:
    • OffSession — OffSession
    • OnSession — OnSession
    • RestrictedOffSession — RestrictedOffSession

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.