Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIFinanceAccount

Account routes: payout, sweep

The Account Verbs payout, sweep as api.sb routes, with inputs, result, refusals and an example.

Reference for Account, one group of Account routes.

Account.payout

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

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

Path: account. Body, as JSON: the other inputs. Emits Account.paidOut.

Inputs

InputTypeRequiredDescription
accountAccountrequiredThe payments balance: the cash Account held at payments.
amountmoneyHow much to send. Defaults to everything available.
instantbooleanTrue to send it within minutes to an eligible debit card or bank, for Stripe’s instant payout cost.
schedulestringSets the Account’s payoutSchedule from now on, in place of sending a payout now.

Returns

OutputTypeRequiredDescription
accountAccountrequiredThe payments balance after the payout.
transactionTransactionrequiredThe payout, a Transaction of kind payout.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/accounts/acct_nV4f0K7dTw/payout \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "account": {
    "$id": "https://api.sb/leaseline.app/accounts/acct_nV4f0K7dTw",
    "$type": "Account",
    "class": "cash"
  },
  "transaction": {
    "$id": "https://api.sb/leaseline.app/transactions/txn_XoxtZe3CQI",
    "$type": "Transaction",
    "kind": "charge",
    "amount": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Account.payout",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Account.sweep

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

Text
POST /{namespace}/accounts/{from}/sweep

Path: from. Body, as JSON: the other inputs. Emits Account.swept.

Inputs

InputTypeRequiredDescription
fromAccountrequiredThe cash Account the money leaves.
toAccountrequiredThe cash Account it lands in.
amountmoneyHow much to move. Leave it out and set keep to move everything above a floor.
keepmoneyLeave this much in from and move the rest.
repeatstringTurns the move into a standing rule that sweeps on this schedule.

Returns

OutputTypeRequiredDescription
accountAccountrequiredThe to Account, with the money landed.
transactionTransactionrequiredThe move, reconciled on both Accounts.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/accounts/acct_nV4f0K7dTw/sweep \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"acct_nV4f0K7dTw"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "account": {
    "$id": "https://api.sb/leaseline.app/accounts/acct_nV4f0K7dTw",
    "$type": "Account",
    "class": "cash"
  },
  "transaction": {
    "$id": "https://api.sb/leaseline.app/transactions/txn_XoxtZe3CQI",
    "$type": "Transaction",
    "kind": "charge",
    "amount": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Account.sweep",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

get, list

Previous

Bill

Next