Newer Version Available

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

PaymentCart

Represents a payment cart that collects payment items before processing. Use this object to group multiple payment items (such as invoices) together for batch payment processing. The cart tracks the total amount and processing status of the payment. This object is available in API version 66.0 and later.

Supported Calls

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

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the account associated with the payment cart.
This field is a relationship field.
Relationship Name
Account
Refers To
Account
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the contact associated with the payment cart.
This field is a relationship field.
Relationship Name
Contact
Refers To
Contact
Description
Type
textarea
Properties
Create, Nillable, Update
Description
A description of the payment cart. Maximum length is 5,000 characters.
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 LastReferencedDate 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 auto-generated name of the payment cart. Uses the format PC-{000000000}.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user or queue that owns the payment cart.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The processing status of the payment cart. Default value is Draft.
Possible values are:
  • Draft
  • Failed
  • Processing
  • Succeeded
The default value is Draft.
TotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount of all items in the payment cart. This is a roll-up summary field that calculates the SUM of PaymentCartItem.Amount.
This field is a calculated field.

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.

PaymentCartHistory
History is available for tracked fields of the object.
PaymentCartOwnerSharingRule
Sharing rules are available for the object.
PaymentCartShare
Sharing is available for the object.