LogoLogo
  • Welcome
  • Getting Started
  • Integration Methods
  • SDKs
  • Tebex for Unreal Engine 5
  • Tebex for Unity Engine
  • Webstore Builder
    • Overview
    • Getting Started
    • Twig
      • Tags
      • Filters
      • Functions
    • Global Variables
      • basket
      • store
      • page
    • Pages
      • index.html
      • checkout.html
      • username.html
      • options.html
      • package.html
      • cms/page.html
      • category.html
      • layout.html
    • Sidebar Modules
      • module.communitygoal.html
      • module.featuredpackage.html
      • module.giftcardbalance.html
      • module.goal.html
      • module.payments.html
      • module.serverstatus.html
      • module.textbox.html
      • module.topdonator.html
    • Assets
    • Schema
    • Developer Plan
    • Footer
    • Guides
      • Package Slugs
  • Headless API
    • Overview
    • Getting Your Listings
    • Creating a Basket
    • Adding Packages
    • Gifting Packages
    • Applying Discounts / Creator Codes
    • Directing to Checkout
    • Endpoints
    • Postman Config
    • Example Integration
  • Checkout API
    • Overview
    • Headers and Authentication
    • Start the Checkout Process
    • Checkout Webhooks
    • Endpoints
    • Errors
    • Postman Config
  • Tebex.js
    • Overview
    • Integration
    • Events
    • Web Components
    • Custom Render Location
    • NPM
    • GitHub
  • Webhooks
    • Overview
    • Login Webhooks
  • Game Server API
    • Overview
    • Authentication
    • Error Handling
    • Endpoints
  • Affiliate API
    • Overview
    • Referrals
    • Game Types
    • Webhooks
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Webstore Builder
  2. Sidebar Modules

module.giftcardbalance.html

Previousmodule.featuredpackage.htmlNextmodule.goal.html

Last updated 7 months ago

Was this helpful?

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.

Variables
Type
Description

module.header

string

The header of the module.

search

boolean

If the customer has attempted to search for a giftcard.

giftcard

object

If a giftcard was found from their search, it will be populated in this object.

giftcard.card_number

string

The gift card number the customer has searched for.

giftcard.void

boolean

If the giftcard that has been searched for has been voided by the store owner.

giftcard.remaining_balance

string

The remaining balance of the giftcard which has been searched for.

Request Variable

If you'd like access to a variable that is not currently available,

please let us know.