Configures a payment provider to be offered as part of the checkout process. Mainly contains the necessary credentials for the provider’s API.
Property
Value
API Name
s_c__Payment_Provider__c
Label
Payment Provider
Plural Label
Payment Providers
Type
Custom Object
Fields
Field Label
API Name
Type
Required
Description
Active
s_c__Active__c
Checkbox
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
s_c__Api_Key__c
Text(255)
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
s_c__Api_Mode__c
Text(255)
Yes
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
s_c__Api_Options__c
LongTextArea(25000)
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
s_c__Api_Secret__c
Text(255)
Yes
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”.
[DEPRECATED] Channel
s_c__Channel__c
MultiselectPicklist
No
The channel supported by this payment provider provider.
Channels
s_c__Channels__c
MultiselectPicklist
No
The channels this payment provider applies to (e.g. web, pos).
Description
s_c__Description__c
LongTextArea(500)
No
Description to show on the checkout payment selection page when this payment provider is selected.
Display Name
s_c__Display_Name__c
Text(255)
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
s_c__Payment_Instructions_Markdown__c
LongTextArea(1000)
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 https://help.getstoreconnect.com/documentation/how-to-use-markdown.
Position
s_c__Position__c
Number(18,0)
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
These objects hold a lookup or master-detail relationship to Payment Provider (s_c__Payment_Provider__c). Where the referring record exists to join things together, Also links to shows what it connects this object to.
