Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Revenue
Platforms and marketplaces
Money management
Developer resources

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
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node
Go
.NET
No results
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:

payout-details.js
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:

MethodTypeDescription
setPayoutstringThe ID of the payout to display, which must be a payout on the connected account. If you don’t specify a valid ID, the embedded component renders nothing. To find the ID, you can retrieve a list of payouts.required
setOnClose() => voidWe send this event when the user closes the overlay.

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

Was this page helpful?
YesNo
  • Need help? Contact Support.
  • Join our early access programme.
  • Check out our changelog.
  • Questions? Contact Sales.
  • LLM? Read llms.txt.
  • Powered by Markdoc