Instant Payouts promotion

Show promotional content to increase Instant Payout conversion for your connected accounts.

Render a UI component for connected accounts that displays the ability to make an Instant Payout, and the amount of funds available to pay out instantly. Connected accounts can initiate an Instant Payout through this component by clicking the call-to-action button.

Display dynamic content

This component displays dynamic content (header, subheader, call-to-action text) per-connected account to increase instant payout usage. The content can change based on time (for example, weekends).

In addition, this component always shows the amount eligible for Instant Payouts.

Display logic

For connected accounts where Stripe is responsible for negative balances

The component renders when the following conditions are met:

• Stripe is responsible for negative balances ( defaults.responsibilities.losses_collector has the value stripe )
• The connected account has funds eligible for Instant Payouts (as determined by Stripe )
• In the component parameters, enabled is set to true

The component doesn’t render any UI otherwise.

For connected accounts where the platform is responsible for negative balances

The component renders when the following conditions are met:

• The platform is responsible for negative balances ( defaults.responsibilities.losses_collector has the value application )
• Your platform and connected account are in a supported country for Instant Payouts and meet the eligibility criteria
• Your platform has configured Instant Payouts pricing in the platform pricing tool . You must configure separate pricing rules for each Instant Payout currency.
• The connected account has available funds to pay out
• In the component parameters, enabled is set to true

The component doesn’t render any UI otherwise.

Note

You’re liable for uncovered negative balances caused by refunds or disputes and are responsible for managing risk and eligibility for Instant Payouts. Additionally, you can determine whether the UI renders in the onInstantPayoutsPromotionLoaded callback function.

Create an account session

When creating an account session, enable the Instant Payouts promotion component by specifying instant_payouts_promotion in the components parameter. This component requires the instant_payouts feature to be enabled.

Command Line

Select a language

cURL

Stripe CLI

Ruby

Python

PHP

Java

Node.js

Go

.NET

No results

Rendering the component

After creating the account session and initializing ConnectJS, you can render the Instant Payouts promotion component in the front end. This component provides two optional callback handlers so platforms can track connected account usage:

instant-payouts-promotion.js

Select a language

JavaScript

React

No results

const handlePromotionLoaded = ({promotionShown}) => {
 if (promotionShown) {
 // Logic specific to when promotion is shown (for example, track in analytics)
 } else {
 // ...
 }
};

const handleInstantPayoutCreated = ({payoutId}) => {
 console.log('Instant Payout created:', payoutId);
};

const container = document.getElementById('instant-payouts-promotion-container');
const instantPayoutsPromotion = stripeConnectInstance.create('instant-payouts-promotion');

instantPayoutsPromotion.setOnInstantPayoutsPromotionLoaded(handlePromotionLoaded);
instantPayoutsPromotion.setOnInstantPayoutCreated(handleInstantPayoutCreated);

container.appendChild(instantPayoutsPromotion);