Private preview
Financial account rewards Private preview
Show reward earnings for a connected account's financial account.
The financial account rewards component shows connected accounts the lifetime rewards, current-month accrual, next payout date, annual reward rate, and monthly payout history for a financial account. To learn about eligibility and configure rewards, see Platform cash rewards.
The component is in private preview and requires @stripe/connect-js version 3.4.8-preview.0 or later, or @stripe/react-connect-js version 3.4.8-preview.0 or later. Learn more about private preview components.
Create an Account Session
First, set up Connect embedded components. When you create an Account Session, enable the Financial account rewards component by setting components.financial_account_rewards.enabled to true.
Command Line
Select a language
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
Render the component
financial-account-rewards.js
const financialAccountRewards = stripeConnectInstance.create('financial-account-rewards');
financialAccountRewards.setFinancialAccount("{{FINANCIAL_ACCOUNT_ID}}");
// Add the component to an existing element on your page.
container.appendChild(financialAccountRewards);
Supported parameters
This embedded component supports the following parameter:
| Method | Type | Description | |
|---|---|---|---|
setFinancialAccount | string | The ID of the financial account to display rewards for. | required |
Request access
Request early access to cash rewards
The cash rewards feature is currently limited to preview users. Enter your email address to request access.
