List stored-value instruments (carte cadeau, avoir)
Returns one page of the issued instrument book (gift cards, credit notes and store credit share one aggregate). Filter with kind and/or status, sort by code or balanceCents, and walk with page/pageSize (max 100) until pageCount. Use this to survey or reconcile the book; to resolve ONE card a customer is holding, use the by-code lookup instead — a scanned code is not searchable here.
Authorizations
Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.
Query Parameters
1-based page number (default 1).
0 < x <= 9007199254740991Rows per page, 1-100 (default 20).
0 < x <= 100Instrument kind to filter on: gift_card / credit_note / store_credit.
gift_card, credit_note, store_credit Instrument status to filter on, e.g. active / depleted / void.
active, depleted, void Field to order by: code or balanceCents.
code, balanceCents Order direction for sortField (default asc).
asc, desc Response
A page of instrument read models with the pagination totals.
A page of instrument read models with the pagination totals.
-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991
