ChargeOver

What’s supported

Supported actions

This connector supports:

• Read Actions, including full historic backfill. Incremental reading is supported for the objects listed below. For all other objects, a full read of the ChargeOver instance will be done per scheduled read.
• Write Actions.
• Proxy Actions, using the base URL https://{{.workspace}}.chargeover.com.

Supported objects

The ChargeOver connector supports reading from the following objects:

• _chargeoverjs
• _customfield
• _integration_map
• _log_system
• _report
• _resthook
• ach
• admin
• brand
• campaign
• class
• country
• coupon
• creditcard
• currency
• customer (supports incremental read)
• invoice (supports incremental read)
• item
• item_category
• language
• note
• package (supports incremental read)
• quote (supports incremental read)
• terms
• tokenized
• transaction (supports incremental read)
• usage (supports incremental read)
• user

The ChargeOver connector supports writing to the following objects:

• _resthook
• ach
• creditcard
• customer
• invoice
• item
• note
• package
• quote
• sms
• tokenized
• usage

Example integration

For an example manifest file of a ChargeOver integration, visit our samples repo on GitHub.

Before you get started

To connect ChargeOver with Ampersand, you will need a ChargeOver account.

Creating ChargeOver credentials

To begin using the API in your ChargeOver account, you need to enable REST API support:

1. Navigate to Settings.
2. Click on Developers > More Dev Tools.
3. Click the Get Started button under REST API.
4. Enable the REST API. Once enabled, your username and password for Basic Authentication will be displayed.

Note your domain name - this is the subdomain in your ChargeOver URL (e.g., if your URL is https://mycompany.chargeover.com, your domain name is mycompany). See the ChargeOver getting started guide for details.

Using the connector

This connector uses Basic Auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To start integrating with ChargeOver:

• Create a manifest file like the example above.
• Deploy it using the amp CLI.
• If you are using Read Actions, create a destination.
• Embed the InstallIntegration UI component. The UI component will prompt the customer for their domain name, username and password.
• Start using the connector!
  • If your integration has Read Actions, you’ll start getting webhook messages.
  • If your integration has Write Actions, you can start making API calls to our Write API.
  • If your integration has Proxy Actions, you can start making Proxy API calls.