Prints the gift card's remaining balance.

Description

This article is about renewed gift cards that you can enable as an experimental feature.

The new model of gift cards is due to replace the old discount coupons of the Gift card type on 1 June 2021.

When necessary, learn more about the old discount coupons if you don't wish to use this feature.

If the visitor hasn't entered any gift card codes, the tag won't print anything.

To print the gift card balance reserved for paying for the order, use the {GiftCardBalanceReserved} tag.

Syntax

{GiftCardBalanceLeft(
    html: boolean,
    exchanged: boolean,
    currencysymbol: boolean,
    decimals: int,
    decimalsep: string,
    thousandssep: string 
)}

Scope

Required scope: globaali

The tag is used in the {CartGiftCards} tag's helper attribute.

Attribuutit

html:

Defines whether the content should be printed wrapped in the default HTML markup.

Allowed values:true/false

exchanged:

Defines whether to take currency conversion into account in the output if the customer has placed an order in a currency other than euro.

The exchanged attribute is used only if the Currency Converter extension is in use.

This attribute works only after the customer has placed an order. So, you can use the attribute in order templates and e.g. inside the order products' tags.

Allowed values:true/false. The default value is false.

The content is always printed in euros if the value is false.

currencysymbol:

Defines whether the currency symbol should be printed along with the sum. The symbol to be printed is selected automatically based on the currency in use.

The exchanged attribute defines which currency symbol should be printed.

The currency symbol can also be printed by using the {CurrencySymbol} tag.

Allowed values:true/false. The default value is false.

decimals:

Defines the number of decimal places to be printed (2 by default).

Allowed values:integers

decimalsep:

Defines the character used as a decimal separator.

The most popular decimal separators are comma and dot, the use of which depends on the store's locale.

Allowed values: the character that should be used as a decimal separator. E.g. decimalsep: '.'

Comma is used by default.

thousandssep:

Defines the character used as a thousands separator.

The most commonly used thousands separators are space, comma and dot. You may want to define thousands separators according to the locale.

Allowed values: a character that should be used as the thousands separator in prices.

By default, the non-breaking space   is used.

after/before:

By using the after and before attributes you can define content that is output either after or before the tag's output.

Allowed values:The HTML and Interface markup

E.g.

  • before: '<p>Tämä merkkaus näkyy ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas näkyy tagin oman sisällön jälkeen.</p>'

If the tag does not produce any content, neither the content of the after and before attributes will be output.

escape:

Adds an escape character before quotation marks in the output.

The attribute makes it easier to process the tag-produced content when using JavaScript.

Allowed values:true/false. The default value is false.

or:

Defines alternative content that is displayed if the tag itself does not produce any content.

Allowed values:The HTML and Interface markup

E.g. or:'Sisältöä ei löytynyt.'