---
title: "CBOSS"
source: https://support.storeconnect.com/articles/cboss-payment-provider
type: article
format: markdown
site: StoreConnect Support — product and developer documentation for StoreConnect
site_index: https://storeconnect.com/llms.txt
docs_index: https://support.storeconnect.com/llms.txt
note: Append .md to any page or article URL on this site to get its Markdown form.
---
# CBOSS

CBOSS takes card payments for your online store on a hosted payment page. Customers select CBOSS at checkout, enter their card details on the CBOSS page, and return to your store when the payment is complete.

Use this process to add CBOSS to the provider list in Salesforce and connect your CBOSS account to your store.

CBOSS works with web checkout only. It does not support subscriptions, pre-authorization, Apple Pay, Google Pay, express checkout, or POS. StoreConnect cannot refund a CBOSS payment, so issue refunds in your CBOSS account.

## Before you start

- You have a CBOSS account with a client account number and an originator ID for your store.
- You have the API key and API secret that CBOSS supplied for the integration.
- You have Salesforce admin access to edit fields in **Object Manager**.

## Add CBOSS to the Provider picklist

CBOSS is not one of the values in the **Provider** picklist on the **Payment Provider** object, so you add it yourself. Do this first, because you select it in the next section.

1. In Setup, go to **Object Manager** > **Payment Provider** > **Fields & Relationships**.
2. Open the **Provider** field.
3. Click **Edit**.
4. Clear the **Restrict picklist to the values defined in the value set** checkbox, then click **Save**.
5. In the **Values** section, click **New**.

   :::warning
   Enter the value exactly as `Cboss`, with a capital C and the rest lowercase. Any other spelling, such as `CBOSS`, saves without an error, but the CBOSS payment form never appears at checkout.
   :::

6. Enter `Cboss`, then click **Save**.

`Cboss` now appears in the **Values** list for the **Provider** field.

## Create the CBOSS payment provider

1. Go to the **Payment Providers** list.
2. Click **New**.
3. Complete the fields as follows:

   | Field | Value |
   |-------|-------|
   | Store | The store that takes CBOSS payments |
   | Display Name | The name customers see at checkout, for example `Credit card` |
   | Provider | `Cboss` |
   | API Mode | `production` to take live payments. Any other value, such as `sandbox`, sends payments to the CBOSS test environment. |
   | API Key | The API key supplied by CBOSS |
   | API Secret | The API secret supplied by CBOSS |
   | API Options | Your client account number and originator ID, in the format shown in the next step |
   | Channels | `Web` |
   | Active | Checked |

4. In **API Options**, enter your client account number as `client_id` and your originator ID as `application_id`, one per line:

   ```yaml

   client_id: 1234
   application_id: 38
   ```

5. Click **Save**.

Your store's checkout now lists CBOSS under the **Display Name** you entered. When a customer selects it and pays, the CBOSS payment page opens with the order total, and a successful payment returns the customer to your store to complete the order.

---

## Follow StoreConnect

- [Email Newsletter](https://storeconnect.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://storeconnect.com/partners)
- [Become a Partner](https://storeconnect.com/become-a-partner)
- [News](https://storeconnect.com/articles/news)
- [Events](https://storeconnect.com/articles/events)
- [Feature Comparison](https://storeconnect.com/how-we-compare)
- [Download a free trial](https://appexchange.salesforce.com/appxListingDetail?listingId=a0N3A00000FMkeKUAT)
- [Book a Demo](https://storeconnect.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

## Machine-readable

- [Site index for agents](https://storeconnect.com/llms.txt): curated map of the StoreConnect site in llms.txt format
- [Documentation index for agents](https://support.storeconnect.com/llms.txt): full technical and product documentation map

Every page and article on this site has a Markdown rendering: append `.md` to its URL.

Continue in Markdown: [Help documentation](https://support.storeconnect.com/help-documentation.md) · [Developer reference](https://support.storeconnect.com/developer-reference.md) · [Videos & tutorials](https://support.storeconnect.com/videos-tutorials.md) · [Release notes](https://support.storeconnect.com/release-notes.md)

---

StoreConnect Support — https://support.storeconnect.com/articles/cboss-payment-provider