New in Chargebee: Explore Reveal and understand your payment performance end-to-end.Try Now
Docschargebee docs
HomeBillingCPQPaymentsRevRecGrowthReveal
Support

Introduction


  • Overview

Transactions


  • Get Started
    • Adyen
    • Braintree
    • PayPal
    • Shopify Payments
      • Shopify Payments Staff Account
    • Stripe
  • Insights
  • Understand Payment Performance
  • Alerts

Settlements


  • Get Started
    • Adyen
    • Braintree
    • PayPal
    • Shopify Payments
      • Shopify Payments Staff Account
    • Stripe
  • Reconciliation
  • Fees
  • Records

Data Security


  • Data Control
  • PII Data
  • Card Vaulting
  • Data Policies, Processes and Methods

Glossary


  • Standard Terms
  1. Reveal
  2. Transactions
  3. Get Started
  4. Shopify Payments
  1. Reveal
  2. Transactions
  3. Get Started
  4. Shopify Payments

Shopify Payments

Why connect Shopify Payments for Transactions

Connect Shopify Payments as a source so Reveal can import payment activity from your Shopify store into Transactions. After the connection is complete, Reveal imports historical data and continues to monitor live activity so you can:

  • Track authorization and decline rates for Shopify Payments
  • Diagnose failures, including disputes
  • Act on payment-performance changes from Insights and Alerts

The same Shopify Payments source can also feed Settlements, so finance teams can reconcile payouts, track unsettled volume, and analyze processing fees. Connecting Shopify Payments does not change how payments are processed. Reveal reads data from Shopify; it does not modify live payment flows.

See Get started with Transactions for the overall connection workflow. If your goal is payout reconciliation rather than authorization analytics, see Connect Shopify Payments for Settlements.

How the Shopify Payments guide differs from the staff account page

This page is the connection guide for Shopify Payments in Transactions. Use it to create a private app exclusive to your store, collect the Access Token and Shop Name, and add Shopify Payments as a source in Reveal.

Shopify Payments staff account is the Shopify-side staff checklist. Use that page to invite Reveal as a staff user and assign the permissions Reveal needs. After you complete the staff invite, return here if you still need to add the source.

Reveal needs these values to complete the connection:

  • Access Token
  • Shop Name / Shop URL
  • Alias

Connecting Shopify Payments involves multiple steps. While it doesn't require any coding, there are quite a few steps to follow, and missing any of them can cause issues.

You will need to create a private app in Shopify that is exclusive to your store.

To add Shopify Payments to your Reveal Transactions dashboard, complete the following steps:

  1. Create a private app in Shopify
  2. Add Shopify Payments as a source in Reveal
  3. Add Reveal as a staff user in Shopify

Prerequisites

After you create and install the app for your store in your Shopify account, you will get the API credentials to connect your store to the Chargebee Reveal dashboard.

Create a private app in Shopify

Create a private app exclusive to your store so Reveal can read orders, payouts, disputes, and related Shopify Payments data through the Admin API.

Note

Shopify's admin can change. Refer to Generate access tokens for admin-created custom apps for where to retrieve the Admin API access token and which Admin API scopes to assign. For the current steps to create a new app, refer to Create apps using the Dev Dashboard. The instructions in this section are a working guide for connecting Reveal.

  1. Navigate to Shopify Admin > Settings > Apps and Sales channel > Develop apps > Create an app.

    Shopify admin Settings page showing the path to Apps and sales channels and Develop apps.
  2. Give a name for the private app and select yourself as the developer's email address, then click on Create app.

  3. On the next page, click Configure Admin API scopes.

  4. Select the following scopes:

    • read_orders
    • read_reports
    • read_shopify_payments_payouts
    • read_analytics
    • read_shopify_payments_disputes
    • read_draft_orders
    • read_order_edits
    • read_returns
    • read_shopify_payments_accounts
    Shopify admin API scopes list with the read scopes required for Reveal selected.
  5. Now click Install app.

  6. Once your app is installed, click on API credentials to view the Access token.

Note Access Token can be viewed only once. Store it in a secure place from where you can retrieve it later if needed.

Add Shopify Payments as a source in Reveal

  1. You should have the following values ready to add Shopify Payments as a Source in your Reveal dashboard:
    • Access Token that you should have from the first step of this integration, and
    • Shop Name/Shop URL.
  2. To collect Shop Name/Shop URL, click on Home.
  3. Copy the string that is after admin.shopify.com/store/ from your browser.
    Shopify admin browser address bar showing the shop name after admin.shopify.com/store/.
  4. In the example above, it is myshopifydemo.
  5. Now, go to your Reveal dashboard > Sources > Add a source.
  6. Click on Shopify Payments.
  7. Paste the Access Token and Shop Name that you copied in the relevant fields.
  8. Add an alias to identify this source.
  9. Click Connect.

Add Reveal as a staff user in Shopify

This guide walks you through the steps for inviting Reveal to your Shopify Payments store. For the dedicated staff-account checklist, see Shopify Payments staff account.

Note

Shopify's Users and permissions settings can change. Refer to Inviting users for the latest steps to add a staff user from Settings > Users. Refer to Store permissions for the current names of the Home, Orders, Draft orders, Analytics, App development, Finance, and Apps and channels permissions. The instructions in this section are a working guide for connecting Reveal.

Invite Reveal as a staff user

You can add staff accounts to your Shopify store to let staff log in as separate users. To add staff, you need to be the store owner or have the Edit permissions and Add and remove staff permissions.

If you want to add staff who can log in to your admin and to Shopify POS to add POS app-only staff, then you also need the Manage Point of Sale staff permission and the required Shopify POS permissions.

Follow these steps:

  1. From your Shopify admin, click Settings > Users and permissions.
  2. Click Add staff.
  3. Enter the staff member's full name as it is displayed on any government-issued ID, and their email address.
  4. Do one of the following:
    • Select which permissions you want to give the staff member.
    • To give the staff member all available permissions, select Select all.
    • Click Send invite.

Required permissions for Reveal staff

Following are the permissions that you need to provide to Reveal staff account:

General staff permissions

Following are the general staff permissions:

  1. Home
  2. Orders: View Orders, Export Orders
  3. Draft Orders: View
  4. Analytics: Reports and Dashboards
  5. App development: Select all 3 options
  6. Finance: View Shopify Payments Payouts, View Balance Activity, View all Shopify credit account activity

Apps and channels permissions

  • Manage and install apps and channels

Take the next step with Shopify Payments in Transactions

  • Shopify Payments staff account — Invite Reveal as a staff user and assign the permissions Reveal needs.
  • Get started with Transactions — Connect other processors and see what happens after data loads.
  • Insights — Review authorization health after Shopify Payments data is available.
  • Shopify Payments for Settlements — Connect the same Shopify Payments store for reconciliation and fees if you also use Settlements.

Was this article helpful?