PaymentLink

Represents a payment link that a merchant can copy and send to a payer via email and text message. The payment link contains a title, a description of what they’re paying for, and the amount of the transaction in the payer’s currency. This object is available in API version 58.0 and later.

Supported Calls

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

Special Access Rules

To access Commerce PaymentLink, your org must have a Salesforce Payments license.

Fields

Field	Details
AccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Payer account. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account
Amount	Type currency Properties Create, Filter, Sort, Update Description Amount the payer is paying for.
CurrencyIsoCode	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description 3-digit ISO code for the payment currency shown on the payment link page. The default value is `USD`.
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Open description field, to be featured on the payment link page describing what is being paid.
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, this record might only have been referenced and not viewed directly.
PaymentLinkNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Auto-generated number that identifies the payment link.
PaymentMethodSetId	Type reference Properties Create, Filter, Group, Sort, Update Description Reference to the PaymentMethodSet object, which determines what payment methods are shown to the payer. This field is a relationship field. Relationship Name PaymentMethodSet Relationship Type Lookup Refers To MerchAccPaymentMethodSet
PaymentUrl	Type url Properties Filter, Group, Sort Description Unique URL of the Pay Now page, auto-generated, and not editable.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether or not the payment link is active and can be used. Possible values are: `Active` `Disabled` The default value is `Active`.
Title	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Title of the Payment Link page, indicating what is being paid.

Object Reference for the Salesforce Platform

PaymentLink

Supported Calls

Special Access Rules

Fields