调至内容部分
创建账户
或
登录
Stripe 文档徽标
/
询问人工智能
创建账户
登录
开始
付款
销售收入
平台和交易市场
资金管理
开发人员工具
概览
版本管理
更改日志
升级您的 API 版本
升级 SDK 版本
开发人员工具
SDK
API
测试
Workbench
事件接收端
工作流程
Stripe CLI
Stripe Shell
开发人员管理平台
代理工具包
使用大语言模型构建Stripe for Visual Studio CodeStripe 健康警报文件上传
安全与隐私
安全
隐私
扩展 Stripe
Stripe 应用程序
    概览
    开始
    创建应用程序
    Stripe Apps 的原理
    示例应用程序
    构建应用
    存储密钥
    API 认证方法
    授权流程
    服务器端逻辑
    侦听事件
    处理不同模式
    启用沙盒支持
    应用设置页面
    构建 UI
    轻松入驻
    发布您的应用
    分发选择
    上传您的应用
    版本与发布
    测试您的应用
    发布您的应用
    推广您的应用
    添加深度链接
    创建安装链接
    在 UI 扩展中分配角色
    安装后操作
    应用程序分析
    应用程序嵌入式组件
    嵌入第三方 Stripe 应用
    迁移到 Stripe 应用
    迁移或构建扩展
      旧版扩展
    将插件迁移到 Stripe 应用程序或 Stripe Connect
    参考编号
    应用描述文件
    CLI
    扩展 SDK
    权限
    视口
    设计样式
    组件
Stripe Connector
合作伙伴
合作伙伴生态
合作伙伴认证
首页开发人员工具Stripe AppsMigrate or build an extension

注意

该页尚未提供此语言版本。我们正在加紧将我们的文档翻译成更多语言,很快将为您提供译文。

Legacy extensions已废弃

Learn about the deprecated extensions integration pattern and historical reference information.

Stripe Apps replaces extensions

You can no longer build new Stripe extensions. Stripe Apps replaces extensions for developing on Stripe.

Learn more about building a Stripe App.

If you have an existing legacy extension, view the Stripe Apps migration docs.

注意

You can now automatically send your Stripe data and reports to Snowflake or Amazon Redshift in a few clicks with Stripe Data Pipeline. Learn more.

Build an extension Deprecated

Stripe’s products and features allow companies to accept online payments, but offer other reasons to integrate as well. Companies like Baremetrics and Segment build on top of Stripe to provide their services to Stripe accounts with a Standard dashboard.

Building an extension on Stripe consists of four steps:

  1. Configure OAuth and specify a redirect URI.
  2. Configure branding settings.
  3. Create an OAuth link for your users.
  4. Use the API on behalf of connected accounts.

You’re also required to add business details to activate your account, if you haven’t already.

To get started, visit the Extensions page located in the Developers tab of the Stripe dashboard.

Configure OAuth and specify a redirect URI

You can configure this setting in the Integration section of the Extensions Settings page.

Start your integration by toggling the button to enable onboarding Standard accounts with OAuth. Extensions shouldn’t use OAuth with Express accounts.

Stripe provides a unique identifier for your extension called a client_id. You set the redirect_uri and users are directed to that page after they connect their accounts. You must specify all redirect URIs in your extension settings. The development and production versions of these two values help with testing. Take note of these values so you can create an OAuth link in the third step.

Configure branding settings

You can customize how your business appears to your users in the Branding section of the Extensions Settings page.

Users see your logo when they link their Stripe accounts to your application. After they link their accounts, your icon displays in their connected applications list.

Create an OAuth link for your users

OAuth 2.0

For more information, read the Connect OAuth Reference. You can also use an OAuth 2.0 client to implement the flow for you.

Stripe offers a standard OAuth 2.0 flow to connect to Stripe accounts. Using the client_id and redirect_uri values from step one, you can create an OAuth link for your users to onboard with. We recommend showing this link with a Connect with Stripe button that sends users to the authorize_url endpoint:

https://connect.stripe.com/oauth/authorize?response_type=code&client_id=ca_FkyHCg7X8mlvCUdMDao4mMxagUfhIwXb&scope=read_only

Here’s an example of how you can display the above link to your user, along with the Connect with Stripe button:

连接

After the user clicks the link on your site, we redirect them to a page to allow or deny the connection to your extension. Stripe’s authorization flow prompts them to either choose an existing account to connect with your extension, or create a new one.

After the user connects their existing or newly created account to your extension, we redirect them back to the URL you set as your extension’s redirect_uri .

At the end of the OAuth workflow, you’re provided with authorization credentials for the user’s account:

{ ... "stripe_user_id": "acct_0123456789", ... }

You need to store the stripe_user_id so you can identify user accounts.

Use the API on behalf of connected accounts

After users link their Stripe accounts to your application, you can make API requests on their behalf. To perform API requests, you need your extension account’s secret key, and a Stripe-Account header that identifies the account that you’re making the request for. All Stripe libraries support this style of authentication on a per-request basis.

Fetching stored data

Stored data includes information like charges and customer details. With read_only access, you can make most GET requests in Stripe’s API. You can retrieve a single object (for example, retrieve a Payment Intent) or a list of objects (for example, list all Payment Intents).

Command Line
curl
curl https://api.stripe.com/v1/payment_intents \ -u
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:
\ -d "created[lte]"=1612048287 \ -d "limit"=50 \ -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}"

While the API performs at a high level, repeatedly fetching large data sets slows your application’s responsiveness. We recommended storing fetched data on your side for analysis and reporting.

Listening for real-time data

In addition to stored data, you can access real-time data through webhooks. After you define an extension webhook endpoint in your account, Stripe sends event notifications to your endpoint for every connected account. The event object’s account property identifies the account where the event occurred.

For example, the event below shows that a customer was created in the acct_0123456789 account. Again, we recommend storing this data on your side for analysis and reporting. By watching events as they occur, your application can respond faster, and you won’t need to make as many API calls.

{ "id": "evt_s2Vou5FYSwfCpH", "livemode": true, "object": "event", "type": "customer.created", "account": "acct_0123456789", "pending_webhooks": 2, "created": 1349654313, "data": {...} }

Charging for your application

Your extension’s Stripe account can process its own charges, so you can still charge for your application with read_only access. After customers connect their Stripe accounts, ask for their payment details and then create a subscription for them in your Stripe account. Make sure to store the created customer ID with the associated Stripe account ID, so that you can track which users are paid and active, and which ones are not.

If you create subscriptions, you can also specify an application_fee_percent as a fee for your application. This is charged on top of any Stripe fees. Read the Subscriptions documentation to learn more.

Disconnected accounts

Users can disconnect their accounts from your integration at any time. When this happens, Stripe sends an account.application.deauthorized webhook. You can use this notification to trigger cleanup on your end, such as disabling the user’s account on your site or removing their data.

You can also disconnect accounts from your integration, by making a request to the OAuth deauthorization endpoint.

此页面的内容有帮助吗?
是否
需要帮助?联系支持。
加入我们的早期使用计划。
查看我们的更改日志。
有问题?联系销售。
LLM? Read llms.txt.
Powered by Markdoc