> For the complete documentation index, see [llms.txt](https://docs.tebex.io/developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tebex.io/developers/templates/sidebar-modules/module.giftcardbalance.html.md).

# module.giftcardbalance.html

The gift card balance module lets your customers enter a gift card and determine the amount of value that remains on the specified gift card.

<table><thead><tr><th width="320.3333333333333">Variables</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>module.header</code></td><td>string</td><td>The header of the module.</td></tr><tr><td><code>search</code></td><td>boolean</td><td>If the customer has attempted to search for a giftcard.</td></tr><tr><td><code>giftcard</code></td><td>object</td><td>If a giftcard was found from their search, it will be populated in this object.</td></tr><tr><td><code>giftcard.card_number</code></td><td>string</td><td>The gift card number the customer has searched for.</td></tr><tr><td><code>giftcard.void</code></td><td>boolean</td><td>If the giftcard that has been searched for has been voided by the store owner.</td></tr><tr><td><code>giftcard.remaining_balance</code></td><td>string</td><td>The remaining balance of the giftcard which has been searched for.</td></tr></tbody></table>

### Request Variable

If you'd like access to a variable that is not currently available, [please let us know.](https://forms.monday.com/forms/8cbacdac7c30b725cd4617cbba0e5eeb?r=use1)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.tebex.io/developers/templates/sidebar-modules/module.giftcardbalance.html.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.