Skip to content
Log in

Payment Object Reference

On this page

Overview

A Payment object holds the payment information associated with an Order checked out by a shopper.

Property Value
API Name s_c__Payment__c
Label Payment
Plural Label Payments
Type Custom Object

Fields

Field Label API Name Type Required Description
Amount Tendered s_c__Amount_Tendered__c Currency(10,5) No The amount given by the customer when making this payment (before change is given).
Amount s_c__Amount__c Currency(18,2) No The amount of this Payment including any surcharges
Change Given s_c__Change_Given__c Currency(10,5) No The amount given as change to the customer as part of this payment.
Error Messages s_c__Error_Messages__c LongTextArea(131072) No Any errors that occurred when the system attempted to process this payment.
Invoice Reference s_c__Invoice_Reference__c Text(255) No Optional reference to the invoice for this Payment. Not used by StoreConnect.
Invoice URL s_c__Invoice_Url__c Text(255) No Optional URL of the invoice for this Payment. Not used by StoreConnect.
Last Error At s_c__Last_Error_At__c DateTime No The date/time the last error occurred when the system attempted to process this payment.
Latest Api Response s_c__Latest_Api_Response__c LongTextArea(131072) No [Internal Use] Latest response returned by the Payment_Provider__c.
Linked Payment s_c__Linked_Payment_Id__c Lookup (s_c__Payment__c) No Reference to a related Payment, e.g. linking a refund to its original payment.
Method s_c__Method__c Text(255) No The name of the Payment_Provider__c that created this Payment (e.g. “Stripe”).
Order s_c__Order_Id__c Lookup (Order) No Reference to the Order for which this Payment was created.
Origin s_c__Origin__c Text(255) No The cause of this Payment’s creation, for example AP01 for a payment recorded through the client API’s POST /payments endpoint. See Payment origin codes for the full list. To identify externally recorded payments, filter on this field rather than Status, because card payments taken at checkout also have the status success.
Paid At s_c__Paid_At__c DateTime No The date and time the money for this Payment was collected. Set when a charge succeeds, on the first capture of a preauthorized payment, or when a delayed-settlement payment such as ACH settles. Blank for a declined charge, a payment still awaiting capture or settlement, a payment that failed settlement, and Adyen ACH payments, which have no settlement check. Older records created before the field was populated can also be blank.
Payment Method s_c__Payment_Method_Id__c Lookup (s_c__Payment_Method__c) No Optional reference to the saved payment method used for this payment.
Payment Provider s_c__Payment_Provider_Id__c Lookup (s_c__Payment_Provider__c) No The Payment_Provider__c used to process this Payment.
Points Amount s_c__Points_Amount__c Number(18,0) No The points amount of this Payment including any surcharges.
Preauth Amount To Capture s_c__Preauth_Amount_To_Capture__c Currency(18,2) No The amount to capture from a pre-authorized payment.
Preauthorization Token s_c__Preauthorization_Token__c Text(255) No Preauthorization token used by Payment_Provider__c for capturing payment.
Reason s_c__Reason__c Text(255) No Reason for the payment action, e.g. refund reason.
Register Shift s_c__Register_Shift_Id__c Lookup (s_c__Register_Shift__c) No The Register Shift in which this payment was taken. For a refund, this is the shift in which the refund was processed, which may differ from the original order’s shift. Used by end-of-shift reconciliation.
Response s_c__Response__c Text(255) No [Internal Use] Response returned by the Payment_Provider__c.
Salesforce User Id s_c__Salesforce_User_Id__c Text(18) No Salesforce User ID of the user who initiated the payment action.
Status s_c__Status__c Picklist No Status of the payment record, e.g. success, pending, or preauthorized. Payments recorded through the client API’s POST /payments endpoint are always saved with a status of success and count toward the order’s paid balance. StoreConnect does not deduplicate POST /payments requests, so send each payment exactly once; balance-counting instead prevents collecting the same balance again through the storefront’s pay-balance flow.
Surcharge Amount s_c__Surcharge_Amount__c Currency(18,2) No The amount of the surcharge (included within the amount)
Surcharge Product s_c__Surcharge_Product_Id__c Lookup (Product2) No The product used when generating the surcharge on this payment
Transaction Number s_c__Transaction_Number__c Text(255) No Transaction number returned by the Payment_Provider__c.
StoreConnect External ID s_c__sC_Id__c Text(36) No StoreConnect External ID, do not modify in Salesforce

Relationships

Field Type Related Object Relationship Name
s_c__Linked_Payment_Id__c Lookup s_c__Payment__c Linked_Payments
s_c__Order_Id__c Lookup Order Payments
s_c__Payment_Method_Id__c Lookup s_c__Payment_Method__c Payments
s_c__Payment_Provider_Id__c Lookup s_c__Payment_Provider__c Payment_Payment_Providers
s_c__Register_Shift_Id__c Lookup s_c__Register_Shift__c Payment_Register_Shift
s_c__Surcharge_Product_Id__c Lookup Product2 Payment_Surcharge_Products

Referenced by

These objects hold a lookup or master-detail relationship to Payment (s_c__Payment__c). Where the referring record exists to join things together, Also links to shows what it connects this object to.

Object Field Type Relationship Name Also links to
s_c__Account_Credit_Ledger__c s_c__Payment_Id__c Lookup Account_Credit_Ledgers s_c__Account_Credit__c, Contact
s_c__Account_Points_Ledger__c s_c__Payment_Id__c Lookup Account_Points_Ledger_Payments —
s_c__Audit_Log__c s_c__Payment_Id__c Lookup Audit_Logs_Payment —
s_c__Payment__c s_c__Linked_Payment_Id__c Lookup Linked_Payments —
s_c__Payment_Installment__c s_c__Payment_Id__c Lookup Payment_Installment_Payment —
s_c__Payment_Item__c s_c__Payment_Id__c Lookup Payment_Item_Payment OrderItem
s_c__Voucher_Payment__c s_c__Payment_Id__c Lookup Voucher_Payment_Payments s_c__Voucher__c

On the storefront

Storefront templates read this object through the Payment Liquid object, written as payment in a theme.

Salesforce field Liquid attribute
s_c__Amount_Tendered__c payment.amount_tendered
s_c__Amount__c payment.amount
s_c__Change_Given__c payment.change_given
s_c__Invoice_Reference__c payment.invoice_reference
s_c__Invoice_Url__c payment.invoice_url
s_c__Method__c payment.payment_method
s_c__Points_Amount__c payment.points_amount
s_c__Status__c payment.status
s_c__Surcharge_Amount__c payment.surcharge_amount
s_c__Transaction_Number__c payment.transaction_number

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.

Was this article helpful?

Was this article helpful?