Payout details

Show details of a given payout.

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.

Command Line

Select a language

cURL

Stripe CLI

Ruby

Python

PHP

Java

Node.js

Go

.NET

No results

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

payout-details.js

Select a language

JavaScript

React

No results

// 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:

To enable the dismiss behaviour of this component, listen to the close event by calling setOnClose.