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

Card routes

Every Card Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Card.

NounSystemRun by
CardSpend managementFinance Lead

Card.get

Returns one Card by id. Verb page.

Text
GET /{namespace}/cards/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Card.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
cardCardrequiredThe Card.

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 https://api.sb/leaseline.app/cards/card_YkjOnjSexq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Card",
  "$id": "https://api.sb/leaseline.app/cards/card_YkjOnjSexq",
  "card": {
    "$id": "https://api.sb/leaseline.app/cards/card_YkjOnjSexq",
    "$type": "Card",
    "form": "singleUse",
    "status": "active",
    "limit": "limit_UWHXYVKsJB"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/cards/card_YkjOnjSexq",
    "up": "https://api.sb/leaseline.app/cards"
  }
}

Card.list

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

Text
GET /{namespace}/cards

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
cardslist of CardrequiredOne page of Cards.

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 "https://api.sb/leaseline.app/cards?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Card",
  "cards": [
    {
      "$id": "https://api.sb/leaseline.app/cards/card_YkjOnjSexq",
      "$type": "Card",
      "form": "singleUse",
      "status": "active",
      "limit": "limit_UWHXYVKsJB"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "card_YkjOnjSexq"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/cards?limit=20",
    "next": "https://api.sb/leaseline.app/cards?after=card_YkjOnjSexq"
  }
}

Card.issue

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

Text
POST /{namespace}/cards/issue

Body, as JSON: the inputs. Emits Card.issued.

Inputs

InputTypeRequiredDescription
mandateMandaterequiredThe Mandate the Card spends under.
formstringrequiredWhich kind of Card to issue.
taskTaskFor a singleUse Card: the Task it pays for.
merchantstringFor a merchant Card: the one merchant it may pay.

Returns

OutputTypeRequiredDescription
cardCardrequiredThe active Card, with its last four digits and limits.

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.
The card program of the Startup’s owner of record awaits its grant, so no Card can be issued.card-program-pendingCall 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 grantcard-program-pendingClear what the check names, then call it again.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/cards/issue \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mandate":"mandate_mKKPrmFQYD","form":"singleUse"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "card": {
    "$id": "https://api.sb/leaseline.app/cards/card_YkjOnjSexq",
    "$type": "Card",
    "form": "singleUse",
    "status": "active",
    "limit": "limit_UWHXYVKsJB"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Card.issue",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Commission

Next