# Payment Provider Object Reference Source: https://support.storeconnect.com/articles/payment-provider-object-reference ยท Last modified 21 August 2026 ## Overview 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 | | Provider | `s_c__Provider__c` | Picklist | Yes | The payment provider, e.g. Stripe, PayPal, etc. | | Store | `s_c__Store_Id__c` | Lookup ([s_c__Store__c](store-object-reference)) | Yes | The store that this payment provider belongs to. | | Surcharge Product | `s_c__Surcharge_Product_Id__c` | Lookup ([Product2](product2-object-reference)) | No | This product contains the price to surcharge on the order total when using this payment method | | 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__Store_Id__c` | Lookup | [s_c__Store__c](store-object-reference) | Store_Payment_Providers | | `s_c__Surcharge_Product_Id__c` | Lookup | [Product2](product2-object-reference) | Payment_Provider_Surcharge_Products | ## Referenced by 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. | Object | Field | Type | Relationship Name | Also links to | |--------|-------|------|-------------------|---------------| | [s_c__Payment__c](payment-object-reference) | `s_c__Payment_Provider_Id__c` | Lookup | Payment_Payment_Providers | โ€” | | [s_c__Payment_Method__c](payment-method-object-reference) | `s_c__Payment_Provider_Id__c` | Lookup | Payment_Methods_Payment_Provider | [Contact](contact-object-reference) | | [s_c__Subscription__c](subscription-object-reference) | `s_c__Payment_Provider_Id__c` | Lookup | Payment_Provider | โ€” | --- ## Follow StoreConnect - [Email Newsletter](https://getstoreconnect.com/c/lp-newsletter) - [LinkedIn Newsletter](https://www.linkedin.com/build-relation/newsletter-follow?entityUrn=7444956928444862464) - [YouTube](https://www.youtube.com/channel/UCngKdP2x8l1wcbAKW3tvU8g) - [LinkedIn](https://www.linkedin.com/company/storeconnect) - [X / Twitter](https://x.com/storeconnecthq) ## Popular Links - [Partners](https://getstoreconnect.com/partners) - [News](https://getstoreconnect.com/articles/news) - [Events](https://getstoreconnect.com/articles/events) - [Feature Comparison](https://getstoreconnect.com/how-we-compare) - [Download a free trial](https://appexchange.salesforce.com/appxListingDetail?listingId=a0N3A00000FMkeKUAT) - [Book a Demo](https://getstoreconnect.com/contact) ## Documentation - [Help documentation](https://support.storeconnect.com/help-documentation) - [AI agents](https://support.storeconnect.com/ai) - [Videos & tutorials](https://support.storeconnect.com/videos-tutorials) - [Developer reference](https://support.storeconnect.com/developer-reference) - [Release notes](https://support.storeconnect.com/release-notes) - [Troubleshooting](https://support.storeconnect.com/troubleshooting) - [Trust Center](https://trust.getstoreconnect.com/) - [Status Page](https://status.storeconnect.com/) ## Contact - info@getstoreconnect.com - US +1 415 745 3230 - AUS +61 2 8365 2308 100 S Ashley Dr, Suite 600-2461 Tampa FL 33602-600 USA Level 22, Sydney Place 180 George Street Sydney, NSW, 2000, AUS --- StoreConnect Support โ€” https://support.storeconnect.com/articles/payment-provider-object-reference