Account methods: payout, sweep

Reference for Account, one group of Account methods.

Account.payout

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

TypeScript

interface AccountVerbs {
  payout(input: AccountPayoutInput, options?: SB.CallOptions): SB.Call<AccountPayoutOutput>
}

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.

Returns

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

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.	None.

Example

TypeScript

import { $ } from 'startup-builder'

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

Sweep moves cash between two cash Accounts of the same owner, once or on a standing rule, within the Treasurer’s Limit. Verb page.

TypeScript

interface AccountVerbs {
  sweep(input: AccountSweepInput, options?: SB.CallOptions): SB.Call<AccountSweepOutput>
}

Inputs

Input	Type	Required	Description
`from`	Account	required	The cash Account the money leaves.
`to`	Account	required	The cash Account it lands in.
`amount`	`money`		How much to move. Leave it out and set `keep` to move everything above a floor.
`keep`	`money`		Leave this much in `from` and move the rest.
`repeat`	`string`		Turns the move into a standing rule that sweeps on this schedule.

Returns

Output	Type	Required	Description
`account`	Account	required	The `to` Account, with the money landed.
`transaction`	Transaction	required	The move, reconciled on both Accounts.

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.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const { account, transaction } = await $.Account.sweep({ from: 'acct_nV4f0K7dTw', to: 'acct_nV4f0K7dTw' })