afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/AlternativePaymentMethod.json

479 lines
25 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"wsdl_segment",
"field_reference"
],
"title": "AlternativePaymentMethod - Data API",
"description": "Represents a payment method that isnt cash, a debit card, or a credit card. This object defines methods that arent defined by the CardPaymentMethod or DigitalWallet objects. Examples of alternative payment methods include CashOnDeliver, Klarna, and Direct Debit. AlternativePaymentMethod functions the same as any other type of payment method for processing transactions through a payment gateway. This object is available in API version 51.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AccountId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The account for the alternative payment method. This field is a relationship field.",
"relationship_name": "Account",
"relationship_type": "Lookup",
"refers_to": "Account"
},
"AlternativePaymentMethodNumber": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "Salesforce ID number for the alternative payment method."
},
"AuditEmail": {
"type": "email",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The email address of the payment owner where audit information about payments is sent."
},
"BankAccountHolderType": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Determines if 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": "Type of bank account such as a checking or savings account."
},
"BillingFirstName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The first name of the payment method owner, based on their billing address details. This field is available in API version 58.0 and later."
},
"BillingLastName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The last name of the payment method owner, based on their billing address details. This field is available in API version 58.0 and later."
},
"BillingName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The first and last name of the payment method owner, based on their billing address details. This field is available in API version 58.0 and later."
},
"Comments": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "Users can add comments to provide additional details about a record. Maximum of 1000 characters."
},
"CompanyName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Company name for this payment method. Part of the payment methods address."
},
"Email": {
"type": "email",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Email address of the payment method holder."
},
"ExtendedPaymentMethodType": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Other alternative payment methods used for the transaction. This field is available in API version 66.0 and later."
},
"GatewayToken": {
"type": "encryptedstring",
"properties": "Create, Nillable, Update",
"description": "Tokenized form of the alternative payment method, returned by the gateway. Stored as encrypted text."
},
"GatewayTokenDetails": {
"type": "textarea",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "A unique tokenized ID generated by the payment gateway when this payment method first interacts with the gateway. Used to identify the payment method during future transactions."
},
"IpAddress": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "IP address for the payment method owner."
},
"IsAutoPayEnabled": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "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 Alternative Payment Method page layout in the UI. It isn't automatically added."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user only accessed this record or list view (LastReferencedDate) but not viewed it."
},
"MacAddress": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Mac Address of the payment method holder."
},
"NickName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "User-defined nickname for this payment method."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The user who owns the alternative payment method. This field is a polymorphic relationship field.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "Group, User"
},
"PaymentGatewayId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "ID of the payment gateway entity used to handle transactions from this payment method. 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 alternative payment method. For more information about address fields, see Address Compound Fields."
},
"PaymentMethodCity": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Payment method address details."
},
"PaymentMethodCountry": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Payment method address details."
},
"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 about geolocation compound fields, see Compound Field Considerations and Limitations."
},
"PaymentMethodLongitude": {
"type": "double",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "Longitude of the payment method address. Used with the PaymentMethodLatitude to specify the precise geolocation of the address. For details about geolocation compound fields, see Compound Field Considerations and Limitations."
},
"PaymentMethodPostalCode": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Details of the address for this payment method."
},
"PaymentMethodState": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Details of the address for this payment method."
},
"PaymentMethodStreet": {
"type": "textarea",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Details of the address for this 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 a 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, such as Visa, Mastercard, EPS, SepaDebit, and Klarna. 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 payment method's owner."
},
"ProcessingMode": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort",
"description": "Indicates whether the payment method was created in Salesforce or externally. Required. Possible values are: External: Select this value if you create the alternative payment method record through any method other than the Salesforce Payments Connect API. Salesforce: Select this value if you use Salesforce Payments Connect API to create the alternative payment method record."
},
"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"
},
"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—Pre-arranged payment and deposit entry TEL—Telephone-initiated entry WEB—Internet or mobile-initiated entry"
},
"Status": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "The state of the payment method. Required. Possible values are: Active—The Payments platform can use the alternative payment method to make payments. Active alternative payment methods can't be deleted. Canceled—The Payments platform can no longer use the payment method to make payments. A value of Canceled can't be changed back to Active or Inactive InActive—The Payment platform currently can't use the payment method to make payments. Admins can change this value to Active or Canceled when needed."
}
},
"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=\"AlternativePaymentMethod\">\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=\"AlternativePaymentMethodNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"AuditEmail\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"BankAccountHolderType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"BankAccountType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"BankCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"BillingFirstName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"BillingLastName\" 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=\"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=\"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=\"Mandate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"NickName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"PaymentGatewayLogs\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"StandardEntryClassCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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"
},
"AlternativePaymentMethodNumber": {
"field_label": "Alternative Payment Method Number",
"type": "string",
"length": "255"
},
"AuditEmail": {
"field_label": "Audit Email",
"type": "email",
"length": "80"
},
"BankAccountHolderType": {
"field_label": "Account Ownership Type",
"type": "picklist",
"length": "255"
},
"BankAccountType": {
"field_label": "Bank Account Type",
"type": "string",
"length": "25"
},
"BankCode": {
"field_label": "Bank Code",
"type": "string",
"length": "25"
},
"BillingFirstName": {
"field_label": "First name of the person tied to billing address",
"type": "string",
"length": "255"
},
"BillingLastName": {
"field_label": "Last name of the person tied to billing address",
"type": "string",
"length": "255"
},
"BillingName": {
"field_label": "Name of the person tied to billing address",
"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"
},
"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": "encryptedstring",
"length": "1000"
},
"GatewayTokenDetails": {
"field_label": "Gateway Token Details",
"type": "textarea",
"length": "1000"
},
"Id": {
"field_label": "Alternative Payment Method 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"
},
"Mandate": {
"field_label": "Mandate Text",
"type": "string",
"length": "255"
},
"NickName": {
"field_label": "Nickname",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"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"
},
"StandardEntryClassCode": {
"field_label": "Standard Entry Class Code (ACH)",
"type": "picklist",
"length": "255"
},
"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"
]
}