| 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.
|
| 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:
- 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:
- The default value is MultiUse.
|
j