Card methods · StartupBuilder

Reference for Card.

Noun	System	Run by
Card	Spend management	Finance Lead

Card.get

Returns one Card by id. Verb page.

TypeScript

interface CardVerbs {
  get(input: CardGetInput, options?: SB.CallOptions): SB.Call<Card>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Card.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`card`	Card	required	The Card.

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 card = await $.Card.get({ id: 'card_YkjOnjSexq' })

Returns Cards, newest first, one page at a time. Verb page.

TypeScript

interface CardVerbs {
  list(input?: CardListInput, options?: SB.CallOptions): SB.ListCall<Card>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`cards`	list of Card	required	One page of Cards.

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 cards = await $.Card.list({ limit: 20 })

Issue creates a Card under a Mandate once the Mandate check passes, with explicit limits on every interval. Verb page.

TypeScript

interface CardVerbs {
  issue(input: CardIssueInput, options?: SB.CallOptions): SB.Call<Card>
}

Inputs

Input	Type	Required	Description
`mandate`	Mandate	required	The Mandate the Card spends under.
`form`	`string`	required	Which kind of Card to issue.
`task`	Task		For a `singleUse` Card: the Task it pays for.
`merchant`	`string`		For a `merchant` Card: the one merchant it may pay.

Returns

Output	Type	Required	Description
`card`	Card	required	The active Card, with its last four digits and limits.

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.
The card program of the Startup’s owner of record awaits its grant, so no Card can be issued.	`card-program-pending`	Call again once the program is granted; nothing on the Startup’s side changes.	None.
`card-program-pending` while the card program of the Startup’s owner of record awaits its grant	`card-program-pending`	Clear what the check names, then call it again.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const card = await $.Card.issue({ mandate: 'mandate_mKKPrmFQYD', form: 'singleUse' })