Instant Payouts promotion

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 liable for payments losses

The component renders when these conditions are met, and when Stripe is liable for payments losses:

• 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 liable for payments losses

The component shows when these conditions are met, and when the platform is liable for payments losses:

• Your platform is in a supported country for Instant Payouts, and the connected account is in the same country as the platform, and uses the local currency
• 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.

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.

curl https://api.stripe.com/v1/account_sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d account=
{{CONNECTED_ACCOUNT_ID}} \
  -d "components[instant_payouts_promotion][enabled]"=true \
  -d "components[instant_payouts_promotion][features][instant_payouts]"=true

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:

const handlePromotionLoaded = ({promotionShown}) => {
  if (promotionShown) {
    // Logic specific to when promotion is shown (i.e. 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);