PaymentInstrument

AccountHolderName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Name of the payment instrument holder.

AccountId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The ID of the Account or PersonAccount that is using the payment instrument.

  This field is a relationship field.

• Relationship Name: Account
• Refers To: Account

BankAccountHolderType

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Determines if the bank account holder is an individual or a company.

BankAccountNumber

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The bank account number used for payment.

BankAccountType

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Type of the bank account.

BankCode

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Code of bank associated with the bank account.

BankName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Name of bank associated with the bank account.

CardBrand

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The credit card brand, network, or issuer.

DigitalWalletProvider

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The provider of the digital wallet.

DisbursementAddress

• Type: address
• Properties: Filter, Nillable
• Description: This is a compound field of type Address and combines these fields: DisbursementCity, DisbursementCountry, DisbursementGeocodeAccuracy, DisbursementLatitude, DisbursementLongitude, DisbursementPostalCode, DisbursementState, and DisbursementStreet. For more information, see Address Compound Fields.

  Available in API version 67.0 and later.

ExpiryMonth

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Expire month if payment method is credit card.

ExpiryYear

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Expire year if payment method is credit card.

ExternalPayeeIdentifier

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: External identifier for the payee in external payment systems.

  Available in API version 67.0 and later.

GatewayName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The name of the payment gateway.

GatewayReference

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: A reference number from the gateway for this payment instrument.

Last4

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Last 4 digits of payment method.

LastReferencedDate

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

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, and LastReferenceDate is not null, the user accessed this record or list view indirectly.

Name

• Type: string
• Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
• Description: The name of the Payment Instrument.

OwnerId

• Type: reference
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: ID of the owner of this record.

  This field is a polymorphic relationship field.

• Relationship Name: Owner
• Refers To: Group, User

PaymentProcessorName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The name of the payment processor.

ProcessorReference

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The reference of the payment processor associated with the payment instrument.

Status

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The status of the payment instrument.

  Available in API version 67.0 and later.

Type

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the type of the payment instrument.

This object has the following associated objects. If the API version isn't specified, they're available in the same API versions as this object. Otherwise, they're available in the specified API version and later.

PaymentInstrumentHistory

History is available for tracked fields of the object.

PaymentInstrumentShare

Sharing is available for the object.