Bank accounts (Portal)

List payouts to a bank account

Returns the payouts Stripe has sent to this bank account. Every payout moves money from the connected Stripe account into the bank, never the other way.

GET

https://api.portal.magicdoor.com/company-app/bank-accounts/{bankAccountId}/payouts

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

bankAccountIdstringrequired

The bank account whose payouts to list. It must have a Stripe connection. A Snowflake id sent as a decimal string.

example: 1801556677120004096

Query parameters

created.startstring · date-time

Return only payouts created at or after this moment, read in the company's timezone. Give at least one of created.start and created.end when filtering by date.

created.endstring · date-time

Return only payouts created at or before this moment, read in the company's timezone.

Response

200 · The payouts, as a bare array. This endpoint is not paginated.

idstring

The payout's id at Stripe. An opaque provider token, not a MagicDoor Snowflake id — pass it back verbatim to fetch the payout's details.

stripeAccountIdstring

The Stripe connected account the payout was made from. An opaque provider token.

amountnumber

How much the payout moves into the bank account, in dollars and cents.

currencystring

The currency of the payout, as reported by Stripe.

descriptionstring

Stripe's description of the payout. Absent when it has none.

statementDescriptorstring

The text that appears on the bank statement. Absent when none was set.

methodstring

How Stripe sent the money, as Stripe reports it — for example standard or instant.

typestring

The destination type Stripe reports, for example bank_account.

statusstring

The payout's state as Stripe reports it, for example paid, pending, in_transit, canceled or failed.

automaticboolean

true when Stripe created the payout on its own schedule rather than it being requested.

createdstring · date-time

When Stripe created the payout, in the company's timezone.

arrivalDatestring · date-time

When Stripe expects the money to land in the bank account, in the company's timezone.

destinationIdstring

Stripe's id for the account the money was sent to. An opaque provider token. Absent when Stripe does not report one.