--- schema_version: "1" id: f09961d7ad1c67c35b93350184325e7909352a82f2f891abb4464304e202d11c title: PaymentLink collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_paymentlink.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentlink.htm source_site: developer.salesforce.com content_type: documentation content_hash: 4fbf471ebf3b50d55d96780968b2130d2480342467891deb04b6ac3f65af9d85 description: A link that a merchant can share with customers to collect payments for products and services. The payment link, which you can embed into a Salesforce app or send directly to a customer, directs the customer to a Pay Now payment page. The page can show a total amount owed or an itemized list or products, shipping and tax charges, and a total amount owed. The customer enters their contact and payment details, and submits their payment. The amounts are shown in the store's currency. This object is available in API version 58.0 and later. --- # PaymentLink A link that a merchant can share with customers to collect payments for products and services. The payment link, which you can embed into a Salesforce app or send directly to a customer, directs the customer to a Pay Now payment page. The page can show a total amount owed or an itemized list or products, shipping and tax charges, and a total amount owed. The customer enters their contact and payment details, and submits their payment. The amounts are shown in the store'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 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 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 owes. | | 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 | | CollectionPlanId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The collection plan associated with the payment link. This field is a relationship field. Available in API version 63.0 and later with Financial Services and Automotive Cloud. Relationship Name CollectionPlan Refers To CollectionPlan | | CurrencyIsoCode | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description 3-digit ISO code for the payment currency that is shown on the Pay Now page. Possible values are: - EUR – Euro - GBP – British Pound - USD – US Dollar The default value is USD. | | CustomMetadata | Type textarea Properties Create, Nillable, Update Description The metadata that merchants specify when creating a payment link. This metadata is sent to payment gateways so merchants can use this data to reconcile transactions against their own invoices or internal IDs. | | Description | Type textarea Properties Create, Nillable, Update Description Text on the Pay Now payment page that’s visible to your customers. This text can communicate any information you want. | | Expiry Time | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time that the payment link expires. The time is based on the user’s time zone, not the org’s time zone. | | IsBusinessAccountPayment | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the payment link is for a business account (true) or not (false). 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, this record can be 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 | | PaymentInitiationSource | Type string Properties Create, Filter, Nillable, Sort, Update Description The origin of the payment, based on the information in the Payment Link record. | | 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 | | PaymentScheduleItemId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The payment schedule item associated with the payment link. This field is a relationship field. Available in API version 63.0 and later with Financial Services and Automotive Cloud. Relationship Name PaymentScheduleItem Refers To PaymentScheduleItem | | PaymentUrl | Type url Properties Filter, Group, Sort Description Unique URL of the Pay Now page. This URL IS auto-generated, and not editable. | | QrCodeImageId | Type reference Properties Filter, Group, Nillable, Sort Description Reference to the QR code image included in the payment link record. This field is a relationship field. Relationship Name QrCodeImage Relationship Type Lookup Refers To ContentVersion | | 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 for the purchase. This amount is shown 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 Indicates the type of payment link created, which the merchant can share with the customer to receive payment. The payment link also determines which Pay Now page is generated and what’s included on that page. Possible values are: - CheckoutWithOrder (only for orgs with Payments and Commerce)—includes the amount owed based on the products you select, lists the products purchased, and calculates tax using the billing address and selected shipping options. After a customer makes a payment, this link type creates an order record. - PredefinedAmount—shows only an amount due for products purchased. The merchant enters the amount due when creating the payment link. - WithProducts—Deprecated. New payment links can't be created with this link type. 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 - SingleUse The default value is MultiUse. | ## Associated Objects This object has these 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [PaymentLinkShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.