Reload Gift Card
POST/api/gift-cards/:giftCard/reload
Add value to an existing gift card. Writes a reload ledger entry and returns it with the card's new balance.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Permission: pos.manage.
Request body fields:
amount(numeric, required, > 0) — the amount to add. Error message when not > 0: "The reload amount must be greater than zero."notes(string, nullable, max 2000) — internal note.reference(string, nullable, max 255) — external reference for the reload (e.g. a receipt or payment reference).
Returns 201 with { data: <ledger entry>, balance: <float>, message: "Gift card reloaded." }.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.