{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "DigitalWallet - Data API",
  "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.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to",
    "notes"
  ],
  "fields": {
    "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",
      "notes": "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"
    },
    "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. 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."
    },
    "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."
    },
    "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: 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."
    }
  },
  "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.",
  "wsdl_segment": "```xml\n<complexType name=\"DigitalWallet\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Account\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n        <element name=\"AccountId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"AuditEmail\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"BillingName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Comments\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CompanyName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Customer\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DigitalWalletNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Email\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ExtendedPaymentMethodType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GatewayToken\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GatewayTokenDetails\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GatewayTokenEncrypted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IpAddress\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsAutoPayEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MacAddress\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NickName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentAuthorizations\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"PaymentGateway\" nillable=\"true\" minOccurs=\"0\" type=\"ens:PaymentGateway\"/>\n        <element name=\"PaymentGatewayId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PaymentMethodAddress\" nillable=\"true\" minOccurs=\"0\" type=\"tns:address\"/>\n        <element name=\"PaymentMethodCity\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentMethodCountry\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentMethodDetails\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentMethodGeocodeAccuracy\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentMethodLatitude\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"PaymentMethodLongitude\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"PaymentMethodPostalCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentMethodState\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentMethodStreet\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentMethodSubType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PaymentMethodType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Payments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Phone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ProcessingMode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Refunds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Status\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n<complexType name=\"address\">\n  <complexContent>\n    <extension base=\"tns:location\">\n      <sequence>\n        <element name=\"city\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"country\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"countryCode\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"geocodeAccuracy\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"postalCode\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"state\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"stateCode\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"street\" type=\"xsd:string\" nillable=\"true\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<complexType name=\"location\">\n  <sequence>\n    <element name=\"latitude\" type=\"xsd:double\" nillable=\"true\"/>\n    <element name=\"longitude\" type=\"xsd:double\" nillable=\"true\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "AccountId": {
      "field_label": "Account ID",
      "type": "reference",
      "length": "18"
    },
    "AuditEmail": {
      "field_label": "Audit Email",
      "type": "email",
      "length": "80"
    },
    "BillingName": {
      "field_label": "Billing Name",
      "type": "string",
      "length": "255"
    },
    "Comments": {
      "field_label": "Comments",
      "type": "textarea",
      "length": "1000"
    },
    "CompanyName": {
      "field_label": "Company Name",
      "type": "string",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Customer": {
      "field_label": "Customer ID",
      "type": "string",
      "length": "255"
    },
    "DigitalWalletNumber": {
      "field_label": "Digital Wallet Number",
      "type": "string",
      "length": "255"
    },
    "Email": {
      "field_label": "Registered Email",
      "type": "email",
      "length": "80"
    },
    "ExtendedPaymentMethodType": {
      "field_label": "Extended Payment Method Type",
      "type": "string",
      "length": "255"
    },
    "GatewayToken": {
      "field_label": "Gateway Token",
      "type": "string",
      "length": "255"
    },
    "GatewayTokenDetails": {
      "field_label": "Gateway Token Details",
      "type": "textarea",
      "length": "1000"
    },
    "GatewayTokenEncrypted": {
      "field_label": "Gateway Token Encrypted",
      "type": "encryptedstring",
      "length": "1000"
    },
    "Id": {
      "field_label": "Digital Wallet ID",
      "type": "id",
      "length": "18"
    },
    "IpAddress": {
      "field_label": "IP Address",
      "type": "string",
      "length": "39"
    },
    "IsAutoPayEnabled": {
      "field_label": "Auto Pay",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "MacAddress": {
      "field_label": "MAC Address",
      "type": "string",
      "length": "32"
    },
    "NickName": {
      "field_label": "Nickname",
      "type": "string",
      "length": "255"
    },
    "PaymentGatewayId": {
      "field_label": "Payment Gateway ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentMethodAddress": {
      "field_label": "Payment Method Address",
      "type": "address"
    },
    "PaymentMethodCity": {
      "field_label": "City",
      "type": "string",
      "length": "40"
    },
    "PaymentMethodCountry": {
      "field_label": "Country",
      "type": "string",
      "length": "80"
    },
    "PaymentMethodDetails": {
      "field_label": "Payment Method Details",
      "type": "string",
      "length": "255"
    },
    "PaymentMethodGeocodeAccuracy": {
      "field_label": "Geo Code Accuracy",
      "type": "picklist",
      "length": "40"
    },
    "PaymentMethodLatitude": {
      "field_label": "Latitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "PaymentMethodLongitude": {
      "field_label": "Longitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "PaymentMethodPostalCode": {
      "field_label": "Postal Code",
      "type": "string",
      "length": "20"
    },
    "PaymentMethodState": {
      "field_label": "State",
      "type": "string",
      "length": "80"
    },
    "PaymentMethodStreet": {
      "field_label": "Street",
      "type": "textarea",
      "length": "255"
    },
    "PaymentMethodSubType": {
      "field_label": "Payment Method Sub Type",
      "type": "string",
      "length": "255"
    },
    "PaymentMethodType": {
      "field_label": "Payment Method Type",
      "type": "picklist",
      "length": "255"
    },
    "Phone": {
      "field_label": "Phone",
      "type": "phone",
      "length": "40"
    },
    "ProcessingMode": {
      "field_label": "Processing Mode",
      "type": "picklist",
      "length": "255"
    },
    "SavedPaymentMethodId": {
      "field_label": "Saved Payment Method ID",
      "type": "reference",
      "length": "18"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Type": {
      "field_label": "Type",
      "type": "string",
      "length": "40"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}