Payout details

Payout details renders the details of a given payout. Its UI is equivalent to the overlay that the payouts embedded component renders when the user clicks a payout row.

This component allows you to render the payout detail overlay directly from your UI. For example, you can invoke it from a custom payouts list instead of using the payouts embedded component.

When creating an Account Session, enable payout details by specifying payout_details in the components parameter.

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

After creating the account session and initializing ConnectJS, you can render the payout details component in the front end:

// Include this element in your HTML
const payoutDetails = stripeConnectInstance.create('payout-details');
payoutDetails.setPayout('{{PAYOUT_ID}}');
// use setOnClose to set a callback function to close payout-details
payoutDetails.setOnClose(() => {
  payoutDetails.remove();
});
container.appendChild(payoutDetails);

Supported parameters

This embedded component supports the following parameters: