---
title: "Update eGift Balance"
method: PUT
path: "/programs/{programCode}/account/{accountIdentifier}/egifts/{egiftId}/balance"
tags: ["EGift"]
---

# Update eGift Balance

`PUT /programs/{programCode}/account/{accountIdentifier}/egifts/{egiftId}/balance`

Update the balance of a specific eGift for the given account and program.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required
- `egiftId` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- EGiftUpdateBalanceRequest — Represents a request to update the balance of an eGift account. Contains the account identifier, eGift ID, and the new balance value. Used in API operations that require updating the balance of a specific eGift.
  - `balance` number, double — Gets or sets the new balance value to be set for the eGift. Serialized as "balance" in the request payload.

## Response `200`

OK

- EGiftUpdateBalanceResponse — Represents the response returned after updating the balance of an e-gift card. Inherits standard response metadata and details from Gd.Bos.DataTransfer.Response.ResponseBase. Contains the updated Gd.Bos.DataTransfer.GiftCard information.
  - `eGift` GiftCard — Represents a gift card with associated account, balance, barcode, and product information.
    - `eGiftId` string, nullable — Gets or sets the unique identifier for the e-gift card.
    - `accountNumber` string, nullable — Gets or sets the account number associated with the gift card.
    - `pin` string, nullable — Gets or sets the PIN code for the gift card.
    - `barcode3rdLineData` string, nullable — Gets or sets the third line data for the barcode, if applicable.
    - `barcodeType` string, nullable — Gets or sets the type of barcode used for the gift card.
    - `barcodeCharacteristics` BarcodeCharacteristics[], nullable — Gets or sets the set of barcode characteristics for the gift card.
      - `id` string, nullable — Gets or sets the unique identifier for the barcode characteristics.
      - `barCodeFormat` string, nullable — Gets or sets the format of the barcode (e.g., QR, Code128).
      - `barcodeType` string, nullable — Gets or sets the type of the barcode (e.g., 1D, 2D).
      - `barcodeSubtype` string, nullable — Gets or sets the subtype of the barcode, providing additional classification.
    - `balance` number, double — Gets or sets the current balance of the gift card.
    - `balanceAsOfDate` string, date-time — Gets or sets the date and time when the balance was last checked.
    - `numberOfTimesBalanceChecked` integer — Gets or sets the number of times the balance has been checked.
    - `cardImage` string, nullable — Gets or sets the image associated with the gift card.
    - `brandName` string, nullable — Gets or sets the brand name of the gift card.
    - `productName` string, nullable — Gets or sets the product name of the gift card.
    - `maxBalanceCheckAllowed` integer — Gets or sets the maximum number of times the balance can be checked.
    - `purchaseDate` string, date-time — Gets or sets the date when the gift card was purchased.
    - `purchaseAmount` number, double — Gets or sets the purchase amount of the gift card.
    - `status` boolean — Gets or sets a value indicating whether the gift card is active.
    - `productType` 'DigitalProduct' | 'EGift' | 'GamerDeals' — Gets or sets the type of product associated with the gift card.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/versions/666553766b78/schema)