Interface: TenderView
Interface: TenderView in @ticketlayer/live.
@ticketlayer/live / index / TenderView
Defined in: core/tenders.ts:25
How a held tender is shown. Carries no code.
Properties#
balance#
balance: number;Defined in: core/tenders.ts:37
What it could pay when applied, in minor units: the read's spendable
where it carries one, otherwise its balance. A balance can be null for a
caller who may not see what is on it (backstage #251), so the client never
relies on it when spendable is there.
currency#
currency: string;Defined in: core/tenders.ts:38
expiresAt#
expiresAt: string | null;Defined in: core/tenders.ts:39
id#
id: string;Defined in: core/tenders.ts:27
This client's own id for the held tender (tnd_...); not an API id.
instrument#
instrument: "gift_card" | "account_credit";Defined in: core/tenders.ts:28
last4#
last4: string | null;Defined in: core/tenders.ts:30
The last four characters of a gift card's code; null for credit.
narrowed#
narrowed: boolean;Defined in: core/tenders.ts:43
Narrowed to one event or account: the API may refuse it for some orders.
storedValueAccountId#
storedValueAccountId: string | null;Defined in: core/tenders.ts:41
The credit balance's id (sva_...); null for a gift card, which is named by its code.