Payment_Provider__c Object Reference

Field Definitions

Field Name Type Required Unique Description
Active__c Checkbox(true) No No If enabled this Payment Provider will appear as an option in the Store checkout. If disabled it will not appear in the checkout.
Api_Key__c Text No No The API key for the payment provider’s API that you will have received from the payment provider. This is the public part of your credentials, akin to a username. It may also be referred to as a “Client ID” (such as with PayPal), or simply a “key”. This should not be confused with the “secret” or “private” key.
Api_Mode__c Text Yes No The mode of the payment provider’s API to use. This is determined by the terminology of the API is question, and will likely be a word similar to the following: “test”, “sandbox”, “live”, etc.
Api_Options__c LongTextArea No No This allows you to provide other options that are required for this API connection to work. The required format of this field depends on the payment provider being used. Please reference the relevant StoreConnect Payment Gateway provider documentation for details on what is supported for your gateway.
Api_Secret__c Text Yes No The API secret key for the payment provider’s API that you will have received from the payment provider. This is the private/secret part of your credentials, and could also be referred to as a “Password” or “Private Key”.
Description__c LongTextArea No No Description to show on the checkout payment selection page when this payment provider is selected.
Display_Name__c Text No No The name of the payment provider that you want to show up on the available payment providers list on the website.
Payment_Instructions_Markdown__c LongTextArea No No Payment Instruction to show on the order summary page when this payment provider is used. Use Markdown or HTML to format your text. Find out more at
Position__c Number(18, 0) No No The position of this payment provider on the store checkout page. Lower numbers are shown first, payment providers without a position are then ordered by name
Provider__c Picklist Yes No The payment provider, e.g. Stripe, PayPal, etc.
Store_Id__c Lookup(Store__c) Yes No The store that this payment provider belongs to.
Surcharge_Product_Id__c Lookup(Product2) No No This product contains the price to surcharge on the order total when using this payment method
sC_Id__c Text No Yes StoreConnect External ID, do not modify in Salesforce

For more information about how or when to use the above, see our documentation.


Back to Documentation