AlmondTill/G3N API

Stored value instrument

The StoredValueInstrument family — 5 operations.

A stored value instrument is spendable value your group has issued — a gift card, a gift certificate, or customer-bound store credit. Stock is born staged (printed cards awaiting activation) or immediately active with an opening balance; money movements are reason-coded onto its ledger, and a code once used burns forever — never reissued.

Operations

OperationKindWhat it does
createStoredValueInstrumentmutationCreate a new gift card or store-credit instrument — customer-held, money-like at your organization.
doomStoredValueInstrumentmutationPermanently retire a gift card or store-credit instrument — customer-held, money-like.
storedValueInstrumentqueryLook up one record — a gift card or store-credit instrument — customer-held, money-like.
storedValueInstrumentsqueryThe stored value instrument list — each entry is a gift card or store-credit instrument — customer-held, money-like.
updateStoredValueInstrumentmutationEdit a gift card or store-credit instrument — customer-held, money-like — change its details.