Set up your Stripe integration

Set up the Stripe integration to access commerce data from customers who use Stripe to accept payments.

The following tasks explain how to set up both the Test and the production integrations. Test your Stripe integration explains how to use the Stripe Test integration to pull test data into Codat.

Supported environments

You can switch between test mode and live mode when building and configuring Stripe extensions. Codat provides a different integration for each mode.

Test mode lets you test Stripe extensions using test data and cards. To enable test mode, use the Test mode switch at the top right of every page:

Live mode is for accepting live payments. To enable live mode, you first need to activate your Stripe account by providing additional information about your business. You can't access live data using the Codat Stripe integration until your Stripe account is fully activated.

Two Stripe integrations are available in the Codat Portal: Stripe Test and Stripe.

Integration name

Connects to...

Pulls...

Stripe Test

Stripe in test mode, using the test client ID.

Test commerce data created in Stripe. Stripe test data is pulled for the following data types: Company info, Customers, Disputes, Payments, Products, and Transactions.

Stripe

Stripe in live mode, using the live client ID.

Live commerce data from production Stripe accounts.

Create a Stripe extension and get your test or live credentials

  1. Visit Stripe and sign in to your Stripe developer account.

  2. Click Developers to access the Developers Dashboard, then click Extensions in the side menu.

  3. Click Get started to view the Extensions page.

  4. Under Configure branding settings, click Edit. The Extension settings page opens in a new tab.

  5. Click the Test mode switch to choose between defining the extension settings for live mode or test mode. Enable test mode if you're setting up the Stripe Test integration and enable live mode if you're setting up the Stripe integration. Important: select the mode you want to use before changing any settings on the Extension settings page.

  1. In the Branding section, customize the information under Business details and Appearance, then click Save branding changes. Stripe uses these options to customize the interstitial pages that appear in the Link flow.

  2. In the Integration section, click the View test data switch to toggle between displaying the live client ID or test client ID. In this screenshot, the Test mode client ID is displayed:

  1. Under OAuth settings, click OAuth for Standard accounts.

  2. Under Redirects, click Add URI then enter the following URI: https://stripe.codat.io/oauth/callback

🚧

Check the active mode

After changing between test mode and live mode for the first time, you might need to re-select the OAuth for Standard accounts switch and re-enter the redirect URI.

  1. Copy the Test mode client ID or Live mode client ID from the Integrations section. You can paste this to a text file or similar.

  2. On the Developers Dashboard, click API keys in the side menu. The API keys page is displayed.

  3. Under Standard keys, click Reveal test key or Reveal live key to show your test or live API key. Leave this browser tab open so you can copy the key to use in the following procedure.

If you need to add or change a key in future, you can search for API Keys in the Stripe Developers Dashboard.

Add your extension's secure credentials to the integration

Next, add the secure credentials for your Stripe extension to the Stripe Test or Stripe integration in Codat.

In the Codat Portal:

  1. In the navigation bar, click Integrations > Commerce.

  2. Configure the correct Stripe integration depending on whether you're testing the integration or building for production.

    • If live mode is enabled for your Stripe extension, click Manage next to the Stripe integration.
    • If test mode is enabled for your Stripe extension, click Manage next to the Stripe Test integration.

    The Stripe Credentials or Stripe Test Credentials page is displayed.

  3. Under Access to company data, configure the permitted sync frequency for the integration. Select Allow one-off data sync… or Allow continuous data sync.

  4. Enter the client ID for your Stripe extension in the Client ID box.

    • If live mode is enabled for your Stripe extension, enter the Live mode client ID.
    • If test mode is enabled for your Stripe extension, enter the Test mode client ID.
  5. In the Secret Key box, enter the test key or live key value for your Stripe extension (see step 12 of the preceding task).

  6. Click Save.

Enable the integration

In the Codat Portal:

  1. In the navigation bar, click Integrations > Commerce.

  2. Click the toggle next to Stripe Test or Stripe to set the integration to Enabled.

If the integration is enabled successfully, the switch remains set to Enabled. If authentication fails, an error displays and the switch reverts to Disabled. Check that your Stripe credentials were entered into the Portal correctly.

Check the commerce sync settings

Syncing of all commerce data types must be enabled before you can pull commerce transactions from Stripe to Codat. Follow the steps in Commerce sync settings; you only need to do this once.


Did this page help you?