--- schema_version: "1" id: 9cdfecd4fd10bde67edb439e36c8632883e8270f6c4fbe0433f866bd4d252f2b title: DigitalWallet collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_digitalwallet.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_digitalwallet.htm source_site: developer.salesforce.com content_type: documentation content_hash: f0e06f613d9e32e2be3eecaf203d7e485686ae227c45b52e2f0326fb446d1ef8 description: 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. This object is available in API version 48.0 and later. --- # 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. 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 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 | | --- | --- | | AccountId | 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 Lookup Refers To Account | | AuditEmail | Type email Properties Create, Filter, Group, Nillable, Sort, Update 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. | | BillingName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing name linked to customer's digital wallet. Available in API version 64.0 and later. | | Comments | Type textarea Properties Create, Nillable, Update Description Users can provide additional details about the digital wallet. Supports a maximum of 1000 characters. | | CompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Company of the digital wallet owner. | | Customer | Type string Properties Create, Filter, Group, Nillable, Sort Description Customer name of the digital wallet owner. | | DigitalWalletNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated reference number for the digital wallet. | | Email | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email of the digital wallet owner. | | ExtendedPaymentMethodType | Type string Properties Create, Filter, Group, Nillable, Sort, Update 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. This field is available in API version 66.0 and later. | | GatewayToken | 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. | | GatewayTokenDetails | Type textarea Properties Create, Filter, Nillable, Sort, Update Description Unique ID generated by the payment gateway for the card for future transactions. | | GatewayTokenEncrypted | Type encryptedstring Properties Create, Nillable, Update 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. | | IpAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update 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. | | IsAutoPayEnabled | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Indicates whether the payment method can be used for recurring payments (True) or not (False). The default value is False. This field is available in API v55.0 and later. For orgs that upgraded from v54.0, you must add this field to the Digital Wallet page layout in the UI. It isn't automatically added. | | 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, it's possible the user only referenced this record (LastReferencedDate) but not viewed it. | | MacAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update 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. | | NickName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description User-defined nickname for the digital wallet. | | PaymentGatewayId | 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 Lookup Refers To PaymentGateway | | PaymentMethodAddress | 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](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.") | | PaymentMethodCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodDetails | Type string Properties Create, Filter, Group, Nillable, Sort Description Optional information about the payment method type. This field is available in API version 57.0 and later. | | PaymentMethodGeocodeAccuracy | 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_geolocation.htm "Geolocation fields are accessible in the SOAP and REST APIs as a Location—a structured compound data type—or as individual latitude and longitude elements."). Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | PaymentMethodLatitude | 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](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."). | | PaymentMethodLongitude | 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](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."). | | PaymentMethodPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Part of the address for the payment method. | | PaymentMethodSubType | Type string Properties Create, Filter, Group, Nillable, Sort Description More information about the payment method. For example, if the PaymentMethodType is Visa, this field can be digital wallet. This field is available in API version 57.0 and later. | | PaymentMethodType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update 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. This field is available in API version 57.0 and later. | | Phone | Type phone Properties Create, Filter, Group, Nillable, Sort, Update 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. | | ProcessingMode | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Defines whether the digital wallet is used for transactions made inside or outside the payment platform. Possible values are: - External—Transactions happened outside of the Salesforce payments platform. - Salesforce—Salesforce made and recorded an external call to 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. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important ProcessingMode is required to create a DigitalWallet entity. | | SavedPaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the saved payment method record. Relationship Name SavedPaymentMethod Relationship Type Lookup Refers To SavedPaymentMethod | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Defines the state of the digital wallet as a payment source. Possible values are: - Active—Customers can make payments with the digital wallet. - Canceled—The digital wallet can no longer be used for payments. This status can’t be changed. - InActive—The digital wallet can’t be used for payments until a user changes its status to Active. |