Skip to content

by Startups.Studio

Mandate.spend

POST /{namespace}/mandates/{mandate}/spend

Spend pays an outside party for a Startup with a single-use card, within a Mandate and its Limit.

Noun: Mandate
Mode: do
Event: Mandate.spent

You, to your agent

Spend the latest mandate.

curl -X POST https://api.sb/kilnbakery.com/mandates/mandate_1/spend \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":{"amount":9,"currency":"USD"},"payee":"Example payee"}'

import { $ } from 'startup-builder'

const { transaction, mandate } = await $.Mandate.spend({ mandate: 'mandate_1', amount: { amount: 9, currency: 'USD' }, payee: 'Example payee' })

npx startup-builder do Mandate.spend --json '{"mandate":"mandate_1","amount":{"amount":9,"currency":"USD"},"payee":"Example payee"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Mandate.spend({ mandate: 'mandate_1', amount: { amount: 9, currency: 'USD' }, payee: 'Example payee' })"
  }
}

Inputs

Input	Type	Required	Description
`mandate`	Mandate	required	The Mandate that covers the purchase.
`amount`	`money`	required	The amount to spend.
`payee`	`string`	required	Who is paid.

Outputs

Output	Type	Required	Description
`transaction`	Transaction	required	The card Transaction.
`mandate`	Mandate	required	The Mandate with its remaining Limit.

Effects

Emits Mandate.spent.
Performed by the Treasurer.
One-way (money): it waits out its delay window, and runs in the send and do modes.
Checks the Mandate’s Limit; above it, opens an Approval and the Action waits.
Posts a cost Entry against the Action that spent.

Refuses when

Check	Error	Fix	Then call
The operation is part of an Offer the caller has not accepted or paid for.	`payment-required`	Accept the Offer named in the response, then retry the call.	Offer.accept
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.	Mandate.spend

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

Mandate.revoke

Previous Page

Mandate.update

Next Page