Newer Version Available

This content describes an older version of this product. View Latest

PaymentIntent

Represents data temporarily stored during a transaction’s lifecycle that can identify the buyer, the merchant, and the amount the buyer is sending to the merchant. Data such as timestamp and amount returned can also be stored in PaymentIntent. This object is available in API version 58.0 and later.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()

Special Access Rules

To access Salesforce Payments objects, you must have a Salesforce Payments license with the Payments permission enabled for your org. Salesforce Payments entities are available only in Lightning Experience.

Fields

Field Details
AccountId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Displays the account record of the buyer.
This field is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
AmountCapturable
Type
currency
Properties
Filter, Nillable, Sort
Description
Payment amount that a merchant can collect after the fulfillment of an order.
AmountRefundable
Type
currency
Properties
Filter, Nillable, Sort
Description
Payment amount that a merchant can refund.
AuthorizationReversalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Amount canceled before completing the transfer of funds from buyer to merchant.
AuthorizedAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Amount authorized by the payer’s bank.
CapturedAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total amount that a merchant secured from a buyer.
CurrencyIsoCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
ISO code for any currency allowed by the organization. Available only for orgs with the multicurrency feature enabled.
Possible values are:
  • Euro
  • USD
The default is USD.
Guid
Type
string
Properties
Filter, Group, idLookup, Nillable, Sort
Description
Unique ID of the payment sent to Stripe or PayPal. This ID links the Payments Merchant Account record with the payment at the payment provider.
IntentAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total amount that a merchant expects to receive from a buyer.
IsCaptureComplete
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates that the funds for a given payment are paid.
The default value is false.
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. If this value is null, it’s possible that this record was referenced but not viewed.
MerchantAccountId
Type
reference
Properties
Filter, Group, Sort
Description
Required field that represents the association of the merchant account record with a payment intent record.
This field is a relationship field.
Relationship Name
MerchantAccount
Relationship Type
Lookup
Refers To
MerchantAccount
PaymentGatewayId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the payment gateway that processed the payment.
Relationship Name
PaymentGateway
Relationship Type
Lookup
Refers To
PaymentGateway
PaymentIntentNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Autogenerated number assigned to the payment record, for example PI-000000001.
PaymentLinkGmvDate
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Date the payment is captured from a payment link transaction. The total amount paid is expressed as the Gross Merchandise Value (GMV).
PaymentLinkId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Auto-assigned number identifying the payment link.
This field is a relationship field.
Relationship Name
PaymentLink
Relationship Type
Lookup
Refers To
PaymentLink
PaymentMethodDetails
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Additional information about the payment method type such as the four last digits of a card number.
PaymentMethodId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Refers to the record for the payment method implementation: card payment method, digital wallet, or alternative payment method.
This field is a polymorphic relationship field.
Relationship Name
PaymentMethod
Relationship Type
Lookup
Refers To
PaymentMethod
PaymentMethodSubType
Type
string
Properties
Filter, Group, Nillable, Sort
Description
A payment method that exists as a subtype of a payment method type. For example, Visa, Mastercard, and American Express exist as subtypes of payment method types such as Apple Pay and Google Pay.
PaymentMethodType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Payment method used for the transaction.
Possible values are:
  • ACH
  • AfterpayClearpay
  • AmericanExpress
  • ApplePay
  • BACS
  • BECS
  • BanContact
  • DinersClub
  • Discover
  • EPS
  • GooglePay
  • Jcb
  • Klarna
  • Maestro
  • MasterCard
  • Other
  • PayPal
  • SepaDebit
  • UnionPay
  • Venmo
  • Visa
  • iDeal
ProviderReference
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Identifies a payment record by the payment provider at the payment gateway.
RefundedAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total or partial amount refunded to the buyer due to product return, merchant’s lack of inventory, or shipping and delivering problems.
Status
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Status of the payment record.
Possible values are:
  • Authorized
  • Canceled
  • Created
  • Expired
  • Failed
  • PartiallyCaptured
  • PartiallyRefunded
  • Pending
  • Refunded
  • Succeeded