Stripe
Creating API keys in Stripe
- Log in to your Stripe account.
- In your Stripe dashboard, click on Developers.
- Click on API Keys.
- You can choose to create a new Secret Key if you want to.
- Copy the Publishable key and Secret key.
Adding Stripe as a source in Reveal
- Copy the following keys that you created from the previous steps:
- Secret Key
- Publishable Key
- Go to your Reveal dashboard for Transactions or Settlements.
- Click on Sources > Add a new source.
- Select Stripe.
- Paste the keys in the relevant fields.
- Add an alias.
- Click on Connect.
Using restricted keys in Stripe
You can use Stripe's Restricted API keys instead of Secret keys. Creating Stripe-Restricted keys is straightforward. This guide provides both a quick summary and detailed instructions.
Follow these steps to create restricted keys:
- Navigate to this link OR
Developers:arrow_right:Create Restricted Keyand give an identifiable name to the restricted key. You may want to name this 'Reveal' and give reveal.ioas the website (if Stripe asks for this). - Copy this
restricted keyand store them in a secure and retrievable place. - On the Reveal dashboard you will be asked for:
- Secret Key: Enter the
restricted keycopied in Step 2. - Publishable Key: Copy the publishable key from Developers > API keys or this link on the Stripe dashboard.
- Alias: Enter an identifier (business name or MID) for this Stripe account corresponding to the keys.
- Secret Key: Enter the
Here is the list of permissions to be provided to every RESOURCE TYPE:
| RESOURCE TYPE | PERMISSIONS | CONNECT PERMISSIONS |
|---|---|---|
| All core resources | Read | Read |
| All Checkout resources | Read | Read |
| All Billing resources | Read | Read |
| All Connect resources | Read | - |
| All Orders resources | Read | Read |
| All Reporting resources | Read | Read |
| All webhook resources | Write | - |
| Stripe CLI permissions | None | None |
| All Payment Links resources | None | None |
| All Terminal resources | Read | Read |
| Tax | Read | Read |
| Radar | Read | Read |
| All Climate resources | Read | Read |
Detailed steps to create restricted keys
Follow these steps to create restricted keys:
- Log in to your Stripe Account.
- Go to Developers > Create Restricted Key.
- Provide a Key Name. This is an identifier of your choice.
- In the resource type, provide Write access to:
- All Webhook Resources
- In the same resource type section, provide Read access to the following resources:
- All Core Resources
- All Checkout Resources
- All Billing Resources
- All connect resources
- All Order resources
- Stripe CLI permissions
- All Payment Link Resources
- Tax
- Terminal Resources
- Radar
- Climate resources
- All Reporting Resources
- Click on Create Key in the bottom right corner of the screen.
- Copy the keys and store it in a secure and retrievable place.
- Use this restricted key along with the publishable key in your Reveal dashboard to add Stripe as a source.
Was this article helpful?