Björk UI

Components•API reference table

API reference table

A parameter reference for API docs. Path, query and body params sit in tabs, nested object fields expand in place with an indent guide, union types wrap as chips, and every name carries a copyable deep link.

Dependencies

Motion clsx

Copy below cli

npx shadcn add @bjork-ui/api-reference-table

How to use

import { ApiReferenceTable, type ApiSection } from "@/components/bjork-ui/tables/api-reference-table";const sections: ApiSection[] = [  {    id: "body",    label: "Body",    params: [      { name: "amount", type: "integer", required: true, description: "Amount in the smallest currency unit." },      {        name: "destination",        type: "object",        required: true,        description: "Where the funds land.",        children: [          { name: "type", type: '"bank_account" | "debit_card"', required: true, description: "Kind of destination." },        ],      },      { name: "source_balance", type: "string", deprecated: "Use `source_type` instead.", description: "Balance to draw from." },    ],  },];<ApiReferenceTable  title="Create a payout"  method="POST"  path="/v2/accounts/{account_id}/payouts"  sections={sections}  defaultExpanded={["destination"]}  onCopyAnchor={(anchor) => console.log(anchor)}/>

Create a payout

POST/v2/accounts/{account_id}/payouts

Create a payout body parameters
Parameter	Type	Default	Description
`amount`Required	`integer`	None	Amount in the smallest currency unit. `125000` sends 1,250.00 in a two-decimal currency.
`currency`Required	`string`	None	Three-letter ISO 4217 code in lowercase, such as `usd` or `eur`. Must match the destination.
`destination`Required	`object`5 fields	None	Where the funds land. Pass an existing id or describe a new account.
`destination.type`Required	`"bank_account""debit_card""wallet"`(one of 3 values)	None	Kind of destination. Determines which other fields apply.
`destination.id`	`string`	None	An existing destination, such as `ba_8Hq2Lm`. Overrides the fields below.
`destination.account_number`	`string`	None	Bank account number. Required when `type` is `bank_account`.
`destination.routing_number`	`string`	None	Nine-digit routing number for US accounts.
`destination.holder`	`object`2 fields	None	The person or business that owns the account.
`method`	`"standard""instant"`(one of 2 values)	`"standard"`	`instant` arrives in minutes for a 1% fee. `standard` settles in one to two business days.
`scheduled_for`since 2024-11	`timestampnull`(one of 2 values)	`null`	Unix timestamp to hold the payout until. Must be within 90 days.
`statement_descriptor`	`string`	None	Up to 22 characters shown on the recipient's bank statement.
`metadata`	`Record<string, string>`	`{}`	Up to 50 key-value pairs for your own reference. Never shown to the recipient.
`source_balance`Deprecated	`"available""pending"`(one of 2 values)	`"available"`	Which balance to draw from.Use `source_type` instead. Removed in 2026-01.

15 parametersHover a name to copy its link