DigitalWallet

Represents a customer’s digital wallet service. Salesforce Payments can use a digital wallet as a payment source when processing payments through a payment gateway.

Introduced in API version 48.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

  • 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: reference

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

  • Description:

    The account of the customer owns the digital wallet.

    This field is a relationship field.

  • Relationship name: Account

  • Relationship type: relationship

  • Refers to: Account

  • Type: email

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

  • Introduced: API version 49.0

  • Description:

    Email address of the digital wallet owner where audit information about payments gets sent.

    This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own.

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Description: Billing name linked to customer’s digital wallet.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Users can provide additional details about the digital wallet. Supports a maximum of 1000 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Company of the digital wallet owner.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: Customer name of the digital wallet owner.
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: System-generated reference number for the digital wallet.
  • Type: email
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Email of the digital wallet owner.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Description: Other digital payment methods used for the transaction. This field value is required when the value of the PaymentMethodType field is extd_altrn_payment_method_type or extd_wallet.
  • Type: string

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

  • Description:

    Unencrypted unique token ID generated by the payment gateway to represent the digital wallet during transactions. This field is available for backward compatibility. To secure the token, use the GatewayTokenEncrypted field.

    If you try to record a GatewayToken for a digital wallet that already has a GatewayToken or GatewayTokenEncrypted value, Salesforce throws an error.

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: Unique ID generated by the payment gateway for the card for future transactions.
  • Type: encryptedstring

  • Properties: Create, Nillable, Update

  • Introduced: API version 52.0

  • Description:

    Encrypted unique token ID generated by the payment gateway to represent the digital wallet during transactions. Encrypted using Salesforce Classic Encryption for custom fields.

    Available in API v52.0 and later.

  • Type: string

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

  • Introduced: API version 49.0

  • Description:

    The IP address of the digital wallet owner.

    This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own.

  • Type: boolean

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

  • Introduced: API version 55.0

  • Default value: false

  • Type: string

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

  • Introduced: API version 49.0

  • Description:

    The MAC address of the digital wallet owner.

    This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own.

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: User-defined nickname for the digital wallet.
  • Type: reference

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

  • Description:

    Gateway used with transactions for the digital wallet.

    This field is a relationship field.

  • Relationship name: PaymentGateway

  • Relationship type: relationship

  • Refers to: PaymentGateway

  • Type: address
  • Properties: Filter, Nillable
  • Description: Full address associated with the digital wallet payment method. For more information about address fields, see Address Compound Fields
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Part of the address for the payment method.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Part of the address for the payment method.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 57.0
  • Description: Optional information about the payment method type.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Accuracy level of the geocode for the payment method address. An accuracy level contains information about the location of a latitude and longitude. For more information about geolocation fields, see Geolocation Compound Field.
  • Possible values:
    • Address — Address
    • Block — Block
    • City — City
    • County — County
    • ExtendedZip — ExtendedZip
    • NearAddress — NearAddress
    • Neighborhood — Neighborhood
    • State — State
    • Street — Street
    • Unknown — Unknown
    • Zip — Zip
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Latitude of the payment method address. Used with the PaymentMethodLongitude to specify the precise geolocation of the address. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Latitude of the payment method address. Used with the PaymentMethodLatitude to specify the precise geolocation of the address. For details on geolocation compound fields, see Compound Field Considerations and Limitations.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Part of the address for the payment method.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Part of the address for the payment method.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Part of the address for the payment method.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 57.0
  • Description: More information about the payment method. For example, if the PaymentMethodType is Visa, this field can be digital wallet.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 57.0
  • Description: Payment method used for the transaction. Possible values include credit cards such as Visa and American Express, digital wallets like Apple Pay and PayPal, direct debits such as ACH, BECS, Bacs, non-card payments methods such as EPS, SEPA, and iDEAL, extended alternate payments methods, and extended wallets.
  • Type: phone

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

  • Introduced: API version 49.0

  • Description:

    Phone number of the digital wallet owner.

    This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own.

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort

  • Introduced: API version 49.0

  • Description:

    Defines whether the digital wallet is used for transactions made inside or outside the payment platform.

    This field is available in API v49.0 and later. It doesn’t appear in the UI by default for Salesforce orgs that upgraded from v48.0. Users must add it to the DigitalWallet page layout on their own.

  • Possible values:

    • External — External — Transactions happened outside of the Salesforce payments platform.
    • Salesforce — Salesforce — Salesforce made and recorded an external call to the payment platform.

    ProcessingMode is required to create a DigitalWallet entity.

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: The ID of the saved payment method record.
  • Relationship name: SavedPaymentMethod
  • Relationship type: relationship
  • Refers to: SavedPaymentMethod
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Defines the state of the digital wallet as a payment source.
  • Possible values:
    • Active — Active — Customers can make payments with the digital wallet.
    • Canceled — Canceled — The digital wallet can no longer be used for payments. This status can’t be changed.
    • InActive — InActive — The digital wallet can’t be used for payments until a user changes its status to Active.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update