API ReferenceEndpointsPublic API (v1)Get a gift card and its full ledger

Get a gift card and its full ledger

Returns one gift card with its ledger, newest entry first (latest 200). The code is masked.

GET
/v1/gift-cards/{id}
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

Path Parameters

idstring

Gift card ID

curl -X GET "https://api.brainerce.com/api/v1/gift-cards/string"
{
  "id": "clx1a2b3c4d5e6f7g8h9",
  "codeLast4": "K7QX",
  "maskedCode": "••••-••••-••••-K7QX",
  "initialAmount": "200.00",
  "balance": "120.00",
  "heldAmount": "20.00",
  "spendable": "100.00",
  "currency": "ILS",
  "status": "ACTIVE",
  "customerId": "clx1a2b3c4d5e6f7g8h9",
  "recipientEmail": "[email protected]",
  "expiresAt": "2027-01-15T00:00:00.000Z",
  "expiredAt": null,
  "createdAt": "2026-09-02T10:30:00.000Z",
  "expired": false,
  "orderId": "clx1a2b3c4d5e6f7g8h9",
  "recipientName": "Dana Cohen",
  "transactions": [
    {
      "id": "clx1a2b3c4d5e6f7g8h9",
      "type": "ISSUE",
      "amount": "-25.00",
      "balanceAfter": "175.00",
      "orderId": "clx1a2b3c4d5e6f7g8h9",
      "actorUserId": "api-key-user",
      "note": "Goodwill for a damaged parcel",
      "createdAt": "2026-09-02T10:30:00.000Z"
    }
  ]
}

{
  "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/{id}"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/gift-cards/{id}"
}

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