Skip to content

by Startups.Studio

Finance Account

Account.payout

POST /{namespace}/accounts/{account}/payout

Payout sends available cash from the payments balance to the owner’s bank and lists every Transaction the payout carries.

Noun: Account
Mode: do
Event: Account.paidOut

You, to your agent

Pay out the balance of my account to the bank.

curl -X POST https://api.sb/routewise.dev/accounts/account_1/payout \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { account, transaction } = await $.Account.payout({ account: 'account_1' })

npx startup-builder do Account.payout --json '{"account":"account_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Account.payout({ account: 'account_1' })"
  }
}

Inputs

Input	Type	Required	Description
`account`	Account	required	The payments balance: the cash Account held at `payments`.
`amount`	`money`		How much to send. Defaults to everything available.
`instant`	`boolean`		True to send it within minutes to an eligible debit card or bank, for Stripe’s instant payout cost.
`schedule`	`string`		Sets the Account’s `payoutSchedule` from now on, in place of sending a payout now.

Outputs

Output	Type	Required	Description
`account`	Account	required	The payments balance after the payout.
`transaction`	Transaction	required	The payout, a Transaction of kind `payout`.

Effects

Emits Account.paidOut.
Performed by the Treasurer.
One-way (money): it waits out its delay window, and runs in the send and do modes.
Runs on the Account’s payoutSchedule, daily by default; a call sends one now, or with schedule changes the rhythm.
A payout the bank returns lands back in the payments balance and opens a Task to fix the bank details.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Account.payout

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (money)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The spend Limit of the Permission or Mandate it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Account.list

Previous Page

Account.sweep

Next Page