Stripe App Sandbox - Nango Docs

Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

Pre-built tooling

✅ Authorization

Tools	Status
Pre-built authorization (OAuth)	✅
Credentials auto-refresh	✅
Pre-built authorization UI	✅
Custom authorization UI	✅
End-user authorization guide	✅
Expired credentials detection	✅

✅ Read & write data

Tools	Status
Pre-built integrations	🚫 (time to contribute: <48h)
API unification	✅
2-way sync	✅
Webhooks from Nango on data modifications	✅
Real-time webhooks from 3rd-party API	🚫 (time to contribute: <48h)
Proxy requests	✅

✅ Observability & data quality

Tools	Status
HTTP request logging	✅
End-to-end type safety	✅
Data runtime validation	✅
OpenTelemetry export	✅
Slack alerts on errors	✅
Integration status API	✅

✅ Customization

Tools	Status
Create or customize use-cases	✅
Pre-configured pagination	🚫 (time to contribute: <48h)
Pre-configured rate-limit handling	🚫 (time to contribute: <48h)
Per-customer configurations	✅

No pre-built syncs or actions available yet.

Not seeing the integration you need? Build your own independently.

Pre-Requisites	Status	Comment
Paid dev account	✅	You must have an activated Stripe account (submit business info). No charges required, but activation is mandatory.
Paid test account	✅	Stripe does not require or support a paid test account. Sandbox accounts are available by default in every account.
Partnership	✅	Not required to develop or publish apps, but Stripe may offer partnership options for higher visibility.
App review	❌	Required if you want to publish the app publicly on the Stripe App Marketplace. Stripe will review your app before approval.
Security audit	✅	Not strictly required, but apps must follow Stripe’s security best practices. A formal audit may be needed depending on your app’s access level and data usage.

Setup guide

Create a Stripe account

If you don’t already have one, sign up for a Stripe account.

Install Stripe CLI

If you haven’t already, install the Stripe CLI.
Log in using your Stripe account:
stripe login

Install the Stripe Apps CLI plugin

Run the following command to install the Stripe Apps plugin:
stripe plugin install apps
Verify the plugin version is 1.5.12 or newer:
stripe apps -v

Create your Stripe App

Create a new app project using the CLI:
stripe apps create my-stripe-app
This creates a local project folder with a manifest and app code.

Edit the app manifest

Open the stripe-app.json file and update these fields:

stripe_api_access_type: Set to oauth
distribution_type: Set to public
allowed_redirect_uris: Add your redirect URI as https://api.nango.dev/oauth/callback
sandbox_install_compatible: Set to true Example:

{
  "id": "com.example.my-app",
  "version": "0.0.1",
  "name": "My Stripe App",
  "icon": "./icon.png",
  "permissions": [],
  "stripe_api_access_type": "oauth",
  "distribution_type": "public",
  "sandbox_install_compatible": true,
  "allowed_redirect_uris": [
    "https://api.nango.dev/oauth/callback"
  ]
}

Add required permissions and UI (optional)

Add permissions your app requires to access Stripe resources in the manifest (e.g., read_only, customers:read, etc.).

"permissions": [
    {
        "permission": "customer_read",
        "purpose": "Receive access to the customer’s phone number"
    }
]

Optionally add a settings view or other UI extensions if your app has a user-facing configuration.

Upload your app to Stripe (requires live account)

Ensure you’re logged into a fully activated (non-sandbox) Stripe account.
Upload your app to Stripe:
stripe apps upload

Sandbox accounts cannot upload apps. You must activate your account first.

Obtain your Client ID and Client Secret

Go to your app’s details page in the Stripe Dashboard.
Open the External test tab.
Click Get started if you haven’t already configured the external test OAuth setup.
After setup, Stripe will generate OAuth installation links in the Test OAuth section. Your Client ID will be included in the Sandbox link as a query parameter (e.g., client_id=…).
To obtain your Client Secret, go to the API Keys page in the Stripe Dashboard and copy your Secret key (starts with sk_test_…).

⚠️ Make sure that your client_id and secret key come from the same Stripe sandbox account and environment. Mixing keys from different environments or accounts will result in authorization errors like “Authorization code provided does not belong to you.” Save these credentials securely as you’ll need them when configuring your integration in Nango.

Follow the Quickstart.

Need help getting started? Get help in the community.

Contribute useful links by editing this page

API gotchas

The Stripe App Sandbox is a test environment that simulates real installs and OAuth flows without affecting live data. Use it for external development or testing purposes.

Contribute API gotchas by editing this page

Connect to Stripe App Sandbox

Guide to connect to Stripe App Sandbox using Connect UI

​Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

​Pre-built tooling

​Setup guide

​API gotchas

Connect to Stripe App Sandbox

Overview

Pre-built tooling

Setup guide

API gotchas