API ReferenceEndpointsPublic API (v1)Outstanding gift card liability

Outstanding gift card liability

Per currency. Expired value is reported separately and is NOT written off — whether expiry extinguishes the obligation is an open legal question, so it is never folded into either side.

GET
/v1/gift-cards/liability
AuthorizationBearer <token>

Admin API key (server-to-server). Issue via the dashboard at Settings → API keys. Plain-text key is shown once — store in a secret manager. Format: Authorization: Bearer brainerce_xxxxxxxxx.

In: header

curl -X GET "https://api.brainerce.com/api/v1/gift-cards/liability"
{
  "active": "3250.00",
  "held": "40.00",
  "expiredNotWrittenOff": "120.00",
  "currency": "ILS",
  "byCurrency": [
    {
      "currency": "ILS",
      "active": "3250.00",
      "held": "40.00",
      "expiredNotWrittenOff": "120.00"
    }
  ],
  "enabled": true
}

{
  "statusCode": 401,
  "code": "UNAUTHORIZED",
  "message": "Invalid or expired credential",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/products/bulk/{jobId}"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/gift-cards/liability"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/store"
}