Stripe
This page explains how to add Stripe as a source in Reveal. To connect Stripe, you need a Stripe restricted key. A restricted key limits Reveal to the specific permissions it needs. To create the restricted key, see Create your Stripe restricted key.
Add Stripe as a source in Reveal
Before you start, create your Stripe restricted key and copy your Stripe publishable key. See Create your Stripe restricted key.
- On your Reveal dashboard, head to Settlements.
- Click Sources > Add source.
- Select Stripe.
- On the Restricted Key field, enter your Stripe restricted key that you copied from Stripe.
- In the Alias field, enter an identifier for this Stripe account, such as the business name or MID.
- Click Connect.
- You will see a prompt reading 'Integration successful'. You can now track the added source by clicking the 'Sources' section.
Create your restricted key in Stripe
Note
Reveal requests read-only access to your Stripe data. The only exception is Webhook Endpoints, which needs write access so Reveal can create the webhook it uses to receive events from Stripe. For more on how Reveal handles your data, see Data policies, processes, and methods.
- Navigate to your Stripe dashboard.
- Click Developers on the bottom left corner. Select API keys.
- Click the 'Create restricted key' button. Among the reasons shown in the modal, select 'Providing this key to a thurd-party application. Click Continue.
- On the 'Create a restricted key' modal, fill in the Name and URL fields. You may want to name this 'Reveal' and give Reveal as the website (if Stripe asks for this).
- Check the 'Customize permissions for this key' box incase you plan on connecting a third party app other than Reveal.
Set the following permissions when you create the key.
| Resource type | Permissions | Connect permissions |
|---|---|---|
| All core resources | Read | Read |
| Webhook Endpoints | Write | - |
| All Billing resources | Read | Read |
| All Reporting resources | Read | Read |
| All Connect resources | Read | - |
| Radar | Read | - |
- On choosing the permissions, click 'Create key'.
- You will receive a verification email from Stripe. Access your email and verify your identity by clicking the button.
- You will now land on Stripe's 'restricted key' modal. Copy this
restricted keyand store it in a secure and retrievable place. - Back in your Reveal dashboard, you will be asked for:
- Restricted Key: Enter the
restricted keycopied from Stripe. - Alias: Enter an identifier (business name or MID) for this Stripe account corresponding to the keys.
- Restricted Key: Enter the
Use the restricted key to add Stripe as a source in Reveal.
Was this article helpful?