Load a balance link's page (booking facts and the live balance)

GET

/b/{token}

const url = 'https://quikstik-core.fly.dev/b/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://quikstik-core.fly.dev/b/example

Token-based auth: the minted token IS the authorization (capability-token design, as /g/{token} and /p/{token}); no session. The balance is read live from the obligation at every call — the link stores no amount — so a rebook between two reads is reflected. A link that can no longer be paid is 410 with link_expired, link_cancelled or link_paid (or, for Accept: text/html, the “This link is no longer valid” page with status 410). A link whose live balance is zero is retired to paid on read and answers 410 link_paid: a $0 pay button is never rendered. With Accept: text/html an open link serves the hosted balance page instead of JSON.

Parameters

Path Parameters

token

required

string

Responses

200

Open link — booking facts and the live balance.

application/json

object

status

required

string

Allowed values: open

product_name

string

nullable

date

Merchant-zone date, e.g. Saturday, September 12, 2026.

string

nullable

time

Merchant-zone time, e.g. 8:15 AM.

string

nullable

meeting_point

string

nullable

party

Array<string>

balance_minor

required

The LIVE balance. Never zero.

integer

>= 1

currency

required

string

paid_so_far_minor

required

integer

Example

{
  "status": "open"
}

404

Invalid_or_expired_token (unknown token).

410

The link can no longer be paid.

application/json

object

reason

required

string

Allowed values: link_expired link_cancelled link_paid

message

string

Example

{
  "reason": "link_expired"
}

503

Balance_link_unavailable.