Get a payout
Fetches one Stripe payout with every balance entry that made it up and a summary of the amount, fees and net, so a bank deposit can be reconciled line by line.
Authorization
AuthorizationstringrequiredPath parameters
bankAccountIdstringrequiredThe bank account the payout was sent to. A Snowflake id sent as a decimal string.
payoutIdstringrequiredStripe's id for the payout, taken from the payout list. An opaque provider token, not a Snowflake id.
Response
200 · The payout, its balance entries, and the summary.
idstringThe payout's id at Stripe. An opaque provider token, not a MagicDoor Snowflake id — pass it back verbatim to fetch the payout's details.
stripeAccountIdstringThe Stripe connected account the payout was made from. An opaque provider token.
amountnumberHow much the payout moves into the bank account, in dollars and cents.
currencystringThe currency of the payout, as reported by Stripe.
descriptionstringStripe's description of the payout. Absent when it has none.
statementDescriptorstringThe text that appears on the bank statement. Absent when none was set.
methodstringHow Stripe sent the money, as Stripe reports it — for example standard or instant.
typestringThe destination type Stripe reports, for example bank_account.
statusstringThe payout's state as Stripe reports it, for example paid, pending, in_transit, canceled or failed.
automaticbooleantrue when Stripe created the payout on its own schedule rather than it being requested.
createdstring · date-timeWhen Stripe created the payout, in the company's timezone.
arrivalDatestring · date-timeWhen Stripe expects the money to land in the bank account, in the company's timezone.
destinationIdstringStripe's id for the account the money was sent to. An opaque provider token. Absent when Stripe does not report one.
itemsPayoutItem[]Every Stripe balance entry that rolled into this payout, with the property, unit, lease and person behind each one resolved.
summaryobjectWhat the payout came to in total.