List the cards in a series
GET
/api/v1/card-batches/{id}/cards
prm_cards_list
One row per card, carrying the plaintext code and, for prepaid series, the login username and password. Behind both the card-list permission and the per-series subtree gate for that reason.
state and effective_state are different questions and you almost always want the second. Nothing ever writes state 'expired', so a voucher past its expiry still reads as 'unused' in state and shows as available stock; effective_state applies the expiry at read time. Meanwhile disposition answers who holds the card — a voucher sold at the till but not yet redeemed is still 'unused' and is not stock you can sell again.
نظرة سريعة
- المصادقة
- رمز موظّف أو جلسة
- تتطلب صلاحية
-
prm_cards_listView card batches & cards
المعاملات
| المعامل | الوصف |
|---|---|
idمطلوب
path · integer
|
Series id. |
filter[state]
query · string
|
Stored state — unused, consumed, active, exhausted, revoked. |
filter[disposition]
query · string
|
Who holds the card, which is orthogonal to state. |
filter[has_customer]
query · boolean
|
Cards linked to a subscriber. |