| 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
- Email address of the payment owner where audit
information about payments gets sent.
|
| BillingFirstName |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- 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
- 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
- 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 method’s address.
|
| Email |
- Type
- email
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Email address of the payment method holder.
|
| 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
- 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
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
- Shows 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 Commerce Payments Connect API.
-
Salesforce:
Select this value if you use Commerce Payments
Connect API to create the alternative payment
method record.
|
| 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.
|
j