Education Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Education Cloud
Release Notes
Education Cloud Data Model Overview
Education Cloud Standard Objects
Education Cloud Fields on Standard Objects
Education Cloud Associated Objects
Education Cloud Standard Value Set Names and Standard Picklist Fields
Education Cloud Tooling API Objects
Education Cloud Business APIs
Fundraising
Fundraising Standard Objects
DocGenerationQueryResult
DonorGiftConcept
DonorGiftSummary
GiftAgreement
GiftBatch
GiftCommitment
GiftCmtChangeAttrLog
GiftCommitmentSchedule
GiftDefaultDesignation
GiftDefaultSoftCredit
GiftDesignation
GiftEntry
GiftRefund
GiftSoftCredit
GiftTransaction
GiftTransactionDesignation
GiftTribute
GiftValueForecast
OutreachSourceCode
OutreachSummary
PartyCategory
PartyPhilanthropicAssessment
PartyPhilanthropicIndicator
PartyPhilanthropicMilestone
PartyPhilanthropicOccurrence
PartyPhilanthropicRsrchPrfl
PaymentInstrument
PlannedGift
PlannedGiftAnnuityRate
PlannedGiftPerformance
Fundraising Fields on Other Objects
Fundraising Business APIs
Fundraising Invocable Actions
Fundraising Metadata API Types
Fundraising Tooling API Objects
PDF

PaymentInstrument

Represents the details related to the Payment Instrument used to complete the transaction. This object is available in API version 60.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

This object is available only if the Fundraising Access license is enabled and the Fundraising User system permission is assigned to users

Fields

Field Details
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 Account or PersonAccount that is using the payment instrument.
This field is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
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.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The currency ISO code. This field is hidden when multicurrency is off.
Possible values are:
  • AUD—Australian Dollar
  • GBP—British Pound
  • USD—U.S. Dollar
The default value is USD.
DigitalWalletProvider
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The provider of the digital wallet.
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.
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 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.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The unique, auto-numbered name of the payment instrument.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
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.
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of the payment instrument.
Possible values are:
  • ACH
  • BACS Debit
  • BECS Debit
  • Bancontact
  • Credit Card
  • PayPal
  • SEPA Direct Debit
  • Venmo
  • iDEAL

Associated Objects

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.

PaymentInstrumentFeed
Feed tracking is available for the object.
PaymentInstrumentHistory
History is available for tracked fields of the object.
PaymentInstrumentShare
Sharing is available for the object.