Error

A valid request URL is required to generate request examples

{
  "expiredBalanceCents": 1200,
  "expiredCount": 2,
  "neverRedeemedBalanceCents": 5000,
  "neverRedeemedCount": 1,
  "totalBreakageCents": 6200,
  "totalCount": 3
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Instruments

Report stored-value breakage over a capped sample

Aggregates unredeemable and untouched stored value AS OF THE REQUEST CLOCK: expired* counts instruments past their expiresAt that still carry a balance, neverRedeemed* counts live instruments never drawn on, and total* sums both. Voided instruments are excluded. ⚠️ NOT A NETWORK TOTAL: the underlying query reads only the FIRST 100 instruments of the book, unsorted, so on a book larger than 100 these figures are an arbitrary sample and the response carries no indication that it was truncated. Treat the result as indicative only — do NOT use it for an accounting write-back of unclaimed value or any figure that must reconcile. It takes no parameters and never mutates.

GET

giftcards

breakage

Error

A valid request URL is required to generate request examples

{
  "expiredBalanceCents": 1200,
  "expiredCount": 2,
  "neverRedeemedBalanceCents": 5000,
  "neverRedeemedCount": 1,
  "totalBreakageCents": 6200,
  "totalCount": 3
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Authorizations

Authorization

string

header

required

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.

Response

The breakage totals in integer cents, plus the instrument counts.

expiredBalanceCents

integer

required