| AccountHolderEmail |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Email address of the payment method holder.
|
| AccountHolderName |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Full name of the payment method holder.
|
| 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:
|
| BankAccountType |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Characterizes the bank account, such as a checking or savings
account.
|
| BankCode |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Code that represents the bank who issued the payment method.
|
| BankName |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Name of the bank that issued the payment method.
|
| BillingAddress |
- Type
- address
- Properties
- Filter, Nillable
- Description
- The billing address of the account holder of the payment method.
This is the compound form of the billing address. Read-only. For
details on compound address fields, see Address Compound
Fields.
|
| BillingCity |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Details for the billing address. Maximum size is 40
characters.
|
| BillingCountry |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Details for the billing address. Maximum size is 80
characters.
|
|
BillingGeocodeAccuracy
|
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist, Sort,
Update
- Description
- Accuracy level of the geocode for the billing address. For details
on geolocation compound fields, see Compound Field Considerations and Limitations.
|
| BillingLatitude |
- Type
- double
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
-
Used with
BillingLongitude to specify the precise
geolocation of a billing address. Acceptable values are numbers
between –90 and 90 with up to 15 decimal places. For
details on geolocation compound fields, see Compound Field Considerations and Limitations.
|
| BillingLongitude |
- Type
- double
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
-
Used with
BillingLatitude to specify the precise
geolocation of a billing address. Acceptable values are numbers
between –180 and 180 with up to 15 decimal places.
See Compound Field Considerations and Limitations for
details on geolocation compound fields.
|
| BillingPostalCode |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Details for the billing address. Maximum size is 20
characters.
|
| BillingState |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Details for the billing address. Maximum size is 80
characters.
|
|
BillingStreet
|
- Type
- textarea
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Details for the billing address.
|
| ExpiryMonth |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- Month the payment method expires.
|
| ExpiryYear |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- Year the payment method expires.
|
| GatewayReference |
- Type
- string
- Properties
- Filter, Group, idLookup, Nillable, Sort
- Description
- A reference to the saved payment owner at the payment gateway. For
example, a Stripe customer ID.
|
| GatewayToken |
- Type
- encryptedstring
- Properties
- Nillable
- Description
- Unencrypted unique token ID generated by the payment gateway to
represent the card payment method during transactions.
GatewayToken is for use with APIs earlier
than version 52.0. For version 53.0 and latter, use the
GatewayTokenEncrypted field. To secure the token, use the
GatewayTokenEncrypted field.
- An error message appears if you try to record a
GatewayToken for a card payment method that
already has a GatewayToken or
GatewayTokenEncrypted value.
|
| IsDefault |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Customer’s default payment method.
- The default value is false.
|
| IsMerchantCreated |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the merchant saved the payment method on behalf
of the payer. The Payer must provide consent to the merchant to
save this information.
- The default value is false.
|
| Issuer |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Financial institution issuing the payment method.
|
| Last4 |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Last four digits of the payment method account number.
|
| LastReferencedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp for when the current user last viewed a record or
list view related to this record, but didn’t access it
directly.
|
| 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 referenced this
record but didn’t view it directly.
|
| MerchantAccountId |
- Type
- reference
- Properties
- Filter, Group, Sort
- Description
- Identifies the Salesforce Payments Merchant Account.
- This field is a relationship field.
- Relationship Name
- MerchantAccount
- Relationship Type
- Lookup
- Refers To
- MerchantAccount
|
| Name |
- Type
- string
- Properties
- Filter, Group, idLookup, Sort
- Description
- Name of the saved payment method.
|
| Network |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Saved payment method card network, for example Visa or Union
Pay.
|
| Nickname |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Additional name or label to easily identify the payment
method.
|
| PaymentGatewayId |
- Type
- reference
- Properties
- Filter, Group, Sort
- Description
- The payment gateway that is used to create a gateway token. For
transactions with a saved payment method in Salesforce, this field
stores the payment gateway ID used in the transaction. This field
is a relationship field.
- This field is a relationship field.
- Relationship Name
- PaymentGateway
- Relationship Type
- Lookup
- Refers To
- PaymentGateway
|
| ReferenceOwnerId |
- Type
- reference
- Properties
- Filter, Group, Sort
- Description
- ID of the Account or Contact record that owns the payment
method.
- This field is a polymorphic relationship field.
- Relationship Name
- ReferenceOwner
- Relationship Type
- Lookup
- Refers To
- Account or Contact
|
| 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 or deposit entry
-
TEL—Telephone-initiated entry
-
WEB—Internet or
mobile-initiated entry
|
| Status |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- Status of the saved payment method.
- Possible values are:
- Active
- AwaitingPayment
-
Errored—Failed
- Expired
|
| Type |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Type of saved payment method.
- Possible values are:
- au_becs_debit
- bacs_debit
- bancontact
- card
- ideal
- sepa_debit
-
us_bank_account
– ACH Direct Debit
|
| UsageType |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- Indicates if the payment method is used on or off session.
- Possible values are:
- OffSession
- OnSession
- RestrictedOffSession
|
j