ChargeOver API Authentication

How to authenticate ChargeOver API requests: one Bearer API key plus a connectionId. MindCloud stores your ChargeOver credentials — no auth headers to build.

Every ChargeOver API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your ChargeOver account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a ChargeOver connection in Connections. ChargeOver uses a username and password. You enter them when you create the connection — MindCloud stores them securely so your requests never carry raw credentials.
Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected ChargeOver account that should run the action. MindCloud stores and refreshes the ChargeOver credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Customers with an ChargeOver connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/chargeOver/actions/list-customers/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which ChargeOver account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect ChargeOver

You need your ChargeOver Site Name, API Username, and Private Key. ChargeOver only shows the Private Key once when it is generated.

Open the REST API settings
Sign in to ChargeOver and go to Settings > Developers > More Dev Tools > REST API.
Enable REST API access
Turn on REST APIs if they are currently disabled for the tenant.
Create API credentials
Click Add New API Credentials, enter a name for the credential, and generate the pair.
Copy the API Username and Private Key
Save both values somewhere secure before you leave the page.
Enable the new credential
Enable the API against the new credential so external requests can authenticate successfully.
Enter the connection values in MindCloud
Use your tenant subdomain as Site Name, then enter the API Username and Private Key in the connection form.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.