PaymentLink

A payment link that a merchant can embed into a Salesforce app. The link directs payers to a Pay Now page that shows what’s being paid for, in the payers currency, and lets payers enter their payment data. 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.
CartID	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the cart record. Relationship Name Cart Relationship Type Lookup Refers To Webcart
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 Pay Now page. The default value is `USD`.
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description on the Pay Now page explaining 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 Create, Defaulted on create, Filter, Group, Sort, Update 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.
OwnerID	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this record. Relationship Name Owner Relationship Type Lookup Refers To Group, User
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. This URL IS auto-generated, and not editable.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Indicates whether the payment link is active and can be used. Possible values are: `Active` `Disabled` The default value is `Active`.
TaxAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description Amount of the tax to be included on the Pay Now page.
Title	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Title of the Pay Now page, indicating what is being paid.
Type	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Determines whether the Pay Now page shows an itemized list of products or only an amount due. Possible values are: `PredefinedAmount`—Show Predefined Amount `WithProducts`—Show with Products. This type doesn’t allow the merchant to edit the cart. The default value is `PredefinedAmount`.
UsageType	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Determines whether the payment link is used one time or multiple times before the configured expiration date and time. Possible values are: `MultiUse`—Multiple Uses `SingleUse` The default value is `MultiUse`.

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.

PaymentLinkOwnerSharingRule: Sharing rules are available for the object.
PaymentLinkShare: Sharing is available for the object.

Object Reference for the Salesforce Platform

PaymentLink

Supported Calls

Special Access Rules

Fields

Associated Objects