Payment - Liquid Object Reference
On this page
Description
The Payment object represents a payment made for an Order.
:::note
This object supports custom data via the data attribute.
:::
Backed by
This drop renders the s_c__Payment__c Salesforce object. A theme writes it as payment.
| Liquid attribute | Salesforce field |
|---|---|
amount |
s_c__Amount__c |
amount_tendered |
s_c__Amount_Tendered__c |
change_given |
s_c__Change_Given__c |
invoice_reference |
s_c__Invoice_Reference__c |
invoice_url |
s_c__Invoice_Url__c |
payment_method |
s_c__Method__c |
points_amount |
s_c__Points_Amount__c |
status |
s_c__Status__c |
surcharge_amount |
s_c__Surcharge_Amount__c |
transaction_number |
s_c__Transaction_Number__c |
Every other attribute on this drop is derived by StoreConnect rather than read straight from one field. The Attributes section lists them all.
Fields you add yourself are not listed above. Expose one with a Custom Data Mapping record, then read it from payment.data. See custom data fields in Liquid.
Attributes
| Attribute | Type | Description |
|---|---|---|
account_credit_path |
String | Returns the url path to the AccountCredit used for this Payment (if any) |
amount |
Number | Returns the payment amount |
amount_tendered |
Number | Returns the Cash amount tendered for this Payment |
change_given |
Number | Returns the change given in Cash for this Payment |
currency_code |
String | Returns the currency code for this Payment |
description |
String | Returns the a description of the payment method used |
id |
String | Returns the unique id for this Payment |
instructions_content |
String | Returns the value of the Instructions attribute as rich text |
invoice_reference |
String | Returns the invoice reference number for this Payment |
invoice_url |
String | Returns the a url to the invoice for this Payment |
order |
Order | Returns the Order that this Payment belongs to |
paid_at |
Timestamp | Returns timestamp of this Payment |
payment_method |
String | Returns the payment method used |
payment_provider |
PaymentProvider | Returns the PaymentProvider used for this Payment |
points_amount |
Number | Returns the points payment amount |
status |
String | Returns the status of this Payment |
surcharge_amount |
Number | Returns the surcharge amount included in this Payment |
transaction_number |
String | Returns a transaction reference number for this Payment |
wallet_type |
String | Returns the wallet type used (e.g., \ |
Available on
- AccountCreditTransaction - Liquid Object Reference —
payment - AccountPointsTransaction - Liquid Object Reference —
payment - Order - Liquid Object Reference —
payments - Subscription - Liquid Object Reference —
payments
Was this article helpful?
Thanks for your feedback! It helps us improve our docs.