createStoredValueInstrument

mutation · in the family Stored value instrument

What it does

Create a new gift card or store-credit instrument — customer-held, money-like at your organization.

Create a StoredValueInstrument DIRECTLY in the caller's org group.

Who may call it

Capability area: Till and cash management — Manual drawer entries and force-closing a till.

Owner
Manager
Associate Manager
An API key whose scope allows api:createStoredValueInstrument

Arguments

Name	Type	Required	Notes
`input`	NewStoredValueInstrumentInput `NewStoredValueInstrumentInput!`	yes	No further notes.

Returns

StoredValueInstrument StoredValueInstrument! — A StoredValueInstrument — a balance-bearing money instrument: gift_card (purchasable, reloadable-by-field, bearer) · gift_certificate (fixed-amount) · store_credit (refund/goodwill-born, customer-BOUND, never purchasable as a line). The FSM tracks USABILITY; the StoredValueEntry ledger tracks VALUE — balanceMinor is the cached ledger sum, stamped in the SAME transaction as every entry (the / law), with every decrement CONDITIONED (never negative — CONFLICT/INSUFFICIENT_BALANCE). Dual-birth: immediate active (the issue entry rides the create) or STAGED inactive printed stock (activated at sale via the Order line arm, or directly via activateStoredValueInstrument). Selling/reloading one is an Order LINE (untaxed — basis instrument_sale; engine-invisible); redeeming one is an applyTender step-5 internal tender; store credit from a return mints via refundReturn method=store_credit. Doom is gated by CONFLICT/BALANCE_OUTSTANDING while value remains (zero via reason-coded adjust FIRST — no silent money destruction).

Example request

mutation ExampleCreateStoredValueInstrument($input: NewStoredValueInstrumentInput!) {
  createStoredValueInstrument(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    instrumentType
    code
    reloadable
    balanceMinor
    currency
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "organizationId": "01900000-0000-7000-8000-44b781470000",
    "instrumentType": "gift_card"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createStoredValueInstrument": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "SV-EXMP-0000-000F",
      "type": "StoredValueInstrument",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "instrumentType": "gift_card",
      "code": "BJ-001",
      "reloadable": true,
      "balanceMinor": 1,
      "currency": "USD"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
NOT_FOUND/* — That record could not be found. (NOT_FOUND)
CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

Sell and redeem gift cards and store credit